aasm 3.0.17 → 3.0.18

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.0.18
+
+ * fixing issue #66
+
 ## 3.0.17
 
  * supporting instance level inspection for states (including permissible state, see issue #54)

data/lib/aasm.rb

@@ -1,17 +1,18 @@
 require 'ostruct'
 
-# TODO shorten this [thorsten, 2011-12-20]
-require File.join(File.dirname(__FILE__), 'aasm', 'version')
-require File.join(File.dirname(__FILE__), 'aasm', 'errors')
-require File.join(File.dirname(__FILE__), 'aasm', 'base')
-require File.join(File.dirname(__FILE__), 'aasm', 'instance_base')
-require File.join(File.dirname(__FILE__), 'aasm', 'transition')
-require File.join(File.dirname(__FILE__), 'aasm', 'event')
-require File.join(File.dirname(__FILE__), 'aasm', 'state')
-require File.join(File.dirname(__FILE__), 'aasm', 'localizer')
-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')
+%w(
+    version
+    errors
+    base
+    instance_base
+    transition
+    event
+    state
+    localizer
+    state_machine
+    persistence
+    aasm
+  ).each { |file| require File.join(File.dirname(__FILE__), 'aasm', file) }
 
 # load the deprecated methods and modules
 Dir[File.join(File.dirname(__FILE__), 'aasm', 'deprecated', '*.rb')].sort.each { |f| require File.expand_path(f) }

data/lib/aasm/aasm.rb

@@ -83,7 +83,10 @@ module AASM
 
   # may be overwritten by persistence mixins
   def aasm_read_state
-    aasm.enter_initial_state
+    # all the following lines behave like @current_state ||= aasm.enter_initial_state
+    current = aasm.instance_variable_get("@current_state")
+    return current if current
+    aasm.instance_variable_set("@current_state", aasm.enter_initial_state)
   end
 
   # may be overwritten by persistence mixins
@@ -134,61 +137,67 @@ module AASM
 
 private
 
-  def aasm_fire_event(name, options, *args)
-    persist = options[:persist]
-
-    event = self.class.aasm_events[name]
+  def aasm_fire_event(event_name, options, *args)
+    event = self.class.aasm_events[event_name]
     begin
       old_state = aasm.state_object_for_name(aasm.current_state)
-
-
       old_state.fire_callbacks(:exit, self)
 
       # new event before callback
       event.fire_callbacks(:before, self)
 
       if new_state_name = event.fire(self, *args)
-        new_state = aasm.state_object_for_name(new_state_name)
+        fired(event, old_state, new_state_name, options)
+      else
+        failed(event_name, old_state)
+      end
+    rescue StandardError => e
+      event.fire_callbacks(:error, self, e) || raise(e)
+    end
+  end
+
+  def fired(event, old_state, new_state_name, options)
+    persist = options[:persist]
 
-        # new before_ callbacks
-        old_state.fire_callbacks(:before_exit, self)
-        new_state.fire_callbacks(:before_enter, self)
+    new_state = aasm.state_object_for_name(new_state_name)
 
-        new_state.fire_callbacks(:enter, self)
+    # new before_ callbacks
+    old_state.fire_callbacks(:before_exit, self)
+    new_state.fire_callbacks(:before_enter, self)
 
-        persist_successful = true
-        if persist
-          persist_successful = aasm.set_current_state_with_persistence(new_state_name)
-          event.fire_callbacks(:success, self) if persist_successful
-        else
-          aasm.current_state = new_state_name
-        end
+    new_state.fire_callbacks(:enter, self)
 
-        if persist_successful
-          old_state.fire_callbacks(:after_exit, self)
-          new_state.fire_callbacks(:after_enter, self)
-          event.fire_callbacks(:after, self)
+    persist_successful = true
+    if persist
+      persist_successful = aasm.set_current_state_with_persistence(new_state_name)
+      event.fire_callbacks(:success, self) if persist_successful
+    else
+      aasm.current_state = new_state_name
+    end
 
-          self.aasm_event_fired(name, old_state.name, aasm.current_state) if self.respond_to?(:aasm_event_fired)
-        else
-          self.aasm_event_failed(name, old_state.name) if self.respond_to?(:aasm_event_failed)
-        end
+    if persist_successful
+      old_state.fire_callbacks(:after_exit, self)
+      new_state.fire_callbacks(:after_enter, self)
+      event.fire_callbacks(:after, self)
 
-        persist_successful
+      self.aasm_event_fired(event.name, old_state.name, aasm.current_state) if self.respond_to?(:aasm_event_fired)
+    else
+      self.aasm_event_failed(event.name, old_state.name) if self.respond_to?(:aasm_event_failed)
+    end
 
-      else
-        if self.respond_to?(:aasm_event_failed)
-          self.aasm_event_failed(name, old_state.name)
-        end
-
-        if AASM::StateMachine[self.class].config.whiny_transitions
-          raise AASM::InvalidTransition, "Event '#{event.name}' cannot transition from '#{aasm.current_state}'"
-        else
-          false
-        end
-      end
-    rescue StandardError => e
-      event.fire_callbacks(:error, self, e) || raise(e)
+    persist_successful
+  end
+
+  def failed(event_name, old_state)
+    if self.respond_to?(:aasm_event_failed)
+      self.aasm_event_failed(event_name, old_state.name)
+    end
+
+    if AASM::StateMachine[self.class].config.whiny_transitions
+      raise AASM::InvalidTransition, "Event '#{event_name}' cannot transition from '#{aasm.current_state}'"
+    else
+      false
     end
   end
+
 end

data/lib/aasm/base.rb

@@ -30,7 +30,7 @@ module AASM
       @state_machine.initial_state = name if options[:initial] || !@state_machine.initial_state
 
       @clazz.send(:define_method, "#{name.to_s}?") do
-        aasm_current_state == name
+        aasm.current_state == name
       end
 
       unless @clazz.const_defined?("STATE_#{name.to_s.upcase}")

data/lib/aasm/instance_base.rb

@@ -6,7 +6,7 @@ module AASM
     end
 
     def current_state
-      @current_state ||= @instance.aasm_read_state
+      @instance.aasm_read_state
     end
 
     def current_state=(state)

data/lib/aasm/persistence/base.rb

@@ -33,10 +33,11 @@ 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)
         if new_record?
-          send(self.class.aasm_column).blank? ? aasm.determine_state_name(self.class.aasm_initial_state) : send(self.class.aasm_column).to_sym
+          state.blank? ? aasm.determine_state_name(self.class.aasm_initial_state) : state.to_sym
         else
-          send(self.class.aasm_column).nil? ? nil : send(self.class.aasm_column).to_sym
+          state.nil? ? nil : state.to_sym
         end
       end
 

data/lib/aasm/version.rb

@@ -1,3 +1,3 @@
 module AASM
-  VERSION = "3.0.17"
+  VERSION = "3.0.18"
 end

data/spec/models/father.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+
+class Father < ActiveRecord::Base
+  include AASM
+
+  aasm do
+    state :missing_details, :initial => true
+    state :pending_details_confirmation
+
+    event :add_details do
+      transitions :from => :missing_details, :to => :pending_details_confirmation
+    end
+  end
+
+  def update_state
+     if may_add_details?
+       add_details!
+     end
+  end
+
+end

data/spec/models/son.rb

@@ -0,0 +1,3 @@
+class Son < Father
+  include AASM
+end

data/spec/schema.rb

@@ -27,4 +27,9 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string "status"
   end
 
+  create_table "fathers", :force => true do |t|
+    t.string "aasm_state"
+    t.string "type"
+  end
+
 end

data/spec/unit/persistence/active_record_persistence_spec.rb

@@ -122,6 +122,13 @@ end
 
 describe 'transitions with persistence' do
 
+  it "should work for valid models" do
+    valid_object = Validator.create(:name => 'name')
+    valid_object.should be_sleeping
+    valid_object.status = :running
+    valid_object.should be_running
+  end
+
   it 'should not store states for invalid models' do
     validator = Validator.create(:name => 'name')
     validator.should be_valid

data/spec/unit/subclassing_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe 'subclassing' do
+  let(:son) {Son.new}
+
   it 'should have the parent states' do
     Foo.aasm_states.each do |state|
       FooTwo.aasm_states.should include(state)
@@ -15,5 +17,15 @@ describe 'subclassing' do
   it "should have the same events as its parent" do
     Baz.aasm_events.should == Bar.aasm_events
   end
+
+  it 'should know how to respond to `may_add_details?`' do
+    son.may_add_details?.should be_true
+  end
+
+  it 'should not break if I call Son#update_state' do
+    son.update_state
+    son.aasm_current_state.should == :pending_details_confirmation
+  end
+  
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aasm
 version: !ruby/object:Gem::Version
-  version: 3.0.17
+  version: 3.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315275195540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,15 +24,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315275195540
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315275193680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -40,15 +35,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315275193680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315275191760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,15 +46,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315275191760
 - !ruby/object:Gem::Dependency
   name: sdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315275191120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -72,15 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315275191120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267341460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,15 +68,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
+  version_requirements: *70315267341460
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267340520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -104,15 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267340520
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267339020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,15 +90,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267339020
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267338380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -136,15 +101,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267338380
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267336860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -152,15 +112,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267336860
 - !ruby/object:Gem::Dependency
   name: ruby-debug-completion
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267334180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -168,15 +123,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267334180
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70315267318500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -184,12 +134,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70315267318500
 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, aasm@mt7.de
@@ -234,6 +179,7 @@ files:
 - spec/models/callback_new_dsl.rb
 - spec/models/callback_old_dsl.rb
 - spec/models/conversation.rb
+- spec/models/father.rb
 - spec/models/foo.rb
 - spec/models/invalid_persistor.rb
 - spec/models/mongoid/simple_mongoid.rb
@@ -243,6 +189,7 @@ files:
 - spec/models/persistence.rb
 - spec/models/process_with_new_dsl.rb
 - spec/models/silencer.rb
+- spec/models/son.rb
 - spec/models/sub_classing.rb
 - spec/models/this_name_better_not_be_in_use.rb
 - spec/models/transactor.rb
@@ -286,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: State machine mixin for Ruby objects
@@ -301,6 +248,7 @@ test_files:
 - spec/models/callback_new_dsl.rb
 - spec/models/callback_old_dsl.rb
 - spec/models/conversation.rb
+- spec/models/father.rb
 - spec/models/foo.rb
 - spec/models/invalid_persistor.rb
 - spec/models/mongoid/simple_mongoid.rb
@@ -310,6 +258,7 @@ test_files:
 - spec/models/persistence.rb
 - spec/models/process_with_new_dsl.rb
 - spec/models/silencer.rb
+- spec/models/son.rb
 - spec/models/sub_classing.rb
 - spec/models/this_name_better_not_be_in_use.rb
 - spec/models/transactor.rb