aasm 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0591e36b1ec9ec8d001ad39aa0acb2a2ca1b6b1e
-  data.tar.gz: a2ea3e316659e38c6f3ac4c97ebfd9028191188a
+  metadata.gz: 8d198d23fad17dc052b4135e5ef02470edd8e146
+  data.tar.gz: 85019079c1b7cfb236cf529b833561ba35030d51
 SHA512:
-  metadata.gz: aa6226703caef5b98f8a113542fb881d05a061ef0a2cd7c634ad6660620c60974fe4dd16afecd2c1be9e7dc79323ab4bfae7ae735271b04fcef23d1182ec1ad7
-  data.tar.gz: 3d6182336e70ca8b07638545441f5cf75a93f1981f87d04ca3c7fad08cef0c3b14d7c4950f55efabbf9e1411c37be2cf4e9ba0a806b9ff45f219dccb4c357a21
+  metadata.gz: c1a3a8f5df97b012148fa50b79150d218f0dad130a4014e68502a2982b98ab3a6b79148832dac285321901366ab5ec976af11a5f431966ac528d60d5c62dcc5c
+  data.tar.gz: 9e09e2ec97235c8761fd34a4c884cb6d9579e9960acf02815f472e0068586b8c4d2ff50b6d08d71f6571f31d81aa9cf345b94784d7cde1a066b1ddf0f44c466b

data/CHANGELOG.md

@@ -2,7 +2,13 @@
 
 ## 4.1.0 (not yet released)
 
- * `aasm_human_event_name` is deprecated, use `aasm.human_event_name` instead
+ * `aasm_column` has been removed. Use `aasm.attribute_name` instead
+ * `aasm_human_event_name` has been removed. Use `aasm.human_event_name` instead
+
+## 4.0.3
+
+ * bugfix: fire guards only once per transition, part 2 (see [issue #187](https://github.com/aasm/aasm/issues/187) for details)
+ * `aasm_column` is deprecated. Use `aasm.attribute_name` instead
 
 ## 4.0.2
 
@@ -11,6 +17,7 @@
 ## 4.0.1
 
  * fire guards only once per transition (see [issue #184](https://github.com/aasm/aasm/issues/184) for details)
+ * `aasm_human_event_name` is deprecated, use `aasm.human_event_name` instead
 
 ## 4.0.0
 

data/lib/aasm/base.rb

@@ -34,6 +34,16 @@ module AASM
       end
     end
 
+    # This method is both a getter and a setter
+    def attribute_name(column_name=nil)
+      if column_name
+        @state_machine.config.column = column_name.to_sym
+      else
+        @state_machine.config.column ||= :aasm_state
+      end
+      @state_machine.config.column
+    end
+
     def initial_state(new_initial_state=nil)
       if new_initial_state
         @state_machine.initial_state = new_initial_state

data/lib/aasm/event.rb

@@ -106,7 +106,8 @@ module AASM
 
       transitions.each do |transition|
         next if to_state and !Array(transition.to).include?(to_state)
-        if Array(transition.to).include?(options[:may_fire]) || transition.allowed?(obj, *args)
+        if (options.key?(:may_fire) && Array(transition.to).include?(options[:may_fire])) ||
+           (!options.key?(:may_fire) && transition.allowed?(obj, *args))
           result = to_state || Array(transition.to).first
           if options[:test_only]
             # result = true

data/lib/aasm/localizer.rb

@@ -21,7 +21,7 @@ module AASM
 
     def item_for(klass, state, ancestor, options={})
       separator = options[:old_style] ? '.' : '/'
-      :"#{i18n_scope(klass)}.attributes.#{i18n_klass(ancestor)}.#{klass.aasm_column}#{separator}#{state}"
+      :"#{i18n_scope(klass)}.attributes.#{i18n_klass(ancestor)}.#{klass.aasm.attribute_name}#{separator}#{state}"
     end
 
     def translate_queue(checklist)

data/lib/aasm/persistence/active_record_persistence.rb

@@ -84,17 +84,17 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state(state)
-          old_value = read_attribute(self.class.aasm_column)
+          old_value = read_attribute(self.class.aasm.attribute_name)
           aasm_write_attribute state
 
           success = if aasm_skipping_validations
             value = aasm_raw_attribute_value state
-            self.class.where(self.class.primary_key => self.id).update_all(self.class.aasm_column => value) == 1
+            self.class.where(self.class.primary_key => self.id).update_all(self.class.aasm.attribute_name => value) == 1
           else
             self.save
           end
           unless success
-            write_attribute(self.class.aasm_column, old_value)
+            write_attribute(self.class.aasm.attribute_name, old_value)
             return false
           end
 
@@ -128,11 +128,11 @@ module AASM
         end
 
         def aasm_column_looks_like_enum
-          self.class.columns_hash[self.class.aasm_column.to_s].type == :integer
+          self.class.columns_hash[self.class.aasm.attribute_name.to_s].type == :integer
         end
 
         def aasm_guess_enum_method
-          self.class.aasm_column.to_s.pluralize.to_sym
+          self.class.aasm.attribute_name.to_s.pluralize.to_sym
         end
 
         def aasm_skipping_validations
@@ -140,7 +140,7 @@ module AASM
         end
 
         def aasm_write_attribute(state)
-          write_attribute self.class.aasm_column, aasm_raw_attribute_value(state)
+          write_attribute self.class.aasm.attribute_name, aasm_raw_attribute_value(state)
         end
 
         def aasm_raw_attribute_value(state)
@@ -167,7 +167,7 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          aasm.enter_initial_state if send(self.class.aasm_column).blank?
+          aasm.enter_initial_state if send(self.class.aasm.attribute_name).blank?
         end
 
         def aasm_fire_event(name, options, *args, &block)

data/lib/aasm/persistence/base.rb

@@ -6,7 +6,7 @@ module AASM
         base.extend ClassMethods
       end
 
-      # Returns the value of the aasm_column - called from <tt>aasm.current_state</tt>
+      # Returns the value of the aasm.attribute_name - called from <tt>aasm.current_state</tt>
       #
       # If it's a new record, and the aasm state column is blank it returns the initial state
       # (example provided here for ActiveRecord, but it's true for Mongoid as well):
@@ -33,7 +33,7 @@ module AASM
       #
       # This allows for nil aasm states - be sure to add validation to your model
       def aasm_read_state
-        state = send(self.class.aasm_column)
+        state = send(self.class.aasm.attribute_name)
         if new_record?
           state.blank? ? aasm.determine_state_name(self.class.aasm.initial_state) : state.to_sym
         else
@@ -42,41 +42,9 @@ module AASM
       end
 
       module ClassMethods
-        # Maps to the aasm_column in the database.  Defaults to "aasm_state".  You can write
-        # (example provided here for ActiveRecord, but it's true for Mongoid as well):
-        #
-        #   create_table :foos do |t|
-        #     t.string :name
-        #     t.string :aasm_state
-        #   end
-        #
-        #   class Foo < ActiveRecord::Base
-        #     include AASM
-        #   end
-        #
-        # OR:
-        #
-        #   create_table :foos do |t|
-        #     t.string :name
-        #     t.string :status
-        #   end
-        #
-        #   class Foo < ActiveRecord::Base
-        #     include AASM
-        #     aasm_column :status
-        #   end
-        #
-        # This method is both a getter and a setter
-        def aasm_column(column_name=nil)
-          if column_name
-            AASM::StateMachine[self].config.column = column_name.to_sym
-            # @aasm_column = column_name.to_sym
-          else
-            AASM::StateMachine[self].config.column ||= :aasm_state
-            # @aasm_column ||= :aasm_state
-          end
-          # @aasm_column
-          AASM::StateMachine[self].config.column
+        def aasm_column(attribute_name=nil)
+          warn "[DEPRECATION] aasm_column is deprecated. Use aasm.attribute_name instead"
+          aasm.attribute_name(attribute_name)
         end
       end # ClassMethods
 
@@ -90,7 +58,7 @@ module AASM
       if AASM::StateMachine[@klass].config.create_scopes && !@klass.respond_to?(name)
         if @klass.ancestors.map {|klass| klass.to_s}.include?("ActiveRecord::Base")
 
-          conditions = {"#{@klass.table_name}.#{@klass.aasm_column}" => name.to_s}
+          conditions = {"#{@klass.table_name}.#{@klass.aasm.attribute_name}" => name.to_s}
           if ActiveRecord::VERSION::MAJOR >= 3
             @klass.class_eval do
               scope name, lambda { where(conditions) }
@@ -101,7 +69,7 @@ module AASM
             end
           end
         elsif @klass.ancestors.map {|klass| klass.to_s}.include?("Mongoid::Document")
-          scope_options = lambda { @klass.send(:where, {@klass.aasm_column.to_sym => name.to_s}) }
+          scope_options = lambda { @klass.send(:where, {@klass.aasm.attribute_name.to_sym => name.to_s}) }
           @klass.send(:scope, name, scope_options)
         end
       end

data/lib/aasm/persistence/mongoid_persistence.rb

@@ -55,7 +55,7 @@ module AASM
         end
 
         def with_state_scope(state)
-          with_scope where(aasm_column.to_sym => state.to_s) do
+          with_scope where(aasm.attribute_name.to_sym => state.to_s) do
             yield if block_given?
           end
         end
@@ -75,11 +75,11 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state(state)
-          old_value = read_attribute(self.class.aasm_column)
-          write_attribute(self.class.aasm_column, state.to_s)
+          old_value = read_attribute(self.class.aasm.attribute_name)
+          write_attribute(self.class.aasm.attribute_name, state.to_s)
 
           unless self.save(:validate => false)
-            write_attribute(self.class.aasm_column, old_value)
+            write_attribute(self.class.aasm.attribute_name, old_value)
             return false
           end
 
@@ -99,7 +99,7 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state_without_persistence(state)
-          write_attribute(self.class.aasm_column, state.to_s)
+          write_attribute(self.class.aasm.attribute_name, state.to_s)
         end
 
       private
@@ -120,14 +120,14 @@ module AASM
         #   foo.aasm_state # => nil
         #
         def aasm_ensure_initial_state
-          send("#{self.class.aasm_column}=", aasm.enter_initial_state.to_s) if send(self.class.aasm_column).blank?
+          send("#{self.class.aasm.attribute_name}=", aasm.enter_initial_state.to_s) if send(self.class.aasm.attribute_name).blank?
         end
       end # InstanceMethods
 
       module NamedScopeMethods
         def aasm_state_with_named_scope name, options = {}
           aasm_state_without_named_scope name, options
-          self.named_scope name, :conditions => { "#{table_name}.#{self.aasm_column}" => name.to_s} unless self.respond_to?(name)
+          self.named_scope name, :conditions => { "#{table_name}.#{self.aasm.attribute_name}" => name.to_s} unless self.respond_to?(name)
         end
       end
     end

data/lib/aasm/persistence/sequel_persistence.rb

@@ -17,7 +17,7 @@ module AASM
           super
         end
 
-        # Returns the value of the aasm_column - called from <tt>aasm.current_state</tt>
+        # Returns the value of the aasm.attribute_name - called from <tt>aasm.current_state</tt>
         #
         # If it's a new record, and the aasm state column is blank it returns the initial state
         #
@@ -43,7 +43,7 @@ module AASM
         #
         # This allows for nil aasm states - be sure to add validation to your model
         def aasm_read_state
-          state = send(self.class.aasm_column)
+          state = send(self.class.aasm.attribute_name)
           if new? && state.to_s.strip.empty?
             aasm.determine_state_name(self.class.aasm.initial_state)
           elsif state.nil?
@@ -70,7 +70,7 @@ module AASM
         #
         def aasm_ensure_initial_state
           aasm.enter_initial_state if
-            send(self.class.aasm_column).to_s.strip.empty?
+            send(self.class.aasm.attribute_name).to_s.strip.empty?
         end
 
         # Writes <tt>state</tt> to the state column and persists it to the database
@@ -83,7 +83,7 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state state
-          aasm_column = self.class.aasm_column
+          aasm_column = self.class.aasm.attribute_name
           update_only({aasm_column => state.to_s}, aasm_column)
         end
 
@@ -100,7 +100,7 @@ module AASM
         #
         # NOTE: intended to be called from an event
         def aasm_write_state_without_persistence state
-          send("#{self.class.aasm_column}=", state.to_s)
+          send("#{self.class.aasm.attribute_name}=", state.to_s)
         end
       end
     end

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "4.0.2"
+  VERSION = "4.0.3"
 end

data/spec/models/callbacks/multiple_transitions_transition_guard.rb

@@ -0,0 +1,65 @@
+module Callbacks
+  class MultipleTransitionsTransitionGuard
+    include AASM
+
+    def initialize(options={})
+      @fail_event_guard = options[:fail_event_guard]
+      @fail_transition_guard = options[:fail_transition_guard]
+      @log = options[:log]
+    end
+
+    aasm do
+      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
+
+      state :failed
+
+      event :close, :before => :before, :after => :after, :guard => :event_guard do
+        transitions :to => :closed, :from => [:open], :guard => :transition_guard, :after => :transitioning
+        transitions :to => :failed, :from => [:open]
+      end
+
+      event :open, :before => :before, :after => :after do
+        transitions :to => :open, :from => :closed
+      end
+    end
+
+    def log(text)
+      puts text if @log
+    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 transitioning; log('transitioning'); end
+
+    def before; log('before'); end
+    def after; log('after'); end
+  end
+end

data/spec/unit/callbacks_spec.rb

@@ -49,27 +49,58 @@ describe 'callbacks for the new DSL' do
 
   context "if the transition guard fails" do
     it "does not run any state callback if guard is defined inline" do
-      callback = CallbackNewDsl.new
+      show_debug_log = false
+      callback = CallbackNewDsl.new(:log => show_debug_log, :fail_transition_guard => true)
       callback.aasm.current_state
 
-      expect(callback).to receive(:before).once.ordered
-      expect(callback).to receive(:event_guard).once.ordered.and_return(true)
-      expect(callback).to receive(:transition_guard).once.ordered.and_return(false)
-      expect(callback).to_not receive(:before_exit_open)
-      expect(callback).to_not receive(:exit_open)
-      expect(callback).to_not receive(:transitioning)
-      expect(callback).to_not receive(:before_enter_closed)
-      expect(callback).to_not receive(:enter_closed)
-      expect(callback).to_not receive(:aasm_write_state)
-      expect(callback).to_not receive(:after_exit_open)
-      expect(callback).to_not receive(:after_enter_closed)
-      expect(callback).to_not receive(:after)
+      unless show_debug_log
+        expect(callback).to receive(:before).once.ordered
+        expect(callback).to receive(:event_guard).once.ordered.and_return(true)
+        expect(callback).to receive(:transition_guard).once.ordered.and_return(false)
+        expect(callback).to_not receive(:before_exit_open)
+        expect(callback).to_not receive(:exit_open)
+        expect(callback).to_not receive(:transitioning)
+        expect(callback).to_not receive(:before_enter_closed)
+        expect(callback).to_not receive(:enter_closed)
+        expect(callback).to_not receive(:aasm_write_state)
+        expect(callback).to_not receive(:after_exit_open)
+        expect(callback).to_not receive(:after_enter_closed)
+        expect(callback).to_not receive(:after)
+      end
 
       expect {
         callback.close!
       }.to raise_error(AASM::InvalidTransition)
     end
 
+    it "does not run transition_guard twice for multiple permitted transitions" do
+      require 'models/callbacks/multiple_transitions_transition_guard'
+
+      show_debug_log = false
+      callback = Callbacks::MultipleTransitionsTransitionGuard.new(:log => show_debug_log, :fail_transition_guard => true)
+      callback.aasm.current_state
+
+      unless show_debug_log
+        expect(callback).to receive(:before).once.ordered
+        expect(callback).to receive(:event_guard).once.ordered.and_return(true)
+        expect(callback).to receive(:transition_guard).once.ordered.and_return(false)
+        expect(callback).to receive(:event_guard).once.ordered.and_return(true)
+        expect(callback).to receive(:before_exit_open).once.ordered
+        expect(callback).to receive(:exit_open).once.ordered
+        expect(callback).to receive(:aasm_write_state).once.ordered.and_return(true)  # this is when the state changes
+        expect(callback).to receive(:after_exit_open).once.ordered
+        expect(callback).to receive(:after).once.ordered
+
+        expect(callback).to_not receive(:transitioning)
+        expect(callback).to_not receive(:before_enter_closed)
+        expect(callback).to_not receive(:enter_closed)
+        expect(callback).to_not receive(:after_enter_closed)
+      end
+
+      callback.close!
+      expect(callback.aasm.current_state).to eql :failed
+    end
+
     it "does not run any state callback if guard is defined with block" do
       callback = GuardWithinBlock.new #(:log => true, :fail_transition_guard => true)
       callback.aasm.current_state

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -30,7 +30,7 @@ describe "instance methods" do
     let(:columns_hash) { Hash[column_name, column] }
 
     before :each do
-      gate.class.stub(:aasm_column).and_return(column_name.to_sym)
+      gate.class.aasm.stub(:attribute_name).and_return(column_name.to_sym)
       gate.class.stub(:columns_hash).and_return(columns_hash)
     end
 
@@ -55,7 +55,7 @@ describe "instance methods" do
     subject { lambda{ gate.send(:aasm_guess_enum_method) } }
 
     before :each do
-      gate.class.stub(:aasm_column).and_return(:value)
+      gate.class.aasm.stub(:attribute_name).and_return(:value)
     end
 
     it "pluralizes AASM column name" do
@@ -81,7 +81,7 @@ describe "instance methods" do
     context "when AASM enum setting is simply set to true" do
       before :each do
         AASM::StateMachine[Gate].config.stub(:enum).and_return(true)
-        Gate.stub(:aasm_column).and_return(:value)
+        Gate.aasm.stub(:attribute_name).and_return(:value)
         gate.stub(:aasm_guess_enum_method).and_return(:values)
       end
 
@@ -104,7 +104,7 @@ describe "instance methods" do
     context "when AASM enum setting is not enabled" do
       before :each do
         AASM::StateMachine[Gate].config.stub(:enum).and_return(nil)
-        Gate.stub(:aasm_column).and_return(:value)
+        Gate.aasm.stub(:attribute_name).and_return(:value)
       end
 
       context "when AASM column looks like enum" do
@@ -172,7 +172,7 @@ describe "instance methods" do
           gate.aasm_write_state state_sym
 
           expect(obj).to have_received(:update_all)
-            .with(Hash[gate.class.aasm_column, state_code])
+            .with(Hash[gate.class.aasm.attribute_name, state_code])
         end
       end
 
@@ -253,7 +253,7 @@ describe "instance methods" do
     expect(gate.aasm.current_state).to eq(:closed)
   end
 
-  it "should return the aasm column when not new and the aasm_column is not nil" do
+  it "should return the aasm column when not new and the aasm.attribute_name is not nil" do
     allow(gate).to receive(:new_record?).and_return(false)
     gate.aasm_state = "state"
     expect(gate.aasm.current_state).to eq(:state)
@@ -293,8 +293,8 @@ describe 'subclasses' do
   end
 
   it "should have the same column as its parent even for the new dsl" do
-    expect(SimpleNewDsl.aasm_column).to eq(:status)
-    expect(DerivateNewDsl.aasm_column).to eq(:status)
+    expect(SimpleNewDsl.aasm.attribute_name).to eq(:status)
+    expect(DerivateNewDsl.aasm.attribute_name).to eq(:status)
   end
 end
 

data/spec/unit/persistence/sequel_persistence_spec.rb

@@ -81,8 +81,8 @@ describe 'sequel' do
       end
 
       it "should have the same column as its parent even for the new dsl" do
-        expect(@model.aasm_column).to eq(:status)
-        expect(Class.new(@model).aasm_column).to eq(:status)
+        expect(@model.aasm.attribute_name).to eq(:status)
+        expect(Class.new(@model).aasm.attribute_name).to eq(:status)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Scott Barron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -147,6 +147,7 @@ files:
 - spec/models/auth_machine.rb
 - spec/models/bar.rb
 - spec/models/callback_new_dsl.rb
+- spec/models/callbacks/multiple_transitions_transition_guard.rb
 - spec/models/conversation.rb
 - spec/models/double_definer.rb
 - spec/models/father.rb
@@ -222,6 +223,7 @@ test_files:
 - spec/models/auth_machine.rb
 - spec/models/bar.rb
 - spec/models/callback_new_dsl.rb
+- spec/models/callbacks/multiple_transitions_transition_guard.rb
 - spec/models/conversation.rb
 - spec/models/double_definer.rb
 - spec/models/father.rb