aasm 4.2.0 → 4.3.0

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -32,34 +32,11 @@ module AASM
       #
       def self.included(base)
         base.send(:include, AASM::Persistence::Base)
-        base.extend AASM::Persistence::MongoidPersistence::ClassMethods
         base.send(:include, AASM::Persistence::MongoidPersistence::InstanceMethods)
 
         base.after_initialize :aasm_ensure_initial_state
       end
 
-      module ClassMethods
-
-        def find_in_state(number, state, *args)
-          with_state_scope state do
-            find(number, *args)
-          end
-        end
-
-        def count_in_state(state, *args)
-          with_state_scope state do
-            count(*args)
-          end
-        end
-
-        def with_state_scope(state)
-          with_scope where(aasm.attribute_name.to_sym => state.to_s) do
-            yield if block_given?
-          end
-        end
-
-      end
-
       module InstanceMethods
 
         # Writes <tt>state</tt> to the state column and persists it to the database
@@ -72,12 +49,12 @@ module AASM
         #   Foo.find(1).aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
-        def aasm_write_state(state)
-          old_value = read_attribute(self.class.aasm.attribute_name)
-          write_attribute(self.class.aasm.attribute_name, state.to_s)
+        def aasm_write_state(state, name=:default)
+          old_value = read_attribute(self.class.aasm(name).attribute_name)
+          write_attribute(self.class.aasm(name).attribute_name, state.to_s)
 
           unless self.save(:validate => false)
-            write_attribute(self.class.aasm.attribute_name, old_value)
+            write_attribute(self.class.aasm(name).attribute_name, old_value)
             return false
           end
 
@@ -96,8 +73,8 @@ module AASM
         #   Foo.find(1).aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
-        def aasm_write_state_without_persistence(state)
-          write_attribute(self.class.aasm.attribute_name, state.to_s)
+        def aasm_write_state_without_persistence(state, name=:default)
+          write_attribute(self.class.aasm(name).attribute_name, state.to_s)
         end
 
       private
@@ -118,16 +95,18 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          send("#{self.class.aasm.attribute_name}=", aasm.enter_initial_state.to_s) if send(self.class.aasm.attribute_name).blank?
+          AASM::StateMachine[self.class].keys.each do |state_machine_name|
+            send("#{self.class.aasm(state_machine_name).attribute_name}=", aasm(state_machine_name).enter_initial_state.to_s) if send(self.class.aasm(state_machine_name).attribute_name).blank?
+          end
         end
       end # InstanceMethods
 
-      module NamedScopeMethods
-        def aasm_state_with_named_scope name, options = {}
-          aasm_state_without_named_scope name, options
-          self.named_scope name, :conditions => { "#{table_name}.#{self.aasm.attribute_name}" => name.to_s} unless self.respond_to?(name)
-        end
-      end
+      # module NamedScopeMethods
+      #   def aasm_state_with_named_scope name, options = {}
+      #     aasm_state_without_named_scope name, options
+      #     self.named_scope name, :conditions => { "#{table_name}.#{self.aasm.attribute_name}" => name.to_s} unless self.respond_to?(name)
+      #   end
+      # end
     end
   end # Persistence
 end # AASM

data/lib/aasm/persistence/plain_persistence.rb

@@ -2,21 +2,22 @@ module AASM
   module Persistence
     module PlainPersistence
 
-      def aasm_read_state
-        # all the following lines behave like @current_state ||= aasm.enter_initial_state
-        current = aasm.instance_variable_get("@current_state")
+      # 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}")
         return current if current
-        aasm.instance_variable_set("@current_state", aasm.enter_initial_state)
+        aasm(name).instance_variable_set("@current_state_#{name}", aasm(name).enter_initial_state)
       end
 
       # may be overwritten by persistence mixins
-      def aasm_write_state(new_state)
+      def aasm_write_state(new_state, name=:default)
         true
       end
 
       # may be overwritten by persistence mixins
-      def aasm_write_state_without_persistence(new_state)
-        true
+      def aasm_write_state_without_persistence(new_state, name=:default)
+        aasm(name).instance_variable_set("@current_state_#{name}", new_state)
       end
 
     end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -44,10 +44,10 @@ module AASM
         # 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
-          state = send(self.class.aasm.attribute_name)
+        def aasm_read_state(name=:default)
+          state = send(self.class.aasm(name).attribute_name)
           if new? && state.to_s.strip.empty?
-            aasm.determine_state_name(self.class.aasm.initial_state)
+            aasm(name).determine_state_name(self.class.aasm(name).initial_state)
           elsif state.nil?
             nil
           else
@@ -71,9 +71,11 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          aasm.enter_initial_state if
-            (new? || values.key?(self.class.aasm.attribute_name)) &&
-            send(self.class.aasm.attribute_name).to_s.strip.empty?
+          AASM::StateMachine[self.class].keys.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?
+          end
         end
 
         # Writes <tt>state</tt> to the state column and persists it to the database
@@ -85,8 +87,8 @@ module AASM
         #   Foo[1].aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
-        def aasm_write_state state
-          aasm_column = self.class.aasm.attribute_name
+        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
 
@@ -102,8 +104,8 @@ module AASM
         #   Foo[1].aasm.current_state # => :closed
         #
         # NOTE: intended to be called from an event
-        def aasm_write_state_without_persistence state
-          send("#{self.class.aasm.attribute_name}=", state.to_s)
+        def aasm_write_state_without_persistence state, name=:default
+          send("#{self.class.aasm(name).attribute_name}=", state.to_s)
         end
       end
     end

data/lib/aasm/state_machine.rb

@@ -10,13 +10,14 @@ module AASM
       (@machines ||= {})[klass.to_s] = machine
     end
 
-    attr_accessor :states, :events, :initial_state, :config
+    attr_accessor :states, :events, :initial_state, :config, :name
 
-    def initialize
+    def initialize(name)
       @initial_state = nil
       @states = []
       @events = {}
       @config = AASM::Configuration.new
+      @name = name
     end
 
     # called internally by Ruby 1.9 after clone()
@@ -26,13 +27,17 @@ module AASM
       @events = @events.dup
     end
 
-    def add_state(name, klass, options)
-      set_initial_state(name, options)
+    def add_state(state_name, klass, options)
+      set_initial_state(state_name, options)
 
       # allow reloading, extending or redefining a state
-      @states.delete(name) if @states.include?(name)
+      @states.delete(state_name) if @states.include?(state_name)
 
-      @states << AASM::Core::State.new(name, klass, options)
+      @states << AASM::Core::State.new(state_name, klass, self, options)
+    end
+
+    def add_event(name, options, &block)
+      @events[name] = AASM::Core::Event.new(name, self, options, &block)
     end
 
     private

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.2.0"
+  VERSION = "4.3.0"
 end

data/spec/database.rb

@@ -1,5 +1,5 @@
 ActiveRecord::Migration.suppress_messages do
-  %w{gates readers writers transients simples  no_scopes no_direct_assignments thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states}.each do |table_name|
+  %w{gates multiple_gates readers writers transients simples no_scopes multiple_no_scopes no_direct_assignments multiple_no_direct_assignments thieves multiple_thieves localizer_test_models persisted_states provided_and_persisted_states with_enums with_true_enums with_false_enums false_states multiple_with_enums multiple_with_true_enums multiple_with_false_enums multiple_false_states}.each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "aasm_state"
     end
@@ -8,17 +8,34 @@ ActiveRecord::Migration.suppress_messages do
   ActiveRecord::Migration.create_table "simple_new_dsls", :force => true do |t|
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_simple_new_dsls", :force => true do |t|
+    t.string "status"
+  end
+
+  ActiveRecord::Migration.create_table "complex_active_record_examples", :force => true do |t|
+    t.string "left"
+    t.string "right"
+  end
 
   ActiveRecord::Migration.create_table "validators", :force => true do |t|
     t.string "name"
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_validators", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
 
   ActiveRecord::Migration.create_table "transactors", :force => true do |t|
     t.string "name"
     t.string "status"
     t.integer "worker_id"
   end
+  ActiveRecord::Migration.create_table "multiple_transactors", :force => true do |t|
+    t.string "name"
+    t.string "status"
+    t.integer "worker_id"
+  end
 
   ActiveRecord::Migration.create_table "workers", :force => true do |t|
     t.string "name"
@@ -29,9 +46,18 @@ ActiveRecord::Migration.suppress_messages do
     t.string "name"
     t.string "status"
   end
+  ActiveRecord::Migration.create_table "multiple_invalid_persistors", :force => true do |t|
+    t.string "name"
+    t.string "status"
+  end
 
   ActiveRecord::Migration.create_table "fathers", :force => true do |t|
     t.string "aasm_state"
     t.string "type"
   end
+
+  ActiveRecord::Migration.create_table "basic_active_record_two_state_machines_examples", :force => true do |t|
+    t.string "search"
+    t.string "sync"
+  end
 end

data/spec/models/active_record/basic_active_record_two_state_machines_example.rb

@@ -0,0 +1,25 @@
+class BasicActiveRecordTwoStateMachinesExample < ActiveRecord::Base
+  include AASM
+
+  aasm :search do
+    state :initialised, :initial => true
+    state :queried
+    state :requested
+
+    event :query do
+      transitions :from => [:initialised, :requested], :to => :queried
+    end
+    event :request do
+      transitions :from => :queried, :to => :requested
+    end
+  end
+
+  aasm :sync do
+    state :unsynced, :initial => true
+    state :synced
+
+    event :synchronise do
+      transitions :from => :unsynced, :to => :synced
+    end
+  end
+end

data/spec/models/active_record/complex_active_record_example.rb

@@ -0,0 +1,33 @@
+class ComplexActiveRecordExample < ActiveRecord::Base
+  include AASM
+
+  aasm :left, :column => 'left' do
+    state :one, :initial => true
+    state :two
+    state :three
+
+    event :increment do
+      transitions :from => :one, :to => :two
+      transitions :from => :two, :to => :three
+    end
+    event :reset do
+      transitions :from => :three, :to => :one
+    end
+  end
+
+  aasm :right, :column => 'right' do
+    state :alpha, :initial => true
+    state :beta
+    state :gamma
+
+    event :level_up do
+      transitions :from => :alpha, :to => :beta
+      transitions :from => :beta, :to => :gamma
+    end
+    event :level_down do
+      transitions :from => :gamma, :to => :beta
+      transitions :from => :beta, :to => :alpha
+    end
+  end
+
+end

data/spec/models/active_record/derivate_new_dsl.rb

@@ -1,3 +1,7 @@
 require_relative 'simple_new_dsl'
+
 class DerivateNewDsl < SimpleNewDsl
 end
+
+class MultipleDerivateNewDsl < MultipleSimpleNewDsl
+end

data/spec/models/active_record/false_state.rb

@@ -15,3 +15,21 @@ class FalseState < ActiveRecord::Base
     end
   end
 end
+
+class MultipleFalseState < ActiveRecord::Base
+  include AASM
+
+  def initialize(*args)
+    super
+    self.aasm_state = false
+  end
+
+  aasm :left do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/gate.rb

@@ -17,3 +17,23 @@ class Gate < ActiveRecord::Base
     end
   end
 end
+
+class MultipleGate < ActiveRecord::Base
+  include AASM
+
+  # Fake this column for testing purposes
+  # attr_accessor :aasm_state
+
+  def value
+    'value'
+  end
+
+  aasm :left, :column => :aasm_state do
+    state :opened
+    state :closed
+
+    event :view do
+      transitions :to => :read, :from => [:needs_attention]
+    end
+  end
+end

data/spec/models/active_record/no_direct_assignment.rb

@@ -8,3 +8,14 @@ class NoDirectAssignment < ActiveRecord::Base
     end
   end
 end
+
+class MultipleNoDirectAssignment < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :aasm_state, :no_direct_assignment => true do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/no_scope.rb

@@ -8,3 +8,14 @@ class NoScope < ActiveRecord::Base
     end
   end
 end
+
+class MultipleNoScope < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :aasm_state, :create_scopes => false do
+    state :pending, :initial => true
+    state :running
+    event :run do
+      transitions :from => :pending, :to => :running
+    end
+  end
+end

data/spec/models/active_record/provided_and_persisted_state.rb

@@ -10,15 +10,15 @@ class ProvidedAndPersistedState < ActiveRecord::Base
     end
   end
 
-  def aasm_read_state
+  def aasm_read_state(*args)
     :gamma
   end
 
-  def aasm_write_state(new_state)
+  def aasm_write_state(new_state, *args)
     @persisted_store = new_state
   end
 
-  def aasm_write_state_without_persistence(new_state)
+  def aasm_write_state_without_persistence(new_state, *args)
     @transient_store = new_state
   end
 end

data/spec/models/active_record/simple_new_dsl.rb

@@ -6,3 +6,12 @@ class SimpleNewDsl < ActiveRecord::Base
     state :new
   end
 end
+
+class MultipleSimpleNewDsl < ActiveRecord::Base
+  include AASM
+  aasm :left, :column => :status
+  aasm :left do
+    state :unknown_scope
+    state :new
+  end
+end