aasm 4.11.0 → 4.12.0

data/lib/aasm/configuration.rb

@@ -34,5 +34,9 @@ module AASM
 
     # Configure a logger, with default being a Logger to STDERR
     attr_accessor :logger
+
+    class << self
+      attr_accessor :hide_warnings
+    end
   end
 end

data/lib/aasm/core/event.rb

@@ -22,10 +22,21 @@ module AASM::Core
         :before_transaction,
         :ensure,
         :error,
+        :before_success,
         :success,
       ], &block) if block
     end
 
+    # called internally by Ruby 1.9 after clone()
+    def initialize_copy(orig)
+      super
+      @transitions = @transitions.collect { |transition| transition.clone }
+      @guards      = @guards.dup
+      @unless      = @unless.dup
+      @options     = {}
+      orig.options.each_pair { |name, setting| @options[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+
     # a neutered version of fire - it doesn't actually fire the event, it just
     # executes the transition guards to determine if a transition is even
     # an option given current conditions.
@@ -112,12 +123,8 @@ module AASM::Core
 
     def _fire(obj, options={}, to_state=nil, *args)
       result = options[:test_only] ? false : nil
-      if @transitions.map(&:from).any?
-        transitions = @transitions.select { |t| t.from == obj.aasm(state_machine.name).current_state }
-        return result if transitions.size == 0
-      else
-        transitions = @transitions
-      end
+      transitions = @transitions.select { |t| t.from == obj.aasm(state_machine.name).current_state || t.from == nil}
+      return result if transitions.size == 0
 
       # If to_state is not nil it either contains a potential
       # to_state or an arg
@@ -126,16 +133,19 @@ module AASM::Core
           args.unshift(to_state)
           to_state = nil
         end
+      else
+        args.unshift(nil) if args.nil? || args.empty? # If single arg given which is nil, push it back to args
       end
 
       transitions.each do |transition|
         next if to_state and !Array(transition.to).include?(to_state)
-        if (options.key?(:may_fire) && Array(transition.to).include?(options[:may_fire])) ||
+        if (options.key?(:may_fire) && transition.eql?(options[:may_fire])) ||
            (!options.key?(:may_fire) && transition.allowed?(obj, *args))
-          result = to_state || Array(transition.to).first
+
           if options[:test_only]
-            # result = true
+            result = transition
           else
+            result = to_state || Array(transition.to).first
             Array(transition.to).each {|to| @valid_transitions[to] = transition }
             transition.execute(obj, *args)
           end

data/lib/aasm/core/state.rb

@@ -9,6 +9,13 @@ module AASM::Core
       update(options)
     end
 
+    # called internally by Ruby 1.9 after clone()
+    def initialize_copy(orig)
+      super
+      @options = {}
+      orig.options.each_pair { |name, setting| @options[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+
     def ==(state)
       if state.is_a? Symbol
         name == state

data/lib/aasm/core/transition.rb

@@ -28,6 +28,15 @@ module AASM::Core
       @opts = opts
     end
 
+    # called internally by Ruby 1.9 after clone()
+    def initialize_copy(orig)
+      super
+      @guards = @guards.dup
+      @unless = @unless.dup
+      @opts   = {}
+      orig.opts.each_pair { |name, setting| @opts[name] = setting.is_a?(Hash) || setting.is_a?(Array) ? setting.dup : setting }
+    end
+
     def allowed?(obj, *args)
       invoke_callbacks_compatible_with_guard(@guards, obj, args, :guard => true) &&
       invoke_callbacks_compatible_with_guard(@unless, obj, args, :unless => true)

data/lib/aasm/instance_base.rb

@@ -33,9 +33,9 @@ module AASM
       AASM::Localizer.new.human_state_name(@instance.class, state_object_for_name(current_state))
     end
 
-    def states(options={})
+    def states(options={}, *args)
       if options.has_key?(:permitted)
-        selected_events = events(:permitted => options[:permitted])
+        selected_events = events({:permitted => options[:permitted]}, *args)
         # An array of arrays. Each inner array represents the transitions that
         # transition from the current state for an event
         event_transitions = selected_events.map {|e| e.transitions_from_state(current_state) }
@@ -45,10 +45,10 @@ module AASM
           return nil if transitions.empty?
 
           # Return the :to state of the first transition that is allowed (or not) or nil
-          if options[:permitted] 
-            transition = transitions.find { |t| t.allowed?(@instance) }
+          if options[:permitted]
+            transition = transitions.find { |t| t.allowed?(@instance, *args) }
           else
-            transition = transitions.find { |t| !t.allowed?(@instance) }
+            transition = transitions.find { |t| !t.allowed?(@instance, *args) }
           end
           transition ? transition.to : nil
         end.flatten.compact.uniq
@@ -60,7 +60,7 @@ module AASM
       end
     end
 
-    def events(options={})
+    def events(options={}, *args)
       state = options[:state] || current_state
       events = @instance.class.aasm(@name).events.select {|e| e.transitions_from_state?(state) }
 
@@ -71,9 +71,9 @@ module AASM
         # filters the results of events_for_current_state so that only those that
         # are really currently possible (given transition guards) are shown.
         if options[:permitted]
-          events.select! { |e| @instance.send("may_#{e.name}?") }
+          events.select! { |e| @instance.send("may_#{e.name}?", *args) }
         else
-          events.select! { |e| !@instance.send("may_#{e.name}?") }
+          events.select! { |e| !@instance.send("may_#{e.name}?", *args) }
         end
       end
 

data/lib/aasm/persistence/active_record_persistence.rb

@@ -103,7 +103,7 @@ module AASM
       private
 
         def aasm_update_column(name, value)
-          self.class.where(self.class.primary_key => self.id).update_all(self.class.aasm(name).attribute_name => value) == 1
+          self.class.unscoped.where(self.class.primary_key => self.id).update_all(self.class.aasm(name).attribute_name => value) == 1
         end
 
         def aasm_rollback(name, old_value)

data/lib/aasm/persistence/base.rb

@@ -53,9 +53,9 @@ module AASM
 
   class Base
     # make sure to create a (named) scope for each state
-    def state_with_scope(name, *args)
-      state_without_scope(name, *args)
-      create_scope(name) if create_scope?(name)
+    def state_with_scope(*args)
+      names = state_without_scope(*args)
+      names.each { |name| create_scope(name) if create_scope?(name) }
     end
     alias_method :state_without_scope, :state
     alias_method :state, :state_with_scope

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -50,8 +50,7 @@ module AASM
 
       module InstanceMethods
 
-        # Writes <tt>state</tt> to the state column and persists it to the database
-        # using update_attribute (which bypasses validation)
+        # Writes <tt>state</tt> to the state field and persists it to the database
         #
         #   foo = Foo.find(1)
         #   foo.aasm.current_state # => :opened
@@ -62,17 +61,24 @@ module AASM
         # NOTE: intended to be called from an event
         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)
+          aasm_write_attribute(state, name)
 
-          unless self.save(:validate => false)
-            write_attribute(self.class.aasm(name).attribute_name, old_value)
-            return false
+          success = if aasm_skipping_validations(name)
+                      value = aasm_raw_attribute_value(state, name)
+                      aasm_update_column(name, value)
+                    else
+                      self.save
+                    end
+
+          unless success
+            aasm_rollback(name, old_value)
+            raise Mongoid::Errors::Validations.new(self) if aasm_whiny_persistence(name)
           end
 
-          true
+          success
         end
 
-        # Writes <tt>state</tt> to the state column, but does not persist it to the database
+        # 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
@@ -85,11 +91,44 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state_without_persistence(state, name=:default)
-          write_attribute(self.class.aasm(name).attribute_name, state.to_s)
+          aasm_write_attribute(state, name)
         end
 
       private
 
+        def aasm_update_column(name, value)
+          attribute_name = self.class.aasm(name).attribute_name
+
+          if Mongoid::VERSION.to_f >= 4
+            set(Hash[attribute_name, value])
+          else
+            set(attribute_name, value)
+          end
+
+          true
+        end
+
+        def aasm_rollback(name, old_value)
+          write_attribute(self.class.aasm(name).attribute_name, old_value)
+          false
+        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 aasm_whiny_persistence(state_machine_name)
+          AASM::StateMachineStore.fetch(self.class, true).machine(state_machine_name).config.whiny_persistence
+        end
+
+        def aasm_write_attribute(state, name=:default)
+          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
+
         # Ensures that if the aasm_state column is nil and the record is new
         # that the initial state gets populated before validation on create
         #

data/lib/aasm/persistence.rb

@@ -12,9 +12,6 @@ module AASM
         elsif hierarchy.include?("Mongoid::Document")
           require_persistence :mongoid
           include_persistence base, :mongoid
-        elsif hierarchy.include?("MongoMapper::Document")
-          require_persistence :mongo_mapper
-          include_persistence base, :mongo_mapper
         elsif hierarchy.include?("Sequel::Model")
           require_persistence :sequel
           include_persistence base, :sequel

data/lib/aasm/state_machine.rb

@@ -16,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)

data/lib/aasm/state_machine_store.rb

@@ -1,8 +1,11 @@
+require 'concurrent'
 module AASM
   class StateMachineStore
+    @stores = Concurrent::Map.new
+
     class << self
       def stores
-        @stores ||= {}
+        @stores
       end
 
       # do not overwrite existing state machines, which could have been created by
@@ -38,7 +41,7 @@ module AASM
     end
 
     def initialize
-      @machines = {}
+      @machines = Concurrent::Map.new
     end
 
     def clone

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.11.0"
+  VERSION = "4.12.0"
 end

data/lib/generators/active_record/aasm_generator.rb

@@ -12,7 +12,7 @@ module ActiveRecord
 
       def copy_aasm_migration
         if model_exists?
-          migration_template "migration_existing.rb", "db/migrate/add_aasm_state_to_#{table_name}.rb"
+          migration_template "migration_existing.rb", "db/migrate/add_#{column_name}_to_#{table_name}.rb"
         else
           migration_template "migration.rb", "db/migrate/aasm_create_#{table_name}.rb"
         end

data/lib/motion-aasm.rb

@@ -13,7 +13,6 @@ exclude_files = [
   'aasm/rspec.*',
   'aasm/persistence/active_record_persistence.rb',
   'aasm/persistence/dynamoid_persistence.rb',
-  'aasm/persistence/mongo_mapper_persistence.rb',
   'aasm/persistence/mongoid_persistence.rb',
   'aasm/persistence/sequel_persistence.rb',
   'aasm/persistence/redis_persistence.rb'

data/spec/en.yml

@@ -7,3 +7,6 @@ en:
     attributes:
       localizer_test_model:
         aasm_state/opened: "It's open now!"
+    errors:
+      messages:
+        record_invalid: "Invalid record"

data/spec/generators/active_record_generator_spec.rb

@@ -1,39 +1,47 @@
 require 'spec_helper'
-require 'generator_spec'
-require 'generators/active_record/aasm_generator'
 
-describe ActiveRecord::Generators::AASMGenerator, type: :generator do
-  destination File.expand_path("../../../tmp", __FILE__)
+if defined?(ActiveRecord)
+  require 'generator_spec'
+  require 'generators/active_record/aasm_generator'
+
+  describe ActiveRecord::Generators::AASMGenerator, type: :generator do
+    destination File.expand_path("../../../tmp", __FILE__)
+
+    before(:all) do
+      prepare_destination
+    end
+
+    it "creates model with aasm block for default column_name" do
+      run_generator %w(user)
+      assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
+    end
+
+    it "creates model with aasm block for custom column_name" do
+      run_generator %w(user state)
+      assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+    it "creates model with aasm block for namespaced model" do
+      run_generator %w(Admin::User state)
+      assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
+    end
+
+    it "creates migration for model with aasm_column" do
+      run_generator %w(post)
+      assert_migration "db/migrate/aasm_create_posts.rb", /create_table(:posts) do |t|\n  t.string :aasm_state\n/
+    end
+
+    it "add aasm_column in existing model" do
+      run_generator %w(job)
+      assert_file "app/models/job.rb"
+      run_generator %w(job)
+      assert_migration "db/migrate/add_aasm_state_to_jobs.rb"
+    end
+
+    it "add custom aasm_column in existing model" do
+      run_generator %w(job state)
+      assert_migration "db/migrate/add_state_to_jobs.rb"
+    end
 
-  before(:all) do
-    prepare_destination
   end
-
-  it "creates model with aasm block for default column_name" do
-    run_generator %w(user)
-    assert_file "app/models/user.rb", /include AASM\n\n  aasm do\n  end\n/
-  end
-
-  it "creates model with aasm block for custom column_name" do
-    run_generator %w(user state)
-    assert_file "app/models/user.rb", /aasm :column => 'state' do\n  end\n/
-  end
-
-  it "creates model with aasm block for namespaced model" do
-    run_generator %w(Admin::User state)
-    assert_file "app/models/admin/user.rb", /aasm :column => 'state' do\n  end\n/
-  end
-
-  it "creates migration for model with aasm_column" do
-    run_generator %w(post)
-    assert_migration "db/migrate/aasm_create_posts.rb", /create_table(:posts) do |t|\n  t.string :aasm_state\n/
-  end
-
-  it "add aasm_column in existing model" do
-    run_generator %w(job)
-    assert_file "app/models/job.rb"
-    run_generator %w(job)
-    assert_migration "db/migrate/add_aasm_state_to_jobs.rb"
-  end
-
 end

data/spec/generators/mongoid_generator_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
-require 'generator_spec'
-require 'generators/mongoid/aasm_generator'
 
-begin
-  require "mongoid"
+if defined?(Mongoid::Document)
+  require 'generator_spec'
+  require 'generators/mongoid/aasm_generator'
 
   describe Mongoid::Generators::AASMGenerator, type: :generator do
     destination File.expand_path("../../../tmp", __FILE__)
@@ -28,6 +27,5 @@ begin
     end
 
   end
-rescue LoadError
-  puts "Not running Mongoid specs because mongoid gem is not installed!!!"
+
 end

data/spec/models/{invalid_persistor.rb → active_record/invalid_persistor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class InvalidPersistor < ActiveRecord::Base
   include AASM
   aasm :column => :status, :skip_validation_on_save => true do

data/spec/models/{silent_persistor.rb → active_record/silent_persistor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class SilentPersistor < ActiveRecord::Base
   include AASM
   aasm :column => :status, :whiny_persistence => false do

data/spec/models/active_record/simple_new_dsl.rb

@@ -2,7 +2,7 @@ class SimpleNewDsl < ActiveRecord::Base
   include AASM
   aasm :column => :status
   aasm do
-    state :unknown_scope
+    state :unknown_scope, :another_unknown_scope
     state :new
   end
 end
@@ -11,7 +11,7 @@ class MultipleSimpleNewDsl < ActiveRecord::Base
   include AASM
   aasm :left, :column => :status
   aasm :left do
-    state :unknown_scope
+    state :unknown_scope, :another_unknown_scope
     state :new
   end
 end

data/spec/models/{transactor.rb → active_record/transactor.rb}

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class Transactor < ActiveRecord::Base
 
   belongs_to :worker

data/spec/models/{validator.rb → active_record/validator.rb}

@@ -1,12 +1,15 @@
-require 'active_record'
-
 class Validator < ActiveRecord::Base
   attr_accessor :after_all_transactions_performed,
     :after_transaction_performed_on_fail,
     :after_transaction_performed_on_run,
     :before_all_transactions_performed,
     :before_transaction_performed_on_fail,
-    :before_transaction_performed_on_run
+    :before_transaction_performed_on_run,
+    :invalid
+
+  validate do |model|
+    errors.add(:validator, "invalid") if invalid
+  end
 
   include AASM
 

data/spec/models/callbacks/basic.rb

@@ -43,6 +43,7 @@ module Callbacks
             :before => :before_event,
             :after => :after_event,
             :guard => :event_guard,
+            :before_success => :event_before_success,
             :ensure => :ensure_event do
         transitions :to => :closed, :from => [:open],
                     :guard => :transition_guard,
@@ -78,6 +79,8 @@ module Callbacks
     def event_guard;              log('event_guard');         !@fail_event_guard;      end
     def transition_guard;         log('transition_guard');    !@fail_transition_guard; end
 
+    def event_before_success;     log('event_before_success'); end
+
     def after_transition;         log('after_transition');        end
     def after_all_transitions;    log('after_all_transitions');   end
 
@@ -86,8 +89,8 @@ module Callbacks
     def after_event;              log('after_event');         end
     def after_all_events;         log('after_all_events');    end
 
-    def after_transition;     log('after_transition');    end
-    def success_transition;   log('transition_success');  end
+    def after_transition;         log('after_transition');    end
+    def success_transition;       log('transition_success');  end
 
     def ensure_event;             log('ensure');              end
     def ensure_on_all_events;     log('ensure');              end

data/spec/models/guard_with_params.rb

@@ -0,0 +1,24 @@
+class GuardWithParams
+  include AASM
+  aasm do
+    state :new, :reviewed, :finalized
+
+    event :mark_as_reviewed do
+      transitions :from => :new, :to => :reviewed, :guards => [:user_is_manager?]
+    end
+  end
+
+  def user_is_manager?(user)
+    ok = false
+    if user && user.has_role?(:manager)
+      ok = true
+    end
+    return ok
+  end
+end
+
+class GuardParamsClass
+  def has_role?(role)
+    true
+  end
+end

data/spec/models/guard_with_params_multiple.rb

@@ -0,0 +1,18 @@
+class GuardWithParamsMultiple
+  include AASM
+  aasm(:left) do
+    state :new, :reviewed, :finalized
+
+    event :mark_as_reviewed do
+      transitions :from => :new, :to => :reviewed, :guards => [:user_is_manager?]
+    end
+  end
+
+  def user_is_manager?(user)
+    ok = false
+    if user.has_role? :manager
+      ok = true
+    end
+    return ok
+  end
+end

data/spec/models/mongoid/invalid_persistor_mongoid.rb

@@ -0,0 +1,39 @@
+class InvalidPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  aasm :left, column: :status, skip_validation_on_save: true do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end
+
+class MultipleInvalidPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  aasm :left, column: :status, skip_validation_on_save: true do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end

data/spec/models/mongoid/silent_persistor_mongoid.rb

@@ -0,0 +1,39 @@
+class SilentPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  aasm :left, column: :status, whiny_persistence: false do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end
+
+class MultipleSilentPersistorMongoid
+  include Mongoid::Document
+  include AASM
+
+  field :name
+  field :status
+
+  aasm :left, column: :status, whiny_persistence: false do
+    state :sleeping, :initial => true
+    state :running
+    event :run do
+      transitions :to => :running, :from => :sleeping
+    end
+    event :sleep do
+      transitions :to => :sleeping, :from => :running
+    end
+  end
+  validates_presence_of :name
+end