motion_model 0.3.8 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,13 @@
+2012-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:
+
+            MotionModel::ArrayModelAdapter
+
+            after including MotionModel::Model to get the same functionality.
+            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.
 
 2012-01-14: Fixed problem where data returned from forms was of type NSString, which

data/README.md

@@ -31,6 +31,36 @@ you like with it. See the LICENSE file in this project.
 * [Problems/Comments](#problemscomments)
 * [Submissions/Patches](#submissionspatches)
 
+Most Recent Important Change
+=================
+
+Please see the CHANGELOG for update on changes.
+
+Version 0.3.8 to 0.4.0 is a minor version bump, not a patch version. Upgrading
+to 0.4.0 *will break existing code*. To update your code, simply insert the following line:
+
+```ruby
+class ModelWithAdapter
+  include MotionModel::Model
+  include MotionModel::ArrayModelAdapter # <== Here!
+
+  columns :name
+end
+```
+
+This change lays the foundation for using other persistence adapters.
+If you don't want to update all your models, install the gem:
+
+```
+$ gem install motion_model -v 0.3.8
+```
+
+or if you are using bundler:
+
+```
+gem motion_model, "0.3.8"
+```
+
 Getting Going
 ================
 
@@ -200,7 +230,7 @@ You must return `true` from your validator if the value passes validation otherw
 An important note about `save` once you include `Validatable`, you have two flavors
 of save:
 
-Method                 | Meaning              
+Method                 | Meaning
 -----------------------|---------------------------
 `save(options)`        |Just saves the data if it is valid (passes validations) or if you have specified `:validate => false`
 `save!`                |Saves the data if it is valid, otherwise raises a `MotionModel::Validatable::RecordInvalid` exception

data/lib/motion_model/adapters/array_model_adapter.rb

@@ -0,0 +1,145 @@
+module MotionModel
+  module ArrayModelAdapter
+    def adapter
+      'Array Model Adapter'
+    end
+
+    def self.included(base)
+      base.extend(PrivateClassMethods)
+      base.extend(PublicClassMethods)
+      base.instance_variable_set("@collection", [])             # Actual data
+    end
+
+    module PublicClassMethods
+
+      def collection
+        @collection ||= []
+      end
+
+      def insert(object)
+        collection << object
+      end
+
+      def length
+        collection.length
+      end
+      alias_method :count, :length
+
+      # Deletes all rows in the model -- no hooks are called and
+      # deletes are not cascading so this does not affected related
+      # data.
+      def delete_all
+        # 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
+      end
+
+      # Finds row(s) within the data store. E.g.,
+      #
+      #   @post = Post.find(1)  # find a specific row by ID
+      #
+      # or...
+      #
+      #   @posts = Post.find(:author).eq('bob').all
+      def find(*args, &block)
+        if block_given?
+          matches = collection.collect do |item|
+            item if yield(item)
+          end.compact
+          return ArrayFinderQuery.new(matches)
+        end
+
+        unless args[0].is_a?(Symbol) || args[0].is_a?(String)
+          target_id = args[0].to_i
+          return collection.select{|element| element.id == target_id}.first
+        end
+
+        ArrayFinderQuery.new(args[0].to_sym, @collection)
+      end
+      alias_method :where, :find
+
+      # Returns query result as an array
+      def all
+        collection
+      end
+
+      def order(field_name = nil, &block)
+        ArrayFinderQuery.new(@collection).order(field_name, &block)
+      end
+
+    end
+
+    module PrivateClassMethods
+
+      # Returns next available id
+      def next_id #nodoc
+        @_next_id
+      end
+
+      # Sets next available id
+      def next_id=(value) #nodoc
+        @_next_id = value
+      end
+
+      # Increments next available id
+      def increment_id #nodoc
+        @_next_id += 1
+      end
+
+    end
+
+    def before_initialize(options)
+      assign_id(options)
+    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
+    # work. It only undeletes the object you still own.
+
+    def undelete
+      collection << self
+      self.class.issue_notification(self, :action => 'add')
+    end
+
+    # Count of objects in the current collection
+    def length
+      collection.length
+    end
+    alias_method :count, :length
+
+    private
+
+    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
+    end
+
+    def collection #nodoc
+      self.class.instance_variable_get('@collection')
+    end
+
+    def do_insert
+      collection << self
+    end
+
+    def do_update
+    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')
+    end
+
+  end
+end

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

@@ -1,5 +1,5 @@
 module MotionModel
-  class FinderQuery
+  class ArrayFinderQuery
     attr_accessor :field_name
     
     def initialize(*args)#nodoc

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) && !relation_column?(column)
+      !skippable.include?(column) && !self.class.relation_column?(column)
     end
 
     def returnable_columns #nodoc

data/lib/motion_model/model/model.rb

@@ -40,6 +40,7 @@
 module MotionModel
   class PersistFileError < Exception; end
   class RelationIsNilError < Exception; end
+  class AdapterNotFoundError < Exception; end
 
   module Model
     def self.included(base)
@@ -48,7 +49,6 @@ module MotionModel
       base.instance_variable_set("@_columns", [])               # Columns in model
       base.instance_variable_set("@_column_hashes", {})         # Hashes to for quick column lookup
       base.instance_variable_set("@_relations", {})             # relations
-      base.instance_variable_set("@collection", [])             # Actual data
       base.instance_variable_set("@_next_id", 1)                # Next assignable id
       base.instance_variable_set("@_issue_notifications", true) # Next assignable id
     end
@@ -155,6 +155,14 @@ module MotionModel
         column_named(column).default || nil
       end
 
+      def read(attrs)
+        new(attrs).instance_eval do
+          @new_record = false
+          @dirty = false
+          self
+        end
+      end
+
       # Creates an object and saves it. E.g.:
       #
       #   @bob = Person.create(:name => 'Bob', :hobby => 'Bird Watching')
@@ -166,25 +174,6 @@ module MotionModel
         row
       end
 
-      def length
-        @collection.length
-      end
-      alias_method :count, :length
-
-      # Deletes all rows in the model -- no hooks are called and
-      # deletes are not cascading so this does not affected related
-      # data.
-      def delete_all
-        # 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
-      end
-
       # Destroys all rows in the model -- before_delete and after_delete
       # hooks are called and deletes are not cascading if declared with
       # :delete => destroy in the has_many macro.
@@ -198,56 +187,23 @@ module MotionModel
         # Note collection is not emptied, and next_id is not reset.
       end
 
-      # Finds row(s) within the data store. E.g.,
-      #
-      #   @post = Post.find(1)  # find a specific row by ID
-      #
-      # or...
-      #
-      #   @posts = Post.find(:author).eq('bob').all
-      def find(*args, &block)
-        if block_given?
-          matches = @collection.collect do |item|
-            item if yield(item)
-          end.compact
-          return FinderQuery.new(matches)
-        end
-
-        unless args[0].is_a?(Symbol) || args[0].is_a?(String)
-          target_id = args[0].to_i
-          return @collection.select{|element| element.id == target_id}.first
-        end
-
-        FinderQuery.new(args[0].to_sym, @collection)
-      end
-      alias_method :where, :find
-
       # Retrieves first row of query
       def first
-        @collection.first
+        all.first
       end
 
       # Retrieves last row of query
       def last
-        @collection.last
-      end
-
-      # Returns query result as an array
-      def all
-        @collection
-      end
-
-      def order(field_name = nil, &block)
-        FinderQuery.new(@collection).order(field_name, &block)
+        all.last
       end
 
       def each(&block)
         raise ArgumentError.new("each requires a block") unless block_given?
-        @collection.each{|item| yield item}
+        all.each{|item| yield item}
       end
 
       def empty?
-        @collection.empty?
+        all.empty?
       end
     end
 
@@ -339,19 +295,12 @@ module MotionModel
         @_column_hashes[name.to_sym]
       end
 
-      # Returns next available id
-      def next_id #nodoc
-        @_next_id
-      end
-
-      # Sets next available id
-      def next_id=(value) #nodoc
-        @_next_id = value
+      def relation_column?(column) #nodoc
+        [:belongs_to, :belongs_to_id, :has_many].include? column_named(column).type
       end
 
-      # Increments next available id
-      def increment_id #nodoc
-        @_next_id += 1
+      def virtual_relation_column?(column) #nodoc
+        [:belongs_to, :has_many].include? column_named(column).type
       end
 
       def has_relation?(col) #nodoc
@@ -369,12 +318,13 @@ module MotionModel
     end
 
     def initialize(options = {})
-      @data ||= {}
+      raise AdapterNotFoundError.new("You must specify a persistence adapter.") unless self.respond_to? :adapter
 
-      assign_id options
+      @data ||= {}
+      before_initialize(options)
 
       columns.each do |col|
-        unless relation_column?(col) # all data columns
+        unless self.class.relation_column?(col) # all data columns
           initialize_data_columns col, options
         else
           @data[col] = options[col] if column_named(col).type == :belongs_to_id
@@ -382,6 +332,11 @@ module MotionModel
       end
 
       @dirty = true
+      @new_record = true
+    end
+
+    def new_record?
+      @new_record
     end
 
     # Default to_i implementation returns value of id column, much as
@@ -405,13 +360,14 @@ module MotionModel
         # Existing object implies update in place
         action = 'add'
         set_auto_date_field 'created_at'
-        if obj = collection.find{|o| o.id == @data[:id]}
-          obj = self
+        if @new_record
+          do_insert
+        else
+          do_update
           set_auto_date_field 'updated_at'
           action = 'update'
-        else
-          collection << self
         end
+        @new_record = false
         @dirty = false
         self.class.issue_notification(self, :action => action)
       end
@@ -422,7 +378,6 @@ module MotionModel
       self.send("#{field_name}=", Time.now) if self.respond_to? field_name
     end
 
-    # Deletes the current object. The object can still be used.
     def call_hook(hook_name, postfix)
       hook = "#{hook_name}_#{postfix}"
       self.send(hook, self) if respond_to? hook.to_sym
@@ -436,11 +391,7 @@ module MotionModel
     end
 
     def delete
-      call_hooks('delete') do
-        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')
-      end
+      call_hooks('delete') { do_delete }
     end
 
     # Destroys the current object. The difference between delete
@@ -464,22 +415,6 @@ module MotionModel
       delete
     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
-    # work. It only undeletes the object you still own.
-
-    def undelete
-      collection << self
-      self.class.issue_notification(self, :action => 'add')
-    end
-
-    # Count of objects in the current collection
-    def length
-      collection.length
-    end
-    alias_method :count, :length
-
     # True if the column exists, otherwise false
     def column?(column_name)
       self.class.column?(column_name.to_sym)
@@ -518,30 +453,12 @@ module MotionModel
       @dirty
     end
 
-
     private
 
-    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
-    end
-
-    def relation_column?(column) #nodoc
-      [:belongs_to, :belongs_to_id, :has_many].include? column_named(column).type
-    end
-
     def initialize_data_columns(column, options) #nodoc
        self.send("#{column}=".to_sym, options[column] || self.class.default(column))
     end
 
-    def collection #nodoc
-      self.class.instance_variable_get('@collection')
-    end
-
     def column_named(name) #nodoc
       self.class.column_named(name.to_sym)
     end
@@ -568,14 +485,5 @@ module MotionModel
       end
     end
 
-    # Any way you reach this means you've tried to access a method
-    # not defined on this model.
-    def method_missing(method, *args, &block) #nodoc
-      if self.respond_to? method
-        return method(args, &block)
-      else
-        raise NoMethodError.new("nil column #{self.class}##{method} accessed from #{caller[1]}.")
-      end
-    end
   end
 end

data/lib/motion_model/version.rb

@@ -1,4 +1,8 @@
-
+# 0.3.8 is the last version without adapters.
+# for backward compatibility, users should
+# specify that version in their gem command
+# or forward port their code to take advantage
+# of adapters.
 module MotionModel
-  VERSION = "0.3.8"
+  VERSION = "0.4.0"
 end

data/spec/cascading_delete_spec.rb

@@ -1,11 +1,13 @@
 class Assignee
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :assignee_name => :string
   belongs_to :task
 end
 
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns       :name => :string,
                 :details => :string,
                 :some_day => :date
@@ -14,6 +16,7 @@ end
 
 class CascadingTask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns       :name => :string,
                 :details => :string,
                 :some_day => :date
@@ -22,6 +25,7 @@ end
 
 class CascadedAssignee
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns       :assignee_name => :string
   belongs_to    :cascading_task
   has_many      :employees
@@ -29,6 +33,7 @@ end
 
 class Employee
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns       :name
   belongs_to    :CascadedAssignee
 end

data/spec/column_options_spec.rb

@@ -1,5 +1,6 @@
 class ModelWithOptions
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
 
   columns :date => {:type => :date, :formotion => {:picker_type => :date_time}}
 end

data/spec/date_spec.rb

@@ -14,6 +14,7 @@ describe "time conversions" do
   it "Sets created_at when an item is created" do
     class Creatable
       include MotionModel::Model
+      include MotionModel::ArrayModelAdapter
       columns :name => :string,
               :created_at => :date
     end
@@ -25,6 +26,7 @@ describe "time conversions" do
     it "Sets updated_at when an item is created" do
     class Updateable
       include MotionModel::Model
+      include MotionModel::ArrayModelAdapter
       columns :name => :string,
               :created_at => :date,
               :updated_at => :date

data/spec/finder_spec.rb

@@ -1,6 +1,7 @@
 class Task
   include MotionModel::Model
-  columns       :name => :string, 
+  include MotionModel::ArrayModelAdapter
+  columns       :name => :string,
   							:details => :string,
   							:some_day => :date
 end
@@ -47,7 +48,7 @@ describe 'finders' do
     end
       
     it 'returns a FinderQuery object' do
-      Task.where(:details).should.is_a(MotionModel::FinderQuery)
+      Task.where(:details).should.is_a(MotionModel::ArrayFinderQuery)
     end
       
     it 'using where instead of find' do
@@ -58,6 +59,7 @@ describe 'finders' do
     it "performs set inclusion(in) queries" do
       class InTest
         include MotionModel::Model
+        include MotionModel::ArrayModelAdapter
         columns :name
       end
         
@@ -92,7 +94,7 @@ describe 'finders' do
       end
         
       it 'returns a FinderQuery' do
-        @items_less_than_5.should.is_a MotionModel::FinderQuery
+        @items_less_than_5.should.is_a MotionModel::ArrayFinderQuery
       end
         
       it 'handles block-style finders' do

data/spec/formotion_spec.rb

@@ -1,5 +1,6 @@
 class ModelWithOptions
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Formotion
 
   columns :name => :string,
@@ -13,6 +14,7 @@ end
 
 class RelatedModel
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
 
   columns :name => :string
   belongs_to :model_with_options

data/spec/model_casting_spec.rb

@@ -1,5 +1,6 @@
 class TypeCast
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :a_boolean => :boolean,
           :an_int => {:type => :int, :default => 3},
           :an_integer => :integer,

data/spec/model_hook_spec.rb

@@ -3,7 +3,8 @@ class Task
   attr_reader :before_save_called, :after_save_called
 
   include MotionModel::Model
-  columns       :name => :string, 
+  include MotionModel::ArrayModelAdapter
+  columns       :name => :string,
                 :details => :string,
                 :some_day => :date
 

data/spec/model_spec.rb

@@ -1,6 +1,7 @@
 class Task
   include MotionModel::Model
-  columns       :name => :string, 
+  include MotionModel::ArrayModelAdapter
+  columns       :name => :string,
   							:details => :string,
   							:some_day => :date
 
@@ -11,11 +12,13 @@ end
 
 class ATask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :name, :details, :some_day
 end
 
 class TypeCast
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :a_boolean => :boolean,
           :an_int => {:type => :int, :default => 3},
           :an_integer => :integer,
@@ -230,6 +233,15 @@ describe "Creating a model" do
         @new_task.save
         lambda{@new_task.name = 'now dirty'}.should.change{@new_task.dirty?}
       end
+
+      it 'marks an updated object as clean' do
+        @new_task.save
+        @new_task.should.not.be.dirty
+        @new_task.name = 'now updating task'
+        @new_task.should.be.dirty
+        @new_task.save
+        @new_task.should.not.be.dirty
+      end
     end
   end
   

data/spec/notification_spec.rb

@@ -1,5 +1,6 @@
 class NotifiableTask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :name
   @@notification_called = false
   @@notification_details = :none

data/spec/persistence_spec.rb

@@ -1,5 +1,6 @@
 class PersistTask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :name, :desc
 end
 
@@ -33,6 +34,7 @@ describe 'persistence' do
     it 'column addition' do
       class Foo
         include MotionModel::Model
+        include MotionModel::ArrayModelAdapter
         columns       :name => :string
       end
       @foo = Foo.create(:name=> 'Bob')
@@ -42,6 +44,7 @@ describe 'persistence' do
   
       class Foo
         include MotionModel::Model
+        include MotionModel::ArrayModelAdapter
         columns       :name => :string,
                       :address => :string
       end
@@ -58,6 +61,7 @@ describe 'persistence' do
     it "column removal" do
       class Foo
         include MotionModel::Model
+        include MotionModel::ArrayModelAdapter
         columns       :name => :string, :desc => :string
       end
 
@@ -69,6 +73,7 @@ describe 'persistence' do
       Object.send(:remove_const, :Foo)
       class Foo
         include MotionModel::Model
+        include MotionModel::ArrayModelAdapter
         columns       :name => :string,
                       :address => :string
       end
@@ -86,6 +91,7 @@ describe 'persistence' do
   describe "remembering filename" do
     class Foo
       include MotionModel::Model
+      include MotionModel::ArrayModelAdapter
       columns :name => :string
     end
 
@@ -142,12 +148,14 @@ end
 
 class Parent
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns   :name
   has_many  :children
 end
   
 class Child
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns     :name
   belongs_to  :parent
 end

data/spec/relation_spec.rb

@@ -1,11 +1,13 @@
 class Assignee
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :assignee_name => :string
   belongs_to :task
 end
 
 class Task
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns       :name => :string,
   							:details => :string,
   							:some_day => :date
@@ -15,6 +17,7 @@ end
 
 class User
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :name => :string
 
   has_many :email_accounts
@@ -22,6 +25,7 @@ end
 
 class EmailAccount
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   columns :name => :string
   belongs_to :user
 end

data/spec/transaction_spec.rb

@@ -1,5 +1,6 @@
 class TransactClass
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Model::Transactions
   columns :name, :age
   has_many :transaction_things
@@ -7,6 +8,7 @@ end
 
 class TransactionThing
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Model::Transactions
   columns :thingie_description
   belongs_to :transact_class

data/spec/validation_spec.rb

@@ -1,5 +1,6 @@
 class ValidatableTask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Validatable
   columns       :name => :string, 
                 :email => :string,
@@ -137,6 +138,7 @@ end
 
 class VTask
   include MotionModel::Model
+  include MotionModel::ArrayModelAdapter
   include MotionModel::Validatable
 
   columns :name => :string
@@ -167,4 +169,4 @@ describe "saving with validations" do
     lambda { task.save }.should.change { VTask.count }
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion_model
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bubble-wrap
@@ -41,10 +41,11 @@ files:
 - Rakefile
 - app/app_delegate.rb
 - lib/motion_model.rb
+- lib/motion_model/adapters/array_model_adapter.rb
 - lib/motion_model/ext.rb
 - lib/motion_model/input_helpers.rb
+- lib/motion_model/model/array_finder_query.rb
 - lib/motion_model/model/column.rb
-- lib/motion_model/model/finder_query.rb
 - lib/motion_model/model/formotion.rb
 - lib/motion_model/model/model.rb
 - lib/motion_model/model/model_casts.rb