aasm 2.3.0 → 2.3.1

data/.gitignore

@@ -8,3 +8,4 @@ rdoc
 Gemfile.lock
 spec/debug.log
 spec/*.db
+TODO

data/README.md

@@ -117,6 +117,23 @@ This example uses a few of the more complex features available.
   end
 ```
 
+## Callbacks around events
+```ruby
+  class Relationship
+    include AASM
+
+    aasm_state :dating
+    aasm_state :married
+
+    aasm_event :get_married,
+      :before => :make_vows,
+      :after => :eat_wedding_cake do
+      transitions :to => :married, :from => [:dating]
+    end
+  end
+```
+
+
 # Other Stuff #
 
 Author::  Scott Barron <scott at elitists dot net>

data/aasm.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'shoulda'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'minitest'
+  s.add_development_dependency 'ruby-debug-completion'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/aasm.rb

@@ -7,4 +7,4 @@ require File.join(File.dirname(__FILE__), 'aasm', 'supporting_classes')
 require File.join(File.dirname(__FILE__), 'aasm', 'state_machine')
 require File.join(File.dirname(__FILE__), 'aasm', 'persistence')
 require File.join(File.dirname(__FILE__), 'aasm', 'aasm')
-require File.join(File.dirname(__FILE__), 'aasm', 'i18n')
+require File.join(File.dirname(__FILE__), 'aasm', 'localizer')

data/lib/aasm/aasm.rb

@@ -50,6 +50,13 @@ module AASM
         sm.events[name] = AASM::SupportingClasses::Event.new(name, options, &block)
       end
 
+      # an addition over standard aasm so that, before firing an event, you can ask
+      # may_event? and get back a boolean that tells you whether the guard method
+      # on the transition will let this happen.
+      define_method("may_#{name.to_s}?") do |*args|
+        aasm_test_event(name, *args)
+      end
+      
       define_method("#{name.to_s}!") do |*args|
         aasm_fire_event(name, true, *args)
       end
@@ -72,7 +79,7 @@ module AASM
     end
 
     def human_event_name(event)
-      AASM::I18n.new.human_event_name(self, event)
+      AASM::Localizer.new.human_event_name(self, event)
     end
   end
   
@@ -104,13 +111,19 @@ module AASM
     aasm_events_for_state(aasm_current_state)
   end
 
+  # filters the results of events_for_current_state so that only those that
+  # are really currently possible (given transition guards) are shown.
+  def aasm_permissible_events_for_current_state
+    aasm_events_for_current_state.select{ |e| self.send(("may_" + e.to_s + "?").to_sym) }
+  end
+  
   def aasm_events_for_state(state)
     events = self.class.aasm_events.values.select {|event| event.transitions_from_state?(state) }
     events.map {|event| event.name}
   end
 
   def human_state
-    AASM::I18n.new.human_state(self)
+    AASM::Localizer.new.human_state(self)
   end
 
   private
@@ -149,6 +162,11 @@ module AASM
     obj
   end
 
+  def aasm_test_event(name, *args)
+    event = self.class.aasm_events[name]
+    event.may_fire?(self, *args)
+  end
+  
   def aasm_fire_event(name, persist, *args)
     event = self.class.aasm_events[name]
     begin

data/lib/aasm/event.rb

@@ -7,6 +7,24 @@ class AASM::SupportingClasses::Event
     update(options, &block)
   end
 
+  # a neutered version of fire - it doesn't actually fir 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)
+    transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
+    return false if transitions.size == 0
+    
+    result = false
+    transitions.each do |transition|
+      next if to_state and !Array(transition.to).include?(to_state)
+      if transition.perform(obj)
+        result = true
+        break
+      end
+    end
+    result
+  end
+  
   def fire(obj, to_state=nil, *args)
     transitions = @transitions.select { |t| t.from == obj.aasm_current_state }
     raise AASM::InvalidTransition, "Event '#{name}' cannot transition from '#{obj.aasm_current_state}'" if transitions.size == 0

data/lib/aasm/{i18n.rb → localizer.rb}

@@ -1,4 +1,4 @@
-class AASM::I18n
+class AASM::Localizer
   def human_event_name(klass, event)
     defaults = ancestors_list(klass).map do |ancestor|
       :"#{i18n_scope(klass)}.events.#{i18n_klass(ancestor)}.#{event}"

data/lib/aasm/state_transition.rb

@@ -36,10 +36,10 @@ class AASM::SupportingClasses::StateTransition
 
   def _execute(obj, on_transition, *args)
     case on_transition
-      when Symbol, String
-        obj.send(on_transition, *args)
-      when Proc
-        on_transition.call(obj, *args)
+    when Proc
+      on_transition.arity == 0 ? on_transition.call : on_transition.call(obj, *args)
+    when Symbol, String
+      obj.send(:method, on_transition.to_sym).arity == 0 ? obj.send(on_transition) : obj.send(on_transition, *args)
     end
   end
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/spec/en.yml

@@ -1,10 +1,10 @@
 en:
   activerecord:
     events:
-      i18n_test_model:
+      localizer_test_model:
         close: "Let's close it!"
 
     attributes:
-      i18n_test_model:
+      localizer_test_model:
         aasm_state:
           open: "It's opened now!"

data/spec/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define(:version => 0) do
 
-  %w{gates readers writers transients simples thieves i18n_test_models}.each do |table_name|
+  %w{gates readers writers transients simples thieves localizer_test_models}.each do |table_name|
     create_table table_name, :force => true
   end
 

data/spec/spec_helper.rb

@@ -5,6 +5,9 @@ require 'aasm'
 require 'rspec'
 require 'rspec/autorun'
 
+# require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
+# require 'ruby-debug/completion'
+
 def load_schema
   config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
   ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")

data/spec/unit/{i18n_spec.rb → localizer_spec.rb}

@@ -5,7 +5,7 @@ require 'i18n'
 
 ActiveRecord::Base.logger = Logger.new(STDERR)
 
-class I18nTestModel < ActiveRecord::Base
+class LocalizerTestModel < ActiveRecord::Base
   include AASM
 
   attr_accessor :aasm_state
@@ -18,7 +18,7 @@ class I18nTestModel < ActiveRecord::Base
   aasm_event :open
 end
 
-describe AASM::I18n do
+describe AASM::Localizer do
   before(:all) do
     I18n.load_path << 'spec/en.yml'
     I18n.default_locale = :en
@@ -26,8 +26,8 @@ describe AASM::I18n do
 
   after(:all) { I18n.load_path.clear }
 
-  let (:foo_opened) { I18nTestModel.new }
-  let (:foo_closed) { I18nTestModel.new.tap { |x| x.aasm_state = :closed  } }
+  let (:foo_opened) { LocalizerTestModel.new }
+  let (:foo_closed) { LocalizerTestModel.new.tap { |x| x.aasm_state = :closed  } }
 
   context '.human_state' do
     it 'should return translated state value' do
@@ -41,11 +41,11 @@ describe AASM::I18n do
 
   context '.human_event_name' do
     it 'should return translated event name' do
-      I18nTestModel.human_event_name(:close).should == "Let's close it!"
+      LocalizerTestModel.human_event_name(:close).should == "Let's close it!"
     end
 
     it 'should return humanized event name' do
-      I18nTestModel.human_event_name(:open).should == "Open"
+      LocalizerTestModel.human_event_name(:open).should == "Open"
     end
   end
 end

data/spec/unit/state_transition_spec.rb

@@ -82,3 +82,82 @@ describe AASM::SupportingClasses::StateTransition, '- when performing guard chec
     st.perform(obj)
   end
 end
+
+describe AASM::SupportingClasses::StateTransition, '- when executing the transition with a Proc' do
+  it 'should call a Proc on the object with args' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => Proc.new {|o| o.test}}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    opts[:on_transition].should_receive(:call).with(any_args)
+
+    st.execute(obj, args)
+  end
+
+  it 'should call a Proc on the object without args' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => Proc.new {||}}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    opts[:on_transition].should_receive(:call).with(no_args)
+
+    st.execute(obj, args)
+  end
+end
+
+describe AASM::SupportingClasses::StateTransition, '- when executing the transition with an :on_transtion method call' do
+  it 'should accept a String for the method name' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => 'test'}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    obj.should_receive(:test)
+
+    st.execute(obj, args)    
+  end
+  
+  it 'should accept a Symbol for the method name' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    obj.should_receive(:test)
+
+    st.execute(obj, args)    
+  end
+  
+  it 'should pass args if the target method accepts them' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    obj.class.class_eval do
+      define_method(:test) {|*args| 'success'}
+    end
+
+    return_value = st.execute(obj, args)
+
+    return_value.should == 'success'
+  end
+  
+  it 'should NOT pass args if the target method does NOT accept them' do
+    opts = {:from => 'foo', :to => 'bar', :on_transition => :test}
+    st = AASM::SupportingClasses::StateTransition.new(opts)
+    args = {:arg1 => '1', :arg2 => '2'}
+    obj = mock('object')
+
+    obj.class.class_eval do
+      define_method(:test) {|*args| 'success'}
+    end
+
+    return_value = st.execute(obj, args)
+
+    return_value.should == 'success'
+  end
+    
+end

data/test/functional/auth_machine_test.rb

@@ -29,6 +29,11 @@ class AuthMachine
     transitions :from => [:passive, :pending, :active, :suspended], :to => :deleted
   end
 
+  # a dummy event that can never happen
+  aasm_event :unpassify do
+    transitions :from => :passive, :to => :active, :guard => Proc.new {|u| false }
+  end
+  
   aasm_event :unsuspend do
     transitions :from => :suspended, :to => :active,  :guard => Proc.new {|u| u.has_activated? }
     transitions :from => :suspended, :to => :pending, :guard => Proc.new {|u| u.has_activation_code? }
@@ -89,6 +94,29 @@ class AuthMachineTest < Test::Unit::TestCase
     end
 
     context 'when being unsuspended' do
+      
+      should 'be able to be unsuspended' do
+        @auth = AuthMachine.new
+        @auth.activate!
+        @auth.suspend!
+        assert @auth.may_unsuspend?
+      end
+      
+      should 'not be able to be unsuspended into active' do
+        @auth = AuthMachine.new
+        @auth.suspend!
+        assert_equal false, @auth.may_unsuspend?(:active)
+      end
+      
+      should 'not be able to be unpassified' do
+        @auth = AuthMachine.new
+        @auth.activate!
+        @auth.suspend!
+        @auth.unsuspend!
+        
+        assert_equal false, @auth.may_unpassify?
+      end
+      
       should 'be active if previously activated' do
         @auth = AuthMachine.new
         @auth.activate!

data/test/test_helper.rb

@@ -33,11 +33,11 @@ class Test::Unit::TestCase
 end
 
 begin
-  require 'ruby-debug'
-  Debugger.start
+  require 'ruby-debug'; Debugger.settings[:autoeval] = true; debugger; rubys_debugger = 'annoying'
+  require 'ruby-debug/completion'
 rescue LoadError
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'aasm'
+require 'aasm'

data/test/unit/state_machine_test.rb

@@ -7,22 +7,22 @@ class StateMachineTest < Test::Unit::TestCase
     should "be created without memory leak" do
       assert_equal 1, AASM::StateMachine.instance_variable_get("@machines").size  # AuthMachine      
       assert_number_of_objects AASM::SupportingClasses::State, 5                  # AuthMachine
-      assert_number_of_objects AASM::SupportingClasses::Event, 10                 # AuthMachine
-      assert_number_of_objects AASM::SupportingClasses::StateTransition, 18       # AuthMachine
+      assert_number_of_objects AASM::SupportingClasses::Event, 11                 # AuthMachine
+      assert_number_of_objects AASM::SupportingClasses::StateTransition, 19       # AuthMachine
       
       load File.expand_path(File.dirname(__FILE__) + '/../models/process.rb')
       assert_equal 2, AASM::StateMachine.instance_variable_get("@machines").size  # AuthMachine + Process
       assert_number_of_objects Models::Process, 0
       assert_number_of_objects AASM::SupportingClasses::State, 8                  # AuthMachine + Process
-      assert_number_of_objects AASM::SupportingClasses::Event, 12                 # AuthMachine + Process
-      assert_number_of_objects AASM::SupportingClasses::StateTransition, 20       # AuthMachine + Process
+      assert_number_of_objects AASM::SupportingClasses::Event, 13                 # AuthMachine + Process
+      assert_number_of_objects AASM::SupportingClasses::StateTransition, 21       # AuthMachine + Process
       
       Models.send(:remove_const, "Process") if Models.const_defined?("Process")
       load File.expand_path(File.dirname(__FILE__) + '/../models/process.rb')
       assert_equal 2, AASM::StateMachine.instance_variable_get("@machines").size  # AuthMachine + Process
       assert_number_of_objects AASM::SupportingClasses::State, 8                  # AuthMachine + Process
-      assert_number_of_objects AASM::SupportingClasses::Event, 12                 # AuthMachine + Process
-      assert_number_of_objects AASM::SupportingClasses::StateTransition, 20       # AuthMachine + Process
+      assert_number_of_objects AASM::SupportingClasses::Event, 13                 # AuthMachine + Process
+      assert_number_of_objects AASM::SupportingClasses::StateTransition, 21       # AuthMachine + Process
     end
     
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: aasm
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 2
   - 3
-  - 0
-  version: 2.3.0
+  - 1
+  version: 2.3.1
 platform: ruby
 authors: 
 - Scott Barron
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-02 00:00:00 +02:00
+date: 2011-09-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -134,6 +134,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug-completion
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
 description: AASM is a continuation of the acts as state machine rails plugin, built for plain Ruby objects.
 email: scott@elitists.net, ttilley@gmail.com
 executables: []
@@ -153,7 +167,7 @@ files:
 - lib/aasm.rb
 - lib/aasm/aasm.rb
 - lib/aasm/event.rb
-- lib/aasm/i18n.rb
+- lib/aasm/localizer.rb
 - lib/aasm/persistence.rb
 - lib/aasm/persistence/active_record_persistence.rb
 - lib/aasm/state.rb
@@ -171,7 +185,7 @@ files:
 - spec/unit/active_record_persistence_spec.rb
 - spec/unit/before_after_callbacks_spec.rb
 - spec/unit/event_spec.rb
-- spec/unit/i18n_spec.rb
+- spec/unit/localizer_spec.rb
 - spec/unit/state_spec.rb
 - spec/unit/state_transition_spec.rb
 - test/functional/auth_machine_test.rb
@@ -227,7 +241,7 @@ test_files:
 - spec/unit/active_record_persistence_spec.rb
 - spec/unit/before_after_callbacks_spec.rb
 - spec/unit/event_spec.rb
-- spec/unit/i18n_spec.rb
+- spec/unit/localizer_spec.rb
 - spec/unit/state_spec.rb
 - spec/unit/state_transition_spec.rb
 - test/functional/auth_machine_test.rb