state_shifter 0.8.1 → 1.0.3

data/lib/state_shifter/definition/contents.rb

@@ -2,51 +2,63 @@ module StateShifter
   module Definition
     class Contents
 
-      attr_accessor :states, :initial_state, :events, :on_transition_proc
+      attr_accessor :states, :initial_state, :events, :state_tags, :on_transition_proc
 
       def initialize &definition
-        @states = {}
-        @events = {}
+        @states     = {}
+        @events     = {}
+        @state_tags = {}
         instance_eval &definition if block_given?
       end
 
       def state name, &events_and_stuff
-        this_state = State.new(name)
-        @initial_state = this_state if @states.empty? # first state declared is the initial one
-        
-        raise ::StateShifter::RedifiningState, this_state.name if @states.has_key?(this_state.name.to_sym)
-        
+        if @states.empty? # first state declared is the initial one
+          this_state = State.new(name, true)
+          @initial_state = this_state
+        else
+          this_state = State.new(name)
+        end
+
+        raise RedifiningState, this_state.name if @states.has_key?(this_state.name.to_sym)
+
         @states[this_state.name.to_sym] = this_state
         @current_state = this_state
         instance_eval &events_and_stuff if events_and_stuff
       end
 
+      def tags *names
+        names.each do |name|
+          @state_tags[name] ||= []
+          @state_tags[name] << @current_state.name
+        end
+      end
+
       def event hash_or_sym, hash=nil
         this_event =
           if hash.nil?
             if hash_or_sym.is_a?(Symbol)
               # looping event
               event_name = hash_or_sym
-              
+
               Event.new @current_state.name.to_sym, event_name
             else
               # normal event
               event_guards = hash_or_sym.delete(:if)
               event_name = hash_or_sym.keys.first
               event_next_state = hash_or_sym[event_name.to_sym]
-        
+
               Event.new @current_state.name.to_sym, event_name, event_next_state, event_guards
             end
           else
             event_guards = hash.delete(:if)
             event_name = hash_or_sym
             event_callback = hash.delete(:call)
-            
+
             Event.new @current_state.name.to_sym, event_name, @current_state.name.to_sym, event_guards, event_callback
           end
 
-        raise ::StateShifter::RedifiningEvent, this_event.name if @events.has_key?(this_event.name.to_sym)        
-        
+        raise RedifiningEvent, this_event.name if @events.has_key?(this_event.name.to_sym)
+
         @events[this_event.name.to_sym] = this_event
         @current_state.events[event_name.to_sym] = this_event
       end
@@ -56,7 +68,7 @@ module StateShifter
           @current_state.entry_callback = proc_contents
         else
           @current_state.entry_callback = event_name
-          @current_state.entry_callback_args = ( event_args.size == 1 ? event_args.first : event_args )
+          @current_state.entry_callback_args = ( event_args.size == 1 ? event_args.first : event_args ) unless event_args.empty?
         end
       end
 

data/lib/state_shifter/definition/instance_methods.rb

@@ -7,11 +7,11 @@ module StateShifter
       end
 
       def get_current_state
-        instance_variable_defined?(:@current_state) ? @current_state : state_machine_definition.initial_state.name.to_sym
+        instance_variable_defined?(:@current_state) ? @current_state.to_sym : state_machine_definition.initial_state.name.to_sym
       end
 
       def set_current_state value
-        @current_state = value
+        @current_state = value.to_sym
       end
 
       def state_machine_definition
@@ -39,16 +39,13 @@ module StateShifter
       end
 
       def names_for what
-        state_machine_definition.send(what).collect {|name, definition| name }
+        state_machine_definition.send(what).collect {|name, definition| name.to_sym }
       end
 
       def check_event_callbacks event_name
         event_def = state_machine_definition.get(:event, event_name)
-        begin
-          self.send event_def.callback
-        rescue NoMethodError
-          raise ::StateShifter::CallbackMethodNotDefined, event_def.callback
-        end
+
+        self.send event_def.callback
       end
 
       def current_state_def
@@ -60,14 +57,16 @@ module StateShifter
 
         if proc_or_method_name.is_a?(Symbol)
           method_args = current_state_def.entry_callback_args
-          begin
+
+          if method_args
             self.send proc_or_method_name, method_args
-          rescue NoMethodError
-            raise ::StateShifter::CallbackMethodNotDefined, proc_or_method_name
+          else
+            self.send proc_or_method_name
           end
+
         else
           self.instance_exec(old_state, trigger.to_sym, &proc_or_method_name)
-        end        
+        end
       end
 
       def transition args
@@ -75,20 +74,20 @@ module StateShifter
 
         # BOOP!
         old_state = get_current_state
-        set_current_state args[:to].to_sym
+        set_current_state args[:to]
         #
 
-        check_event_callbacks(args[:trigger]) if state_machine_definition.get(:event, args[:trigger]).has_callback?
+        self.instance_exec(old_state, get_current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
 
         call_state_entry_callback(args[:trigger], old_state) if current_state_def.has_entry_callback?
-        
-        self.instance_exec(old_state, get_current_state, args[:trigger].to_sym, (Time.now - _start), &state_machine_definition.on_transition_proc) if state_machine_definition.has_on_transition_proc?
+
+        check_event_callbacks(args[:trigger]) if state_machine_definition.get(:event, args[:trigger]).has_callback?
 
         true
       end
 
       def halt message
-        raise ::StateShifter::TransitionHalted, message
+        raise TransitionHalted, message
       end
 
       def check_guards event_name
@@ -99,7 +98,7 @@ module StateShifter
             begin
               return false, guard unless self.send(guard.to_sym)
             rescue NoMethodError
-              raise ::StateShifter::GuardMethodUndefined, guard
+              raise GuardMethodUndefined, guard
             end
           end
           true

data/lib/state_shifter/definition.rb

@@ -8,6 +8,7 @@ module StateShifter
       if Object.const_defined?(:ActiveRecord)
         if klass < ActiveRecord::Base
           klass.send :include, ActiveRecordIntegrationMethods
+          klass.send :_include_state_scopes=, true
           klass.before_validation :write_initial_state
         end
       end

data/lib/state_shifter/draw.rb

@@ -0,0 +1,38 @@
+module StateShifter
+
+  class Draw
+
+    gem 'ruby-graphviz', '>=0.9.0'
+    require 'graphviz'
+
+    def self.graph klasses, options
+      klasses.split(',').each do |klass|
+        this_class = eval(klass)
+
+        graph = GraphViz.new(:G, :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB')
+
+        this_class.state_machine_definition.states.each do |state_name, state_definition|
+          node = state_definition.draw(graph, options)
+          node.fontname = options[:font] if options[:font]
+        end
+
+        this_class.state_machine_definition.events.each do |event_name, event_definition|
+          edge = event_definition.draw(graph, options)
+          edge.fontname = options[:font] if options[:font]
+        end
+
+        graphvizVersion = Constants::RGV_VERSION.split('.')
+
+        if graphvizVersion[0] == '0' && graphvizVersion[1] == '9' && graphvizVersion[2] == '0'
+          output_options = {:output => options[:format], :file => options[:output_filename]}
+        else
+          output_options = {options[:format] => options[:output_filename]}
+        end
+
+        graph.output(output_options)
+      end
+    end
+  end
+
+end
+

data/lib/state_shifter/event.rb

@@ -18,5 +18,10 @@ module StateShifter
       !@callback.nil?
     end
 
+    def draw(graph, options = {})
+      to = @to ? @to : @from
+      graph.add_edges(@from.to_s, to.to_s, :label => @name.to_s)
+    end
+
   end
 end

data/lib/state_shifter/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module StateShifter
+  class Railtie < ::Rails::Railtie
+
+    rake_tasks do
+      load 'tasks/state_shifter.rake'
+    end
+
+  end
+end

data/lib/state_shifter/state.rb

@@ -1,21 +1,43 @@
 module StateShifter
 
   class State
-  
-    attr_reader :name, :events
+
+    attr_reader :name, :events, :initial
     attr_accessor :entry_callback, :entry_callback_args
 
-    def initialize name
+    def initialize name, initial=false
       @name = name
       @events = {}
+      @initial = initial
       @entry_callback = nil
-      @entry_callback_args = []
+      @entry_callback_args = nil
     end
 
     def has_entry_callback?
       !@entry_callback.nil?
     end
 
+    def initial?
+      @initial
+    end
+
+    def final?
+      @events.empty?
+    end
+
+    def draw graph, options
+      node = graph.add_nodes(@name.to_s,
+                            :label => @name.to_s,
+                            :width => '1',
+                            :height => '1',
+                            :shape => final? ? 'doublecircle' : 'ellipse'
+                           )
+
+      graph.add_edges(graph.add_nodes('starting_state', :shape => 'point'), node) if initial?
+
+      node
+    end
+
   end
 
 end

data/lib/state_shifter.rb

@@ -5,12 +5,18 @@ require 'state_shifter/definition/contents'
 require 'state_shifter/definition/class_methods'
 require 'state_shifter/definition/instance_methods'
 require 'state_shifter/definition/active_record_integration_methods'
+require 'state_shifter/draw'
 
-class ::StateShifter::TransitionHalted < Exception ; end
-class ::StateShifter::GuardMethodUndefined < Exception ; end
-class ::StateShifter::GuardNotSatisfied < Exception ; end
-class ::StateShifter::CallbackMethodNotDefined < Exception ; end
-class ::StateShifter::RedifiningEvent < Exception ; end
-class ::StateShifter::RedifiningState < Exception ; end
-class ::StateShifter::PersistenceAttributeAlreadyDefined < Exception ; end
+require 'state_shifter/railtie' if defined?(Rails)
 
+module StateShifter
+
+  class TransitionHalted < Exception ; end
+  class GuardMethodUndefined < Exception ; end
+  class GuardNotSatisfied < Exception ; end
+  class CallbackMethodNotDefined < Exception ; end
+  class RedifiningEvent < Exception ; end
+  class RedifiningState < Exception ; end
+  class PersistenceAttributeAlreadyDefined < Exception ; end
+
+end

data/lib/tasks/state_shifter.rake

@@ -0,0 +1,26 @@
+namespace :state_shifter do
+  desc 'Draws state machines using GraphViz (options: CLASS=User,Vehicle; FONT=Arial; FORMAT=png; ORIENTATION=portrait; OUTPUT_FILENAME=filename)'
+  task :draw do
+
+    unless ENV['CLASS']
+      puts 'you need to specify at least one CLASS'
+      exit 1
+    end
+
+    options = {}
+
+    options[:format]          = ENV['FORMAT'] || 'png'
+    options[:output_filename] = ENV['OUTPUT_FILENAME'] || "#{ENV['CLASS']}.#{options[:format]}"
+    options[:font]            = ENV['FONT'] || 'Arial'
+    options[:orientation]     = ENV['ORIENTATION'] || 'portrait'
+
+    if defined?(Rails)
+      Rake::Task['environment'].invoke
+    else
+      $:.unshift(File.dirname(__FILE__) + '/..')
+      require 'state_shifter'
+    end
+
+    StateShifter::Draw.graph(ENV['CLASS'], options)
+  end
+end

data/spec/state_shifter_spec.rb

@@ -5,7 +5,7 @@ require_relative '../examples/review'
 require_relative '../examples/review_custom_persistence'
 
 shared_examples_for 'a simple state machine' do
-  
+
   before(:each) do
     @state_machine = described_class.new
     @state_machine.save if @state_machine.class < ActiveRecord::Base
@@ -20,6 +20,8 @@ shared_examples_for 'a simple state machine' do
     @state_machine.initial_state.should == :new
     @state_machine.current_state.should == :new
 
+    @state_machine.current_state_def.initial?.should be_true
+
     @state_machine.submit
     @state_machine.initial_state.should == :new
 
@@ -78,6 +80,8 @@ shared_examples_for 'a simple state machine' do
     @state_machine.next_states.should == [:awaiting_review]
     @state_machine.transitionable_states.should == [:awaiting_review]
 
+    @state_machine.current_state_def.final?.should be_false
+
     @state_machine.submit!
     @state_machine.next_states.should == [:being_reviewed]
     @state_machine.transitionable_states.should == [:being_reviewed]
@@ -89,6 +93,8 @@ shared_examples_for 'a simple state machine' do
     @state_machine.accept
     @state_machine.next_states.should == []
     @state_machine.transitionable_states.should == []
+
+    @state_machine.current_state_def.final?.should be_true
   end
 
   it 'should respect proper transition precedence' do
@@ -99,7 +105,7 @@ shared_examples_for 'a simple state machine' do
 end
 
 describe Simple do
-   
+
   it_should_behave_like 'a simple state machine'
 
 end
@@ -127,24 +133,12 @@ describe 'Advanced state machine functionality' do
   end
 
   it 'should complain about undefined guards' do
-    advanced = Advanced.new
-    lambda { advanced.can_start_date_reached?}.should raise_error(StateShifter::GuardMethodUndefined, 'start_date_reached?')
-  end
-
-  it 'should complain about undefined callbacks on state entry' do
-    advanced = Advanced.new
-    advanced.forced_start!
-    
-    lambda { advanced.deadline_reached }.should raise_error(StateShifter::CallbackMethodNotDefined, 'send_notification_to_organizers')
-  end
-
-  it 'should complain about looping event callbacks not being defined' do
-    lambda { @advanced.start_date_changed }.should raise_error(StateShifter::CallbackMethodNotDefined, 'handle_start_date_changed')
+    lambda { @advanced.can_start_date_reached?}.should raise_error(StateShifter::GuardMethodUndefined, 'start_date_reached?')
   end
 
   it 'should call looping event callbacks' do
     @advanced.stub!(:handle_start_date_changed)
-    
+
     @advanced.should_receive(:handle_start_date_changed)
     @advanced.start_date_changed
   end
@@ -155,7 +149,7 @@ describe 'Advanced state machine functionality' do
     @advanced.forced_start
 
     # method name only
-    @advanced.should_receive(:send_notification_to_organizers)
+    @advanced.should_receive(:send_notification_to_organizers).with(no_args())
     @advanced.deadline_reached!
   end
 
@@ -181,6 +175,12 @@ describe 'Advanced state machine functionality' do
     @advanced.forced_start!
   end
 
+  it 'the on_transition callback should work in the proper order' do
+    @advanced.should_receive(:benchmark).ordered.with(:initialized, :preparing, :event_associated!, an_instance_of(Float)).and_return(nil)
+    @advanced.should_receive(:benchmark).ordered.with(:preparing, :running, :all_done!, an_instance_of(Float)).and_return(nil)
+    @advanced.event_associated!
+  end
+
 end
 
 describe Review do
@@ -197,8 +197,58 @@ describe Review do
     end
   end
 
+  after(:each) do
+    described_class.destroy_all
+  end
+
   it_should_behave_like 'a simple state machine'
 
+  it "should tolerate strings as state names" do
+    state_machine = described_class.new
+    state_machine.save
+
+    state_machine.current_state.should == :new
+    state_machine.update_attribute(:current_state, "new")
+
+    state_machine.new?.should be_true
+
+    state_machine.submit
+    state_machine.initial_state.should == :new
+
+    state_machine.current_state.should == :awaiting_review
+  end
+
+  it "should have tag methods" do
+    described_class.reviewable_states.should eq([:new, :awaiting_review, :being_reviewed])
+
+    state_machine = described_class.new
+    state_machine.save
+
+    state_machine.reviewable?.should be_true
+    state_machine.processing?.should be_false
+
+    state_machine.submit
+    state_machine.reviewable?.should be_true
+    state_machine.processing?.should be_true
+
+    state_machine.review!
+    state_machine.reviewable?.should be_true
+    state_machine.processing?.should be_true
+
+    state_machine.accept!
+    state_machine.reviewable?.should be_false
+    state_machine.processing?.should be_false
+  end
+
+  it "should have state scopes" do
+    state_machine = described_class.new
+    state_machine.save
+    state_machine.submit
+
+    described_class.awaiting_review.size.should eq(1)
+    described_class.reviewable.size.should eq(1)
+  end
+
 end
 
 describe ReviewCustomPersistence do
@@ -217,6 +267,21 @@ describe ReviewCustomPersistence do
 
   it_should_behave_like 'a simple state machine'
 
+  it "should tolerate strings as state names" do
+    state_machine = described_class.new
+    state_machine.save
+
+    state_machine.current_state.should == :new
+    state_machine.update_attribute(:stamp, "new")
+
+    state_machine.new?.should be_true
+
+    state_machine.submit
+    state_machine.initial_state.should == :new
+
+    state_machine.current_state.should == :awaiting_review
+  end
+
 end
 
 describe 'Malformed persistence definition' do

data/state_shifter.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: state_shifter 1.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "state_shifter"
-  s.version = "0.8.1"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Bruno Antunes"]
-  s.date = "2012-08-28"
+  s.date = "2015-04-10"
   s.description = "state_shifter is a gem that adds state machine behavior to a class"
   s.email = "sardaukar.siet@gmail.com"
   s.extra_rdoc_files = [
@@ -38,55 +40,66 @@ Gem::Specification.new do |s|
     "lib/state_shifter/definition/class_methods.rb",
     "lib/state_shifter/definition/contents.rb",
     "lib/state_shifter/definition/instance_methods.rb",
+    "lib/state_shifter/draw.rb",
     "lib/state_shifter/event.rb",
+    "lib/state_shifter/railtie.rb",
     "lib/state_shifter/state.rb",
+    "lib/tasks/state_shifter.rake",
     "spec/spec_helper.rb",
     "spec/state_shifter_spec.rb",
     "state_shifter.gemspec"
   ]
   s.homepage = "http://github.com/sardaukar/state_shifter"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "2.4.5"
   s.summary = "state_shifter is a gem that adds state machine behavior to a class"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<activerecord>, ["~> 3.2.x"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<rspec-nc>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.9.0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 4.0.9"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3.10"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
-      s.add_development_dependency(%q<redcarpet>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 3.2.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<ruby-graphviz>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 1.8.2"])
+      s.add_development_dependency(%q<i18n>, [">= 0.6.6"])
     else
-      s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<rspec-nc>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.9.0"])
+      s.add_dependency(%q<activerecord>, ["~> 4.0.9"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.10"])
+      s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
-      s.add_dependency(%q<redcarpet>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<redcarpet>, [">= 3.2.3"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<ruby-graphviz>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 1.8.2"])
+      s.add_dependency(%q<i18n>, [">= 0.6.6"])
     end
   else
-    s.add_dependency(%q<activerecord>, ["~> 3.2.x"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<rspec-nc>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.9.0"])
+    s.add_dependency(%q<activerecord>, ["~> 4.0.9"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.10"])
+    s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
-    s.add_dependency(%q<redcarpet>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<redcarpet>, [">= 3.2.3"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<ruby-graphviz>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 1.8.2"])
+    s.add_dependency(%q<i18n>, [">= 0.6.6"])
   end
 end