simple_model 1.0.1 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_model (1.0.0)
+    simple_model (1.1.0)
       activemodel (~> 3.0)
       activesupport (~> 3.0)
 

data/README.md

@@ -1,8 +1,16 @@
 # SimpleModel
-A collection of convenience methods for building table-less models. If ActiveModel
-gem is installed, SimpleModel::Based will include ActiveModel::Validations,
-include ActiveModel::Conversion and extend ActiveModel::Naming. If ActiveModel
-gem is not available, SimpleModel::Base defaults to its own built-in Error and Validation modules.
+A collection of convenience methods for building table-less models. 
+SimpleModel implements:
+
+* ActiveModel::Validations
+* ActiveModel::Conversion
+* ActiveModel::Validations::Callbacks
+* ActiveModel::Dirty
+* ActiveModel::Naming
+* ActiveModel::Callbacks
+* ActiveSupport core extentions (see [SimpleModel::Base](https://github.com/JoshMcKin/simple_model/blob/master/lib/simple_model/base.rb))
+
+Additionally SimpleModel implements basic model actions
 
 ## Installation
 
@@ -16,11 +24,20 @@ SimpleModel is available through [Rubygems](http://rubygems.org/gems/simple_mode
       require 'simple_model'
 
         class Item < SimpleModel::Base
+          # Model Actions
           save :save_item, :rollback => :undo_save
+          
+          # Callbacks
+          before_validation :add_to_array
+          
+          # Attributes
           has_booleans :active, :default => true
           has_booleans :paid
-          has_currency :price, :default => 10.0
+          has_currency :price, :default => 10.0.to_currency
           has_times :created_at, :default => :now
+          has_attribute :my_array, :default => []
+          
+          # Validation
           validates_inclusion_of :price, :in => 10..25
           
           def now
@@ -30,7 +47,13 @@ SimpleModel is available through [Rubygems](http://rubygems.org/gems/simple_mode
           def file_name
            @file_name ||= "receipt-#{self.created_at.to_i}.txt"
           end
-          
+
+          private
+
+          def add_to_array
+            my_array << 1
+          end
+  
           def save_item
             begin
               File.open(self.file_name, 'w') do |receipt|
@@ -50,17 +73,25 @@ SimpleModel is available through [Rubygems](http://rubygems.org/gems/simple_mode
         end
         
         item = Item.new
-        item.created_at # => 2011-10-23 21:56:07 -0500
-        item.created_at # => 2011-10-23 21:56:08 -0500
-        item.active     # => true
-        item.paid       # => nil
-        item.paid?      # => false
-        item.price      # => 10.0
+        item.changed?           # => false
+        item.created_at         # => 2011-10-23 21:56:07 -0500
+        item.created_at         # => 2011-10-23 21:56:08 -0500
+        item.active             # => true
+        item.paid               # => nil
+        item.paid?              # => false
+        item.price              # => 10.0
         item.price = '$1,024.00'
-        item.price      # => #<BigDecimal:100c989d8,'0.1024E4',9(27)>
-        item.valid?     # => false
+        item.price              # => #<BigDecimal:100c989d8,'0.1024E4',9(27)>
+        item.changed?           # => true
+        item.price_changed?     # => true
+        item.changes            # => {"price"=>[#<BigDecimal:7fc61b250da8,'0.1E2',9(27)>, #<BigDecimal:7fc61b1ba600,'0.1024E4',9(27)>]}
+        item.my_array           # => []
+        item.valid?             # => false
+        item.my_array           # => [1]
         item.price = 15 
-        item.save       # => true
+        item.save               # => true
+        item.changed?           # => false
+        item.previous_changes   # => {"price"=>[#<BigDecimal:7fc61b1ba600,'0.1024E4',9(27)>, #<BigDecimal:7fc61b1730e8,'0.15E2',9(27)>], "saved"=>[nil, true]} 
                         
 
 

data/lib/simple_model/attributes.rb

@@ -5,7 +5,8 @@ module SimpleModel
   
   module Attributes
     include ExtendCore
-
+    extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
     #Set attribute values to those supplied at initialization
     def initialize(*attrs)
       set_attributes(attrs.extract_options!)
@@ -22,63 +23,99 @@ module SimpleModel
         self.send("#{attr[0].to_sym}=",attr[1])
       end
     end
+    
+    # Hook to run method after attribute is converted but before it is set
+    def before_attribute_set(method,val)   
+    end
+    
     alias :update_attributes :set_attributes
 
     def self.included(base)
       base.extend(ClassMethods)
     end
+    
+    def fetch_default 
+    end
+    
  
     module ClassMethods
-
+      
+      # Hook to call class method after attribute method definitions
+      def after_attribute_definition(attr)  
+      end
+      
+      # Defines a reader method that returns a default value if current value
+      # is nil, if :default is present in the options hash
+      def define_reader_with_options(attr,options)
+        if options.has_key?(:default)
+          define_method(attr.to_s) do
+            default = (options[:default].is_a?(Symbol) ? self.send(options[:default]) : options[:default])
+            val = instance_variable_get("@#{attr.to_s}")    
+            val = default unless instance_variable_defined?("@#{attr.to_s}")
+            val
+          end
+        else
+          attr_reader attr 
+        end
+      end
+      
+      def define_setter(attr,cast_methods)
+        define_method("#{attr.to_s}=") do |val|
+          val = val.cast_to(cast_methods)
+          before_attribute_set(attr,val)
+          instance_variable_set("@#{attr}", val)
+          attributes[attr] = val
+          val
+        end
+      end
+      
+      # Builder for attribute methods
+      def build_attribute_methods(attr,options={},cast_methods=[])
+        define_reader_with_options(attr,options)
+        define_setter(attr,cast_methods)
+        after_attribute_definition attr
+      end
+          
+      # Left this use a module eval for reference, saw no noticable improvement
+      # in speed, so I would rather use code than strings for now
+#      def define_setter_with_eval(attr,cast_methods)
+#        module_eval <<-STR, __FILE__, __LINE__
+#          def #{attr.to_s}=#{attr.to_s}
+#              val = #{attr.to_s}.cast_to(#{cast_methods})
+#              before_attribute_set(:#{attr.to_s},val)
+#              @#{attr.to_s} = val
+#              attributes[:#{attr.to_s}] = val
+#              val
+#          end
+#        STR
+#      end
+      
       #creates setter and getter datatype special attribute
       def has_attributes(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
-
-          attr_reader attr
-          define_reader_with_options(attr,options)
-          define_method("#{attr.to_s}=") do |val|
-            instance_variable_set("@#{attr}", val)
-            attributes[attr] = val
-            val
-
-          end
+          build_attribute_methods(attr,options)
         end
       end
+      alias :has_attribute :has_attributes
 
       # Creates setter and getter methods for boolean attributes
       def has_booleans(*attrs)
         options = attrs.extract_options!
-        attrs.each do |attr|
-
-          attr_reader attr
-          define_reader_with_options(attr,options)  
-          define_method("#{attr.to_s}=") do |val|
-            instance_variable_set("@#{attr}", val.to_s.to_b)
-            attributes[attr] = val
-            val
-          end
-
+        attrs.each do |attr|                 
+          build_attribute_methods(attr,options,[:to_s,:to_b])
           define_method ("#{attr.to_s}?") do
             send("#{attr.to_s}".to_sym).to_s.to_b
           end
         end
       end
-     alias :has_boolean :has_booleans
+      alias :has_boolean :has_booleans
 
       # Creates setter and getter methods for integer attributes
       def has_ints(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
-          attr_reader attr
-          define_reader_with_options(attr,options)
-
-          define_method("#{attr.to_s}=") do |val|             
-            instance_variable_set("@#{attr}", val.to_i)
-            attributes[attr] = val
-            val
-
-          end
+          build_attribute_methods(attr,options,[:to_i])
         end
       end
       alias :has_int :has_ints
@@ -90,26 +127,16 @@ module SimpleModel
       def has_currency(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
-          attr_reader attr
-          define_reader_with_options(attr,options)
-          define_method("#{attr.to_s}=") do |val|
-            instance_variable_set("@#{attr}", val.to_s.to_currency)
-            attributes[attr] = val
-            val
-          end
+          build_attribute_methods(attr,options,[:to_s,:to_currency])
+
         end
       end
 
       def has_decimals(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
-          attr_reader attr
-          define_reader_with_options(attr,options)
-          define_method("#{attr.to_s}=") do |val|
-            instance_variable_set("@#{attr}", BigDecimal("#{val}"))
-            attributes[attr] = val
-            val
-          end
+          build_attribute_methods(attr,options,[:to_f,:to_d])
+
         end
       end
       alias :has_decimal :has_decimals
@@ -118,70 +145,31 @@ module SimpleModel
       def has_floats(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
+          build_attribute_methods(attr,options,[:to_f])
 
-          attr_reader attr
-          define_reader_with_options(attr,options)
-
-          define_method("#{attr.to_s}=") do |val|
-            instance_variable_set("@#{attr}", val.to_f)
-            attributes[attr] = val
-            val
-
-          end
         end
       end
       alias :has_float :has_floats
+      
       # Creates setter and getter methods for date attributes
       def has_dates(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
+          build_attribute_methods(attr,options,[:to_s,:to_date])
 
-          attr_reader attr
-          define_reader_with_options(attr,options)
-          define_method("#{attr.to_s}=") do |val|   
-            val = val.to_date unless val.nil?
-            instance_variable_set("@#{attr}", val )
-            attributes[attr] = val
-            val
-
-          end
         end
       end
       alias :has_date :has_dates
+      
       # Creates setter and getter methods for time attributes
       def has_times(*attrs)
         options = attrs.extract_options!
         attrs.each do |attr|
-          attr_reader attr
-          define_reader_with_options(attr,options)
-          define_method("#{attr.to_s}=") do |val|
-            val = val.to_time unless val.nil?
-            instance_variable_set("@#{attr}", val)
-            attributes[attr] = val
-            val
-          end
-        end
-      end
-
-      def fetch_alias_name(attr)
-        alias_name = (attr.to_s << "_old=").to_sym
-        self.module_eval("alias #{alias_name} #{attr}")
-
-        alias_name
-      end
+          build_attribute_methods(attr,options,[:to_s,:to_time])
 
-      # Defines a reader method that returns a default value if current value
-      # is nil, if :default is present in the options hash
-      def define_reader_with_options(attr,options)
-        unless options[:default].blank?
-          define_method (attr.to_s) do
-            default = options[:default].is_a?(Symbol) ? self.send(options[:default]) : options[:default]
-            val = instance_variable_get("@#{attr.to_s}")    
-            val = default if val.nil?
-            val
-          end
         end
-      end
+      end 
+      alias :has_time :has_times
     end
   end
 end

data/lib/simple_model/base.rb

@@ -20,8 +20,8 @@ module SimpleModel
   #
   # Provides an interface for any class to build tabless models.
   # 
-  # Implements Validations and Callsbacks from ActiveModel and attribute datatype specific
-  # attribute definition with default options
+  # Implements Validations, Callbacks and Dirty from ActiveModel, and datatype specific
+  # attribute definitions with default options
   # 
   # == SimpleModel Actions:
   # 
@@ -82,38 +82,51 @@ module SimpleModel
     extend ActiveModel::Naming
     extend ActiveModel::Callbacks
     include ActiveModel::Validations::Callbacks
+    include ActiveModel::Dirty
+    
     define_model_callbacks :save, :update, :create, :destroy
-     
+    
+    class << self
+      
+      # Collect methods as they are defined, then add to define_attribute_methods
+      def after_attribute_definition(method)
+        @defined_attribute_methods ||= []
+        @defined_attribute_methods << method
+        define_attribute_methods @defined_attribute_methods
+      end
+      
+      def save(*methods)
+        define_model_action(methods,:save)
+      end
+    
+      def create(*methods)
+        define_model_action(methods,:create)
+      end
+    
+      def update(*methods)
+        define_model_action(methods,:update)
+      end
+      
+      #Destroy does not run normal validation by default.
+      def destroy(*methods)   
+        define_model_action(methods,:destroy, {:validate => false})
+      end     
+    end
+    
     has_boolean :saved
     has_boolean :new_record, :default => true
-    
     attr_accessor :id
-
+    
     def persisted?
       saved?
     end
-     
     
-    def self.save(*methods)
-      define_model_action(methods,:save)
-    end
-    
-    def self.create(*methods)
-      define_model_action(methods,:create)
-    end
-    
-    def self.update(*methods)
-      define_model_action(methods,:update)
-    end
-      
-    #Destroy does not run normal validation by default.
-    def self.destroy(*methods)   
-      define_model_action(methods,:destroy, {:validate => false})
-    end 
+    def before_attribute_set(method,val)
+      send("#{method.to_s}_will_change!") unless val == instance_variable_get("@#{method.to_s}")
+    end   
     
     private
-    
-    
+      
     # Skeleton for action instance methods
     def run_model_action(methods,options)
       completed = true
@@ -125,8 +138,11 @@ module SimpleModel
           ran = self.send(method)
           completed = ran unless ran
         end
+        
         if completed
           self.saved = true
+          @previously_changed = changes
+          @changed_attributes.clear    
         else
           self.send(options[:rollback]) unless options[:rollback].blank?
         end    

data/lib/simple_model/extend_core.rb

@@ -5,6 +5,19 @@ module SimpleModel
     require 'bigdecimal'
     require 'bigdecimal/util'
   
+    Object.class_eval do
+      
+      # Expects an array of symboles representing methods for casting the object 
+      # EX: "1".cast_to(:float) # => 1.0
+      def cast_to(methods=[])
+        val = self
+        methods.each do |method|
+          val = val.send(method)
+        end
+        val
+      end
+    end
+    
     Float.class_eval do
     
       # any value greater than 0.0 is true

data/lib/simple_model/simple_model_railtie.rb

@@ -1,11 +1,13 @@
 module SimpleModel
   class SimpleModelRailtie  < ::Rails::Railtie
     initializer "simple_model.extend_core" do
-       extend SimpleModel::ExtendCore
+      extend SimpleModel::ExtendCore
     end
-    initializer "simple_model.ar_error_helper" do
-      class ActiveRecord::Base
-        include SimpleModel::ErrorHelpers
+    if Object.const_defined?(:ActiveRecord)
+      initializer "simple_model.ar_error_helper" do
+        class ActiveRecord::Base
+          include SimpleModel::ErrorHelpers
+        end
       end
     end
   end

data/lib/simple_model/version.rb

@@ -1,3 +1,3 @@
 module SimpleModel
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/attributes_spec.rb

@@ -75,3 +75,18 @@ describe SimpleModel::Attributes, 'has_booleans' do
   end
 
 end
+describe SimpleModel::Attributes, 'has_attributes' do
+  before(:all) do
+    class TestBoolean
+      include SimpleModel::Attributes
+      has_attributes :my_array, :default => []
+    end
+  end
+
+  it "should allow default value to be an empty array" do
+    test = TestBoolean.new
+    test.my_array.should eql([])
+  end
+
+end
+

data/spec/simple_model_spec.rb

@@ -147,6 +147,25 @@ describe SimpleModel do
     t.foo.should eql('foo') 
     t.bar.should eql('bar')
   end
+  
+  it 'Should implement ActiveModel::Dirty' do
+    class TestStuff < SimpleModel::Base
+      save :my_save_method
+      has_attributes :foo,:bar, :default => "def"
+      def my_save_method
+        true
+      end
+    end
+    
+    t = TestStuff.new
+    t.foo = "bar"
+    t.foo_changed?.should be_true
+    t.foo_change.should eql(["def","bar"])
+    t.changed?.should be_true
+    t.save
+    t.changed?.should be_false
+  end
+  
 end
 
 #describe SimpleModel::Errors do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_model
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-24 00:00:00.000000000Z
+date: 2011-11-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70355814091020 !ruby/object:Gem::Requirement
+  requirement: &70101481150080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70355814091020
+  version_requirements: *70101481150080
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70355814090520 !ruby/object:Gem::Requirement
+  requirement: &70101481149580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70355814090520
+  version_requirements: *70101481149580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70355814090140 !ruby/object:Gem::Requirement
+  requirement: &70101481149200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70355814090140
+  version_requirements: *70101481149200
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &70355814089680 !ruby/object:Gem::Requirement
+  requirement: &70101481148740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70355814089680
+  version_requirements: *70101481148740
 description: Simpifies building tableless models or models backed by webservices.
   Create data type specific attributes with default if values.
 email: