aasm 4.12.1 → 4.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51fca1a6911cbe2585301606192b2d0a467ae7e7
-  data.tar.gz: c4bdfee904a029cec8329eb024c608f225a3b746
+  metadata.gz: 13bde38e3731e93db61f6058f32cba8a1a1f6fa0
+  data.tar.gz: a5ab477ba4a18e4e90d2d61c9010421fb39e2011
 SHA512:
-  metadata.gz: 7ce9707a179a75f5e75c038ae8102956503564bca475151a6c64dfad9862b313382fc6b7f3ddc2c8e928dfbb666667b171be5abc7bf7d569e5e72cd4ee59467e
-  data.tar.gz: e2c030b9c239c3ced525745ed32f192712ed946fff5f5ed45c8c2710fe3da2aa8291f41faf351b9241c1eb7e6ecf4bb4ad72aace93aeb6f91e0b8af58d253f73
+  metadata.gz: f51ca4fab23d2e61bdb392ae49a63b2a003a6de07251e39c8dcab892e2282073ed420f35c9bf131f2261ed68bd7d4fdbabd338acd5dbe4ec7f98e1eefaa6c757
+  data.tar.gz: a4eb3ffcceee128b4b3f33bc9e27d69993887a4f7ce2d56a0d4fa0541f154eb3c7cb16d2d9b75a9c4f86fced4af73cf9415b90ca5dd3fcd3d79f3cd81fa981ad

data/Appraisals

@@ -37,10 +37,7 @@ appraise 'rails_5.0' do
   gem 'rails', '5.0.0'
   gem 'mongoid', '~>6.0'
   gem 'sequel'
-
-  # dynamoid is not yet Rails 5 compatible
-  # gem 'dynamoid', '~> 1',                 :platforms => :ruby
-
+  gem 'dynamoid', '~> 1',                 :platforms => :ruby
   gem 'aws-sdk', '~>2',                   :platforms => :ruby
   gem 'redis-objects'
 end

data/CHANGELOG.md

@@ -1,12 +1,17 @@
 # CHANGELOG
 
 ## unreleased
+## 4.12.2
+
+* Fix guards parameter [#484](https://github.com/aasm/aasm/pull/484), thanks to [teohm](https://github.com/teohm)
+* Make errors more inspectable [#452](https://github.com/aasm/aasm/pull/452), thanks to [flexoid](https://github.com/flexoid)
+* Enable Dynamoid for Rails 5 [#483](https://github.com/aasm/aasm/pull/483), thanks to [focusshifter](https://github.com/focusshifter)
 
 ## 4.12.1
 
-* DRY-up Mongoid and ActiveRecord Persistence, Add Sequel transactions and locking #475, thanks to [@Aryk] (https://github.com/Aryk)
-* Add aliases for event methods #476, thanks to [@Aryk] (https://github.com/Aryk)
-* Support Minitest spec expectations (#387), thanks to [@faragorn] (https://github.com/faragorn)
+* DRY-up Mongoid and ActiveRecord Persistence, Add Sequel transactions and locking [#475](https://github.com/aasm/aasm/pull/475), thanks to [@Aryk] (https://github.com/Aryk)
+* Add aliases for event methods [#476](https://github.com/aasm/aasm/pull/476), thanks to [@Aryk] (https://github.com/Aryk)
+* Support Minitest spec expectations [#387](https://github.com/aasm/aasm/pull/387), thanks to [@faragorn] (https://github.com/faragorn)
 ## 4.12.0
 
  * Fix thread safe issue with concurrent-ruby gem [see [pull-request #422](https://github.com/aasm/aasm/pull/442), thanks to [@reidmorrison](https://github.com/reidmorrison)

data/README.md

@@ -165,37 +165,6 @@ class LogRunTime
 end
 ```
 
-Here you can see a list of all possible callbacks, together with their order of calling:
-
-```ruby
-begin
-  event           before_all_events
-  event           before
-  event           guards
-  transition      guards
-  old_state       before_exit
-  old_state       exit
-                  after_all_transitions
-  transition      after
-  new_state       before_enter
-  new_state       enter
-  ...update state...
-  event           before_success      # if persist successful
-  transition      success             # if persist successful
-  event           success             # if persist successful
-  old_state       after_exit
-  new_state       after_enter
-  event           after
-  event           after_all_events
-rescue
-  event           error
-  event           error_on_all_events
-ensure
-  event           ensure
-  event           ensure_on_all_events
-end
-```
-
 Also, you can pass parameters to events:
 
 ```ruby
@@ -228,6 +197,39 @@ and the target state (the to state), like this:
   end
 ```
 
+#### Lifecycle
+
+Here you can see a list of all possible callbacks, together with their order of calling:
+
+```ruby
+begin
+  event           before_all_events
+  event           before
+  event           guards
+  transition      guards
+  old_state       before_exit
+  old_state       exit
+                  after_all_transitions
+  transition      after
+  new_state       before_enter
+  new_state       enter
+  ...update state...
+  event           before_success      # if persist successful
+  transition      success             # if persist successful
+  event           success             # if persist successful
+  old_state       after_exit
+  new_state       after_enter
+  event           after
+  event           after_all_events
+rescue
+  event           error
+  event           error_on_all_events
+ensure
+  event           ensure
+  event           ensure_on_all_events
+end
+```
+
 #### The current event triggered
 
 While running the callbacks you can easily retrieve the name of the event triggered
@@ -280,11 +282,19 @@ class Cleaner
       end
       transitions :from => :idle, :to => :idle
     end
+    
+    event :clean_if_dirty do
+      transitions :from => :idle, :to => :cleaning, :guard => :if_dirty?
+    end
   end
 
   def cleaning_needed?
     false
   end
+  
+  def if_dirty?(status)
+    status == :dirty
+  end
 end
 
 job = Cleaner.new
@@ -292,6 +302,9 @@ job.may_clean?            # => false
 job.clean                 # => raises AASM::InvalidTransition
 job.may_clean_if_needed?  # => true
 job.clean_if_needed!      # idle
+
+job.clean_if_dirty(:clean) # => false
+job.clean_if_dirty(:dirty) # => true
 ```
 
 You can even provide a number of guards, which all have to succeed to proceed
@@ -1016,6 +1029,8 @@ class Job
 end
 ```
 
+You can hide warnings by setting `AASM::Configuration.hide_warnings = true`
+
 ### RubyMotion support
 
 Now supports [CodeDataQuery](https://github.com/infinitered/cdq.git) !

data/gemfiles/rails_5.0.gemfile

@@ -7,6 +7,7 @@ gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "rails", "5.0.0"
 gem "mongoid", "~>6.0"
 gem "sequel"
+gem "dynamoid", "~> 1", :platforms => :ruby
 gem "aws-sdk", "~>2", :platforms => :ruby
 gem "redis-objects"
 

data/lib/aasm/aasm.rb

@@ -1,4 +1,6 @@
 module AASM
+  # this is used internally as an argument default value to represent no value
+  NO_VALUE = :_aasm_no_value
 
   # provide a state machine for the including class
   # make sure to load class methods as well

data/lib/aasm/core/event.rb

@@ -40,11 +40,11 @@ module AASM::Core
     # 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.
-    def may_fire?(obj, to_state=nil, *args)
+    def may_fire?(obj, to_state=::AASM::NO_VALUE, *args)
       _fire(obj, {:test_only => true}, to_state, *args) # true indicates test firing
     end
 
-    def fire(obj, options={}, to_state=nil, *args)
+    def fire(obj, options={}, to_state=::AASM::NO_VALUE, *args)
       _fire(obj, options, to_state, *args) # false indicates this is not a test (fire!)
     end
 
@@ -121,20 +121,19 @@ module AASM::Core
       definitions
     end
 
-    def _fire(obj, options={}, to_state=nil, *args)
+    def _fire(obj, options={}, to_state=::AASM::NO_VALUE, *args)
       result = options[:test_only] ? false : nil
       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
-      unless to_state == nil
-        if !to_state.respond_to?(:to_sym) || !transitions.map(&:to).flatten.include?(to_state.to_sym)
-          args.unshift(to_state)
-          to_state = nil
-        end
+      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
-        args.unshift(nil) if args.nil? || args.empty? # If single arg given which is nil, push it back to args
+        # to_state is an argument
+        args.unshift(to_state)
+        to_state = nil
       end
 
       transitions.each do |transition|

data/lib/aasm/core/transition.rb

@@ -69,7 +69,7 @@ module AASM::Core
 
       case code
       when Symbol, String
-        result = (record.__send__(:method, code.to_sym).arity != 0 ? record.__send__(code, *args) : record.__send__(code))
+        result = (record.__send__(:method, code.to_sym).arity == 0 ? record.__send__(code) : record.__send__(code, *args))
         failures << code unless result
         result
       when Proc

data/lib/aasm/errors.rb

@@ -7,10 +7,7 @@ module AASM
 
     def initialize(object, event_name, state_machine_name, failures = [])
       @object, @event_name, @originating_state, @failures = object, event_name, object.aasm(state_machine_name).current_state, failures
-    end
-
-    def message
-      "Event '#{event_name}' cannot transition from '#{originating_state}'. #{reasoning}"
+      super("Event '#{event_name}' cannot transition from '#{originating_state}'. #{reasoning}")
     end
 
     def reasoning

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.12.1"
+  VERSION = "4.12.2"
 end

data/spec/models/guard_arguments_check.rb

@@ -0,0 +1,17 @@
+class GuardArgumentsCheck
+  include AASM
+
+  aasm do
+    state :new, :reviewed, :finalized
+
+    event :mark_as_reviewed,
+          :guard => proc { |*args| arguments_list(*args) } do
+      transitions :from => :new, :to => :reviewed
+    end
+  end
+
+  def arguments_list(arg1, arg2)
+    return false unless arg1.nil?
+    true
+  end
+end

data/spec/unit/complex_example_spec.rb

@@ -30,14 +30,14 @@ describe 'when being unsuspended' do
   it 'should be able to be unsuspended into active if polite' do
     auth.suspend!
     expect(auth.may_wait?(:waiting, :please)).to be true
-    auth.wait!(nil, :please)
+    auth.wait!(:please)
   end
 
   it 'should not be able to be unsuspended into active if not polite' do
     auth.suspend!
     expect(auth.may_wait?(:waiting)).not_to be true
     expect(auth.may_wait?(:waiting, :rude)).not_to be true
-    expect {auth.wait!(nil, :rude)}.to raise_error(AASM::InvalidTransition)
+    expect {auth.wait!(:rude)}.to raise_error(AASM::InvalidTransition)
     expect {auth.wait!}.to raise_error(AASM::InvalidTransition)
   end
 

data/spec/unit/complex_multiple_example_spec.rb

@@ -39,18 +39,18 @@ describe 'when being unsuspended' do
   it 'should be able to wait into waiting if polite' do
     auth.left_suspend!
     expect(auth.may_left_wait?(:waiting, :please)).to be true
-    auth.left_wait!(nil, :please)
+    auth.left_wait!(:please)
 
     auth.right_suspend!
     expect(auth.may_right_wait?(:waiting)).to be false
-    auth.right_wait!(nil, :please)
+    auth.right_wait!(:please)
   end
 
   it 'should not be able to be unsuspended into active if not polite' do
     auth.left_suspend!
     expect(auth.may_left_wait?(:waiting)).not_to be true
     expect(auth.may_left_wait?(:waiting, :rude)).not_to be true
-    expect {auth.left_wait!(nil, :rude)}.to raise_error(AASM::InvalidTransition)
+    expect {auth.left_wait!(:rude)}.to raise_error(AASM::InvalidTransition)
     expect {auth.left_wait!}.to raise_error(AASM::InvalidTransition)
   end
 

data/spec/unit/event_multiple_spec.rb

@@ -37,7 +37,7 @@ describe 'parametrised events' do
   end
 
   it 'should transition to default state when :after transition invoked' do
-    pe.dress!(nil, 'purple', 'dressy')
+    pe.dress!('purple', 'dressy')
     expect(pe.aasm(:left).current_state).to eq(:working)
   end
 

data/spec/unit/event_spec.rb

@@ -106,7 +106,7 @@ describe 'firing an event' do
     obj = double('object', :aasm => double('aasm', :current_state => :open))
     expect(obj).to receive(:guard_fn).with('arg1', 'arg2').and_return(true)
 
-    expect(event.fire(obj, {}, nil, 'arg1', 'arg2')).to eq(:closed)
+    expect(event.fire(obj, {}, 'arg1', 'arg2')).to eq(:closed)
   end
 
   context 'when given a gaurd proc' do
@@ -118,7 +118,7 @@ describe 'firing an event' do
       line_number = __LINE__ - 2
       obj = double('object', :aasm => double('aasm', :current_state => :student))
 
-      event.fire(obj, {}, nil)
+      event.fire(obj, {})
       expect(event.failed_callbacks).to eq ["#{__FILE__}##{line_number}"]
     end
   end
@@ -133,7 +133,7 @@ describe 'firing an event' do
       obj = double('object', :aasm => double('aasm', :current_state => :student))
       allow(obj).to receive(:paid_tuition?).and_return(false)
 
-      event.fire(obj, {}, nil)
+      event.fire(obj, {})
       expect(event.failed_callbacks).to eq [:paid_tuition?]
     end
   end
@@ -315,7 +315,7 @@ describe 'parametrised events' do
   end
 
   it 'should transition to default state when :after transition invoked' do
-    pe.dress!(nil, 'purple', 'dressy')
+    pe.dress!('purple', 'dressy')
     expect(pe.aasm.current_state).to eq(:working)
   end
 

data/spec/unit/guard_arguments_check_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "nil as first argument" do
+  let(:guard) { GuardArgumentsCheck.new }
+
+  it 'does not raise errors' do
+    expect { guard.mark_as_reviewed(nil, 'second arg') }.not_to raise_error
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.12.1
+  version: 4.12.2
 platform: ruby
 authors:
 - Thorsten Boettger
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -234,6 +234,7 @@ files:
 - spec/models/dynamoid/dynamoid_simple.rb
 - spec/models/foo.rb
 - spec/models/foo_callback_multiple.rb
+- spec/models/guard_arguments_check.rb
 - spec/models/guard_with_params.rb
 - spec/models/guard_with_params_multiple.rb
 - spec/models/guardian.rb
@@ -298,6 +299,7 @@ files:
 - spec/unit/event_naming_spec.rb
 - spec/unit/event_spec.rb
 - spec/unit/exception_spec.rb
+- spec/unit/guard_arguments_check_spec.rb
 - spec/unit/guard_multiple_spec.rb
 - spec/unit/guard_spec.rb
 - spec/unit/guard_with_params_multiple_spec.rb
@@ -356,7 +358,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: State machine mixin for Ruby objects
@@ -414,6 +416,7 @@ test_files:
 - spec/models/dynamoid/dynamoid_simple.rb
 - spec/models/foo.rb
 - spec/models/foo_callback_multiple.rb
+- spec/models/guard_arguments_check.rb
 - spec/models/guard_with_params.rb
 - spec/models/guard_with_params_multiple.rb
 - spec/models/guardian.rb
@@ -478,6 +481,7 @@ test_files:
 - spec/unit/event_naming_spec.rb
 - spec/unit/event_spec.rb
 - spec/unit/exception_spec.rb
+- spec/unit/guard_arguments_check_spec.rb
 - spec/unit/guard_multiple_spec.rb
 - spec/unit/guard_spec.rb
 - spec/unit/guard_with_params_multiple_spec.rb