simple_state_machine 0.6.0.pre → 0.6.0

data/lib/simple_state_machine/tools/graphviz.rb

@@ -0,0 +1,17 @@
+module SimpleStateMachine
+  module Tools
+    require 'cgi'
+    module Graphviz
+      # Graphviz dot format for rendering as a directional graph
+      def to_graphviz_dot
+        transitions.map { |t| t.to_graphviz_dot }.sort.join(";")
+      end
+
+      # Generates a url that renders states and events as a directional graph.
+      # See http://code.google.com/apis/chart/docs/gallery/graphviz.html
+      def google_chart_url
+        "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape to_graphviz_dot}}"
+      end
+    end
+  end
+end

data/lib/simple_state_machine/tools/inspector.rb

@@ -0,0 +1,44 @@
+module SimpleStateMachine
+  module Tools
+    module Inspector
+      def begin_states
+        from_states - to_states
+      end
+
+      def end_states
+        to_states - from_states
+      end
+
+      def states
+        (to_states + from_states).uniq
+      end
+
+      private
+
+        def from_states
+          to_uniq_sym(sample_transitions.map(&:from))
+        end
+
+        def to_states
+          to_uniq_sym(sample_transitions.map(&:to))
+        end
+
+        def to_uniq_sym(array)
+          array.map { |state| state.is_a?(String) ? state.to_sym : state }.uniq
+        end
+
+        def sample_transitions
+          (@subject || sample_subject).state_machine_definition.send :transitions
+        end
+
+        def sample_subject
+          self_class = self.class
+          sample = Class.new do
+            extend SimpleStateMachine::Mountable
+            mount_state_machine self_class
+          end
+          sample
+        end
+    end
+  end
+end

data/lib/simple_state_machine/transition.rb

@@ -0,0 +1,40 @@
+module SimpleStateMachine
+  # Defines transitions for events
+  class Transition
+    attr_reader :event_name, :from, :to
+    def initialize(event_name, from, to)
+      @event_name = event_name.to_s
+      @from       = from.is_a?(Class) ? from : from.to_s
+      @to         = to.to_s
+    end
+
+    # returns true if it's a transition for event_name and subject_state
+    def is_transition_for?(event_name, subject_state)
+      is_same_event?(event_name) && is_same_from?(subject_state)
+    end
+
+    # returns true if it's a error transition for event_name and error
+    def is_error_transition_for?(event_name, error)
+      is_same_event?(event_name) && from.is_a?(Class) && error.is_a?(from)
+    end
+
+    def to_s
+      "#{from}.#{event_name}! => #{to}"
+    end
+
+    # TODO move to Graphiz module
+    def to_graphviz_dot
+      %("#{from}"->"#{to}"[label=#{event_name}])
+    end
+
+    private
+
+      def is_same_event?(event_name)
+        self.event_name == event_name.to_s
+      end
+
+      def is_same_from?(subject_from)
+        from.to_s == 'all' || subject_from.to_s == from.to_s
+      end
+  end
+end

data/lib/simple_state_machine/version.rb

@@ -1,3 +1,3 @@
 module SimpleStateMachine
-  VERSION = "0.6.0.pre"
+  VERSION = "0.6.0"
 end

data/simple_state_machine.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
 
   s.authors = ["Marek de Heus", "Petrik de Heus"]
-  s.description = %q{Simple State Machine is a state machine that focuses on events instead of states}
+  s.description = %q{A simple DSL to decorate existing methods with state transition guards.}
   s.email = ["FIX@example.com"]
   s.homepage = %q{http://github.com/mdh/ssm}
   s.extra_rdoc_files = [

data/spec/active_record_spec.rb

@@ -1,11 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-require "rubygems"
-require "bundler"
-Bundler.require
-#Bundler.setup(:test)#, :activerecord)
-require 'active_record'
-require 'examples/user'
+require 'spec_helper'
 
 ActiveRecord::Base.logger = Logger.new "test.log"
 ActiveRecord::Base.establish_connection(:adapter  => "sqlite3",
@@ -114,7 +107,7 @@ describe ActiveRecord do
     it "rollsback if an exception is raised" do
       user_class = Class.new(User)
       user_class.instance_eval do
-        define_method :without_managed_state_invite do
+        define_method :invite_without_managed_state do
           User.create!(:name => 'name2') #this shouldn't be persisted
           User.create! #this should raise an error
         end
@@ -182,7 +175,7 @@ describe ActiveRecord do
     it "rollsback if an exception is raised" do
       user_class = Class.new(User)
       user_class.instance_eval do
-        define_method :without_managed_state_invite do
+        define_method :invite_without_managed_state do
           User.create!(:name => 'name2') #this shouldn't be persisted
           User.create! #this should raise an error
         end
@@ -242,16 +235,16 @@ describe ActiveRecord do
 
     it "persists transitions" do
       ticket = Ticket.create!
-      ticket.should be_open
+      ticket.ssm_state.should == 'open'
       ticket.close!.should == true
-      ticket.should be_closed
+      ticket.ssm_state.should == 'closed'
     end
 
     it "persists transitions with !" do
       ticket = Ticket.create!
-      ticket.should be_open
+      ticket.ssm_state.should == 'open'
       ticket.close!
-      ticket.should be_closed
+      ticket.ssm_state.should == 'closed'
     end
 
   end

data/spec/{decorator_spec.rb → decorator/default_spec.rb}

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe SimpleStateMachine::Decorator do
+describe SimpleStateMachine::Decorator::Default do
 
   context "given a class" do
     before do
@@ -10,7 +10,7 @@ describe SimpleStateMachine::Decorator do
           @state_machine_definition ||= SimpleStateMachine::StateMachineDefinition.new
         end
       end
-      decorator = SimpleStateMachine::Decorator.new klass
+      decorator = SimpleStateMachine::Decorator::Default.new klass
       decorator.decorate SimpleStateMachine::Transition.new(:event, :state1, :state2)
       @instance = klass.new
       @instance.state = 'state1'
@@ -35,7 +35,7 @@ describe SimpleStateMachine::Decorator do
         @instance.state1?.should  == true
         @instance.state2?.should  == false
       end
-      
+
       it "defines an event method" do
         @instance.should respond_to(:event)
       end
@@ -55,7 +55,7 @@ describe SimpleStateMachine::Decorator do
         def event()   "predefined method" end
       end
       transition =  SimpleStateMachine::Transition.new(:event, :state1, :state2)
-      decorator = SimpleStateMachine::Decorator.new klass
+      decorator = SimpleStateMachine::Decorator::Default.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new
@@ -87,7 +87,7 @@ describe SimpleStateMachine::Decorator do
       end
     end
   end
-  
+
   context "given a class with predefined protected methods" do
     before do
       klass = Class.new do
@@ -102,7 +102,7 @@ describe SimpleStateMachine::Decorator do
         def event()   "predefined method" end
       end
       transition =  SimpleStateMachine::Transition.new(:event, :state1, :state2)
-      decorator = SimpleStateMachine::Decorator.new klass
+      decorator = SimpleStateMachine::Decorator::Default.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new
@@ -154,7 +154,7 @@ describe SimpleStateMachine::Decorator do
         def event()   "predefined method" end
       end
       transition =  SimpleStateMachine::Transition.new(:event, :state1, :state2)
-      decorator = SimpleStateMachine::Decorator.new klass
+      decorator = SimpleStateMachine::Decorator::Default.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new

data/spec/examples_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Examples" do
   describe "TrafficLight" do
@@ -13,7 +13,7 @@ describe "Examples" do
       tl.should be_green
     end
   end
-  
+
   describe "Lamp" do
     it "changes between :on and :off" do
       lamp = Lamp.new
@@ -28,13 +28,13 @@ describe "Examples" do
       lamp.should be_off
     end
   end
-  
+
   describe "Conversation" do
     it "is :unread by default" do
       conversation = Conversation.new
       conversation.should be_unread
     end
-    
+
     it "changes to read on view" do
       conversation = Conversation.new
       conversation.view

data/spec/mountable_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Mountable" do
   before do
@@ -6,14 +6,14 @@ describe "Mountable" do
       event(:event, :state1 => :state2)
 
       def decorator_class
-        SimpleStateMachine::Decorator
+        SimpleStateMachine::Decorator::Default
       end
     end
     klass = Class.new do
       attr_accessor :event_called
       extend SimpleStateMachine::Mountable
       mount_state_machine mountable_class
-      def without_managed_state_event
+      def event_without_managed_state
         @event_called = true
       end
     end

data/spec/simple_state_machine_spec.rb

@@ -1,5 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'cgi'
+require 'spec_helper'
 
 describe SimpleStateMachine do
 

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
+require "rubygems"
+require "bundler"
+Bundler.require
+#Bundler.setup(:test)#, :activerecord)
+require 'active_record'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'simple_state_machine'
 require 'examples/conversation'
 require 'examples/lamp'
 require 'examples/traffic_light'
+require 'examples/user'
 

data/spec/state_machine_definition_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe SimpleStateMachine::StateMachineDefinition do
 
@@ -86,70 +86,6 @@ describe SimpleStateMachine::StateMachineDefinition do
     end
   end
 
-  describe "#begin_states" do
-    before do
-      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
-        def add_events
-          define_event(:event_a, :state1      => :state2)
-          define_event(:event_b, :state2      => :state3)
-          define_event(:event_c, :state1      => :state3)
-          define_event(:event_c, RuntimeError => :state3)
-        end
-
-        def decorator_class
-          SimpleStateMachine::Decorator
-        end
-      end
-    end
-
-    it "returns all 'from' states that aren't 'to' states" do
-      @klass.new.begin_states.should == [:state1, RuntimeError]
-    end
-  end
-
-  describe "#end_states" do
-    before do
-      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
-        def add_events
-          define_event(:event_a, :state1 => :state2)
-          define_event(:event_b, :state2 => :state3)
-          define_event(:event_c, :state1 => :state3)
-        end
-
-        def decorator_class
-          SimpleStateMachine::Decorator
-        end
-
-      end
-    end
-
-    it "returns all 'to' states that aren't 'from' states" do
-      @klass.new.end_states.should == [:state3]
-    end
-  end
-
-  describe "#states" do
-    before do
-      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
-        def add_events
-          define_event(:event_a, :state1 => :state2)
-          define_event(:event_b, :state2 => :state3)
-          define_event(:event_c, :state1 => :state3)
-        end
-
-        def decorator_class
-          SimpleStateMachine::Decorator
-        end
-
-      end
-    end
-
-    it "returns all states" do
-      @klass.new.states.map(&:to_s).sort.should == %w{state1 state2 state3}
-    end
-  end
-
-
   describe "#transitions" do
     it "has a list of transitions" do
       @smd.transitions.should be_a(Array)
@@ -163,16 +99,5 @@ describe SimpleStateMachine::StateMachineDefinition do
     end
   end
 
-  describe "#to_graphviz_dot" do
-    it "converts to graphviz dot format" do
-      @smd.to_graphviz_dot.should ==  %("state1"->"state2"[label=event1];"state2"->"state3"[label=event1])
-    end
-  end
-
-  describe "#google_chart_url" do
-    it "shows the state and event dependencies as a Google chart" do
-      @smd.google_chart_url.should == "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape @smd.to_graphviz_dot}}"
-    end
-  end
 end
 

data/spec/tools/graphviz_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe SimpleStateMachine::Tools::Graphviz do
+
+  before do
+    @klass = Class.new do
+      extend SimpleStateMachine
+      def initialize(state = 'state1')
+        @state = state
+      end
+      event :event1, :state1 => :state2, :state2 => :state3
+    end
+    @smd = @klass.state_machine_definition
+  end
+
+  describe "#to_graphviz_dot" do
+    it "converts to graphviz dot format" do
+      @smd.to_graphviz_dot.should ==  %("state1"->"state2"[label=event1];"state2"->"state3"[label=event1])
+    end
+  end
+
+  describe "#google_chart_url" do
+    it "shows the state and event dependencies as a Google chart" do
+      @smd.google_chart_url.should == "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape @smd.to_graphviz_dot}}"
+    end
+  end
+end
+
+

data/spec/tools/inspector_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe SimpleStateMachine::Tools::Inspector do
+
+  describe "#begin_states" do
+    before do
+      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
+        def add_events
+          define_event(:event_a, :state1      => :state2)
+          define_event(:event_b, :state2      => :state3)
+          define_event(:event_c, :state1      => :state3)
+          define_event(:event_c, RuntimeError => :state3)
+        end
+
+        def decorator_class
+          SimpleStateMachine::Decorator::Default
+        end
+      end
+    end
+
+    it "returns all 'from' states that aren't 'to' states" do
+      @klass.new.begin_states.should == [:state1, RuntimeError]
+    end
+  end
+
+  describe "#end_states" do
+    before do
+      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
+        def add_events
+          define_event(:event_a, :state1 => :state2)
+          define_event(:event_b, :state2 => :state3)
+          define_event(:event_c, :state1 => :state3)
+        end
+
+        def decorator_class
+          SimpleStateMachine::Decorator::Default
+        end
+
+      end
+    end
+
+    it "returns all 'to' states that aren't 'from' states" do
+      @klass.new.end_states.should == [:state3]
+    end
+  end
+
+  describe "#states" do
+    before do
+      @klass = Class.new(SimpleStateMachine::StateMachineDefinition) do
+        def add_events
+          define_event(:event_a, :state1 => :state2)
+          define_event(:event_b, :state2 => :state3)
+          define_event(:event_c, :state1 => :state3)
+        end
+
+        def decorator_class
+          SimpleStateMachine::Decorator::Default
+        end
+
+      end
+    end
+
+    it "returns all states" do
+      @klass.new.states.map(&:to_s).sort.should == %w{state1 state2 state3}
+    end
+  end
+
+end
+
+