state_manager 0.2.12 → 0.2.13

data/.travis.yml

@@ -1,5 +1,7 @@
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.0
 before_install:
   - gem install bundler --version '>= 1.2.2'
-script: "bundle exec rake test"
+script: "bundle exec rake test"

data/Gemfile

@@ -3,11 +3,11 @@ source "http://rubygems.org"
 gemspec
 
 group :development do
+  gem 'byebug'
   gem "bundler"
   gem 'delayed_job_active_record'
   gem 'activerecord'
   gem 'sqlite3'
   gem 'timecop'
   gem 'database_cleaner'
-  gem 'byebug'
 end

data/README.md

@@ -208,6 +208,10 @@ end
 
 In the above example, transitioning between 'submitted.awaiting_review' and 'submitted.reviewing' will *not* trigger the the enter/exit callbacks for the 'submitted' state, however it will be called for the two sub-states.
 
+## ActiveRecord
+
+StateManager works out of the box with ActiveRecord. `enter`, `entered`, `exit`, and `exited` callbacks match up to their equivalent ActiveRecord callbacks: `before_save` and `after_save`. In addition there are `enter_committed` and `exit_committed` ActiveRecord-specific callbacks that are triggered when a transtion has been committed to the underlying database. These hooks are useful for actions that are performed external to the database (e.g. enqueuing to an external task worker).
+
 ## Delayed Job Integration
 
 StateManager comes out of the box with support for [delayed_job](https://github.com/tobi/delayed_job). If delayed_job is available, events can be defined with a `:delay` property which indicates a delay after which the event should automatically be triggered:

data/lib/state_manager/adapters/active_record.rb

@@ -41,17 +41,12 @@ module StateManager
               before_validation do
                 validate_states!
               end
-              before_save do
-                state_managers.values.map(&:before_save)
-              end
-              
-              save_callback = options[:save_callback] && options[:save_callback].to_sym
-              if save_callback == :after_commit
-                after_commit(:on => :create) { state_managers.values.map(&:after_save) }
-                after_commit(:on => :update) { state_managers.values.map(&:after_save) }
-              else # defaults to after_save
-                after_save { state_managers.values.map(&:after_save) }
-              end
+
+              # Callback hooks
+              after_commit(:on => :create) { state_managers.values.map(&:after_commit) }
+              after_commit(:on => :update) { state_managers.values.map(&:after_commit) }
+              before_save { state_managers.values.map(&:before_save) }
+              after_save { state_managers.values.map(&:after_save) }
             end 
           end
         end
@@ -61,6 +56,7 @@ module StateManager
       module ManagerMethods
 
         attr_accessor :pending_transition
+        attr_accessor :uncommitted_transitions
 
         def self.included(base)
           base.class_eval do
@@ -91,8 +87,20 @@ module StateManager
         def after_save
           return unless pending_transition
           _run_after_callbacks(*pending_transition)
+          self.uncommitted_transitions ||= []
+          self.uncommitted_transitions << self.pending_transition
           self.pending_transition = nil
         end
+        
+        def after_commit
+          self.uncommitted_transitions.each{ |t| run_commit_callbacks(*t) }
+          self.uncommitted_transitions.clear
+        end
+
+        def run_commit_callbacks(from_state, to_state, current_event, enter_states, exit_states)
+          exit_states.each{ |s| s.exit_committed if s.respond_to? :exit_committed }
+          enter_states.each{ |s| s.enter_committed if s.respond_to? :enter_committed }
+        end
 
         def write_state(value)
           resource.send :write_attribute, self.class._state_property, value.path

data/lib/state_manager/version.rb

@@ -1,3 +1,3 @@
 module StateManager
-  VERSION = "0.2.12"
+  VERSION = "0.2.13"
 end

data/test/adapters/active_record_test.rb

@@ -8,6 +8,7 @@ class ActiveRecordTest < Minitest::Test
 
     state :unsubmitted do
       event :submit, :transitions_to => 'submitted.awaiting_review'
+      event :activate, :transitions_to => 'active'
     end
     state :submitted do
       state :awaiting_review do
@@ -25,11 +26,21 @@ class ActiveRecordTest < Minitest::Test
     state :rejected
     
     attr_accessor :unsubmitted_entered_count
+    attr_accessor :unsubmitted_enter_committed_count
+    attr_accessor :unsubmitted_exit_committed_count
+
     attr_accessor :active_entered_count
+    attr_accessor :active_enter_committed_count
+    attr_accessor :active_exit_committed_count
+
     def initialize(*args)
       super
       @unsubmitted_entered_count = 0
+      @unsubmitted_enter_committed_count = 0
+      @unsubmitted_exit_committed_count = 0
       @active_entered_count = 0
+      @active_enter_committed_count = 0
+      @active_exit_committed_count =0
     end
 
     def will_transition(*args)
@@ -45,6 +56,14 @@ class ActiveRecordTest < Minitest::Test
       def entered
         state_manager.unsubmitted_entered_count += 1
       end
+
+      def enter_committed
+        state_manager.unsubmitted_enter_committed_count += 1
+      end
+
+      def exit_committed
+        state_manager.unsubmitted_exit_committed_count += 1
+      end
       
     end
     
@@ -53,6 +72,14 @@ class ActiveRecordTest < Minitest::Test
       def entered
         state_manager.active_entered_count += 1
       end
+
+      def enter_committed
+        state_manager.active_enter_committed_count += 1
+      end
+
+      def exit_committed
+        state_manager.active_exit_committed_count += 1
+      end
       
     end
     
@@ -62,12 +89,6 @@ class ActiveRecordTest < Minitest::Test
     extend StateManager::Resource
     state_manager
   end
-  
-  class Post2 < ActiveRecord::Base
-    self.table_name = 'posts'
-    extend StateManager::Resource
-    state_manager(:state, PostStates, :save_callback => :after_commit)
-  end
 
   def exec(sql)
     ActiveRecord::Base.connection.execute sql
@@ -187,8 +208,8 @@ class ActiveRecordTest < Minitest::Test
     end
   end
   
-  def test_after_commit_callback
-    @resource = Post2.find(1)
+  def test_commit_callbacks
+    @resource = Post.find(1)
     assert_state 'unsubmitted'
     assert !@resource.state_manager.before_callbacks_called
     assert !@resource.state_manager.after_callbacks_called
@@ -196,31 +217,43 @@ class ActiveRecordTest < Minitest::Test
     @resource.transaction do
       @resource.save!
       assert @resource.state_manager.before_callbacks_called
-      assert !@resource.state_manager.after_callbacks_called
+      assert @resource.state_manager.after_callbacks_called
+      assert_equal @resource.state_manager.unsubmitted_enter_committed_count, 0
+      @resource.activate!
+      assert_equal @resource.state_manager.unsubmitted_exit_committed_count, 0
+      assert_equal @resource.state_manager.active_enter_committed_count, 0
     end
-    assert @resource.state_manager.after_callbacks_called
+    assert_equal 1, @resource.state_manager.unsubmitted_enter_committed_count
+    assert_equal 1, @resource.state_manager.unsubmitted_exit_committed_count
+    assert_equal 1, @resource.state_manager.active_enter_committed_count
+    @resource.title = 'blah'
+    @resource.save!
+    assert_equal 1, @resource.state_manager.unsubmitted_enter_committed_count
+    assert_equal 1, @resource.state_manager.unsubmitted_exit_committed_count
+    assert_equal 1, @resource.state_manager.active_enter_committed_count
   end
   
-  def test_after_commit_callback_on_create
-    Post2.transaction do
-      @resource = Post2.new
+  def test_commit_callbacks_on_create
+    Post.transaction do
+      @resource = Post.new
       assert !@resource.state_manager.after_callbacks_called
       @resource.save
-      assert !@resource.state_manager.after_callbacks_called
+      assert @resource.state_manager.after_callbacks_called
+      assert_equal 1, @resource.state_manager.unsubmitted_entered_count
+      assert_equal 0, @resource.state_manager.unsubmitted_enter_committed_count
     end
-    assert_equal @resource.state_manager.unsubmitted_entered_count, 1
-    assert @resource.state_manager.after_callbacks_called
+    assert_equal 1, @resource.state_manager.unsubmitted_enter_committed_count
   end
   
-  def test_after_commit_callback_on_different_initial_state
-    Post2.transaction do
-      @resource = Post2.new(:state => 'active')
+  def test_commit_callbacks_on_different_initial_state
+    Post.transaction do
+      @resource = Post.new(:state => 'active')
       assert !@resource.state_manager.after_callbacks_called
       @resource.save
-      assert !@resource.state_manager.after_callbacks_called
+      assert @resource.state_manager.after_callbacks_called
     end
     assert_equal @resource.state_manager.unsubmitted_entered_count, 0
     assert_equal @resource.state_manager.active_entered_count, 1
-    assert @resource.state_manager.after_callbacks_called
+    assert_equal @resource.state_manager.active_enter_committed_count, 1
   end
 end

data/test/helper.rb

@@ -8,6 +8,7 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'minitest/autorun'
+require 'byebug'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -15,7 +16,6 @@ require 'delayed_job_active_record'
 require 'state_manager'
 require 'timecop'
 require 'database_cleaner'
-require 'byebug'
 
 DatabaseCleaner.strategy = :truncation
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_manager
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport