motion_model 0.4.1 → 0.4.2

data/CHANGELOG

@@ -1,10 +1,21 @@
-2102-03-15: Fixed bug where created_at and updated_at were being incorrectly
+2013-04-13: WARNING: Possible breaking change. Hook methods changed to send
+            affected object. So, if you have:
+
+            def after_create
+
+            You will get an error about expecting 1 argument, got 0
+
+            The correct signature is:
+
+            def after_create(sender)
+
+2013-03-15: Fixed bug where created_at and updated_at were being incorrectly
             when restored from persistence (thanks Justin McPherson for finding
             that).
 
             Moved all NSCoder stuff out of Model to ArrayModelAdapter.
 
-2012-02-19: Included Doug Puchalski's great refactoring of Model that provides an
+2013-02-19: Included Doug Puchalski's great refactoring of Model that provides an
             adapter for ArrayModelAdapter. WARNING!!! This is a breaking change
             since version 0.3.8. You will have to include:
 
@@ -14,9 +25,9 @@
             Failure to include an adapter (note: spelling counts :) will result
             in an exception so this will not quietly fail.
 
-2012-01-24: Added block-structured transactions.
+2013-01-24: Added block-structured transactions.
 
-2012-01-14: Fixed problem where data returned from forms was of type NSString, which
+2013-01-14: Fixed problem where data returned from forms was of type NSString, which
             confused some monkey-patching code.
             Changed before_ hooks such that handlers returning false would terminate
             the process. So, if before_save returns anything other than false, the
@@ -24,7 +35,7 @@
             interrupted.
             Fixed immutable string issue in validations.
 
-2012-01-09: Added automatic date/timestamp support for created_at and updated_at columns
+2013-01-09: Added automatic date/timestamp support for created_at and updated_at columns
             Added Hash extension except, Array introspection methods has_hash_key? and
             has_hash_value?
             Commit of Formotion module including optional inclusion/suppression of the

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "rake"
+gem "motion-stump", '~>0.2'

data/README.md

@@ -97,6 +97,7 @@ You can define your models and their schemas in Ruby. For example:
 ```ruby
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
 
   columns :name        => :string,
           :description => :string,
@@ -117,6 +118,7 @@ Models support default values, so if you specify your model like this, you get d
 ```ruby
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
 
   columns :name     => :string,
           :due_date => {:type => :date, :default => '2012-09-15'}
@@ -128,6 +130,7 @@ You can also include the `Validatable` module to get field validation. For examp
 ```ruby
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Validatable
 
   columns :name        => :string,
@@ -188,6 +191,7 @@ To use validations in your model, declare your model as follows:
 ```ruby
 class MyValidatableModel
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Validatable
 
   # All other model-y stuff here
@@ -317,12 +321,14 @@ Using MotionModel
   ```ruby
   class Task
     include MotionModel::Model
+    include MotionModel::ArrayModelAdapter
     columns     :name => :string
     has_many    :assignees
   end
 
   class Assignee
     include MotionModel::Model
+    include MotionModel::ArrayModelAdapter
     columns     :assignee_name => :string
     belongs_to  :task
   end
@@ -361,6 +367,7 @@ The key to how the `destroy` variants work in how the relation is declared. You
 ```ruby
   class Task
     include MotionModel::Model
+    include MotionModel::ArrayModelAdapter
     columns     :name => :string
     has_many    :assignees
   end
@@ -388,6 +395,43 @@ related to the assignees remains intact.
 
 Note: This syntax is modeled on the Rails `:dependent => :destroy` options in `ActiveRecord`.
 
+## Hook Methods
+
+During a save or delete operation, hook methods are called to allow you a chance to modify the
+object at that point. These hook methods are:
+
+```ruby
+before_save(sender)
+after_save(sender)
+before_delete(sender)
+after_delete(sender)
+```
+
+MotionModel makes no distinction between destroy and delete when calling hook methods, as it only
+calls them when the actual object is deleted. In a destroy operation, during the cascading delete,
+the delete hooks are called (again) at the point of object deletion.
+
+Note that the method signatures may be different from previous implementations. No longer can you
+declare a hook method without the `sender` argument.
+
+Finally, contrasting hook methods with notifications, the hook methods `before_save` and `after_save`
+are called before the save operation begins and after it completes. However, the notification (covered
+below) is only issued after the save operation. However... the notification understands whether the
+operation was a save or update. Rule of thumb: If you want to catch an operation before it begins,
+use the hook. If you just want to know about it when it happens, use the notification.
+
+The delete hooks happen around the delete operation and, again, allow you the option to mess with the
+object before you allow the process to go forward (pretty much, the `before_delete` hook does this).
+
+*IMPORTANT*: Returning false in a before hook stops the rest of the operation. So, for example, you
+could prevent the deletion of the last admin by writing something like this:
+
+```ruby
+def before_delete(sender)
+  return false if sender.find(:privilege_level).eq('admin').count < 2
+end
+```
+
 ## Transactions and Undo/Cancel
 
 MotionModel is not ActiveRecord. MotionModel is not a database-backed mapper. The bottom line is that when you change a field in a model, even if you don't save it, you are partying on the central object store. In part, this is because Ruby copies objects by reference, so when you do a find, you get a reference to the object *in the central object store*.
@@ -460,12 +504,14 @@ end
 ```ruby
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   has_many :assignees
   # etc
 end
 
 class Assignee
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   belongs_to :task
   # etc
 end

data/Rakefile

@@ -2,10 +2,13 @@
 require "bundler/gem_tasks"
 $:.unshift("/Library/RubyMotion/lib")
 require 'motion/project'
+require 'bundler'
+Bundler.require
 
 Motion::Project::App.setup do |app|
   # Use `rake config' to see complete project settings.
+  app.name = 'MotionModel'
   app.delegate_class = 'FakeDelegate'
-  app.files = Dir.glob('./lib/motion_model/**/*.rb')
+  app.files = Dir.glob('./lib/motion_model/**/*.rb') + app.files
   app.files = (app.files + Dir.glob('./app/**/*.rb')).uniq
 end

data/lib/motion_model/adapters/array_model_adapter.rb

@@ -7,18 +7,20 @@ module MotionModel
     def self.included(base)
       base.extend(PrivateClassMethods)
       base.extend(PublicClassMethods)
-      base.instance_variable_set("@collection", [])             # Actual data
+      base.instance_eval do
+        _reset_next_id
+      end
     end
 
     module PublicClassMethods
-
-      def collection
+       def collection
         @collection ||= []
       end
 
       def insert(object)
         collection << object
       end
+      alias :<< :insert
 
       def length
         collection.length
@@ -32,11 +34,8 @@ module MotionModel
         # Do each delete so any on_delete and
         # cascades are called, then empty the
         # collection and compact the array.
-        bulk_update do
-          collection.each{|item| item.delete}
-        end
-        @collection = []
-        @_next_id = 1
+        bulk_update { collection.pop.delete until collection.empty? }
+        _reset_next_id
       end
 
       # Finds row(s) within the data store. E.g.,
@@ -59,36 +58,40 @@ module MotionModel
           return collection.select{|element| element.id == target_id}.first
         end
 
-        ArrayFinderQuery.new(args[0].to_sym, @collection)
+        ArrayFinderQuery.new(args[0].to_sym, collection)
       end
       alias_method :where, :find
 
+      def find_by_id(id)
+        find(:id).eq(id).first
+      end
+
       # Returns query result as an array
       def all
         collection
       end
 
       def order(field_name = nil, &block)
-        ArrayFinderQuery.new(@collection).order(field_name, &block)
+        ArrayFinderQuery.new(collection).order(field_name, &block)
       end
 
     end
 
     module PrivateClassMethods
+      private
 
       # Returns next available id
-      def next_id #nodoc
+      def _next_id #nodoc
         @_next_id
       end
 
-      # Sets next available id
-      def next_id=(value) #nodoc
-        @_next_id = value
+      def _reset_next_id
+        @_next_id = 1
       end
 
       # Increments next available id
-      def increment_id #nodoc
-        @_next_id += 1
+      def increment_next_id(other_id) #nodoc
+        @_next_id = [@_next_id, other_id.to_i].max + 1
       end
 
     end
@@ -97,6 +100,10 @@ module MotionModel
       assign_id(options)
     end
 
+    def increment_next_id(other_id)
+      self.class.send(:increment_next_id, other_id)
+    end
+
     # Undelete does pretty much as its name implies. However,
     # the natural sort order is not preserved. IMPORTANT: If
     # you are trying to undo a cascading delete, this will not
@@ -104,7 +111,11 @@ module MotionModel
 
     def undelete
       collection << self
-      self.class.issue_notification(self, :action => 'add')
+      issue_notification(:action => 'add')
+    end
+
+    def collection #nodoc
+      self.class.collection
     end
 
     # This adds to the ArrayStore without the magic date
@@ -122,32 +133,45 @@ module MotionModel
     end
     alias_method :count, :length
 
+    def rebuild_relation_for(name, instance_or_collection) # nodoc
+    end
+
     private
 
+    def _next_id
+      self.class.send(:_next_id)
+    end
+
     def assign_id(options) #nodoc
-      unless options[:id]
-        options[:id] = self.class.next_id
-      else
-        self.class.next_id = [options[:id].to_i, self.class.next_id].max
-      end
-      self.class.increment_id
+      options[:id] ||= _next_id
+      increment_next_id(options[:id])
     end
 
-    def collection #nodoc
-      self.class.instance_variable_get('@collection')
+    def relation_for(col) # nodoc
+      col = column_named(col)
+      related_klass = col.classify
+
+      case col.type
+        when :belongs_to
+          related_klass.find(@data[:id])
+        when :has_many
+          related_klass.find(generate_belongs_to_id(self.class)).belongs_to(self, related_klass).eq(@data[:id])
+        else
+          nil
+      end
     end
 
-    def do_insert
+    def do_insert(options = {})
       collection << self
     end
 
-    def do_update
+    def do_update(options = {})
     end
 
     def do_delete
       target_index = collection.index{|item| item.id == self.id}
       collection.delete_at(target_index) unless target_index.nil?
-      self.class.issue_notification(self, :action => 'delete')
+      issue_notification(:action => 'delete')
     end
 
   end

data/lib/motion_model/adapters/array_model_persistence.rb

@@ -0,0 +1,141 @@
+module MotionModel
+  module ArrayModelAdapter
+    class PersistFileError < Exception; end
+    class VersionNumberError < ArgumentError; end
+
+    module PublicClassMethods
+
+      def validate_schema_version(version_number)
+        raise MotionModel::ArrayModelAdapter::VersionNumberError.new('version number must be a string') unless version_number.is_a?(String)
+        if version_number !~ /^[\d.]+$/
+          raise MotionModel::ArrayModelAdapter::VersionNumberError.new('version number string must contain only numbers and periods')
+        end
+      end
+
+      # Declare a version number for this schema. For example:
+      #
+      # class Task
+      #   include MotionModel::Model
+      #   include MotionModel::ArrayModelAdapter
+      #
+      #   version_number 1.0.1
+      # end
+      #
+      # When a version number mismatch occurs as an individual row is loaded
+      # from persistent storage, the migrate method is invoked, allowing
+      # you to programmatically migrate on a per-row basis.
+
+      def schema_version(*version_number)
+        if version_number.empty?
+          return @schema_version
+        else
+          validate_schema_version(version_number[0])
+          @schema_version = version_number[0]
+        end
+      end
+
+      def migrate
+      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)
+        if schema_version != '1.0.0'
+          migrate
+        end
+
+        @file_name = file_name if 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::PersistFileError.new "Error when reading the data: #{error}"
+          else
+            bulk_update do
+              NSKeyedUnarchiver.unarchiveObjectWithData(data)
+            end
+            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::PersistFileError+ on failure.
+      def serialize_to_file(file_name = nil)
+        @file_name = file_name if 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::PersistFileError.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|
+        next if has_relation?(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
+      add_to_store
+
+      self
+    end
+
+    # Follow Apple's recommendation not to encode missing
+    # values.
+    def encodeWithCoder(coder)
+      columns.each do |attr|
+        # Serialize attributes except the proxy has_many and belongs_to ones.
+        unless [:belongs_to, :has_many].include? column_named(attr).type
+          value = self.send(attr)
+          unless value.nil?
+            coder.encodeObject(value, forKey: attr.to_s)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/motion_model/ext.rb

@@ -351,3 +351,20 @@ def UIInterfaceOrientationIsPortrait(orientation)
   orientation == UIInterfaceOrientationPortrait ||
      orientation == UIInterfaceOrientationPortraitUpsideDown
 end
+
+class Module
+  # Retrieve a constant within its scope
+  def deep_const_get(const)
+    if Symbol === const
+      const = const.to_s
+    else
+      const = const.to_str.dup
+    end
+    if const.sub!(/^::/, '')
+      base = Object
+    else
+      base = self
+    end
+    const.split(/::/).inject(base) { |mod, name| mod.const_get(name) }
+  end
+end

data/lib/motion_model/model/array_finder_query.rb

@@ -161,9 +161,14 @@ module MotionModel
     
     # returns all elements that match as an array.
     def all
-      @collection
+      to_a
     end
     
+    # returns all elements that match as an array.
+    def to_a
+      @collection
+    end
+
     # each is a shortcut method to turn a query into an iterator. It allows
     # you to write code like:
     #

data/lib/motion_model/model/column.rb

@@ -4,14 +4,14 @@ module MotionModel
       attr_accessor :name
       attr_accessor :type
       attr_accessor :default
-      attr_accessor :destroy
+      attr_accessor :dependent
 
       def initialize(name = nil, type = nil, options = {})
         @name = name
         @type = type
         raise RuntimeError.new "columns need a type declared." if type.nil?
         @default = options.delete :default
-        @destroy = options.delete :dependent
+        @dependent = options.delete :dependent
         @options = options
       end
 
@@ -19,16 +19,32 @@ module MotionModel
         @options
       end
 
+      def class_name
+        @options[:joined_class_name] || @name
+      end
+
       def classify
-        case @type
-        when :belongs_to
-          @klass ||= Object.const_get(@name.to_s.camelize)
-        when :has_many
-          @klass ||= Object.const_get(@name.to_s.singularize.camelize)
+        if @options[:class]
+          @options[:class]
         else
-          raise "#{@name} is not a relation. This isn't supposed to happen."
+          case @type
+          when :belongs_to
+            @klass ||= Object.const_get(class_name.to_s.camelize)
+          when :has_many, :has_one
+            @klass ||= Object.const_get(class_name.to_s.singularize.camelize)
+          else
+            raise "#{@name} is not a relation. This isn't supposed to happen."
+          end
         end
       end
+
+      def class_const_get
+        Kernel::const_get(classify)
+      end
+
+      def through_class
+        Kernel::const_get(@options[:through].to_s.classify)
+      end
     end
   end
 end

data/lib/motion_model/model/formotion.rb

@@ -16,7 +16,7 @@ module MotionModel
     def should_return(column) #nodoc
       skippable = [:id]
       skippable += [:created_at, :updated_at] unless @expose_auto_date_fields
-      !skippable.include?(column) && !self.class.relation_column?(column)
+      !skippable.include?(column) && !relation_column?(column)
     end
 
     def returnable_columns #nodoc
@@ -26,14 +26,14 @@ module MotionModel
     def default_hash_for(column, value)
       {:key         => column.to_sym,
        :title       => column.to_s.humanize,
-       :type        => FORMOTION_MAP[type(column)],
+       :type        => FORMOTION_MAP[column_type(column)],
        :placeholder => column.to_s.humanize,
        :value       => value
        }
     end
 
     def is_date_time?(column)
-      column_type = type(column)
+      column_type = column_type(column)
       [:date, :time].include?(column_type)
      end
 
@@ -78,7 +78,7 @@ module MotionModel
     # you say so, offering you the opportunity to validate your form data.
     def from_formotion!(data)
       self.returnable_columns.each{|column|
-        if data[column] && type(column) == :date || type(column) == :time
+        if data[column] && column_type(column) == :date || column_type(column) == :time
           data[column] = Time.at(data[column]) unless data[column].nil?
         end
         value = self.send("#{column}=", data[column])