ruby-xcdm 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Zjc5N2MxNzBmNWIwOTNkYzdjMzc4YmEyYzVmMDI3M2YwOGUxZWZkMA==
+    Njc1YTAyNTBiYWFmMmMzYWMzYTFmMDk5N2QyMzUzYzg1YTdkYzk4OA==
   data.tar.gz: !binary |-
-    ODFhYmNjZDE0OTBkNWE4OTk5YzJkMGQ1OWU1NjAyYmM0ZWU4ZWY4Nw==
+    YzUyZTg0YmZkYzA0NDNmYzIyZTU0YjUwNTRiYWRiZDRiMTM5YTAwOA==
 SHA512:
   metadata.gz: !binary |-
-    ZTQxNTQwNzhjMzQ1OTkyNzljYzY5ZjgxYzJkOWM3YTgzYTIwNzVjN2YzNjU0
-    MzcxNWNhYzUzMTEyYTVjZTM5YTVkYjc3NWMyMmExMGM3YTZiYTc3MDMwZDlh
-    NjYzZDNiNTZhMDFlYTMzNzJmMDVkOTBiYTYxMGIxMDhmM2M1OGE=
+    NDBjMDQ4NTEwMjVkYTRiODIzN2Y3YzliN2Y5NTdiN2IzMGVkOGFmMDQ2MDlh
+    ZjQ5ZDkzOTQ3YWZhMjM1MDNlODczMzg5NTUyNWI4ZTc3YTUyNzljOGQ1ZTQ4
+    OGZhNWNhMjA4MzNkZGM1NWJhYTljNjgyMmEyZjZjMzRhZjRiNjg=
   data.tar.gz: !binary |-
-    ZTcyYTJkZTM4ZmNiMDcyOWVkNDY3MzQxYjdiNDBkOTQzN2E2OWRmYjQzMmEx
-    ODg3OTQ1NDc4ZjBjYmY1YTRmODMwNmQyMjNhYWQ2OTZmMDAxOWVkZTUzMmVj
-    YTY3ZTgyYmQ2MDVhMjQzMTA4NTdhNGU1YzZlM2FhMGJmMDQyOWY=
+    YmVhMTc3OGY1OWVkMjdiZjljMWI5YWU0NjI0OTZmNmUzNDk2OTM0NTZhNmQy
+    NDNlZDgyNGQ2ZmFjNWRhOWY0ZTMxNGZiY2M5MmY5NmEzY2M1ZGU1ZWVhNTMx
+    M2U5MzQ2MWFjM2I2OGMyMGE4ZWU3OTcxNDkyNGUzMWIyZTZlNWI=

data/README.md

@@ -1,24 +1,30 @@
 # ruby-xcdm
 
-This is a tool for generating the same xcdatamodeld files that XCode does when
-designing a datamodel for Core Data.  It is written in pure ruby, but it will
-be of particular interest to RubyMotion developers.  It offers the essential
-features that XCode does, plus a text-based workflow (nicer for git, among
-other things) and some niceties, like automatic inverse relationships.
+This is a tool for generating the same xcdatamodeld files that XCode
+does when designing a datamodel for Core Data.  It is written in pure
+ruby, but it will be of particular interest to RubyMotion developers.
+It offers the essential features that XCode does, plus a text-based
+workflow and some niceties, like automatic inverse relationships.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'ruby-xcdm'
+```ruby
+  gem 'ruby-xcdm'
+```
 
 And then execute:
 
-    $ bundle
+```
+  $ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install ruby-xcdm
+```
+  $ gem install ruby-xcdm
+```
 
 ## Usage (RubyMotion)
 
@@ -26,8 +32,8 @@ Or install it yourself as:
 2. Create one schema version per file within the directory
 3. To build the schema, run `rake schema:build`
 
-If you want to build the schema every time you run the simulator, add this to
-your Rakefile:
+If you want to build the schema every time you run the simulator, add
+this to your Rakefile:
 
 ```ruby
 task :"build:simulator" => :"schema:build"
@@ -39,7 +45,9 @@ task :"build:simulator" => :"schema:build"
 2. Create one schema version per file within the directory
 3. Run the command to generate a datamodel:
 
+```
   xcdm MyApplicationName schemadir datamodeldestdir
+```
 
 
 ## Schema File Format
@@ -47,7 +55,7 @@ task :"build:simulator" => :"schema:build"
 Here's a sample schema file:
 
 ```ruby
-  schema "0.0.1" do
+  schema "001" do
 
     entity "Article" do
 
@@ -69,10 +77,53 @@ Here's a sample schema file:
   end
 ```
 
-All the built-in data types are supported, and inverse relationships are
-generated automatically.  If you need to set some of the more esoteric options
-on properties or relationships, you can include the raw parameters, like
-renamingIdentifier or defaultValueString.
+All the built-in data types are supported:
+
+* integer16
+* integer32
+* integer64
+* decimal
+* double
+* float
+* string
+* boolean
+* datetime
+* binary
+* transformable
+
+Inverse relationships are generated automatically.
+If the inverse relationship cannot be derived 
+from the association name, you can use the :inverse option:
+
+```ruby
+  schema "001" do
+
+    entity "Game" do
+      belongs_to :away_team, inverse: "Team.away_games"
+      belongs_to :home_team, inverse: "Team.home_games"
+    end
+
+    entity "Team" do
+      has_many :away_games, inverse: "Game.away_team"
+      has_many :home_games, inverse: "Game.home_team"
+    end
+
+  end
+```
+
+If you need to set some of the more esoteric options on properties or
+relationships, you can include the raw parameters from
+NSEntityDescription and NSAttributeDescription, like renamingIdentifier
+or defaultValueString.
+
+## Versioning
+
+To create new versions, simply copy the old version, increase the
+version string (the last one in sort order is always interpreted to be
+the current version) and make your changes.  So long as they conform
+to the [automatic versioning
+rules](https://developer.apple.com/library/ios/documentation/cocoa/conceptual/CoreDataVersioning/Articles/vmLightweightMigration.html#//apple_ref/doc/uid/TP40004399-CH4-SW2),
+everything should work seamlessly.
 
 ## Contributing
 

data/lib/xcdm/entity.rb

@@ -19,7 +19,7 @@ module XCDM
       string:        'String',
       boolean:       'Boolean',
       datetime:      'Date',
-      binary:        'Binary Data',
+      binary:        'Binary',
       transformable: 'Transformable'
     }
 

data/lib/xcdm/version.rb

@@ -1,3 +1,3 @@
 module XCDM
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/entity_test.rb

@@ -55,7 +55,7 @@ module XCDM
       assert_equal 'String',        Entity.convert_type(:string)
       assert_equal 'Boolean',       Entity.convert_type(:boolean)
       assert_equal 'Date',          Entity.convert_type(:datetime)
-      assert_equal 'Binary Data',   Entity.convert_type(:binary)
+      assert_equal 'Binary',        Entity.convert_type(:binary)
       assert_equal 'Transformable', Entity.convert_type(:transformable)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-xcdm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ken Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder