state_machine 1.1.2 → 1.2.0

data/lib/state_machine/yard/templates.rb

@@ -0,0 +1,3 @@
+require 'yard'
+
+YARD::Templates::Engine.register_template_path File.expand_path(File.join(File.dirname(__FILE__), 'templates'))

data/lib/state_machine/yard/templates/default/class/html/setup.rb

@@ -0,0 +1,30 @@
+require 'tempfile'
+
+# Define where state machine descriptions will be rendered
+def init
+  super
+  sections.place(:state_machine_details).before(:children)
+end
+
+# Renders state machine details in the main content of the class's documentation
+def state_machine_details
+  erb(:state_machines) if state_machines
+end
+
+# Gets a list of state machines prased for this class
+def state_machines
+  @state_machines ||= begin
+    if state_machines = object['state_machines']
+      state_machines.each do |name, machine|
+        serializer.serialize(state_machine_image_path(machine), machine[:image]) if machine[:image]
+      end
+    end
+  end
+end
+
+# Generates the image path for the given machine's visualization
+def state_machine_image_path(machine)
+  base_path = File.dirname(serializer.serialized_path(object))
+  image_name = "#{object.name}_#{machine[:name]}"
+  "#{File.join(base_path, image_name)}.png"
+end

data/lib/state_machine/yard/templates/default/class/html/state_machines.erb

@@ -0,0 +1,12 @@
+<h2>State Machines</h2>
+
+This class contains <%= state_machines.count %> state machine(s).
+
+<% state_machines.each do |name, machine| %>
+  <h3><%= h(machine[:name]) %></h3>
+  <p><%= h(machine[:description]) %></p>
+  
+  <% if machine[:image] %>
+  <img alt="State machine diagram for <%= h(machine[:name]) %>" src="<%= url_for(state_machine_image_path(machine)) %>" />
+  <% end %>
+<% end %>

data/lib/tasks/state_machine.rb

@@ -1,5 +1,5 @@
 namespace :state_machine do
-  desc 'Draws state machines using GraphViz (options: CLASS=User,Vehicle; FILE=user.rb,vehicle.rb [not required in Rails / Merb]; FONT=Arial; FORMAT=png; ORIENTATION=portrait'
+  desc 'Draws state machines using GraphViz (options: CLASS=User,Vehicle; FILE=user.rb,vehicle.rb [not required in Rails / Merb]; FONT=Arial; FORMAT=png; ORIENTATION=portrait; HUMAN_NAMES=true'
   task :draw do
     # Build drawing options
     options = {}
@@ -8,6 +8,7 @@ namespace :state_machine do
     options[:format] = ENV['FORMAT'] if ENV['FORMAT']
     options[:font] = ENV['FONT'] if ENV['FONT']
     options[:orientation] = ENV['ORIENTATION'] if ENV['ORIENTATION']
+    options[:human_names] = ENV['HUMAN_NAMES'] == 'true' if ENV['HUMAN_NAMES']
     
     if defined?(Rails)
       puts "Files are automatically loaded in Rails; ignoring FILE option" if options.delete(:file)

data/lib/yard-state_machine.rb

@@ -0,0 +1,2 @@
+require 'state_machine/core'
+require 'state_machine/yard'

data/state_machine.gemspec

@@ -10,12 +10,13 @@ Gem::Specification.new do |s|
   s.description       = "Adds support for creating state machines for attributes on any Ruby class"
   s.summary           = "State machines for attributes"
   s.require_paths     = ["lib"]
-  s.files             = `git ls-files`.split("\n")
-  s.test_files        = `git ls-files -- test/*`.split("\n")
+  ignores             = File.read(".gitignore").split.map {|i| i.sub(/\/$/, "/*").sub(/^[^\/]/, "**/\\0")}
+  s.files             = (Dir[".*"] + Dir["**/*"]).select {|f| File.file?(f) && !ignores.any? {|i| File.fnmatch(i, "/#{f}")}}
+  s.test_files        = s.files.grep(/^test\//)
   s.rdoc_options      = %w(--line-numbers --inline-source --title state_machine --main README.md)
   s.extra_rdoc_files  = %w(README.md CHANGELOG.md LICENSE)
   
   s.add_development_dependency("rake")
-  s.add_development_dependency("rcov")
+  s.add_development_dependency("simplecov")
   s.add_development_dependency("appraisal", "~> 0.4.0")
 end

data/test/files/switch.rb

@@ -1,4 +1,8 @@
 class Switch
+  def self.name
+    @name ||= "Switch_#{rand(1000000)}"
+  end
+  
   state_machine do
     event :turn_on do
       transition all => :on

data/test/test_helper.rb

@@ -1,2 +1,7 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start { add_filter '/test/' }
+end
+
 require 'test/unit'
 require 'state_machine'

data/test/unit/branch_test.rb

@@ -125,6 +125,25 @@ class BranchWithMultipleFromRequirementsTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithFromMatcherRequirementTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    @branch = StateMachine::Branch.new(:from => StateMachine::BlacklistMatcher.new([:idling, :parked]))
+  end
+  
+  def test_should_match_if_included
+    assert @branch.matches?(@object, :from => :first_gear)
+  end
+  
+  def test_should_not_match_if_not_included
+    assert !@branch.matches?(@object, :from => :idling)
+  end
+  
+  def test_include_values_in_known_states
+    assert_equal [:idling, :parked], @branch.known_states
+  end
+end
+
 class BranchWithToRequirementTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -188,6 +207,25 @@ class BranchWithMultipleToRequirementsTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithToMatcherRequirementTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    @branch = StateMachine::Branch.new(:to => StateMachine::BlacklistMatcher.new([:idling, :parked]))
+  end
+  
+  def test_should_match_if_included
+    assert @branch.matches?(@object, :to => :first_gear)
+  end
+  
+  def test_should_not_match_if_not_included
+    assert !@branch.matches?(@object, :to => :idling)
+  end
+  
+  def test_include_values_in_known_states
+    assert_equal [:idling, :parked], @branch.known_states
+  end
+end
+
 class BranchWithOnRequirementTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -247,6 +285,21 @@ class BranchWithMultipleOnRequirementsTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithOnMatcherRequirementTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+    @branch = StateMachine::Branch.new(:on => StateMachine::BlacklistMatcher.new([:ignite, :park]))
+  end
+  
+  def test_should_match_if_included
+    assert @branch.matches?(@object, :on => :shift_up)
+  end
+  
+  def test_should_not_match_if_not_included
+    assert !@branch.matches?(@object, :on => :ignite)
+  end
+end
+
 class BranchWithExceptFromRequirementTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -301,6 +354,13 @@ class BranchWithMultipleExceptFromRequirementsTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithExceptFromMatcherRequirementTest < Test::Unit::TestCase
+  def test_should_raise_an_exception
+    exception = assert_raise(ArgumentError) { StateMachine::Branch.new(:except_from => StateMachine::AllMatcher.instance) }
+    assert_equal ':except_from option cannot use matchers; use :from instead', exception.message
+  end
+end
+
 class BranchWithExceptToRequirementTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -355,6 +415,13 @@ class BranchWithMultipleExceptToRequirementsTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithExceptToMatcherRequirementTest < Test::Unit::TestCase
+  def test_should_raise_an_exception
+    exception = assert_raise(ArgumentError) { StateMachine::Branch.new(:except_to => StateMachine::AllMatcher.instance) }
+    assert_equal ':except_to option cannot use matchers; use :to instead', exception.message
+  end
+end
+
 class BranchWithExceptOnRequirementTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -390,6 +457,13 @@ class BranchWithExceptOnRequirementTest < Test::Unit::TestCase
   end
 end
 
+class BranchWithExceptOnMatcherRequirementTest < Test::Unit::TestCase
+  def test_should_raise_an_exception
+    exception = assert_raise(ArgumentError) { StateMachine::Branch.new(:except_on => StateMachine::AllMatcher.instance) }
+    assert_equal ':except_on option cannot use matchers; use :on instead', exception.message
+  end
+end
+
 class BranchWithMultipleExceptOnRequirementsTest < Test::Unit::TestCase
   def setup
     @object = Object.new
@@ -707,6 +781,10 @@ class BranchWithMultipleUnlessConditionalsTest < Test::Unit::TestCase
 end
 
 class BranchWithConflictingConditionalsTest < Test::Unit::TestCase
+  def setup
+    @object = Object.new
+  end
+  
   def test_should_match_if_if_is_true_and_unless_is_false
     branch = StateMachine::Branch.new(:if => lambda {true}, :unless => lambda {false})
     assert branch.match(@object)
@@ -763,27 +841,28 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       states = [:parked, :idling]
       
-      graph = GraphViz.new('G')
-      states.each {|state| graph.add_node(state.to_s)}
+      @graph = StateMachine::Graph.new('test')
+      states.each {|state| @graph.add_nodes(state.to_s)}
       
       @branch = StateMachine::Branch.new(:from => :idling, :to => :parked)
-      @edges = @branch.draw(graph, :park, states)
+      @branch.draw(@graph, :park, states)
+      @edge = @graph.get_edge_at_index(0)
     end
     
     def test_should_create_edges
-      assert_equal 1, @edges.size
+      assert_equal 1, @graph.edge_count
     end
     
     def test_should_use_from_state_from_start_node
-      assert_equal 'idling', @edges.first.instance_variable_get('@xNodeOne')
+      assert_equal 'idling', @edge.node_one(false)
     end
     
     def test_should_use_to_state_for_end_node
-      assert_equal 'parked', @edges.first.instance_variable_get('@xNodeTwo')
+      assert_equal 'parked', @edge.node_two(false)
     end
     
     def test_should_use_event_name_as_label
-      assert_equal 'park', @edges.first['label'].to_s.gsub('"', '')
+      assert_equal 'park', @edge['label'].to_s.gsub('"', '')
     end
   end
   
@@ -792,18 +871,18 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       states = [:parked, :idling, :first_gear]
       
-      graph = GraphViz.new('G')
-      states.each {|state| graph.add_node(state.to_s)}
+      @graph = StateMachine::Graph.new('test')
+      states.each {|state| @graph.add_nodes(state.to_s)}
       
       @branch = StateMachine::Branch.new(:from => [:idling, :first_gear], :to => :parked)
-      @edges = @branch.draw(graph, :park, states)
+      @branch.draw(@graph, :park, states)
     end
     
     def test_should_generate_edges_for_each_valid_from_state
       [:idling, :first_gear].each_with_index do |from_state, index|
-        edge = @edges[index]
-        assert_equal from_state.to_s, edge.instance_variable_get('@xNodeOne')
-        assert_equal 'parked', edge.instance_variable_get('@xNodeTwo')
+        edge = @graph.get_edge_at_index(index)
+        assert_equal from_state.to_s, edge.node_one(false)
+        assert_equal 'parked', edge.node_two(false)
       end
     end
   end
@@ -813,18 +892,18 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       states = [:parked, :idling, :first_gear]
       
-      graph = GraphViz.new('G')
-      states.each {|state| graph.add_node(state.to_s)}
+      @graph = StateMachine::Graph.new('test')
+      states.each {|state| @graph.add_nodes(state.to_s)}
       
       @branch = StateMachine::Branch.new(:except_from => :parked, :to => :parked)
-      @edges = @branch.draw(graph, :park, states)
+      @branch.draw(@graph, :park, states)
     end
     
     def test_should_generate_edges_for_each_valid_from_state
       %w(idling first_gear).each_with_index do |from_state, index|
-        edge = @edges[index]
-        assert_equal from_state, edge.instance_variable_get('@xNodeOne')
-        assert_equal 'parked', edge.instance_variable_get('@xNodeTwo')
+        edge = @graph.get_edge_at_index(index)
+        assert_equal from_state, edge.node_one(false)
+        assert_equal 'parked', edge.node_two(false)
       end
     end
   end
@@ -834,18 +913,18 @@ begin
       @machine = StateMachine::Machine.new(Class.new)
       states = [:parked, :idling, :first_gear]
       
-      graph = GraphViz.new('G')
-      states.each {|state| graph.add_node(state.to_s)}
+      @graph = StateMachine::Graph.new('test')
+      states.each {|state| @graph.add_nodes(state.to_s)}
       
       @branch = StateMachine::Branch.new(:to => :parked)
-      @edges = @branch.draw(graph, :park, states)
+      @branch.draw(@graph, :park, states)
     end
     
     def test_should_generate_edges_for_each_valid_from_state
       %w(parked idling first_gear).each_with_index do |from_state, index|
-        edge = @edges[index]
-        assert_equal from_state, edge.instance_variable_get('@xNodeOne')
-        assert_equal 'parked', edge.instance_variable_get('@xNodeTwo')
+        edge = @graph.get_edge_at_index(index)
+        assert_equal from_state, edge.node_one(false)
+        assert_equal 'parked', edge.node_two(false)
       end
     end
   end
@@ -854,16 +933,17 @@ begin
     def setup
       @machine = StateMachine::Machine.new(Class.new)
       
-      graph = GraphViz.new('G')
-      graph.add_node('parked')
+      graph = StateMachine::Graph.new('test')
+      graph.add_nodes('parked')
       
       @branch = StateMachine::Branch.new(:from => :parked)
-      @edges = @branch.draw(graph, :park, [:parked])
+      @branch.draw(graph, :park, [:parked])
+      @edge = graph.get_edge_at_index(0)
     end
     
     def test_should_create_loopback_edge
-      assert_equal 'parked', @edges.first.instance_variable_get('@xNodeOne')
-      assert_equal 'parked', @edges.first.instance_variable_get('@xNodeTwo')
+      assert_equal 'parked', @edge.node_one(false)
+      assert_equal 'parked', @edge.node_two(false)
     end
   end
   
@@ -871,18 +951,19 @@ begin
     def setup
       @machine = StateMachine::Machine.new(Class.new)
       
-      graph = GraphViz.new('G')
-      graph.add_node('parked')
+      graph = StateMachine::Graph.new('test')
+      graph.add_nodes('parked')
       
       @branch = StateMachine::Branch.new(:from => :idling, :to => nil)
-      @edges = @branch.draw(graph, :park, [nil, :idling])
+      @branch.draw(graph, :park, [nil, :idling])
+      @edge = graph.get_edge_at_index(0)
     end
     
     def test_should_generate_edges_for_each_valid_from_state
-      assert_equal 'idling', @edges.first.instance_variable_get('@xNodeOne')
-      assert_equal 'nil', @edges.first.instance_variable_get('@xNodeTwo')
+      assert_equal 'idling', @edge.node_one(false)
+      assert_equal 'nil', @edge.node_two(false)
     end
   end
 rescue LoadError
-  $stderr.puts 'Skipping GraphViz StateMachine::Branch tests. `gem install ruby-graphviz` >= v0.9.0 and try again.'
+  $stderr.puts 'Skipping GraphViz StateMachine::Branch tests. `gem install ruby-graphviz` >= v0.9.17 and try again.'
 end unless ENV['TRAVIS']

data/test/unit/callback_test.rb

@@ -485,7 +485,7 @@ end
 
 class CallbackWithApplicationTerminatorTest < Test::Unit::TestCase
   def setup
-    @original_terminator = StateMachine::Callback.bind_to_object
+    @original_terminator = StateMachine::Callback.terminator
     StateMachine::Callback.terminator = lambda {|result| result == false}
     
     @object = Object.new
@@ -502,7 +502,7 @@ class CallbackWithApplicationTerminatorTest < Test::Unit::TestCase
   end
   
   def teardown
-    StateMachine::Callback.bind_to_object = @original_bind_to_object
+    StateMachine::Callback.terminator = @original_terminator
   end
 end
 
@@ -597,6 +597,7 @@ class CallbackWithAroundTypeAndMultipleMethodsTest < Test::Unit::TestCase
   
   def test_should_halt_if_first_doesnt_yield
     class << @object
+      remove_method :run_1
       def run_1
         (@before_callbacks ||= []) << :run_1
       end
@@ -612,6 +613,7 @@ class CallbackWithAroundTypeAndMultipleMethodsTest < Test::Unit::TestCase
   
   def test_should_halt_if_last_doesnt_yield
     class << @object
+      remove_method :run_2
       def run_2
         (@before_callbacks ||= []) << :run_2
       end
@@ -624,6 +626,7 @@ class CallbackWithAroundTypeAndMultipleMethodsTest < Test::Unit::TestCase
   
   def test_should_not_evaluate_further_methods_if_after_halts
     class << @object
+      remove_method :run_2
       def run_2
         (@before_callbacks ||= []) << :run_2
         yield

data/test/unit/eval_helpers_test.rb

@@ -14,7 +14,7 @@ class EvalHelpersTest < EvalHelpersBaseTest
   
   def test_should_raise_exception_if_method_is_not_symbol_string_or_proc
     exception = assert_raise(ArgumentError) { evaluate_method(@object, 1) }
-    assert_match /Methods must/, exception.message
+    assert_match(/Methods must/, exception.message)
   end
 end
 
@@ -32,6 +32,36 @@ class EvalHelpersSymbolTest < EvalHelpersBaseTest
   end
 end
 
+class EvalHelpersSymbolProtectedTest < EvalHelpersBaseTest
+  def setup
+    class << (@object = Object.new)
+      protected
+      def callback
+        true
+      end
+    end
+  end
+  
+  def test_should_call_method_on_object_with_no_arguments
+    assert_equal true, evaluate_method(@object, :callback, 1, 2, 3)
+  end
+end
+
+class EvalHelpersSymbolPrivateTest < EvalHelpersBaseTest
+  def setup
+    class << (@object = Object.new)
+      private
+      def callback
+        true
+      end
+    end
+  end
+  
+  def test_should_call_method_on_object_with_no_arguments
+    assert_equal true, evaluate_method(@object, :callback, 1, 2, 3)
+  end
+end
+
 class EvalHelpersSymbolWithArgumentsTest < EvalHelpersBaseTest
   def setup
     class << (@object = Object.new)
@@ -90,6 +120,24 @@ class EvalHelpersSymbolTaintedMethodTest < EvalHelpersBaseTest
   end
 end
 
+class EvalHelpersSymbolMethodMissingTest < EvalHelpersBaseTest
+  def setup
+    class << (@object = Object.new)
+      def method_missing(symbol, *args)
+        send("method_missing_#{symbol}", *args)
+      end
+      
+      def method_missing_callback(*args)
+        args
+      end
+    end
+  end
+  
+  def test_should_call_dynamic_method_with_all_arguments
+    assert_equal [1, 2, 3], evaluate_method(@object, :callback, 1, 2, 3)
+  end
+end
+
 class EvalHelpersStringTest < EvalHelpersBaseTest
   def setup
     @object = Object.new