motion_model 0.2.2 → 0.2.3

data/README.md

@@ -26,6 +26,34 @@ are:
   helpers are certainly not the focus of this release, but
   I am using these in an app to create Apple-like input forms in
   static tables.
+  
+Getting Going
+================
+
+If you are using Bundler, put this in your Gemfile:
+
+```
+gem motion_model
+```
+
+then do:
+
+```
+bundle install
+```
+
+If you are not using Bundler:
+
+```
+gem install motion_model
+```
+
+then put this in your Rakefile after requiring `motion/project`:
+
+```
+require 'motion_model'
+```
+
 
 What Model Can Do
 ================
@@ -124,6 +152,15 @@ Things That Work
     ```ruby  
     @tasks = Task.find{|task| task.name =~ /dog/i && task.assigned_to == 'Bob'}
     ```
+    
+    Note that finders always return a proxy (`FinderQuery`). You must use `first`, `last`, or `all`
+    to get useful results.
+    
+    ```ruby  
+    @tasks = Task.where(:owner).eq('jim')   # => A FinderQuery.
+    @tasks.all                              # => An array of matching results.
+    @tasks.first                            # => The first result
+    ```
 
     You can perform ordering using either a field name or block syntax. Here's an example:
 
@@ -141,7 +178,7 @@ Things That Work
   and of course on the "save" side:
   
   ```ruby
-    @tasks.serialize_to_file('tasks.dat')
+    Task.serialize_to_file('tasks.dat')
   end
   ```
   
@@ -150,11 +187,14 @@ Things That Work
   protocol. When you declare your columns, `MotionModel` understands how to
   serialize your data so you need take no further action.
   
-* Relations, in principle work. This is a part I'm still noodling over
-  so it's not really safe to use them. In any case, how I expect it will
-  shake out is that one-to-one or one-to-many will be supported out of
-  the box, but you will have to take some extra steps to implement
-  many-to-many, just as you would in Rails' `has_many :through`.
+* Relations, in principle work. They are more embedded documents similar
+  to CouchDB or MongoDB. So instead of being separate tables, the embedded
+  documents are model objects contained in a collection.
+  
+  **Relations Are Untested**. This is completely experimental, but to use
+  them, just define a column as type `:array`. Initializing these properly
+  and testing them is a high priority for me, so expect it to be addressed
+  soon.
 
 * Core extensions work. The following are supplied:
 
@@ -165,6 +205,15 @@ Things That Work
   - Array#empty?
   - Hash#empty?
   - Symbol#titleize
+  
+  Also in the extensions is a debug class to log stuff to the console.
+  This may be preferable to `puts` just because it's easier to spot in
+  your code and it gives you the exact level and file/line number of the
+  info/warning/error in your console output:
+  
+  - Debug.info(message)
+  - Debug.warning(message)
+  - Debug.error(message)
 
 Things In The Pipeline
 ----------------------
@@ -178,5 +227,28 @@ Things In The Pipeline
 Problems/Comments
 ------------------
 
-Please raise an issue if you find something that doesn't work, some
+Please **raise an issue** on GitHub if you find something that doesn't work, some
 syntax that smells, etc.
+
+If you want to stay on the bleeding edge, clone yourself a copy (or better yet, fork
+one).
+
+Then be sure references to motion_model are commented out or removed from your Gemfile
+and/or Rakefile and put this in your Rakefile:
+
+```
+require "~/github/local//MotionModel/lib/motion_model.rb"
+```
+
+The `~/github/local` is where I cloned it, but you can put it anyplace. Next, make
+sure you are following the project on GitHub so you know when there are changes.
+
+Submissions/Patches
+------------------
+
+Obviously, the ideal one is a pull request from your own fork, complete with passing
+specs.
+
+Really, even a failing spec or some proposed code is fine. I really want to make
+this a decent tool for RubyMotion developers who need a straightforward data
+modeling and persistence framework.

data/lib/motion_model/ext.rb

@@ -35,3 +35,35 @@ class Symbol
     self.to_s.titleize
   end
 end
+
+class Debug
+  @@silent = false
+  
+  # Use silence if you want to keep messages from being echoed
+  # to the console.
+  def self.silence
+    @@silent = true
+  end
+  
+  # Use resume when you want messages that were silenced to
+  # resume displaying.
+  def self.resume
+    @@silent = false
+  end
+  
+  def self.put_message(type, message)
+    puts("#{type} #{caller[1]}: #{message}") unless @@silent
+  end
+  
+  def self.info(msg)
+    put_message 'INFO', msg
+  end
+  
+  def self.warning(msg)
+    put_message 'WARNING', msg
+  end
+  
+  def self.error(msg)
+    put_message 'ERROR', msg
+  end
+end

data/lib/motion_model/input_helpers.rb

@@ -37,7 +37,6 @@ module MotionModel
       # Only one field mapping may be supplied for
       # a given class.
       def field(field, options = {})
-        puts "adding field #{field}"
         label = options[:label] || field.humanize
         @binding_data << FieldBindingMap.new(:label => label, :name => field)
       end
@@ -110,10 +109,8 @@ module MotionModel
       raise ModelNotSetError.new("You must set the model before binding it.") unless @model
       
       fields do |field|
-        puts "*** retrieving data for #{field.name} and tag #{field.tag} ***"
         view_obj = self.view.viewWithTag(field.tag)
-        puts "view object with tag is #{view_obj.inspect}"
-        @model.send("#{field.name}=".to_sym, view_obj.text)
+        @model.send("#{field.name}=".to_sym, view_obj.text) if view_obj.respond_to?(:text)
       end
     end
 

data/lib/motion_model/model/column.rb

@@ -0,0 +1,22 @@
+module MotionModel
+  module Model
+    class Column
+      attr_accessor :name
+      attr_accessor :type
+      attr_accessor :default
+
+      def initialize(name = nil, type = nil, default = nil)
+        @name = name
+        @type = type
+        @default = default || nil
+      end
+      
+      def add_attr(name, type, default = nil)
+        @name = name
+        @type = type
+        @default = default || nil
+      end
+      alias_method :add_attribute, :add_attr
+    end
+  end
+end

data/lib/motion_model/{finder_query.rb → model/finder_query.rb}

@@ -23,12 +23,18 @@ module MotionModel
     end
     
     ######## relational methods ########
-    def do_comparison(query_string, options = {:case_sensitive => false})
-      query_string = query_string.downcase if query_string.respond_to?(:downcase) && !options[:case_sensitive]
-      @collection = @collection.select do |item|
+    def translate_case(item, case_sensitive)#nodoc
+      item = item.downcase if case_sensitive === false && item.respond_to?(:downcase)
+      item
+    end
+    
+    def do_comparison(query_string, options = {:case_sensitive => false})#nodoc
+      query_string = translate_case(query_string, options[:case_sensitive])
+      @collection = @collection.collect do |item|
         comparator = item.send(@field_name.to_sym)
-        yield query_string, comparator
-      end
+        comparator = translate_case(comparator, options[:case_sensitive])
+        item if yield query_string, comparator
+      end.compact
       self
     end
     

data/lib/motion_model/{model.rb → model/model.rb}

@@ -41,25 +41,6 @@ module MotionModel
   class PersistFileError < Exception; end
   
   module Model
-    class Column
-      attr_accessor :name
-      attr_accessor :type
-      attr_accessor :default
-
-      def initialize(name = nil, type = nil, default = nil)
-        @name = name
-        @type = type
-        @default = default || nil
-      end
-      
-      def add_attr(name, type, default = nil)
-        @name = name
-        @type = type
-        @default = default || nil
-      end
-      alias_method :add_attribute, :add_attr
-    end
-
     def self.included(base)
       base.extend(ClassMethods)
       base.instance_variable_set("@_columns", [])
@@ -98,6 +79,8 @@ module MotionModel
         case fields.first
         when Hash
           fields.first.each_pair do |name, options|
+            raise ArgumentError.new("you cannot use `description' as a column name because of a conflict with Cocoa.") if name.to_s == 'description'
+            
             case options
             when Symbol, String
               add_field(name, options)
@@ -178,6 +161,7 @@ module MotionModel
       # Empties the entire store.
       def delete_all
         @collection = [] # TODO: Handle cascading or let GC take care of it.
+        @collection.compact!
       end
 
       # Finds row(s) within the data store. E.g.,
@@ -227,37 +211,9 @@ module MotionModel
         @collection.each{|item| yield item}
       end      
       
-      # Returns the unarchived object if successful, otherwise false
-      #
-      # Note that subsequent calls to serialize/deserialize methods
-      # will remember the file name, so they may omit that argument.
-      #
-      # Raises a +MotionModel::PersistFileFailureError+ on failure.
-      def deserialize_from_file(file_name = nil)
-        @file_name ||= file_name
-        new_object = self.new
-        
-        if File.exist? documents_file(@file_name)
-          error_ptr = Pointer.new(:object)
-      
-          data = NSData.dataWithContentsOfFile(documents_file(file_name), options:NSDataReadingMappedIfSafe, error:error_ptr)
-      
-          if data.nil?
-            error = error_ptr[0]
-            raise MotionModel::PersistFileFailureError.new "Error when reading the data: #{error}"
-          else
-            return NSKeyedUnarchiver.unarchiveObjectWithData(data)
-          end
-        else
-          return false
-        end
+      def empty?
+        @collection.empty?
       end
-
-      def documents_file(file_name)
-        file_path = File.join NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, true), file_name
-        file_path
-      end
-      
     end
  
     ####### Instance Methods #######
@@ -282,6 +238,8 @@ module MotionModel
         cast_value = cast_to_type(col, options[col])
         @data[col] = cast_value
       end
+      
+      dirty = true
     end
 
     def cast_to_type(column_name, arg)
@@ -298,8 +256,7 @@ module MotionModel
         return_value = arg.is_a?(Float) ? arg : arg.to_f
       when :date
         return arg if arg.is_a?(NSDate)
-        date_string = arg += ' 00:00'
-        return_value = @cached_date_formatter.dateFromString(date_string)
+        return_value = NSDate.dateWithNaturalLanguageString(arg, locale:NSUserDefaults.standardUserDefaults.dictionaryRepresentation)
       else
         raise ArgumentError.new("type #{column_name} : #{type(column_name)} is not possible to cast.")
       end
@@ -311,7 +268,16 @@ module MotionModel
     end
 
     def save
-      self.class.instance_variable_get('@collection') << self
+      collection = self.class.instance_variable_get('@collection')
+      @dirty = false
+      
+      # Existing object implies update in place
+      # TODO: Optimize location of existing id
+      if obj = collection.find{|o| o.id == @data[:id]}
+        obj = self
+      else
+        collection << self
+      end
     end
     
     def delete
@@ -341,32 +307,6 @@ module MotionModel
     def type(field_name)
       self.class.type(field_name)
     end
-
-    def initWithCoder(coder)
-      self.init
-      columns.each do |attr|
-        # If a model revision has taken place, don't try to decode
-        # something that's not there.
-        new_tag_id = 1
-        if coder.containsValueForKey(attr.to_s)
-          value = coder.decodeObjectForKey(attr.to_s)
-          self.instance_variable_set('@' + attr.to_s, value || '')
-        else
-          self.instance_variable_set('@' + attr.to_s, '') # set to empty string if new attribute
-        end
-
-        # re-issue tags to make sure they are unique
-        @tag = new_tag_id
-        new_tag_id += 1
-      end
-      self
-    end
-    
-    def encodeWithCoder(coder)
-      columns.each do |attr|
-        coder.encodeObject(self.send(attr), forKey: attr.to_s)
-      end
-    end
     
     # Modify respond_to? to add model's attributes.
     alias_method :old_respond_to?, :respond_to?
@@ -374,6 +314,10 @@ module MotionModel
       column_named(method) || old_respond_to?(method)
     end
     
+    def dirty?
+      @dirty      
+    end
+    
     # Handle attribute retrieval
     # 
     # Gets and sets work as expected, and type casting occurs
@@ -393,6 +337,7 @@ module MotionModel
       
       if col
         if method.to_s.include?('=')
+          @dirty = true
           return @data[base_method] = self.cast_to_type(base_method, args[0])
         else
           return @data[base_method]
@@ -406,28 +351,6 @@ ERRORINFO
       end
     end
 
-    # Serializes data to a persistent store (file, in this
-    # terminology). Serialization is synchronous, so this
-    # will pause your run loop until complete.
-    #
-    # +file_name+ is the name of the persistent store you
-    # want to use. If you omit this, it will use the last
-    # remembered file name.
-    #
-    # Raises a +MotionModel::PersistFileFailureError+ on failure.
-    def serialize_to_file(file_name = nil)
-      @file_name ||= file_name
-      error_ptr = Pointer.new(:object)
-
-      data = NSKeyedArchiver.archivedDataWithRootObject self
-      unless data.writeToFile(self.class.documents_file(file_name), options: NSDataWritingAtomic, error: error_ptr)
-        # De-reference the pointer.
-        error = error_ptr[0]
-
-        # Now we can use the `error' object.
-        raise MotionModel::PersistFileFailureError.new "Error when writing data: #{error}"
-      end
-    end
   end
 end
 

data/lib/motion_model/model/persistence.rb

@@ -0,0 +1,96 @@
+module MotionModel
+  class PersistFileError < Exception; end
+  
+  module Model
+    module ClassMethods
+      # Returns the unarchived object if successful, otherwise false
+      #
+      # Note that subsequent calls to serialize/deserialize methods
+      # will remember the file name, so they may omit that argument.
+      #
+      # Raises a +MotionModel::PersistFileFailureError+ on failure.
+      def deserialize_from_file(file_name = nil)
+        @file_name ||= file_name
+        
+        if File.exist? documents_file(@file_name)
+          error_ptr = Pointer.new(:object)
+      
+          data = NSData.dataWithContentsOfFile(documents_file(file_name), options:NSDataReadingMappedIfSafe, error:error_ptr)
+          
+          if data.nil?
+            error = error_ptr[0]
+            raise MotionModel::PersistFileFailureError.new "Error when reading the data: #{error}"
+          else
+            collection = NSKeyedUnarchiver.unarchiveObjectWithData(data)
+            return self
+          end
+        else
+          return false
+        end
+      end
+      # Serializes data to a persistent store (file, in this
+      # terminology). Serialization is synchronous, so this
+      # will pause your run loop until complete.
+      #
+      # +file_name+ is the name of the persistent store you
+      # want to use. If you omit this, it will use the last
+      # remembered file name.
+      #
+      # Raises a +MotionModel::PersistFileFailureError+ on failure.
+      def serialize_to_file(file_name = nil)
+        @file_name ||= file_name
+        error_ptr = Pointer.new(:object)
+
+        data = NSKeyedArchiver.archivedDataWithRootObject @collection
+        unless data.writeToFile(documents_file(file_name), options: NSDataWritingAtomic, error: error_ptr)
+          # De-reference the pointer.
+          error = error_ptr[0]
+
+          # Now we can use the `error' object.
+          raise MotionModel::PersistFileFailureError.new "Error when writing data: #{error}"
+        end
+      end
+    
+
+      def documents_file(file_name)
+        file_path = File.join NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, true), file_name
+        file_path
+      end
+    end
+    
+    def initWithCoder(coder)
+      self.init
+
+      new_tag_id = 1
+      columns.each do |attr|
+        # If a model revision has taken place, don't try to decode
+        # something that's not there.
+        if coder.containsValueForKey(attr.to_s)
+          value = coder.decodeObjectForKey(attr.to_s)
+          self.send("#{attr}=", value)
+        else
+          self.send("#{attr}=", nil)
+        end
+
+        # re-issue tags to make sure they are unique
+        @tag = new_tag_id
+        new_tag_id += 1
+      end
+      save
+
+      self
+    end
+    
+    # Follow Apple's recommendation not to encode missing
+    # values.
+    def encodeWithCoder(coder)
+      columns.each do |attr|
+        value = self.send(attr)
+        unless value.nil?
+          coder.encodeObject(value, forKey: attr.to_s)
+        end
+      end
+    end
+    
+  end
+end

data/lib/motion_model/version.rb

@@ -1,3 +1,3 @@
 module MotionModel
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/model_spec.rb

@@ -133,12 +133,13 @@ describe "Creating a model" do
 
   describe 'finders' do
     before do
+      Task.delete_all
       10.times {|i| Task.create(:name => "task #{i}")}
     end
 
     describe 'find' do
       it 'finds elements within the collection' do
-        Task.find(3).name.should.equal('task 3')
+        task = Task.find(3).name.should.equal('task 3')
       end
 
       it 'returns nil if find by id is not found' do
@@ -147,7 +148,15 @@ describe "Creating a model" do
       
       it 'looks into fields if field name supplied' do
         Task.create(:name => 'find me')
-        Task.find(:name).eq('find me').all.length.should.equal(1)
+        tasks = Task.find(:name).eq('find me')
+        tasks.all.length.should.equal(1)
+        tasks.first.name.should == 'find me'
+      end
+      
+      it "provides an array of valid model instances when doing a find" do
+        Task.create(:name => 'find me')
+        tasks = Task.find(:name).eq('find me')
+        tasks.first.name.should.eql 'find me'
       end
       
       it 'allows for multiple (chained) query parameters' do
@@ -168,12 +177,12 @@ describe "Creating a model" do
       
       it 'using where instead of find' do
         atask = Task.create(:name => 'find me', :details => "details 1")
-        found_task = Task.where(:details).contain("details 1").first.details.should.equal("details 1")
+        found_task = Task.where(:details).contain("s 1").first.details.should == 'details 1'
       end
       
       it 'handles case-sensitive queries' do
         task = Task.create :name => 'Bob'
-        Task.find(:name).eq('bob', :case_sensitive => true).all.should.be.empty
+        Task.find(:name).eq('bob', :case_sensitive => true).all.length.should == 0
       end
     
       it 'all returns all members of the collection as an array' do
@@ -248,7 +257,7 @@ describe "Creating a model" do
     it 'deletes a row' do
       target = Task.find(:name).eq('task 3').first
       target.delete
-      Task.find(:description).eq('Task 3').should == nil
+      Task.find(:description).eq('Task 3').length.should.equal 0
     end
     
     it 'deleting a row changes length' do
@@ -327,20 +336,3 @@ describe "Creating a model" do
   end
 end
 
-describe 'persistence' do
-  before do
-    Task.delete_all
-    %w(one two three).each do |task|
-      @tasks = Task.create(:name => "name #{task}")
-    end
-    @tasks.serialize_to_file('test.dat')
-  end
-  
-  it 'reads persisted model data' do
-    tasks = Task.deserialize_from_file('test.dat')
-    
-    Task.first.name.should == 'name one'
-    Task.last.name.should  == 'name three'
-    Task.count.should      == 3
-  end
-end

data/spec/persistence_spec.rb

@@ -0,0 +1,84 @@
+class PersistTask
+  include MotionModel::Model
+  columns :name, :desc
+end
+
+describe 'persistence' do
+  before do
+    PersistTask.delete_all
+    %w(one two three).each do |task|
+      @tasks = PersistTask.create(:name => "name #{task}")
+    end
+  end
+  
+  it "serializes data" do
+    lambda{PersistTask.serialize_to_file('test.dat')}.should.not.raise
+  end
+  
+  it 'reads persisted model data' do
+    PersistTask.serialize_to_file('test.dat')
+
+    PersistTask.delete_all
+    
+    PersistTask.count.should      == 0
+    
+    tasks = PersistTask.deserialize_from_file('test.dat')
+    
+    PersistTask.count.should      == 3
+    PersistTask.first.name.should == 'name one'
+    PersistTask.last.name.should  == 'name three'
+  end
+  
+  describe 'model change resiliency' do
+    it 'column addition' do
+      class Foo
+        include MotionModel::Model
+        columns       :name => :string
+      end
+      @foo = Foo.create(:name=> 'Bob')
+      Foo.serialize_to_file('test.dat')
+      
+      @foo.should.not.respond_to :address
+  
+      class Foo
+        include MotionModel::Model
+        columns       :name => :string,
+                      :address => :string
+      end
+      Foo.deserialize_from_file('test.dat')
+      
+      @foo = Foo.first
+      
+      @foo.name.should == 'Bob'
+      @foo.address.should == nil
+      @foo.should.respond_to :address
+      Foo.length.should == 1
+    end
+    
+    it "column removal" do
+      class Foo
+        include MotionModel::Model
+        columns       :name => :string, :desc => :string
+      end
+      @foo = Foo.create(:name=> 'Bob', :desc => 'who cares anyway?')
+      Foo.serialize_to_file('test.dat')
+      
+      @foo.should.respond_to :desc
+  
+      class Foo
+        include MotionModel::Model
+        columns       :name => :string,
+                      :address => :string
+      end
+      Foo.deserialize_from_file('test.dat')
+      
+      @foo = Foo.first
+      
+      @foo.name.should == 'Bob'
+      @foo.address.should == nil
+      @foo.should.not.respond_to :desc
+      @foo.should.respond_to :address
+      Foo.length.should == 1
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion_model
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Simple model and validation mixins for RubyMotion
 email:
@@ -25,13 +25,16 @@ files:
 - app/app_delegate.rb
 - lib/motion_model.rb
 - lib/motion_model/ext.rb
-- lib/motion_model/finder_query.rb
 - lib/motion_model/input_helpers.rb
-- lib/motion_model/model.rb
+- lib/motion_model/model/column.rb
+- lib/motion_model/model/finder_query.rb
+- lib/motion_model/model/model.rb
+- lib/motion_model/model/persistence.rb
 - lib/motion_model/validatable.rb
 - lib/motion_model/version.rb
 - motion_model.gemspec
 - spec/model_spec.rb
+- spec/persistence_spec.rb
 homepage: https://github.com/sxross/MotionModel
 licenses: []
 post_install_message: 
@@ -58,3 +61,4 @@ specification_version: 3
 summary: Simple model and validation mixins for RubyMotion
 test_files:
 - spec/model_spec.rb
+- spec/persistence_spec.rb