mogenerator + Xmo'd
Visit the project's pretty homepage.
Here's mogenerator's elevator pitch:
mogeneratoris a command-line tool that, given an
.xcdatamodelfile, will generate two classes per entity. The first class,
_MyEntity, is intended solely for machine consumption and will be continuously overwritten to stay in sync with your data model. The second class,
_MyEntity, won't ever be overwritten and is a great place to put your custom logic.
Want more detail? John Blanco has authored a detailed writeup about mogenerator.
Senseful wrote up a nice summary of mogenerator's command-line options.
Xmo'd (pronounced ex-mowed) is an Xcode 3 (Xcode 4 support is planned) plugin that integrates mogenerator into Xcode. It saves you the hassle of having to write a Run Script Build Phase and/or manually adding+removing source files from your project as you add+remove entities.
Xmo'd works by noticing when your
*.xcdatamodel is saved. If the model file's Xcode project item comment contains
xmod, an AppleScript is fired that creates a folder based on your model's file name and populates it with derived source code files from your model. It then adds the new folder to your project as a Group Reference and adds all the source files to your project.
[NEW] mogenerator's standard templates are now bundled into the mogenerator binary itself. This should solve the problem of templates growing out of sync with the intended version of mogenerator (exacerbated by the now-popular homebrew installer). You can still use your own templates with the
--template-groupparameters. issue 79 (Ingvar Nedrebo, rentzsch).
[NEW] Support for per-entity custom base classes, set via
mogenerator.customBaseClasskey in the entity's user info. (Trevor Squires)
[CHANGE] mogenerator installer no longer installs separate template files (but it won't touch those already installed).
[CHANGE] mogenerator's .pkg installer no longer includes Xmo'd since 1) Xmo'd doesn't work with Xcode 4 yet and 2) Xcode.app now lives in /Applications, so the installer needs to get smarter to cope.
[NEW] Support for Xcode 4.3 and it's relocation of
momcinto its bundle. Only supports /Applications/Xcode.app for now. (Matt McGlincy)
[NEW] Can now generate
NSFetchedResultsControllercreation code for to-many relationships (use
--template-var frc=true). (Daniel Tull)
[DOC] Link to John Blanco's Getting Started with Mogenerator.
[NEW] Now generates Mike Ash-style constant structures for attributes, relationships and fetched properties. This allows you to write code like
[obj valueForKey:PersonMOAttributes.age]. Tip: you'll need to enable ARC generation (
--template-var arc=true) if you're using ARC. (Daniel Tull)
--base-class-forceoption, for specifying a base class even if the model file's entities don't specify one. (Joe Carroll)
[NEW] PONSO: NSSet-based templates, improved inverse relationship logic and plug memory leak. (Tyrone Trevorrow)
[FIX] PONSO: Added import for super entity in machine headers. (Tyrone Trevorrow)
[FIX] Migrate from deprecated
-[NSString initWithContentsOfFile:]and fix a MiscMerge warning where an immutable object was assigned to a mutable ivar. (Joshua Smith)
[NEW] New template that dumps a binary .xcdatamodel into a pseudo-ASCII-plist format perfect for diffing. A great way to compare two versions of a data model. (Brian Webster)
[NEW] Attributes and relationships are now sorted for generation. This should eliminate spurious changes to source files when unrelated model entities are changed. After upgrading to 1.23 you probably want to regenerate all your source files without a model change, just to let things settle in before your next real model change. (Nikita Zhuk)
[NEW] Support for generation of PONSOs: Plain Old NSObjects. These are in-memory, typesafe non-CoreData classes generated from your Xcode data models. Generate reams of ObjC classes from a single data model. Supports relationships and basic serialization. See
contributed templates/Nikita Zhuk/ponso/README.txtfor details. (Nikita Zhuk)
[NEW] Support for
MOMC_SUPPRESS_INVERSE_TRANSIENT_ERROR. (Nikita Zhuk)
[NEW] Now generates output directories if they don't already exist or presents an error message if they cannot be created. (Scott Little)
include.m. (Zac Bowling)
[NEW] You can now use
--template-varto pass arbitrary command-line options through to templates. (Adam Cox)
[NEW] Update MiscMerge to NS(U)Integer for 64-bit compatibility. (Nikita Zhuk)
[FIX] Memory leaks in MiscMerge. (Nikita Zhuk)
mogenerate.commandupgraded to use double-dash option names. (rentzsch)
[FIX] Set mogeneratorTestMule's
mogenerate.commandexecutable bit. (rentzsch)
-keyPathsForValuesAffectingValueForKey:is now generated in machine.m files, populated by your entity's scalar attributes. The idea is code like
myObject.myIntAttributeValue++tells Core Data that
myIntAttributehas changed (handy when you're KVO-observing
myIntAttribute). (Tony Arnold)
[NEW] When a model file has multiple versions (
.xcdatamodeldfiles) Xmo'd now uses the "current" version of the model (set the "xmod" command on the xcdatamodeld group). (Vincent Guerci)
[NEW] mogenerator and Xmo'd now supports model-relative paths for the
[NEW] Machine templates now include fetched properties by default. (Jonathan del Strother)
[NEW] Xmo'd: better support for
--(machine|human|output)-dirmodel option path: now they can be full or relative to the model file. Xcode group and file references are no longer deleted/re-added with every save. (John Turnipseed)
--log-commandmodel option. When enabled, Xmo'd will log (to Console.app) the generated+executed
mogeneratorinvocation. Good for automation debugging and also can provide training wheels for using mogenerator directly. (rentzsch)
nilsubstitution dictionary in generated fetch request wrapper code, which resulted in an
NSInvalidArgumentExceptionreason "Cannot substitute a nil substitution dictionary." (Anthony Mittaz)
[NEW] Xmo'd: model comments that start with
--are passed as args to mogenerator. This allows accessing command-line options such as
--base-class. (David LeBer)
[CHANGE] LLVM 2/Xcode 4 doesn't like
[NSDictionary dictionaryWithObjectsAndKeys:nil], issuing a "missing sentinel in method dispatch" warning. Add
prettyFetchRequestsso we can just generate
NSDictionary *substitutionVariables = nilin that case. (Anthony Mittaz)
[FIX] Variable shadowing bug which would cause v1.19's
xcode-selectfunctionality to always fail. (Nikita Zhuk)
- [NEW] Use
xcode-selectto dynamically discover our way to
momcinstead of only hard-coding
/Developer. (Josh Abernathy)
[NEW] Xmo'd works with versioned data models. (rentzsch)
[NEW] Support for fetched properties (Nikita Zhuk)
NSParameterAssert(moc)in fetch request wrappers. (rentzsch)
--list-source-filesoption, which lists model-related source files. (rentzsch)
--model to get a listing of source files that no longer have corresponding entities in the model. The intent is to be able to pipe its output to xargs + git to remove deleted and renamed entities in one command, something like:
$ mogenerator --model ../MyModel.xcdatamodel --orphaned | xargs git rm
[NEW] machine.h template now produces type-safe scalar attribute property declarations. (rentzsch)
[CHANGE] Remove machine.m implementations of to-many relationship setters. (rentzsch)
[CHANGE] Xmo'd: change file ordering to human.m, human.h, machine.m, machine.h (from human.h, human.m, machine.h, machine.m). (rentzsch)
[FIX] Missing space for fetch requests with multiple bindings. (Frederik Seiffert)
[CHANGE] Xmo'd: now adds
.hhuman+machine header files to project (in addition to current
[NEW] Now supports key paths in fetch request predicates so long as they're relationships. (Jon Olson)
[FIX] Log fetch-request-wrapper errors to
NSLog()on iPhone since it lacks
-[NSApp presentError:]. (rentzsch)
IMPORTANT: 1.14 generates code that may be incompatible with clients of 1.13-or-earlier generated code.
+newInManagedObjectContext:has been replaced with
+insertInManagedObjectContext:and method implementations have been replaced with
@dynamic, which don't work so well with overriding (most of these uses can be replaced with Cocoa Bindings). Upgrade only if you have spare cycles to fix-up existing projects.
+insertInManagedObjectContext:to satisfy the LLVM/clang static analyser. (Ruotger Skupin)
[CHANGE] Default machine templates now use @dynamic. The old templates still available in
contributed templates/rentzsch non-dynamic. (Pierre Bernard)
[CHANGE] Xmo'd included again in default mogenerator installation -- the first time since 1.6. (rentzsch)
[CHANGE] Migrated project to github from self-hosted svn+trac installation.
[NEW] Xmo'd version checking whitelists Xcode versions 3.1(.x) and 3.2(.x).
[NEW] Dropped ppc support for Xmo'd. May reconsider if folks yelp. (rentzsch)