aasm 4.12.3 → 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/docker-compose.yml

@@ -0,0 +1,40 @@
+version: "2"
+
+services:
+  aasm:
+    image: aasm/aasm
+    build: .
+    command: bash -c 'bundle exec appraisal install && bundle exec appraisal rspec'
+    environment:
+      - DYNAMODB_HOST=dynamodb
+      - DYNAMODB_PORT=8000
+      - MONGODB_HOST=mongo
+      - MONGODB_PORT=27017
+      - RAILS_ENV=development
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - RETHINKDB_DB=rethinkdb_test
+      - RETHINKDB_HOST=rethinkdb
+      - RETHINKDB_PORT=28015
+    depends_on:
+      - dynamodb
+      - mongo
+      - redis
+      - rethinkdb
+    volumes:
+      - .:/application
+    volumes_from:
+      - bundle
+  bundle:
+    image: aasm/aasm
+    command: echo Bundler data container
+    volumes:
+      - /bundle
+  dynamodb:
+    image: cnadiminti/dynamodb-local:2017-02-16
+  mongo:
+    image: mongo:3.6.1
+  redis:
+    image: redis:4.0.6-alpine
+  rethinkdb:
+    image: rethinkdb:2.3.6

data/gemfiles/norails.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3", ">= 1.3.5", platforms: :ruby
+gem "rails", install_if: false
+gem "sequel"
+gem "redis-objects"
+
+gemspec path: "../"

data/gemfiles/rails_4.2.gemfile

@@ -2,15 +2,16 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
 gem "rails", "4.2.5"
-gem "nokogiri", "1.6.8.1", :platforms => [:ruby_19]
-gem "mime-types", "~> 2", :platforms => [:ruby_19, :jruby]
-gem "mongoid", "~>4.0"
+gem "nokogiri", "1.6.8.1", platforms: [:ruby_19]
+gem "mime-types", "~> 2", platforms: [:ruby_19, :jruby]
+gem "mongoid", "~> 4.0"
 gem "sequel"
-gem "dynamoid", "~> 1", :platforms => :ruby
-gem "aws-sdk", "~>2", :platforms => :ruby
+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 => "../"
+gemspec path: "../"

data/gemfiles/rails_4.2_mongoid_5.gemfile

@@ -2,10 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
 gem "rails", "4.2.5"
-gem "mime-types", "~> 2", :platforms => [:ruby_19, :jruby]
-gem "mongoid", "~>5.0"
+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 => "../"
+gemspec path: "../"

data/gemfiles/rails_4.2_nobrainer.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "4.2.5"
+gem "nobrainer", "~> 0.33.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -2,13 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
 gem "rails", "5.0.0"
-gem "mongoid", "~>6.0"
+gem "mongoid", "~> 6.0"
 gem "sequel"
-gem "dynamoid", "~> 1", :platforms => :ruby
-gem "aws-sdk", "~>2", :platforms => :ruby
+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 => "../"
+gemspec path: "../"

data/gemfiles/rails_5.0_nobrainer.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.0.0"
+gem "nobrainer", "~> 0.33.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.1"
+gem "mongoid", "~>6.0"
+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

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.5", platforms: :ruby
+gem "rails", "5.2"
+gem "mongoid", "~>6.0"
+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'
@@ -9,6 +7,11 @@ require 'aasm/instance_base'
 require 'aasm/core/transition'
 require 'aasm/core/event'
 require 'aasm/core/state'
+require 'aasm/core/invoker'
+require 'aasm/core/invokers/base_invoker'
+require 'aasm/core/invokers/class_invoker'
+require 'aasm/core/invokers/literal_invoker'
+require 'aasm/core/invokers/proc_invoker'
 require 'aasm/localizer'
 require 'aasm/state_machine_store'
 require 'aasm/state_machine'

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
@@ -130,31 +115,51 @@ private
       event.fire_callbacks(:error, self, e, *process_args(event, aasm(state_machine_name).current_state, *args)) ||
       event.fire_global_callbacks(:error_on_all_events, self, e, *process_args(event, aasm(state_machine_name).current_state, *args)) ||
       raise(e)
+      false
     ensure
       event.fire_callbacks(:ensure, self, *process_args(event, aasm(state_machine_name).current_state, *args))
       event.fire_global_callbacks(:ensure_on_all_events, self, *process_args(event, aasm(state_machine_name).current_state, *args))
     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
@@ -167,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

@@ -54,13 +54,14 @@ module AASM
       # make sure to raise an error if no_direct_assignment is enabled
       # and attribute is directly assigned though
       aasm_name = @name
-      klass.send :define_method, "#{@state_machine.config.column}=", ->(state_name) do
-        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)
+
+      if @state_machine.config.no_direct_assignment
+        @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
     end
@@ -134,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}?")
@@ -249,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AASM::Core
   class Event
     include DslHelper
@@ -123,18 +125,19 @@ module AASM::Core
 
     def _fire(obj, options={}, to_state=::AASM::NO_VALUE, *args)
       result = options[:test_only] ? false : nil
+      clear_failed_callbacks
       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 == ::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)
@@ -155,28 +158,15 @@ module AASM::Core
       result
     end
 
-    def invoke_callbacks(code, record, args)
-      case code
-        when Symbol, String
-          unless record.respond_to?(code, true)
-            raise NoMethodError.new("NoMethodError: undefined method `#{code}' for #{record.inspect}:#{record.class}")
-          end
-          arity = record.__send__(:method, code.to_sym).arity
-          record.__send__(code, *(arity < 0 ? args : args[0...arity]))
-          true
-
-        when Proc
-          arity = code.arity
-          record.instance_exec(*(arity < 0 ? args : args[0...arity]), &code)
-          true
-
-        when Array
-          code.each {|a| invoke_callbacks(a, record, args)}
-          true
+    def clear_failed_callbacks
+      # https://github.com/aasm/aasm/issues/383, https://github.com/aasm/aasm/issues/599
+      transitions.each { |transition| transition.failures.clear }
+    end
 
-        else
-          false
-      end
+    def invoke_callbacks(code, record, args)
+      Invoker.new(code, record, args)
+             .with_default_return_value(false)
+             .invoke
     end
   end
 end # AASM

data/lib/aasm/core/invoker.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module AASM
+  module Core
+    ##
+    # main invoker class which encapsulates the logic
+    # for invoking literal-based, proc-based, class-based
+    # and array-based callbacks for different entities.
+    class Invoker
+      DEFAULT_RETURN_VALUE = true
+
+      ##
+      # Initialize a new invoker instance.
+      # NOTE that invoker must be used per-subject/record
+      #      (one instance per subject/record)
+      #
+      # ==Options:
+      #
+      # +subject+ - invoking subject, may be Proc,
+      #             Class, String, Symbol or Array
+      # +record+  - invoking record
+      # +args+    - arguments which will be passed to the callback
+
+      def initialize(subject, record, args)
+        @subject = subject
+        @record = record
+        @args = args
+        @options = {}
+        @failures = []
+        @default_return_value = DEFAULT_RETURN_VALUE
+      end
+
+      ##
+      # Pass additional options to concrete invoker
+      #
+      # ==Options:
+      #
+      # +options+ - hash of options which will be passed to
+      #             concrete invokers
+      #
+      # ==Example:
+      #
+      # with_options(guard: proc {...})
+
+      def with_options(options)
+        @options = options
+        self
+      end
+
+      ##
+      # Collect failures to a specified buffer
+      #
+      # ==Options:
+      #
+      # +failures+ - failures buffer to collect failures
+
+      def with_failures(failures)
+        @failures = failures
+        self
+      end
+
+      ##
+      # Change default return value of #invoke method
+      # if none of invokers processed the request.
+      #
+      # The default return value is #DEFAULT_RETURN_VALUE
+      #
+      # ==Options:
+      #
+      # +value+ - default return value for #invoke method
+
+      def with_default_return_value(value)
+        @default_return_value = value
+        self
+      end
+
+      ##
+      # Find concrete invoker for specified subject and invoker it,
+      # or return default value set by #DEFAULT_RETURN_VALUE or
+      # overridden by #with_default_return_value
+
+      # rubocop:disable Metrics/AbcSize
+      def invoke
+        return invoke_array if subject.is_a?(Array)
+        return literal_invoker.invoke if literal_invoker.may_invoke?
+        return proc_invoker.invoke if proc_invoker.may_invoke?
+        return class_invoker.invoke if class_invoker.may_invoke?
+        default_return_value
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      attr_reader :subject, :record, :args, :options, :failures,
+                  :default_return_value
+
+      def invoke_array
+        return subject.all? { |item| sub_invoke(item) } if options[:guard]
+        return subject.all? { |item| !sub_invoke(item) } if options[:unless]
+        subject.map { |item| sub_invoke(item) }
+      end
+
+      def sub_invoke(new_subject)
+        self.class.new(new_subject, record, args)
+            .with_failures(failures)
+            .with_options(options)
+            .invoke
+      end
+
+      def proc_invoker
+        @proc_invoker ||= Invokers::ProcInvoker
+                          .new(subject, record, args)
+                          .with_failures(failures)
+      end
+
+      def class_invoker
+        @class_invoker ||= Invokers::ClassInvoker
+                           .new(subject, record, args)
+                           .with_failures(failures)
+      end
+
+      def literal_invoker
+        @literal_invoker ||= Invokers::LiteralInvoker
+                             .new(subject, record, args)
+                             .with_failures(failures)
+      end
+    end
+  end
+end