Step-by-step Guide to Using MagicalRecord and Mogenerator
Core Data remains a nightmare framework, with many lines of code to get started.
Apple provides a snippet section just for Core Data. Browse through it, be afraid, then appreciate the 2 libraries I will be introducing here.
In this post, I will explain a step by step to set them up, for there is a lack of proper documentation.
1. Install MagicalRecords
Using CocoaPods, add this to your podfile:
pod 'MagicalRecord/Shorthand', '~> 2.2'
Note: We want to used shorthand, therefore the additional “/Shorthand” in the podfile. Shorthand is recommended, so that you use
findAll instead of
2. Setup pch
Your pch file should look like this:
1 2 3 4
3. Setup when application load/exit
1 2 3 4 5 6 7
Or if you want to setup with a different sqlite name, or deal with migration, refer to this documentation.
4. Using MagicalRecord API
MagicalRecord documentation is kind of messy. Here’s a orderly guide to using:
At this point, you may already use MagicalRecord API with Core Data. Just create your model and entities. Refer to a tutorial if needed.
But it is better to use mogenerator to generate the entitiy classes. I will explain setting up of mogenerator in the rest of the sections. But if you are not using mogenerator, stop here.
5. Install mogenerator
The value of mogenerator is:
Generate 2 classes per entity – 1 for machine and 1 for human (which you can edit)
It is a command-line tool, which you can install using brew:
// On your command line $ sudo brew install mogenerator // Or if you need to update $ sudo brew update && brew upgrade mogenerator
6. Add a Model
Next, add a core data model (if you have not).
Go to File > New File > Core Data > Data Model
You should save
Model.xcdatamodeld in a
7. Add new Entity
Add a new entity into the model. Assume the entity name is
Change the entity name, and also class name to
8. Setup target and build script
Follow the guide to setup a target for mogenerator. That creates a mogenerator target that you can build everytime you change your model.
Here’s my build script:
mogenerator -m "MyApp/Models/Model.xcdatamodeld/Model.xcdatamodel" -O MyApp/Models --template-var arc=true
MyApp/Models/ is the directory containing all my models related file, which is also where I save the data model when I created it. You may make changes accordingly.
You can also refer to the command-line options, if you need to change how it generates.
UPDATE: If you are using v1.28 (Sep 2014), and wants to use ARC, the shorter command is:
mogenerator --v2 -m "MyApp/Models/Model.xcdatamodeld" -O "Jade/Models"
Note that if you have a new version of your model, you should edit the build script correspondingly. eg. I have a “Model 2.xcdatamodel”:
mogenerator -m "MyApp/Models/Model.xcdatamodeld/Model 2.xcdatamodel" -O MyApp/Models --template-var arc=true
9. Build mogenerator target
Select the mogenerator target and build. This will generate all the files.
Person.h/m is the file for human, which you may edit.
_Person.h/m is the file for machines, which you should never touch.
10. Add the files to project
Models group in your project.
Start using with MagicalRecords, or refer to a tutorial if needed.