motion_migrate 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in motion_migrate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jelle Vandebeeck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+# Motion Migrate
+
+Generate the Core Data model from your RubyMotion code. Never open XCode again!
+
+## Why
+
+I love the [Nitron](https://github.com/mattgreen/nitron) gem created by [@mattgreen](https://github.com/mattgreen/). But I missed some features, and I really hate to open Xcode to create the Core Data model. So I created some rake tasks that helped me generate the Core Data model. Thanks to [@mattgreen](https://github.com/mattgreen/) for starting this in the 0.3 branch of the [Nitron](https://github.com/mattgreen/nitron) project.
+
+Another reason why I wanted to create this gem is because I love using [Magical Record](https://github.com/magicalpanda/MagicalRecord). This is really a great way to handle Core Data, it's like a small layer on top of it. 
+
+Most gems that want to --railsify-- Core Data don't make correct use of the different contexts as used by Core Data. So I wanted to be able to use Core Data as it should, by just generating the model. 
+
+Maybe adding some simplicity in creating the relationships between models will be added later. But for now, generating the Core Data model is the main goal!
+
+## Installation
+
+The installation is simple. Just add this line to you Gemfile:
+
+    gem 'motion_migrate'
+
+Execute:
+
+    $ bundle install
+
+And BOOM, you're on your way!
+
+## Usage
+
+With this gem you can set every option you can while using the Xcode modelling tool. I'm not going to describe every option because I assume RubyMotion developers know how Core Data works. Here is a short list of the available options for a property:
+
+- min
+- max
+- default
+- regex
+- external_storage
+- required
+- transient
+- indexed
+- spotlight
+- truth_file
+
+And of course here are the available options for the relationships (belongs to and has many):
+
+- required
+- deletion_rule
+- class_name
+- spotlight
+- truth_file
+- transient
+- min
+- max
+- inverse_of
+- ordered
+
+The 'spec_project' is an example project with two models containing properties and relationships.
+
+But the main question is how to generate this Core Data model. Well start by extending your models from MotionMigrate::Model. This class is extended from NSManagedObject so you're ready to continue with Core Data once the 
+model is generated.
+
+    class Plane < MotionMigrate::Model
+    end
+
+Next define the properties:
+This will generate two properties, a name property and a multi property. To add some relationships to it, you can add a belongs\_to -- rails-like-shizzle-- to the model.
+
+    class Plane < MotionMigrate::Model
+      property :name,  :string
+      property :multi, :boolean, :default => false
+
+      belongs_to :pilot, :class_name => "Pilot", :inverse_of => :planes
+    end
+
+Don't forget to add a has\_many or belongs\_to as a reverse relationship.
+
+    class Pilot < MotionMigrate::Model
+      has_many :planes, :class_name => "Plane", :inverse_of => :pilot
+    end
+
+The relationships as defined above contain the minimal parameters you'll have to pass to the has\_many or belongs\_to.
+
+Now the most important part, migrating the model. Just run this command to generate the Core Data model from the current models.
+
+    $ rake db:migrate
+
+You can also revert to a previous version of the Core Data model by running: 
+
+    $ rake db:rollback
+
+You can check out the other rake tasks by running:
+
+    $ rake -T
+
+## Example
+
+But for me, the most obvious part is an small example application that shows you how this gem is used. Check out the spec_project en run it so you can see it in action.
+
+## Todo
+
+This is certainly not the end, still got a lot to do.
+
+- [ ] Better version generation. (shouldn't always generate a new version unless told to do so)
+- [ ] Clean up the utility methods.
+- [ ] Implement [mogenerator](https://github.com/rentzsch/mogenerator) functionality.
+- [ ] Add << functionatlity to the relationships in orde to add objects.
+- [ ] Try to handle relationships in a more Ruby on Railzy way.
+
+## Tests
+
+When contributing to this project make sure you run the tests to make sure everything keeps working like it should.
+
+Run the migration tests by executing this command from the project root:
+
+    $ rspec
+
+When you want to test the functional integration with [Magical Record](https://github.com/magicalpanda/MagicalRecord) by moving to the spec_project folder and running the specs.
+
+    $ rake spec
+
+## Contributing
+
+It would be awesome if you contribute!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Jelle Vandebeeck
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+Bundler.require
+

data/lib/motion_migrate/generate.rb

@@ -0,0 +1,51 @@
+module MotionMigrate
+  class Model
+    include MotionMigrate::MotionGenerate::Entity
+    include MotionMigrate::MotionGenerate::Parser
+    include MotionMigrate::MotionGenerate::Property
+    include MotionMigrate::MotionGenerate::Relationship
+  end
+
+  class Generate
+    class << self
+      def build
+        models = Dir.glob("app/models/*.rb")
+        raise "! No models defined in 'app/models', add models to this folder if you want to generate the database model." if models.count == 0
+        
+        models.each do |filename|
+          File.open(filename) { |file| eval(file.read) }
+        end
+
+        builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+          xml.model(database_model_attributes) do
+            ObjectSpace.each_object(Class).select { |klass| klass < MotionMigrate::Model }.each do |entity|
+              xml.entity(:name => entity.entity_name, :representedClassName => entity.entity_name, :syncable => "YES") do
+                entity.properties[entity.entity_name].each do |name, property|
+                  xml.attribute(property)
+                end unless entity.properties[entity.entity_name].nil?
+                entity.relationships[entity.entity_name].each do |name, relationship|
+                  xml.relationship(relationship)
+                end unless entity.relationships[entity.entity_name].nil?
+              end
+            end
+          end
+        end
+        builder.to_xml
+      end
+
+      def database_model_attributes
+        {
+          :name => "",
+          :userDefinedModelVersionIdentifier => "",
+          :type => "com.apple.IDECoreDataModeler.DataModel",
+          :documentVersion => "1.0",
+          :lastSavedToolsVersion => "1811",
+          :systemVersion => "11D50",
+          :minimumToolsVersion => "Automatic",
+          :macOSVersion => "Automatic",
+          :iOSVersion => "Automatic"
+        }
+      end
+    end
+  end
+end

data/lib/motion_migrate/model.rb

@@ -0,0 +1,10 @@
+module MotionMigrate
+  class Model < NSManagedObject
+    include MotionMigrate::MotionModel::Property
+    include MotionMigrate::MotionModel::Relationship
+
+    def inspect
+      # Show entity with fields
+    end
+  end
+end

data/lib/motion_migrate/motion_generate/entity.rb

@@ -0,0 +1,15 @@
+module MotionMigrate
+  module MotionGenerate 
+    module Entity
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def entity_name
+          name.split("::").last
+        end
+      end
+    end
+  end
+end

data/lib/motion_migrate/motion_generate/io.rb

@@ -0,0 +1,79 @@
+module MotionMigrate
+  class IO
+    class << self
+      def write(xml="")
+        create_db
+
+        current_schema = nil
+        if version = current_schema_version()
+          File.open(File.join(current_schema(), "contents")) do |f|
+            current_schema = f.read
+          end
+        end
+
+        if current_schema != xml
+          version = (version || 0) + 1
+
+          latest_schema_path = xcdatamodeld_path("schema.#{version}.xcdatamodel")
+          Dir.mkdir(latest_schema_path) unless Dir.exists?(latest_schema_path)
+
+          File.open(File.join(latest_schema_path, "contents"), "w") do |file|
+            file.write(xml)
+          end
+          write_current_schema(version)
+
+          unless File.symlink?("resources/schema.xcdatamodeld")
+            File.symlink("../db/schema.xcdatamodeld", "resources/schema.xcdatamodeld")
+          end
+
+          puts "# Data model migrated to version #{version}."
+        else
+          length = 38 + version.to_s.length
+          puts "# Data model already at version #{version}."
+        end
+      end
+
+      def current_schema_version
+        return nil unless path = current_schema
+
+        version = nil
+        path.match(/\.([0-9]+)\.xcdatamodel$/) do |match|
+          version = match[1].to_i
+        end
+        version
+      end
+
+      def current_schema
+        plist = xcdatamodeld_path(".xccurrentversion")
+        return nil unless File.exists?(plist)
+
+        xcdatamodeld_path(Nokogiri::XML(File.open(plist)).at_xpath("/plist/dict/string").text)
+      end
+
+      def write_current_schema(version)
+        File.open(xcdatamodeld_path(".xccurrentversion"), "w") do |file|
+          file.write(<<-PLIST)
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>_XCCurrentVersionName</key>
+  <string>schema.#{version}.xcdatamodel</string>
+</dict>
+</plist>
+          PLIST
+        end
+      end
+      
+      protected
+
+      def create_db
+        FileUtils.mkdir_p(File.join("db", "schema.xcdatamodeld"))
+      end
+
+      def xcdatamodeld_path(*args)
+        File.join(["db", "schema.xcdatamodeld"] + args)
+      end
+    end
+  end
+end

data/lib/motion_migrate/motion_generate/parser.rb

@@ -0,0 +1,27 @@
+module MotionMigrate
+  module MotionGenerate 
+    module Parser
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def core_data_string(string)
+          string.to_s.split("_").each{|word| word.capitalize! }.join(" ")
+        end
+
+        def core_data_variable(value)
+          value.to_s.split("_").each{ |word| word.capitalize! }.join("")
+        end
+
+        def core_data_boolean(value)
+          value == true ? "YES" : "NO"
+        end
+
+        def core_data_date(value)
+          (value.to_time.to_i - Date.new(2001, 1, 1).to_time.to_i).to_s
+        end
+      end
+    end
+  end
+end

data/lib/motion_migrate/motion_generate/property.rb

@@ -0,0 +1,171 @@
+module MotionMigrate
+  module MotionGenerate 
+    module Property
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def property(name, type, options={})
+          type = type.to_sym
+
+          raise_if_property_type_not_allowed(type)
+          options.each { |key, value| raise_if_property_option_not_allowed(type, key) }
+
+          attribute_type = type == :binary_data ? "Binary" : core_data_string(type)
+          attributes = {
+            name: name,
+            attributeType: attribute_type,
+            optional: core_data_boolean(true),
+            syncable: core_data_boolean(true)
+          }
+          attributes.merge!(core_data_property_attributes(type, options))
+          properties[self.entity_name] = {} if properties[self.entity_name].nil?
+          properties[self.entity_name][name] = attributes
+          attributes
+        end
+
+        def properties
+          @@properties ||= {}
+        end
+
+        def raise_if_property_type_not_allowed(type)
+          unless property_type_allowed?(type)
+            raise <<-ERROR
+! The type must be one of the following: 
+!  :string                   
+!  :integer_16                
+!  :integer_32                 
+!  :integer_64                  
+!  :decimal                      
+!  :double                        
+!  :float                          
+!  :boolean                          
+!  :date                            
+!  :binary_data                       
+            ERROR
+          end
+        end
+
+        def property_type_allowed?(type)
+          [
+            :string, 
+            :integer_16, 
+            :integer_32, 
+            :integer_64, 
+            :decimal, 
+            :double, 
+            :float, 
+            :boolean, 
+            :date, 
+            :binary_data 
+          ].include?(type)
+        end
+
+        def raise_if_property_option_not_allowed(type, option)
+          unless property_option_allowed?(type, option)
+            raise <<-ERROR
+! The option must be one of the following:                                              
+!
+!   For type :string:                                                                  
+!     :min                                                                    
+!     :max                                                                     
+!     :default                                                                  
+!     :regex                                                                     
+!
+!   For type :boolean:                                                            
+!      :default                                                                    
+!
+!   For type :date, :integer_16, :integer_32, :integer_64, :decimal, :double or :float: 
+!      :min                           
+!      :max                            
+!      :default                         
+!
+!   For type :binary_data:               
+!      :external_storage                  
+!
+!   Options allowed for all types:         
+!      :required                            
+!      :transient                                
+!      :indexed                                 
+!      :spotlight                              
+!      :truth_file                            
+            ERROR
+          end
+        end
+
+        def property_option_allowed?(type, option)
+          type = :number if [
+            :integer_16, 
+            :integer_32, 
+            :integer_64, 
+            :decimal, 
+            :double, 
+            :float,
+            :date
+          ].include?(type)
+
+          allowed_options = {
+            number: [:min, :max, :default],
+            string: [:min, :max, :default, :regex],
+            boolean: [:default],
+            binary_data: [:external_storage]
+          }[type]
+
+          allowed_options += [
+            :required,
+            :transient,
+            :indexed,
+            :spotlight,
+            :truth_file
+          ]
+          allowed_options.include?(option)
+        end
+
+        def core_data_property_attributes(type, options)
+          attributes = {}
+
+          options.each do |key, value|
+            case key
+            when :required
+              attributes[:optional] = core_data_boolean(value != true)
+            when :transient
+              attributes[:transient] = core_data_boolean(value)
+            when :indexed
+              attributes[:indexed] = core_data_boolean(value)
+            when :spotlight
+              attributes[:spotlightIndexingEnabled] = core_data_boolean(value)
+            when :truth_file
+              attributes[:storedInTruthFile] = core_data_boolean(value)
+            when :min
+              if type == :date
+                attributes[:minDateTimeInterval] = core_data_date(value)
+              else
+                attributes[:minValueString] = value
+              end
+            when :max
+              if type == :date
+                attributes[:maxDateTimeInterval] = core_data_date(value)
+              else
+                attributes[:maxValueString] = value
+              end
+            when :default
+              if type == :date
+                attributes[:defaultDateTimeInterval] = core_data_date(value)
+              elsif type == :boolean
+                attributes[:defaultValueString] = core_data_boolean(value)
+              else
+                attributes[:defaultValueString] = value
+              end
+            when :regex
+              attributes[:regularExpressionString] = value
+            when :external_storage
+              attributes[:allowsExternalBinaryDataStorage] = core_data_boolean(value)
+            end
+          end
+          attributes
+        end
+      end
+    end
+  end
+end