state_machine 0.9.3 → 0.9.4

data/CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 == master
 
+== 0.9.4 / 2010-08-01
+
+* Fix validation / save hooks in Sequel 3.14.0+
+* Fix integration with dirty attribute tracking on DataMapper 1.0.1+
+* Fix DataMapper 1.0.1+ tests producing warnings
+* Fix validation error warnings in ActiveModel / ActiveRecord 3.0.0 beta5+
+* Fix mass-assignment sanitization breaking in ActiveRecord 3.0.0 beta5+ [Akira Matsuda]
+
 == 0.9.3 / 2010-06-26
 
 * Allow access to human state / event names in transitions and for the current state

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'state_machine'
-  s.version           = '0.9.3'
+  s.version           = '0.9.4'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds support for creating state machines for attributes on any Ruby class'
   s.description       = s.summary

data/lib/state_machine/integrations/active_model.rb

@@ -222,7 +222,7 @@ module StateMachine
         def extended(base) #:nodoc:
           require 'state_machine/integrations/active_model/observer'
           
-          if Object.const_defined?(:I18n)
+          if defined?(I18n)
             locale = "#{File.dirname(__FILE__)}/active_model/locale.rb"
             I18n.load_path.unshift(locale) unless I18n.load_path.include?(locale)
           end
@@ -267,7 +267,8 @@ module StateMachine
             options
           end
           
-          object.errors.add(attribute, message, options.merge(:default => @messages[message]))
+          default_options = default_error_message_options(object, attribute, message)
+          object.errors.add(attribute, message, options.merge(default_options))
         end
       end
       
@@ -312,6 +313,12 @@ module StateMachine
           owner_class.i18n_scope
         end
         
+        # The default options to use when generating messages for validation
+        # errors
+        def default_error_message_options(object, attribute, message)
+          {:message => @messages[message]}
+        end
+        
         # Translates the given key / value combo.  Translation keys are looked
         # up in the following order:
         # * <tt>#{i18n_scope}.state_machines.#{model_name}.#{machine_name}.#{plural_key}.#{value}</tt>

data/lib/state_machine/integrations/active_record.rb

@@ -331,9 +331,9 @@ module StateMachine
         
         ::ActiveRecord::Observer.class_eval do
           include StateMachine::Integrations::ActiveModel::Observer
-        end unless ::ActiveRecord::Observer.included_modules.include?(StateMachine::Integrations::ActiveModel::Observer)
+        end unless ::ActiveRecord::Observer < StateMachine::Integrations::ActiveModel::Observer
         
-        if Object.const_defined?(:I18n)
+        if defined?(I18n)
           locale = "#{File.dirname(__FILE__)}/active_record/locale.rb"
           I18n.load_path.unshift(locale) unless I18n.load_path.include?(locale)
         end
@@ -341,7 +341,7 @@ module StateMachine
       
       # Adds a validation error to the given object 
       def invalidate(object, attribute, message, values = [])
-        if Object.const_defined?(:I18n)
+        if defined?(I18n)
           super
         else
           object.errors.add(self.attribute(attribute), generate_message(message, values))
@@ -366,7 +366,7 @@ module StateMachine
         
         # Only adds dirty tracking support if ActiveRecord supports it
         def supports_dirty_tracking?(object)
-          defined?(::ActiveRecord::Dirty) && object.respond_to?("#{self.attribute}_changed?") || super
+          defined?(::ActiveRecord::Dirty) && object.respond_to?("#{attribute}_changed?") || super
         end
         
         # Always uses the <tt>:activerecord</tt> translation scope
@@ -374,9 +374,19 @@ module StateMachine
           :activerecord
         end
         
+        # The default options to use when generating messages for validation
+        # errors
+        def default_error_message_options(object, attribute, message)
+          if ::ActiveRecord::VERSION::MAJOR >= 3
+            super
+          else
+            {:default => @messages[message]}
+          end
+        end
+        
         # Only allows translation of I18n is available
         def translate(klass, key, value)
-          if Object.const_defined?(:I18n)
+          if defined?(I18n)
             super
           else
             value ? value.to_s.humanize.downcase : 'nil'
@@ -384,9 +394,9 @@ module StateMachine
         end
         
         # Attempts to look up a class's ancestors via:
-        # * #lookup_ancestors
-        # * #self_and_descendants_from_active_record
-        # * #self_and_descendents_from_active_record
+        # * #lookup_ancestors (3.0.0+)
+        # * #self_and_descendants_from_active_record (2.3.2 - 2.3.x)
+        # * #self_and_descendents_from_active_record (2.0.0 - 2.3.1)
         def ancestors_for(klass)
           if ::ActiveRecord::VERSION::MAJOR >= 3
             super
@@ -415,12 +425,16 @@ module StateMachine
               if new_record? && !@initialized_state_machines
                 @initialized_state_machines = true
                 
-                if new_attributes
+                ignore = if new_attributes
                   attributes = new_attributes.dup
                   attributes.stringify_keys!
-                  ignore = remove_attributes_protected_from_mass_assignment(attributes).keys
+                  if ::ActiveRecord::VERSION::MAJOR >= 3
+                    sanitize_for_mass_assignment(attributes).keys
+                  else
+                    remove_attributes_protected_from_mass_assignment(attributes).keys
+                  end
                 else
-                  ignore = []
+                  []
                 end
                 
                 initialize_state_machines(:dynamic => false, :ignore => ignore)

data/lib/state_machine/integrations/data_mapper.rb

@@ -262,19 +262,18 @@ module StateMachine
       # state value actually changed
       def write(object, attribute, value)
         if attribute == :state
-          # Force to Dirty state in 0.10.3+
-          if !(::DataMapper::VERSION =~ /^0\.(9\.|10\.[0-2]$)/)
-            object.persisted_state = ::DataMapper::Resource::State::Dirty.new(object) if object.persisted_state.is_a?(::DataMapper::Resource::State::Clean)
-          end
-          
           result = super
           
           # Change original attributes in 0.9.4 - 0.10.2
           if ::DataMapper::VERSION =~ /^0\.9\./
             object.original_values[self.attribute] = "#{value}-ignored" if object.original_values[self.attribute] == value
-          elsif ::DataMapper::VERSION =~ /^0\.10\.[0-2]$/
+          elsif ::DataMapper::VERSION =~ /^0\.10\./
             property = owner_class.properties[self.attribute]
             object.original_attributes[property] = "#{value}-ignored" unless object.original_attributes.include?(property)
+          else
+            object.persisted_state = ::DataMapper::Resource::State::Dirty.new(object) if object.persisted_state.is_a?(::DataMapper::Resource::State::Clean)
+            property = owner_class.properties[self.attribute]
+            object.persisted_state.original_attributes[property] = value unless object.persisted_state.original_attributes.include?(property)
           end
         else
           result = super

data/lib/state_machine/integrations/sequel.rb

@@ -297,7 +297,11 @@ module StateMachine
                   super(*args)
                 end
                 
-                raise_on_save_failure && !yielded && !result ? save_failure(:validation) : result
+                if defined?(::Sequel::MAJOR) && (::Sequel::MAJOR > 3 || ::Sequel::MAJOR == 3 && ::Sequel::MINOR > 13)
+                  raise_on_failure?(args.first || {}) && !yielded && !result ? raise_hook_failure(:validation) : result
+                else
+                  raise_on_save_failure && !yielded && !result ? save_failure(:validation) : result
+                end
               end
               
               define_method(defined?(::Sequel::MAJOR) && (::Sequel::MAJOR >= 3 || ::Sequel::MAJOR == 2 && ::Sequel::MINOR == 12) ? :_save : :save) do |*args|
@@ -307,7 +311,13 @@ module StateMachine
                   super(*args)
                 end
                 
-                yielded || result ? result : save_failure(:save)
+                if yielded || result
+                  result
+                elsif defined?(::Sequel::MAJOR) && (::Sequel::MAJOR > 3 || ::Sequel::MAJOR == 3 && ::Sequel::MINOR > 13)
+                  raise_hook_failure(:save)
+                else
+                  save_failure(:save)
+                end
               end
             end unless owner_class.state_machines.any? {|name, machine| machine.action == :save && machine != self}
           else

data/lib/state_machine/machine.rb

@@ -483,7 +483,7 @@ module StateMachine
       end
       
       # Add class-/instance-level methods to the owner class for state initialization
-      unless owner_class.included_modules.include?(StateMachine::InstanceMethods)
+      unless owner_class < StateMachine::InstanceMethods
         owner_class.class_eval do
           extend StateMachine::ClassMethods
           include StateMachine::InstanceMethods
@@ -928,11 +928,15 @@ module StateMachine
     # * <tt>park_transition</tt> -  Gets the next transition that would be
     #   performed if the "park" event were to be fired now on the object or nil
     #   if no transitions can be performed.
-    # * <tt>park(run_action = true)</tt> - Fires the "park" event, transitioning
-    #   from the current state to the next valid state.
-    # * <tt>park!(run_action = true)</tt> - Fires the "park" event, transitioning
-    #   from the current state to the next valid state.  If the transition fails,
-    #   then a StateMachine::InvalidTransition error will be raised.
+    # * <tt>park(..., run_action = true)</tt> - Fires the "park" event,
+    #   transitioning from the current state to the next valid state.  If the
+    #   last argument is a boolean, it will control whether the machine's action
+    #   gets run.
+    # * <tt>park!(..., run_action = true)</tt> - Fires the "park" event,
+    #   transitioning from the current state to the next valid state.  If the
+    #   transition fails, then a StateMachine::InvalidTransition error will be
+    #   raised.  If the last argument is a boolean, it will control whether the
+    #   machine's action gets run.
     # 
     # With a namespace of "car", the above names map to the following methods:
     # * <tt>can_park_car?</tt>
@@ -994,15 +998,23 @@ module StateMachine
     #     end
     #   end
     # 
-    # Note that +super+ is called instead of <tt>super(*args)</tt>.  This
-    # allows the entire arguments list to be accessed by transition callbacks
-    # through StateMachine::Transition#args like so:
+    # Note that +super+ is called instead of <tt>super(*args)</tt>.  This allows
+    # the entire arguments list to be accessed by transition callbacks through
+    # StateMachine::Transition#args like so:
     # 
     #   after_transition :on => :park do |vehicle, transition|
     #     kind = *transition.args
     #     ...
     #   end
     # 
+    # *Remember* that if the last argument is a boolean, it will be used as the
+    # +run_action+ parameter to the event action.  Using the +park+ action
+    # example from above, you can might call it like so:
+    # 
+    #   vehicle.park                    # => Uses default args and runs machine action
+    #   vehicle.park(:parallel)         # => Specifies the +kind+ argument and runs the machine action
+    #   vehicle.park(:parallel, false)  # => Specifies the +kind+ argument and *skips* the machine action
+    # 
     # == Example
     # 
     #   class Vehicle

data/lib/state_machine/transition.rb

@@ -150,8 +150,10 @@ module StateMachine
     #   
     #   vehicle = Vehicle.new
     #   transition = StateMachine::Transition.new(vehicle, machine, :ignite, :parked, :idling)
-    #   transition.perform          # => Runs the +save+ action after setting the state attribute
-    #   transition.perform(false)   # => Only sets the state attribute
+    #   transition.perform                  # => Runs the +save+ action after setting the state attribute
+    #   transition.perform(false)           # => Only sets the state attribute
+    #   transition.perform(Time.now)        # => Passes in additional arguments and runs the +save+ action
+    #   transition.perform(Time.now, false) # => Passes in additional arguments and only sets the state attribute
     def perform(*args)
       run_action = [true, false].include?(args.last) ? args.pop : true
       self.args = args

data/test/unit/integrations/data_mapper_test.rb

@@ -26,13 +26,14 @@ module DataMapperTest
       def new_resource(create_table = :foo, &block)
         table_name = create_table || :foo
         
-        resource = Class.new do
+        resource = Class.new
+        resource.class_eval do
           include DataMapper::Resource
           
           storage_names[:default] = table_name.to_s
           def self.name; "DataMapperTest::#{storage_names[:default].capitalize}"; end
           
-          property :id, DataMapper::Types::Serial
+          property :id, resource.class_eval('Serial')
           property :state, String
           
           auto_migrate! if create_table

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: state_machine
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-27 00:00:00 -04:00
+date: 2010-08-01 00:00:00 -04:00
 default_executable: 
 dependencies: []