aasm 4.5.1 → 5.5.0

data/lib/aasm/persistence/no_brainer_persistence.rb

@@ -0,0 +1,105 @@
+require 'aasm/persistence/orm'
+module AASM
+  module Persistence
+    module NoBrainerPersistence
+      # This method:
+      #
+      # * extends the model with ClassMethods
+      # * includes InstanceMethods
+      #
+      # Adds
+      #
+      #   before_validation :aasm_ensure_initial_state
+      #
+      # As a result, it doesn't matter when you define your methods - the following 2 are equivalent
+      #
+      #   class Foo
+      #     include NoBrainer::Document
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #     include AASM
+      #   end
+      #
+      #   class Foo
+      #     include NoBrainer::Document
+      #     include AASM
+      #     def aasm_write_state(state)
+      #       "bar"
+      #     end
+      #   end
+      #
+      def self.included(base)
+        base.send(:include, AASM::Persistence::Base)
+        base.send(:include, AASM::Persistence::ORM)
+        base.send(:include, AASM::Persistence::NoBrainerPersistence::InstanceMethods)
+        base.extend AASM::Persistence::NoBrainerPersistence::ClassMethods
+
+        base.after_initialize :aasm_ensure_initial_state
+      end
+
+      module ClassMethods
+        def aasm_create_scope(state_machine_name, scope_name)
+          scope_options = lambda {
+            where(aasm(state_machine_name).attribute_name.to_sym => scope_name.to_s)
+          }
+          send(:scope, scope_name, scope_options)
+        end
+      end
+
+      module InstanceMethods
+
+        private
+
+        def aasm_save
+          self.save
+        end
+
+        def aasm_raise_invalid_record
+          raise NoBrainer::Error::DocumentInvalid.new(self)
+        end
+
+        def aasm_supports_transactions?
+          false
+        end
+
+        def aasm_update_column(attribute_name, value)
+          write_attribute(attribute_name, value)
+          save(validate: false)
+
+          true
+        end
+
+        def aasm_read_attribute(name)
+          read_attribute(name)
+        end
+
+        def aasm_write_attribute(name, value)
+          write_attribute(name, value)
+        end
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |name|
+            aasm_column = self.class.aasm(name).attribute_name
+            aasm(name).enter_initial_state if !read_attribute(aasm_column) || read_attribute(aasm_column).empty?
+          end
+        end
+      end # InstanceMethods
+    end
+  end # Persistence
+end # AASM

data/lib/aasm/persistence/orm.rb

@@ -0,0 +1,154 @@
+module AASM
+  module Persistence
+    # This module adds transactional support for any database that supports it.
+    # This includes rollback capability and rollback/commit callbacks.
+    module ORM
+
+      # Writes <tt>state</tt> to the state column and persists it to the database
+      #
+      #   foo = Foo.find(1)
+      #   foo.aasm.current_state # => :opened
+      #   foo.close!
+      #   foo.aasm.current_state # => :closed
+      #   Foo.find(1).aasm.current_state # => :closed
+      #
+      # NOTE: intended to be called from an event
+      def aasm_write_state(state, name=:default)
+        attribute_name = self.class.aasm(name).attribute_name
+        old_value = aasm_read_attribute(attribute_name)
+        aasm_write_state_attribute state, name
+
+        success = if aasm_skipping_validations(name)
+          aasm_update_column(attribute_name, aasm_raw_attribute_value(state, name))
+        else
+          aasm_save
+        end
+
+        unless success
+          aasm_rollback(name, old_value)
+          aasm_raise_invalid_record if aasm_whiny_persistence(name)
+        end
+
+        success
+      end
+
+      # Writes <tt>state</tt> to the state field, but does not persist it to the database
+      #
+      #   foo = Foo.find(1)
+      #   foo.aasm.current_state # => :opened
+      #   foo.close
+      #   foo.aasm.current_state # => :closed
+      #   Foo.find(1).aasm.current_state # => :opened
+      #   foo.save
+      #   foo.aasm.current_state # => :closed
+      #   Foo.find(1).aasm.current_state # => :closed
+      #
+      # NOTE: intended to be called from an event
+      def aasm_write_state_without_persistence(state, name=:default)
+        aasm_write_state_attribute(state, name)
+      end
+
+      private
+
+      # Save the record and return true if it succeeded/false otherwise.
+      def aasm_save
+        raise("Define #aasm_save_without_error in the AASM Persistence class.")
+      end
+
+      def aasm_raise_invalid_record
+        raise("Define #aasm_raise_invalid_record in the AASM Persistence class.")
+      end
+
+      # Update only the column without running validations.
+      def aasm_update_column(attribute_name, value)
+        raise("Define #aasm_update_column in the AASM Persistence class.")
+      end
+
+      def aasm_read_attribute(name)
+        raise("Define #aasm_read_attribute the AASM Persistence class.")
+      end
+
+      def aasm_write_attribute(name, value)
+        raise("Define #aasm_write_attribute in the AASM Persistence class.")
+      end
+
+      # Returns true or false if transaction completed successfully.
+      def aasm_transaction(requires_new, requires_lock)
+        raise("Define #aasm_transaction the AASM Persistence class.")
+      end
+
+      def aasm_supports_transactions?
+        true
+      end
+
+      def aasm_execute_after_commit
+        yield
+      end
+
+      def aasm_write_state_attribute(state, name=:default)
+        aasm_write_attribute(self.class.aasm(name).attribute_name, aasm_raw_attribute_value(state, name))
+      end
+
+      def aasm_raw_attribute_value(state, _name=:default)
+        state.to_s
+      end
+
+      def aasm_rollback(name, old_value)
+        aasm_write_attribute(self.class.aasm(name).attribute_name, old_value)
+        false
+      end
+
+      def aasm_whiny_persistence(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.whiny_persistence
+      end
+
+      def aasm_skipping_validations(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.skip_validation_on_save
+      end
+
+      def use_transactions?(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.use_transactions
+      end
+
+      def requires_new?(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.requires_new_transaction
+      end
+
+      def requires_lock?(state_machine_name)
+        AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.requires_lock
+      end
+
+      # Returns true if event was fired successfully and transaction completed.
+      def aasm_fire_event(state_machine_name, name, options, *args, &block)
+        return super unless aasm_supports_transactions? && options[:persist]
+
+        event = self.class.aasm(state_machine_name).state_machine.events[name]
+        event.fire_callbacks(:before_transaction, self, *args)
+        event.fire_global_callbacks(:before_all_transactions, self, *args)
+
+        begin
+          success = if options[:persist] && use_transactions?(state_machine_name)
+            aasm_transaction(requires_new?(state_machine_name), requires_lock?(state_machine_name)) do
+              super
+            end
+          else
+            super
+          end
+
+          if success && !(event.options.keys & [:after_commit, :after_all_commits]).empty?
+            aasm_execute_after_commit do
+              event.fire_callbacks(:after_commit, self, *args)
+              event.fire_global_callbacks(:after_all_commits, self, *args)
+            end
+          end
+
+          success
+        ensure
+          event.fire_callbacks(:after_transaction, self, *args)
+          event.fire_global_callbacks(:after_all_transactions, self, *args)
+        end
+      end
+
+    end # Transactional
+  end # Persistence
+end # AASM

data/lib/aasm/persistence/plain_persistence.rb

@@ -5,7 +5,8 @@ module AASM
       # may be overwritten by persistence mixins
       def aasm_read_state(name=:default)
         # all the following lines behave like @current_state ||= aasm(name).enter_initial_state
-        current = aasm(name).instance_variable_get("@current_state_#{name}")
+        current = aasm(name).instance_variable_defined?("@current_state_#{name}") &&
+                  aasm(name).instance_variable_get("@current_state_#{name}")
         return current if current
         aasm(name).instance_variable_set("@current_state_#{name}", aasm(name).enter_initial_state)
       end

data/lib/aasm/persistence/redis_persistence.rb

@@ -0,0 +1,112 @@
+module AASM
+  module Persistence
+    module RedisPersistence
+
+      def self.included(base)
+        base.send(:include, AASM::Persistence::Base)
+        base.send(:include, AASM::Persistence::RedisPersistence::InstanceMethods)
+      end
+
+      module InstanceMethods
+        # Initialize with default values
+        #
+        # Redis::Objects removes the key from Redis when set to `nil`
+        def initialize(*args)
+          super
+          aasm_ensure_initial_state
+        end
+        # Returns the value of the aasm.attribute_name - called from <tt>aasm.current_state</tt>
+        #
+        # If it's a new record, and the aasm state column is blank it returns the initial state
+        #
+        #   class Foo
+        #     include Redis::Objects
+        #     include AASM
+        #     aasm :column => :status do
+        #       state :opened
+        #       state :closed
+        #     end
+        #   end
+        #
+        #   foo = Foo.new
+        #   foo.current_state # => :opened
+        #   foo.close
+        #   foo.current_state # => :closed
+        #
+        #   foo = Foo[1]
+        #   foo.current_state # => :opened
+        #   foo.aasm_state = nil
+        #   foo.current_state # => nil
+        #
+        # NOTE: intended to be called from an event
+        #
+        # This allows for nil aasm states - be sure to add validation to your model
+        def aasm_read_state(name=:default)
+          state = send(self.class.aasm(name).attribute_name)
+
+          if state.value.nil?
+            nil
+          else
+            state.value.to_sym
+          end
+        end
+
+        # Ensures that if the aasm_state column is nil and the record is new
+        # that the initial state gets populated before validation on create
+        #
+        #   foo = Foo.new
+        #   foo.aasm_state # => nil
+        #   foo.valid?
+        #   foo.aasm_state # => "open" (where :open is the initial state)
+        #
+        #
+        #   foo = Foo.find(:first)
+        #   foo.aasm_state # => 1
+        #   foo.aasm_state = nil
+        #   foo.valid?
+        #   foo.aasm_state # => nil
+        #
+        def aasm_ensure_initial_state
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |name|
+            aasm_column = self.class.aasm(name).attribute_name
+            aasm(name).enter_initial_state if !send(aasm_column).value || send(aasm_column).value.empty?
+          end
+        end
+
+        # Writes <tt>state</tt> to the state column and persists it to the database
+        #
+        #   foo = Foo[1]
+        #   foo.aasm.current_state # => :opened
+        #   foo.close!
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state(state, name=:default)
+          aasm_column = self.class.aasm(name).attribute_name
+          send("#{aasm_column}").value = state
+        end
+
+        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        # (but actually it still does)
+        #
+        # With Redis::Objects it's not possible to skip persisting - it's not an ORM,
+        # it does not operate like an AR model and does not know how to postpone changes.
+        #
+        #   foo = Foo[1]
+        #   foo.aasm.current_state # => :opened
+        #   foo.close
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :opened
+        #   foo.save
+        #   foo.aasm.current_state # => :closed
+        #   Foo[1].aasm.current_state # => :closed
+        #
+        # NOTE: intended to be called from an event
+        def aasm_write_state_without_persistence(state, name=:default)
+          aasm_write_state(state, name)
+        end
+      end
+    end
+  end
+end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -1,10 +1,10 @@
-require_relative 'base'
-
+require 'aasm/persistence/orm'
 module AASM
   module Persistence
     module SequelPersistence
       def self.included(base)
         base.send(:include, AASM::Persistence::Base)
+        base.send(:include, AASM::Persistence::ORM)
         base.send(:include, AASM::Persistence::SequelPersistence::InstanceMethods)
       end
 
@@ -15,46 +15,45 @@ module AASM
         end
 
         def before_create
-          aasm_ensure_initial_state
           super
         end
 
-        # Returns the value of the aasm.attribute_name - called from <tt>aasm.current_state</tt>
-        #
-        # If it's a new record, and the aasm state column is blank it returns the initial state
-        #
-        #   class Foo < Sequel::Model
-        #     include AASM
-        #     aasm :column => :status do
-        #       state :opened
-        #       state :closed
-        #     end
-        #   end
-        #
-        #   foo = Foo.new
-        #   foo.current_state # => :opened
-        #   foo.close
-        #   foo.current_state # => :closed
-        #
-        #   foo = Foo[1]
-        #   foo.current_state # => :opened
-        #   foo.aasm_state = nil
-        #   foo.current_state # => nil
-        #
-        # NOTE: intended to be called from an event
-        #
-        # This allows for nil aasm states - be sure to add validation to your model
-        def aasm_read_state(name=:default)
-          state = send(self.class.aasm(name).attribute_name)
-          if new? && state.to_s.strip.empty?
-            aasm(name).determine_state_name(self.class.aasm(name).initial_state)
-          elsif state.nil?
-            nil
-          else
-            state.to_sym
+        def aasm_raise_invalid_record
+          raise Sequel::ValidationFailed.new(self)
+        end
+
+        def aasm_new_record?
+          new?
+        end
+
+        # Returns nil if fails silently
+        # http://sequel.jeremyevans.net/rdoc/classes/Sequel/Model/InstanceMethods.html#method-i-save
+        def aasm_save
+          !save(raise_on_failure: false).nil?
+        end
+
+        def aasm_read_attribute(name)
+          send(name)
+        end
+
+        def aasm_write_attribute(name, value)
+          send("#{name}=", value)
+        end
+
+        def aasm_transaction(requires_new, requires_lock)
+          self.class.db.transaction(savepoint: requires_new) do
+            if requires_lock
+              # http://sequel.jeremyevans.net/rdoc/classes/Sequel/Model/InstanceMethods.html#method-i-lock-21
+              requires_lock.is_a?(String) ? lock!(requires_lock) : lock!
+            end
+            yield
           end
         end
 
+        def aasm_update_column(attribute_name, value)
+          this.update(attribute_name => value)
+        end
+
         # Ensures that if the aasm_state column is nil and the record is new
         # that the initial state gets populated before validation on create
         #
@@ -71,42 +70,13 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          AASM::StateMachine[self.class].keys.each do |state_machine_name|
+          AASM::StateMachineStore.fetch(self.class, true).machine_names.each do |state_machine_name|
             aasm(state_machine_name).enter_initial_state if
               (new? || values.key?(self.class.aasm(state_machine_name).attribute_name)) &&
-              send(self.class.aasm(state_machine_name).attribute_name).to_s.strip.empty?
+                send(self.class.aasm(state_machine_name).attribute_name).to_s.strip.empty?
           end
         end
 
-        # Writes <tt>state</tt> to the state column and persists it to the database
-        #
-        #   foo = Foo[1]
-        #   foo.aasm.current_state # => :opened
-        #   foo.close!
-        #   foo.aasm.current_state # => :closed
-        #   Foo[1].aasm.current_state # => :closed
-        #
-        # NOTE: intended to be called from an event
-        def aasm_write_state state, name=:default
-          aasm_column = self.class.aasm(name).attribute_name
-          update_only({aasm_column => state.to_s}, aasm_column)
-        end
-
-        # Writes <tt>state</tt> to the state column, but does not persist it to the database
-        #
-        #   foo = Foo[1]
-        #   foo.aasm.current_state # => :opened
-        #   foo.close
-        #   foo.aasm.current_state # => :closed
-        #   Foo[1].aasm.current_state # => :opened
-        #   foo.save
-        #   foo.aasm.current_state # => :closed
-        #   Foo[1].aasm.current_state # => :closed
-        #
-        # NOTE: intended to be called from an event
-        def aasm_write_state_without_persistence state, name=:default
-          send("#{self.class.aasm(name).attribute_name}=", state.to_s)
-        end
       end
     end
   end

data/lib/aasm/persistence.rb

@@ -7,13 +7,25 @@ module AASM
         hierarchy = base.ancestors.map {|klass| klass.to_s}
 
         if hierarchy.include?("ActiveRecord::Base")
+          require_persistence :active_record
           include_persistence base, :active_record
         elsif hierarchy.include?("Mongoid::Document")
+          require_persistence :mongoid
           include_persistence base, :mongoid
-        elsif hierarchy.include?("MongoMapper::Document")
-          include_persistence base, :mongo_mapper
+        elsif hierarchy.include?("NoBrainer::Document")
+          require_persistence :no_brainer
+          include_persistence base, :no_brainer
         elsif hierarchy.include?("Sequel::Model")
+          require_persistence :sequel
           include_persistence base, :sequel
+        elsif hierarchy.include?("Dynamoid::Document")
+          require_persistence :dynamoid
+          include_persistence base, :dynamoid
+        elsif hierarchy.include?("Redis::Objects")
+          require_persistence :redis
+          include_persistence base, :redis
+        elsif hierarchy.include?("CDQManagedObject")
+          include_persistence base, :core_data_query
         else
           include_persistence base, :plain
         end
@@ -21,9 +33,12 @@ module AASM
 
       private
 
-      def include_persistence(base, type)
+      def require_persistence(type)
         require File.join(File.dirname(__FILE__), 'persistence', "#{type}_persistence")
-        base.send(:include, constantize("AASM::Persistence::#{capitalize(type)}Persistence"))
+      end
+
+      def include_persistence(base, type)
+        base.send(:include, constantize("#{capitalize(type)}Persistence"))
       end
 
       def capitalize(string_or_symbol)
@@ -31,7 +46,7 @@ module AASM
       end
 
       def constantize(string)
-        instance_eval(string)
+        AASM::Persistence.const_get(string)
       end
 
     end # class << self

data/lib/aasm/rspec/allow_event.rb

@@ -1,13 +1,17 @@
 RSpec::Matchers.define :allow_event do |event|
   match do |obj|
     @state_machine_name ||= :default
-    obj.aasm(@state_machine_name).may_fire_event?(event)
+    obj.aasm(@state_machine_name).may_fire_event?(event, *@args)
   end
 
   chain :on do |state_machine_name|
     @state_machine_name = state_machine_name
   end
 
+  chain :with do |*args|
+    @args = args
+  end
+
   description do
     "allow event #{expected} (on :#{@state_machine_name})"
   end

data/lib/aasm/rspec/allow_transition_to.rb

@@ -1,13 +1,17 @@
 RSpec::Matchers.define :allow_transition_to do |state|
   match do |obj|
     @state_machine_name ||= :default
-    obj.aasm(@state_machine_name).states(:permitted => true).include?(state)
+    obj.aasm(@state_machine_name).states({:permitted => true}, *@args).include?(state)
   end
 
   chain :on do |state_machine_name|
     @state_machine_name = state_machine_name
   end
 
+  chain :with do |*args|
+    @args = args
+  end
+
   description do
     "allow transition to #{expected} (on :#{@state_machine_name})"
   end

data/lib/aasm/rspec/transition_from.rb

@@ -2,8 +2,11 @@ RSpec::Matchers.define :transition_from do |from_state|
   match do |obj|
     @state_machine_name ||= :default
     obj.aasm(@state_machine_name).current_state = from_state.to_sym
-    # expect(obj).to receive(:broadcast_event).with(@event.to_s, obj, from_state, @to_state)
-    obj.send(@event) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    begin
+      obj.send(@event, *@args) && obj.aasm(@state_machine_name).current_state == @to_state.to_sym
+    rescue AASM::InvalidTransition
+      false
+    end
   end
 
   chain :on do |state_machine_name|
@@ -14,12 +17,13 @@ RSpec::Matchers.define :transition_from do |from_state|
     @to_state = state
   end
 
-  chain :on_event do |event|
+  chain :on_event do |event, *args|
     @event = event
+    @args = args
   end
 
   description do
-    "transition state to :#{@to_state} from :#{expected} on event :#{@event} (on :#{@state_machine_name})"
+    "transition state to :#{@to_state} from :#{expected} on event :#{@event}, with params: #{@args} (on :#{@state_machine_name})"
   end
 
   failure_message do |obj|

data/lib/aasm/state_machine.rb

@@ -1,14 +1,6 @@
 module AASM
   class StateMachine
-
-    # the following two methods provide the storage of all state machines
-    def self.[](klass)
-      (@machines ||= {})[klass.to_s]
-    end
-
-    def self.[]=(klass, machine)
-      (@machines ||= {})[klass.to_s] = machine
-    end
+    # the following four methods provide the storage of all state machines
 
     attr_accessor :states, :events, :initial_state, :config, :name, :global_callbacks
 
@@ -24,8 +16,10 @@ module AASM
     # called internally by Ruby 1.9 after clone()
     def initialize_copy(orig)
       super
-      @states = @states.dup
-      @events = @events.dup
+      @states = orig.states.collect { |state| state.clone }
+      @events = {}
+      orig.events.each_pair { |name, event| @events[name] = event.clone }
+      @global_callbacks = @global_callbacks.dup
     end
 
     def add_state(state_name, klass, options)
@@ -44,7 +38,7 @@ module AASM
     def add_global_callbacks(name, *callbacks, &block)
       @global_callbacks[name] ||= []
       callbacks.each do |callback|
-        @global_callbacks[name] << callback
+        @global_callbacks[name] << callback unless @global_callbacks[name].include? callback
       end
       @global_callbacks[name] << block if block
     end