aasm 5.0.5 → 5.1.1

data/aasm.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', ">= 3"
   s.add_development_dependency 'generator_spec'
   s.add_development_dependency 'appraisal'
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "codecov", ">= 0.1.17", '< 0.1.20'
 
   # debugging
   # s.add_development_dependency 'debugger'

data/gemfiles/norails.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "sqlite3", "~> 1.3", ">= 1.3.5", platforms: :ruby
 gem "rails", install_if: false
 gem "sequel"
 gem "redis-objects"

data/gemfiles/rails_4.2.gemfile

@@ -12,5 +12,6 @@ gem "dynamoid", "~> 1", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
+gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
 
 gemspec path: "../"

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -7,5 +7,6 @@ gem "rails", "4.2.5"
 gem "mime-types", "~> 2", platforms: [:ruby_19, :jruby]
 gem "mongoid", "~> 5.0"
 gem "activerecord-jdbcsqlite3-adapter", "1.3.24", platforms: :jruby
+gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
 
 gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -9,5 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~> 2", platforms: :ruby
 gem "redis-objects"
+gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
 
 gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -9,5 +9,6 @@ gem "sequel"
 gem "dynamoid", "~> 1.3", platforms: :ruby
 gem "aws-sdk", "~>2", platforms: :ruby
 gem "redis-objects"
+gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
 
 gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -9,5 +9,6 @@ gem "sequel"
 gem "dynamoid", "~>2.2", platforms: :ruby
 gem "aws-sdk", "~>2", platforms: :ruby
 gem "redis-objects"
+gem "after_commit_everywhere", "~> 0.1", ">= 0.1.5"
 
 gemspec path: "../"

data/lib/aasm.rb

@@ -1,5 +1,3 @@
-require 'ostruct'
-
 require 'aasm/version'
 require 'aasm/errors'
 require 'aasm/configuration'

data/lib/aasm/aasm.rb

@@ -99,25 +99,10 @@ private
     begin
       old_state = aasm(state_machine_name).state_object_for_name(aasm(state_machine_name).current_state)
 
-      event.fire_global_callbacks(
-        :before_all_events,
-        self,
-        *process_args(event, aasm(state_machine_name).current_state, *args)
-      )
-
-      # new event before callback
-      event.fire_callbacks(
-        :before,
-        self,
-        *process_args(event, aasm(state_machine_name).current_state, *args)
-      )
+      fire_default_callbacks(event, *process_args(event, aasm(state_machine_name).current_state, *args))
 
       if may_fire_to = event.may_fire?(self, *args)
-        old_state.fire_callbacks(:before_exit, self,
-          *process_args(event, aasm(state_machine_name).current_state, *args))
-        old_state.fire_callbacks(:exit, self,
-          *process_args(event, aasm(state_machine_name).current_state, *args))
-
+        fire_exit_callbacks(old_state, *process_args(event, aasm(state_machine_name).current_state, *args))
         if new_state_name = event.fire(self, {:may_fire => may_fire_to}, *args)
           aasm_fired(state_machine_name, event, old_state, new_state_name, options, *args, &block)
         else
@@ -137,25 +122,44 @@ private
     end
   end
 
+  def fire_default_callbacks(event, *processed_args)
+    event.fire_global_callbacks(
+      :before_all_events,
+      self,
+      *processed_args
+    )
+
+    # new event before callback
+    event.fire_callbacks(
+      :before,
+      self,
+      *processed_args
+    )
+  end
+
+  def fire_exit_callbacks(old_state, *processed_args)
+    old_state.fire_callbacks(:before_exit, self, *processed_args)
+    old_state.fire_callbacks(:exit, self, *processed_args)
+  end
+
   def aasm_fired(state_machine_name, event, old_state, new_state_name, options, *args)
     persist = options[:persist]
 
     new_state = aasm(state_machine_name).state_object_for_name(new_state_name)
+    callback_args = process_args(event, aasm(state_machine_name).current_state, *args)
 
-    new_state.fire_callbacks(:before_enter, self,
-      *process_args(event, aasm(state_machine_name).current_state, *args))
+    new_state.fire_callbacks(:before_enter, self, *callback_args)
 
-    new_state.fire_callbacks(:enter, self,
-      *process_args(event, aasm(state_machine_name).current_state, *args)) # TODO: remove for AASM 4?
+    new_state.fire_callbacks(:enter, self, *callback_args) # TODO: remove for AASM 4?
 
     persist_successful = true
     if persist
       persist_successful = aasm(state_machine_name).set_current_state_with_persistence(new_state_name)
       if persist_successful
         yield if block_given?
-        event.fire_callbacks(:before_success, self)
+        event.fire_callbacks(:before_success, self, *callback_args)
         event.fire_transition_callbacks(self, *process_args(event, old_state.name, *args))
-        event.fire_callbacks(:success, self)
+        event.fire_callbacks(:success, self, *callback_args)
       end
     else
       aasm(state_machine_name).current_state = new_state_name
@@ -168,10 +172,8 @@ private
     end
 
     if persist_successful
-      old_state.fire_callbacks(:after_exit, self,
-        *process_args(event, aasm(state_machine_name).current_state, *args))
-      new_state.fire_callbacks(:after_enter, self,
-        *process_args(event, aasm(state_machine_name).current_state, *args))
+      old_state.fire_callbacks(:after_exit, self, *callback_args)
+      new_state.fire_callbacks(:after_enter, self, *callback_args)
       event.fire_callbacks(
         :after,
         self,

data/lib/aasm/base.rb

@@ -59,6 +59,8 @@ module AASM
         @klass.send(:define_method, "#{@state_machine.config.column}=") do |state_name|
           if self.class.aasm(:"#{aasm_name}").state_machine.config.no_direct_assignment
             raise AASM::NoDirectAssignmentError.new('direct assignment of AASM column has been disabled (see AASM configuration for this class)')
+          else
+            super(state_name)
           end
         end
       end
@@ -133,6 +135,8 @@ module AASM
         aasm_fire_event(aasm_name, event, {:persist => false}, *args, &block)
       end
 
+      skip_instance_level_validation(event, name, aasm_name, klass)
+
       # Create aliases for the event methods. Keep the old names to maintain backwards compatibility.
       if namespace?
         klass.send(:alias_method, "may_#{name}_#{namespace}?", "may_#{name}?")
@@ -248,5 +252,20 @@ module AASM
       end
     end
 
+    def skip_instance_level_validation(event, name, aasm_name, klass)
+      # Overrides the skip_validation config for an instance (If skip validation is set to false in original config) and
+      # restores it back to the original value after the event is fired.
+      safely_define_method klass, "#{name}_without_validation!", ->(*args, &block) do
+        original_config = AASM::StateMachineStore.fetch(self.class, true).machine(aasm_name).config.skip_validation_on_save
+        begin
+          AASM::StateMachineStore.fetch(self.class, true).machine(aasm_name).config.skip_validation_on_save = true unless original_config
+          aasm(aasm_name).current_event = :"#{name}!"
+          aasm_fire_event(aasm_name, event, {:persist => true}, *args, &block)
+        ensure
+          AASM::StateMachineStore.fetch(self.class, true).machine(aasm_name).config.skip_validation_on_save = original_config
+        end
+      end
+    end
+
   end
 end

data/lib/aasm/core/event.rb

@@ -131,13 +131,13 @@ module AASM::Core
 
       if to_state == ::AASM::NO_VALUE
         to_state = nil
-      elsif to_state.respond_to?(:to_sym) && transitions.map(&:to).flatten.include?(to_state.to_sym)
-        # nop, to_state is a valid to-state
-      else
+      elsif !(to_state.respond_to?(:to_sym) && transitions.map(&:to).flatten.include?(to_state.to_sym))
         # to_state is an argument
         args.unshift(to_state)
         to_state = nil
       end
+      
+      # nop, to_state is a valid to-state
 
       transitions.each do |transition|
         next if to_state and !Array(transition.to).include?(to_state)

data/lib/aasm/instance_base.rb

@@ -28,7 +28,7 @@ module AASM
     end
 
     def human_state
-      AASM::Localizer.new.human_state_name(@instance.class, state_object_for_name(current_state))
+      state_object_for_name(current_state).display_name
     end
 
     def states(options={}, *args)
@@ -78,6 +78,17 @@ module AASM
       events
     end
 
+    def permitted_transitions
+      events(permitted: true).flat_map do |event|
+        available_transitions = event.transitions_from_state(current_state)
+        allowed_transitions = available_transitions.select { |t| t.allowed?(@instance) }
+
+        allowed_transitions.map do |transition|
+          { event: event.name, state: transition.to }
+        end
+      end
+    end
+
     def state_object_for_name(name)
       obj = @instance.class.aasm(@name).states.find {|s| s.name == name}
       raise AASM::UndefinedState, "State :#{name} doesn't exist" if obj.nil?
@@ -91,7 +102,7 @@ module AASM
         when Proc
           state.call(@instance)
         else
-          raise NotImplementedError, "Unrecognized state-type given.  Expected Symbol, String, or Proc."
+          raise NotImplementedError, "Unrecognized state-type given. Expected Symbol, String, or Proc."
       end
     end
 
@@ -104,11 +115,12 @@ module AASM
     end
 
     def fire(event_name, *args, &block)
-      @instance.send(:aasm_fire_event, @name, event_name, {persist: false}, *args, &block)
+      @instance.send(event_name, *args, &block)
     end
 
     def fire!(event_name, *args, &block)
-      @instance.send(:aasm_fire_event, @name, event_name, {persist: true}, *args, &block)
+      event_name = event_name.to_s.+("!").to_sym
+      @instance.send(event_name, *args, &block)
     end
 
     def set_current_state_with_persistence(state)

data/lib/aasm/persistence/active_record_persistence.rb

@@ -61,6 +61,24 @@ module AASM
 
         private
 
+        def aasm_execute_after_commit
+          begin
+            require 'after_commit_everywhere'
+            raise LoadError unless Gem::Version.new(::AfterCommitEverywhere::VERSION) >= Gem::Version.new('0.1.5')
+
+            self.extend ::AfterCommitEverywhere
+            after_commit do
+              yield
+            end
+          rescue LoadError
+            warn <<-MSG
+  [DEPRECATION] :after_commit AASM callback is not safe in terms of race conditions and redundant calls.
+                Please add `gem 'after_commit_everywhere', '~> 0.1', '>= 0.1.5'` to your Gemfile in order to fix that.
+            MSG
+            yield
+          end
+        end
+
         def aasm_raise_invalid_record
           raise ActiveRecord::RecordInvalid.new(self)
         end

data/lib/aasm/persistence/orm.rb

@@ -81,6 +81,10 @@ module AASM
         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
@@ -116,32 +120,32 @@ module AASM
 
       # Returns true if event was fired successfully and transaction completed.
       def aasm_fire_event(state_machine_name, name, options, *args, &block)
-        if 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
+        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
+          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
-
-            success
-          ensure
-            event.fire_callbacks(:after_transaction, self, *args)
-            event.fire_global_callbacks(:after_all_transactions, self, *args)
           end
-        else
-          super
+
+          success
+        ensure
+          event.fire_callbacks(:after_transaction, self, *args)
+          event.fire_global_callbacks(:after_all_transactions, self, *args)
         end
       end
 

data/lib/aasm/rspec/transition_from.rb

@@ -2,7 +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
-    obj.send(@event, *@args) && 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|

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "5.0.5"
+  VERSION = "5.1.1"
 end

data/spec/database.rb

@@ -27,7 +27,7 @@ ActiveRecord::Migration.suppress_messages do
     t.string "status"
   end
 
-  %w(validators multiple_validators workers invalid_persistors multiple_invalid_persistors silent_persistors multiple_silent_persistors).each do |table_name|
+  %w(validators multiple_validators workers invalid_persistors multiple_invalid_persistors silent_persistors multiple_silent_persistors active_record_callbacks).each do |table_name|
     ActiveRecord::Migration.create_table table_name, :force => true do |t|
       t.string "name"
       t.string "status"
@@ -51,4 +51,9 @@ ActiveRecord::Migration.suppress_messages do
     t.string "search"
     t.string "sync"
   end
+
+  ActiveRecord::Migration.create_table "instance_level_skip_validation_examples", :force => true do |t|
+    t.string "state"
+    t.string "some_string"
+  end
 end

data/spec/en.yml

@@ -4,9 +4,6 @@ en:
       localizer_test_model:
         close: "Let's close it!"
 
-    attributes:
-      localizer_test_model:
-        aasm_state/opened: "It's open now!"
     errors:
       messages:
         record_invalid: "Invalid record"

data/spec/{en_deprecated_style.yml → localizer_test_model_deprecated_style.yml}

@@ -1,9 +1,5 @@
 en:
   activerecord:
-    events:
-      localizer_test_model:
-        close: "Let's close it!"
-
     attributes:
       localizer_test_model:
         aasm_state:

data/spec/localizer_test_model_new_style.yml

@@ -0,0 +1,5 @@
+en:
+  activerecord:
+    attributes:
+      localizer_test_model:
+        aasm_state/opened: "It's open now!"

data/spec/models/active_record/active_record_callback.rb

@@ -0,0 +1,93 @@
+class ActiveRecordCallback < ActiveRecord::Base
+  include AASM
+
+  def reset_data
+    @data = []
+  end
+
+  def data
+    @data.join(' ')
+  end
+
+  aasm column: :status do
+    before_all_events       :before_all_events
+    after_all_events        :after_all_events
+    ensure_on_all_events    :ensure_on_all_events
+    after_all_transitions   :after_all_transitions
+
+    state :open, :initial => true,
+    :before_enter => :before_enter_open,
+    :enter        => :enter_open,
+    :after_enter  => :after_enter_open,
+    :before_exit  => :before_exit_open,
+    :exit         => :exit_open,
+    :after_exit   => :after_exit_open
+
+    state :closed,
+    :before_enter => :before_enter_closed,
+    :enter        => :enter_closed,
+    :after_enter  => :after_enter_closed,
+    :before_exit  => :before_exit_closed,
+    :exit         => :exit_closed,
+    :after_exit   => :after_exit_closed
+
+    event :close,
+        :before => :before_event,
+        :after => :after_event,
+        :guard => :event_guard,
+        :before_success => :event_before_success,
+        :after_commit => :event_after_commit,
+        :ensure => :ensure_event do
+    transitions :to => :closed, :from => [:open],
+                :guard => :transition_guard,
+                :after => :after_transition,
+                :success => :success_transition
+    end
+
+    event :open, :before => :before_event, :after => :after_event  do
+    transitions :to => :open, :from => :closed
+    end
+  end
+
+  def log(text)
+    @data ||= []
+    @data << text
+    #puts text
+  end
+
+  def aasm_write_state(*args);  log('aasm_write_state'); true;  end
+  def before_enter_open;        log('before_enter_open');       end
+  def enter_open;               log('enter_open');              end
+  def before_exit_open;         log('before_exit_open');        end
+  def after_enter_open;         log('after_enter_open');        end
+  def exit_open;                log('exit_open');               end
+  def after_exit_open;          log('after_exit_open');         end
+
+  def before_enter_closed;      log('before_enter_closed'); end
+  def enter_closed;             log('enter_closed');        end
+  def before_exit_closed;       log('before_exit_closed');  end
+  def exit_closed;              log('exit_closed');         end
+  def after_enter_closed;       log('after_enter_closed');  end
+  def after_exit_closed;        log('after_exit_closed');   end
+
+  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
+
+  def before_all_events;        log('before_all_events')    end
+  def before_event;             log('before_event');        end
+  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 ensure_event;             log('ensure');              end
+  def ensure_on_all_events;     log('ensure');              end
+
+  def event_after_commit;       log('after_commit');        end 
+end