aasm 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e82947e11b28a1768717833153778b493f638129
-  data.tar.gz: eb74d70ed1a8ddd968aa24db3ec1903d29d332d8
+  metadata.gz: 1018c5f3c99b9124aa39e379ad07d1edc8e1a41a
+  data.tar.gz: c0f9d694a94587e857dddb747cf5eebbcec6a8e0
 SHA512:
-  metadata.gz: 4144ba3401348e02bfda53f0eff38f7f018b3e8eef93a157bd727ab4bc499a1c645440263bbc405e07da213c553ea9f1bc697c40fcfcb0e79b72cf1bf6dd1a6d
-  data.tar.gz: c80f18c84bf32c1be09220253e438afb8ca249c63c3d68d3ba15bf0669ab71b1b79f6c926affaa3064194cee37be91f5c74e4c290ab82ac277388795c8f35621
+  metadata.gz: 559fbc728a655f88f10b979ea74985c72b2705a663fd3c0b42b04cb2cc92d07c4ab65e791bc44972cb5d192030e30184e2376f6b1301ec3c28d0d612cf443f19
+  data.tar.gz: e13c9a34e666e1a03f3f7474347ca5c4da39a55649a1b34dcc2d38f97d02b84e98e439dc74324a0487a385ae6e5e9eb29570129832800042b25561f9595033b8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 4.1.0 (not yet released)
+
+ * `aasm_human_event_name` is deprecated, use `aasm.human_event_name` instead
+
+## 4.0.1
+
+ * fire guards only once per transition (see [issue #184](https://github.com/aasm/aasm/issues/184) for details)
+
 ## 4.0.0
 
  * support `if` and `unless` guard syntax: (see [issue #179](https://github.com/aasm/aasm/issues/179) and [issue #181](https://github.com/aasm/aasm/issues/181)), thanks to [@bigtunacan](https://github.com/bigtunacan)

data/Gemfile

@@ -5,7 +5,7 @@ gem "coveralls",                        :platforms => :ruby
 gem 'rubysl',                           :platforms => :rbx
 gem "jruby-openssl",                    :platforms => :jruby
 gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rails", "3.2.18"
+gem "rails", "~>4.1"
 gem 'mongoid' if Gem::Version.create(RUBY_VERSION.dup) >= Gem::Version.create('1.9.3')
 gem 'sequel'
 

data/README.md

@@ -13,6 +13,10 @@ that no longer targets only ActiveRecord models. It currently provides adapters
 [Mongoid](http://mongoid.org/), but it can be used for any Ruby class, no matter what
 parent class it has (if any).
 
+## Upgrade from version 3 to 4
+
+Take a look at the [README_FROM_VERSION_3_TO_4](https://github.com/aasm/aasm/blob/master/README_FROM_VERSION_3_TO_4.md) for details how to switch from version 3.x to 4.0 of _AASM_.
+
 ## Usage
 
 Adding a state machine is as simple as including the AASM module and start defining
@@ -137,14 +141,12 @@ Here you can see a list of all possible callbacks, together with their order of
 ```ruby
 begin
   event           before
-  event           guards              # test run
-  transition      guards              # test run
+  event           guards
+  transition      guards
   old_state       before_exit
   old_state       exit
   new_state       before_enter
   new_state       enter
-    event         guards
-    transition    guards
     ...update state...
     transition    after
     event         success             # if persist successful

data/README_FROM_VERSION_3_TO_4.md

@@ -4,7 +4,7 @@
 
 ### Callback order has been changed
 
-The first callback to be run is `:before` of the event. A state's `:before_exit' callback
+The first callback to be run is `:before` of the event. A state's `:before_exit` callback
 is now run directly before its `:exit` callback. Event-based guards are now run before
 any of the transition guards are run. And finally, before running any state callbacks,
 all (event- and transition-based) guards are run to check whether the state callbacks

data/lib/aasm/aasm.rb

@@ -1,5 +1,8 @@
 module AASM
 
+  # provide a state machine for the including class
+  # make sure to load class methods as well
+  # initialize persistence for the state machine
   def self.included(base) #:nodoc:
     base.extend AASM::ClassMethods
 
@@ -26,9 +29,10 @@ module AASM
       @aasm
     end
 
-    # aasm.event(:event_name).human?
+    # deprecated, remove in version 4.1
     def aasm_human_event_name(event) # event_name?
-      AASM::Localizer.new.human_event_name(self, event)
+      warn '[DEPRECATION] AASM: aasm_human_event_name is deprecated, use aasm.human_event_name instead'
+      aasm.human_event_name(event)
     end
   end # ClassMethods
 
@@ -82,11 +86,11 @@ private
         *process_args(event, aasm.current_state, *args)
       )
 
-      if event.may_fire?(self, *args)
+      if may_fire_to = event.may_fire?(self, *args)
         old_state.fire_callbacks(:before_exit, self)
         old_state.fire_callbacks(:exit, self) # TODO: remove for AASM 4?
 
-        if new_state_name = event.fire(self, *args)
+        if new_state_name = event.fire(self, {:may_fire => may_fire_to}, *args)
           aasm_fired(event, old_state, new_state_name, options, *args, &block)
         else
           aasm_failed(event_name, old_state)

data/lib/aasm/base.rb

@@ -85,6 +85,11 @@ module AASM
       @state_machine.events.values
     end
 
+    # aasm.event(:event_name).human?
+    def human_event_name(event) # event_name?
+      AASM::Localizer.new.human_event_name(@klass, event)
+    end
+
     def states_for_select
       states.map { |state| state.for_select }
     end

data/lib/aasm/event.rb

@@ -19,11 +19,11 @@ module AASM
     # executes the transition guards to determine if a transition is even
     # an option given current conditions.
     def may_fire?(obj, to_state=nil, *args)
-      _fire(obj, true, to_state, *args) # true indicates test firing
+      _fire(obj, {:test_only => true}, to_state, *args) # true indicates test firing
     end
 
-    def fire(obj, to_state=nil, *args)
-      _fire(obj, false, to_state, *args) # false indicates this is not a test (fire!)
+    def fire(obj, options={}, to_state=nil, *args)
+      _fire(obj, options, to_state, *args) # false indicates this is not a test (fire!)
     end
 
     def transitions_from_state?(state)
@@ -86,8 +86,8 @@ module AASM
     end
 
     # Execute if test == false, otherwise return true/false depending on whether it would fire
-    def _fire(obj, test, to_state=nil, *args)
-      result = test ? false : nil
+    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.current_state }
         return result if transitions.size == 0
@@ -106,11 +106,11 @@ module AASM
 
       transitions.each do |transition|
         next if to_state and !Array(transition.to).include?(to_state)
-        if transition.allowed?(obj, *args)
-          if test
-            result = true
+        if Array(transition.to).include?(options[:may_fire]) || transition.allowed?(obj, *args)
+          result = to_state || Array(transition.to).first
+          if options[:test_only]
+            # result = true
           else
-            result = to_state || Array(transition.to).first
             transition.execute(obj, *args)
           end
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/spec/unit/callbacks_spec.rb

@@ -11,8 +11,8 @@ describe 'callbacks for the new DSL' do
     expect(callback).to receive(:transition_guard).once.ordered.and_return(true)
     expect(callback).to receive(:before_exit_open).once.ordered                   # these should be before the state changes
     expect(callback).to receive(:exit_open).once.ordered
-    expect(callback).to receive(:event_guard).once.ordered.and_return(true)
-    expect(callback).to receive(:transition_guard).once.ordered.and_return(true)
+    # expect(callback).to receive(:event_guard).once.ordered.and_return(true)
+    # expect(callback).to receive(:transition_guard).once.ordered.and_return(true)
     expect(callback).to receive(:transitioning).once.ordered
     expect(callback).to receive(:before_enter_closed).once.ordered
     expect(callback).to receive(:enter_closed).once.ordered

data/spec/unit/event_spec.rb

@@ -101,7 +101,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, {}, nil, 'arg1', 'arg2')).to eq(:closed)
   end
 
 end

data/spec/unit/localizer_spec.rb

@@ -67,13 +67,13 @@ describe AASM::Localizer, "new style" do
     end
   end
 
-  context 'aasm_human_event_name' do
+  context 'aasm.human_event_name' do
     it 'should return translated event name' do
-      expect(LocalizerTestModel.aasm_human_event_name(:close)).to eq("Let's close it!")
+      expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
     end
 
     it 'should return humanized event name' do
-      expect(LocalizerTestModel.aasm_human_event_name(:open)).to eq("Open")
+      expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
     end
   end
 end
@@ -102,13 +102,13 @@ describe AASM::Localizer, "deprecated style" do
     end
   end
 
-  context 'aasm_human_event_name' do
+  context 'aasm.human_event_name' do
     it 'should return translated event name' do
-      expect(LocalizerTestModel.aasm_human_event_name(:close)).to eq("Let's close it!")
+      expect(LocalizerTestModel.aasm.human_event_name(:close)).to eq("Let's close it!")
     end
 
     it 'should return humanized event name' do
-      expect(LocalizerTestModel.aasm_human_event_name(:open)).to eq("Open")
+      expect(LocalizerTestModel.aasm.human_event_name(:open)).to eq("Open")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake