statemachine 2.2.0 → 2.3.0

data/CHANGES

@@ -1,5 +1,11 @@
 = Statemachine Changelog
 
+== Version 2.3.0
+
+* Introduce on_state_change for building persistent states from @godfat (https://github.com/slagyr/statemachine/pull/13)
+* Update rake tasks according to it's deprecation messages from @godfat (https://github.com/slagyr/statemachine/pull/14)
+* Base Exceptions on StandardError from @Asmod4n (https://github.com/slagyr/statemachine/pull/15)
+
 == Version 2.2.0
 
 * applied dotfile improvements from @wsobel (https://github.com/slagyr/statemachine/pull/12)

data/README.rdoc

@@ -17,11 +17,11 @@ Some documentation is available here in this RDOC documentation.
 You may also find useful documentation on the Statemachine website: http://slagyr.github.com/statemachine
 
 A detailed tutorial and overview of Finite State Machines and this library can be found
-at http://blog.8thlight.com/articles/2006/11/17/understanding-statemachines-part-1-states-and-transitions.
+at http://blog.8thlight.com/micah-martin/2006/11/17/understanding-statemachines-part-1-states-and-transitions.html
 	
 == License
 
-Copyright (C) 2006-2010  Micah Martin
+Copyright (C) 2006-2014  Micah Martin
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public

data/Rakefile

@@ -1,8 +1,8 @@
 $:.unshift('lib')
 require 'rubygems'
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 require 'rake/clean'
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 require 'statemachine'
 require "bundler/gem_tasks"
@@ -85,4 +85,4 @@ end
 
 task :verify_password do
   raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
-end
+end

data/lib/statemachine/builder.rb

@@ -276,6 +276,13 @@ module Statemachine
       require 'statemachine/stub_context'
       context StubContext.new(options)
     end
+
+    # This callback would be called whenever the statemachine is changing the state.
+    # This is useful whenever we want to make the state persistent and store into
+    # some database.
+    def on_state_change(action=nil, &block)
+      @statemachine.state_change_action = action || block
+    end
   end
   
 end

data/lib/statemachine/statemachine.rb

@@ -1,9 +1,9 @@
 module Statemachine
 
-  class StatemachineException < Exception
+  class StatemachineException < StandardError
   end
 
-  class TransitionMissingException < Exception
+  class TransitionMissingException < StandardError
   end
 
   # Used at runtime to execute the behavior of the statemachine.
@@ -38,6 +38,11 @@ module Statemachine
     # so that they can be matched to the correct statemachine.
     attr_accessor :name
 
+    # This callback would be called whenever the statemachine is changing the state.
+    # This is useful whenever we want to make the state persistent and store into
+    # some database.
+    attr_accessor :state_change_action
+
     attr_reader :root #:nodoc:
 
     # Should not be called directly.  Instances of Statemachine::Statemachine are created
@@ -55,9 +60,9 @@ module Statemachine
 
     # Resets the statemachine back to its starting state.
     def reset
-      @state = get_state(@root.startstate_id)
+      self.state = get_state(@root.startstate_id)
       while @state and not @state.concrete?
-        @state = get_state(@state.startstate_id)
+        self.state = get_state(@state.startstate_id)
       end
       raise StatemachineException.new("The state machine doesn't know where to start. Try setting the startstate.") if @state == nil
       @state.enter
@@ -80,6 +85,8 @@ module Statemachine
       elsif value and @states[value.to_sym]
         @state = @states[value.to_sym]
       end
+
+      invoke_action(state_change_action, [@state], "state change action to #{@state}") if state_change_action
     end
 
     # The key method to exercise the statemachine. Any extra arguments supplied will be passed into

data/lib/statemachine/version.rb

@@ -2,7 +2,7 @@ module Statemachine
   module VERSION #:nodoc:
     unless defined? MAJOR
       MAJOR  = 2
-      MINOR  = 2
+      MINOR  = 3
       TINY   = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')

data/spec/sm_state_change_action_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe "State Machine State Change Action" do
+
+  before(:each) do
+    me = self
+    @sm = Statemachine.build do
+      trans :default_state, :start, :test_state
+
+      context me
+
+      sm = statemachine
+      on_state_change do
+        @state = sm.state
+      end
+    end
+  end
+
+  it "would call on_state_change when the state was changed" do
+    @state.should eql(:default_state)
+    @sm.start
+    @state.should eql(:test_state)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statemachine
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: statemachine
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies: []
 description: Statemachine is a ruby library for building Finite State Machines (FSM),
   also known as Finite State Automata (FSA).
@@ -177,6 +177,7 @@ files:
 - spec/sm_entry_exit_actions_spec.rb
 - spec/sm_odds_n_ends_spec.rb
 - spec/sm_simple_spec.rb
+- spec/sm_state_change_action_spec.rb
 - spec/sm_super_state_spec.rb
 - spec/sm_turnstile_spec.rb
 - spec/spec_helper.rb
@@ -205,7 +206,7 @@ rubyforge_project: statemachine
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Statemachine-2.2.0 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
+summary: Statemachine-2.3.0 - Statemachine Library for Ruby http://slagyr.github.com/statemachine
 test_files:
 - spec/action_invokation_spec.rb
 - spec/builder_spec.rb
@@ -217,6 +218,7 @@ test_files:
 - spec/sm_entry_exit_actions_spec.rb
 - spec/sm_odds_n_ends_spec.rb
 - spec/sm_simple_spec.rb
+- spec/sm_state_change_action_spec.rb
 - spec/sm_super_state_spec.rb
 - spec/sm_turnstile_spec.rb
 - spec/spec_helper.rb