simple_state_machine 0.5.2 → 0.6.1

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 = described_class.new klass
       decorator.decorate SimpleStateMachine::Transition.new(:event, :state1, :state2)
       @instance = klass.new
       @instance.state = 'state1'
@@ -18,26 +18,26 @@ describe SimpleStateMachine::Decorator do
 
     describe "#initialize" do
       it "defines a state_machine method" do
-        @instance.state_machine.should be_an(SimpleStateMachine::StateMachine)
+        expect(@instance.state_machine).to be_an(SimpleStateMachine::StateMachine)
       end
 
       it "defines a state getter method" do
-        @instance.should respond_to(:state)
+        expect(@instance).to respond_to(:state)
       end
 
       it "defines a state setter method" do
-        @instance.should respond_to(:state=)
+        expect(@instance).to respond_to(:state=)
       end
     end
 
     describe "#decorate" do
       it "defines state_helper_methods for both states" do
-        @instance.state1?.should  == true
-        @instance.state2?.should  == false
+        expect(@instance.state1?).to  eq(true)
+        expect(@instance.state2?).to  eq(false)
       end
-      
+
       it "defines an event method" do
-        @instance.should respond_to(:event)
+        expect(@instance).to respond_to(:event)
       end
     end
   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 = described_class.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new
@@ -64,30 +64,30 @@ describe SimpleStateMachine::Decorator do
 
     describe "#initialize" do
       it "defines a state_machine method" do
-        @instance.state_machine.should be_an(SimpleStateMachine::StateMachine)
+        expect(@instance.state_machine).to be_an(SimpleStateMachine::StateMachine)
       end
 
       it "defines a state getter method" do
-        @instance.should respond_to(:state)
+        expect(@instance).to respond_to(:state)
       end
 
       it "defines a state setter method" do
-        @instance.should respond_to(:state=)
+        expect(@instance).to respond_to(:state=)
       end
     end
 
     describe "#decorate" do
       it "does not overwrite predefined state_helper_methods" do
-        @instance.state1?.should  == "state1"
-        @instance.state2?.should  == "state2"
+        expect(@instance.state1?).to  eq("state1")
+        expect(@instance.state2?).to  eq("state2")
       end
 
       it "does not overwrite predefined event method" do
-        @instance.event.should == "predefined method"
+        expect(@instance.event).to eq("predefined method")
       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 = described_class.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new
@@ -111,22 +111,22 @@ describe SimpleStateMachine::Decorator do
 
     describe "#initialize" do
       it "defines a state_machine method" do
-        @instance.state_machine.should be_an(SimpleStateMachine::StateMachine)
+        expect(@instance.state_machine).to be_an(SimpleStateMachine::StateMachine)
       end
 
       it "defines a state getter method" do
-        @instance.should respond_to(:state)
+        expect(@instance).to respond_to(:state)
       end
 
       it "defines a state setter method" do
-        @instance.should respond_to(:state=)
+        expect(@instance).to respond_to(:state=)
       end
     end
 
     describe "#decorate" do
       it "does not overwrite predefined protected state_helper_methods" do
-        @instance.send(:state1?).should  == "state1"
-        @instance.send(:state2?).should  == "state2"
+        expect(@instance.send(:state1?)).to  eq("state1")
+        expect(@instance.send(:state2?)).to  eq("state2")
       end
 
       it "keeps predefined protected state_helper_methods protected" do
@@ -135,7 +135,7 @@ describe SimpleStateMachine::Decorator do
       end
 
       it "does not overwrite predefined protected event method" do
-        @instance.event.should == "predefined method"
+        expect(@instance.event).to eq("predefined method")
       end
     end
   end
@@ -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 = described_class.new klass
       decorator.decorate transition
       klass.state_machine_definition.transitions << transition
       @instance = klass.new
@@ -163,22 +163,22 @@ describe SimpleStateMachine::Decorator do
 
     describe "#initialize" do
       it "defines a state_machine method" do
-        @instance.state_machine.should be_an(SimpleStateMachine::StateMachine)
+        expect(@instance.state_machine).to be_an(SimpleStateMachine::StateMachine)
       end
 
       it "defines a state getter method" do
-        @instance.should respond_to(:state)
+        expect(@instance).to respond_to(:state)
       end
 
       it "defines a state setter method" do
-        @instance.should respond_to(:state=)
+        expect(@instance).to respond_to(:state=)
       end
     end
 
     describe "#decorate" do
       it "does not overwrite predefined private state_helper_methods" do
-        @instance.send(:state1?).should  == "state1"
-        @instance.send(:state2?).should  == "state2"
+        expect(@instance.send(:state1?)).to  eq("state1")
+        expect(@instance.send(:state2?)).to  eq("state2")
       end
 
       it "keeps predefined private state_helper_methods private" do
@@ -187,7 +187,7 @@ describe SimpleStateMachine::Decorator do
       end
 
       it "does not overwrite predefined protected event method" do
-        @instance.event.should == "predefined method"
+        expect(@instance.event).to eq("predefined method")
       end
     end
   end

data/spec/examples_spec.rb

@@ -1,57 +1,57 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Examples" do
   describe "TrafficLight" do
     it "changes to the next state" do
       tl = TrafficLight.new
-      tl.should be_green
+      expect(tl).to be_green
       tl.change_state
-      tl.should be_orange
+      expect(tl).to be_orange
       tl.change_state
-      tl.should be_red
+      expect(tl).to be_red
       tl.change_state
-      tl.should be_green
+      expect(tl).to be_green
     end
   end
-  
+
   describe "Lamp" do
     it "changes between :on and :off" do
       lamp = Lamp.new
-      lamp.should be_off
+      expect(lamp).to be_off
       lamp.push_button1
-      lamp.should be_on
+      expect(lamp).to be_on
       lamp.push_button2
-      lamp.should be_off
+      expect(lamp).to be_off
       lamp.push_button2
-      lamp.should be_on
+      expect(lamp).to be_on
       lamp.push_button1
-      lamp.should be_off
+      expect(lamp).to be_off
     end
   end
-  
+
   describe "Conversation" do
     it "is :unread by default" do
       conversation = Conversation.new
-      conversation.should be_unread
+      expect(conversation).to be_unread
     end
-    
+
     it "changes to read on view" do
       conversation = Conversation.new
       conversation.view
-      conversation.should be_read
+      expect(conversation).to be_read
     end
 
     it "changes to closed on close" do
       conversation = Conversation.new
       conversation.close
-      conversation.should be_closed
+      expect(conversation).to be_closed
     end
 
     it "changes to closed on close if :read" do
       conversation = Conversation.new
       conversation.view
       conversation.close
-      conversation.should be_closed
+      expect(conversation).to be_closed
     end
 
   end

data/spec/mountable_spec.rb

@@ -1,24 +1,36 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "Mountable" do
-  before do
-    mountable_class = Class.new(SimpleStateMachine::StateMachineDefinition) do
-      def initialize(subject)
-        self.lazy_decorator = lambda { SimpleStateMachine::Decorator.new(subject) }
-        add_transition(:event, :state1, :state2)
-      end
+describe SimpleStateMachine::Mountable do
+  class MountableExample < SimpleStateMachine::StateMachineDefinition
+    event(:event, :state1 => :state2)
+
+    def decorator_class
+      SimpleStateMachine::Decorator::Default
     end
-    klass = Class.new do
+  end
+
+  let(:klass) do
+    Class.new do
+      attr_accessor :event_called
       extend SimpleStateMachine::Mountable
-      self.state_machine_definition = mountable_class.new self
+      mount_state_machine MountableExample
+      def event_without_managed_state
+        @event_called = true
+      end
     end
-    @instance = klass.new
-    @instance.state = 'state1'
+  end
+  subject do
+    klass.new.tap{|i| i.state = 'state1' }
   end
 
   it "has state_helper methods" do
-    @instance.should be_state1
-    @instance.should_not be_state2
+    expect(subject).to be_state1
+    expect(subject).not_to be_state2
   end
 
+  it "calls existing methods" do
+    subject.event
+    expect(subject).to be_state2
+    expect(subject.event_called).to eq(true)
+  end
 end

data/spec/simple_state_machine_spec.rb

@@ -1,126 +1,162 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'cgi'
+require 'spec_helper'
 
 describe SimpleStateMachine do
- 
+
   it "has an error that extends RuntimeError" do
-    SimpleStateMachine::IllegalStateTransitionError.superclass.should == RuntimeError
+    expect(SimpleStateMachine::IllegalStateTransitionError.superclass).to eq(RuntimeError)
+  end
+
+  let(:klass) do
+    Class.new do
+      extend SimpleStateMachine
+      def initialize(state = 'state1')
+        @state = state
+      end
+    end
   end
 
   describe ".event" do
 
-    before do
-      @klass = Class.new do
-        extend SimpleStateMachine
-        def initialize(state = 'state1')
-          @state = state
+    it "returns what the decorated method returns" do
+      klass.instance_eval do
+        event :event1,  :state1 => :state2
+        define_method :event2 do
+          'event2'
         end
+        event :event2, :state2 => :state3
       end
+      subject = klass.new
+      expect(subject.event1).to eq(nil)
+      expect(subject.event2).to eq('event2')
     end
 
-    it "changes state if event has multiple transitions" do
-      klass = Class.new(@klass)
+    it "calls existing methods" do
       klass.instance_eval do
-        event :event, :state1 => :state2, :state2 => :state3
+        attr_accessor :event_called
+        define_method :event do
+          @event_called = true
+        end
+        event :event, :state1 => :state2
       end
-      example = klass.new
-      example.should be_state1
-      example.event
-      example.should be_state2
-      example.event
-      example.should be_state3
+      subject = klass.new
+      subject.event
+      expect(subject.event_called).to eq(true)
     end
 
-    it "changes state if event has multiple froms" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        event :event, [:state1, :state2] => :state3
+    context "given an event has multiple transitions" do
+      before do
+        klass.instance_eval do
+          event :event, :state1 => :state2, :state2 => :state3
+        end
       end
-      example = klass.new
-      example.event
-      example.should be_state3
-      example = klass.new 'state2'
-      example.should be_state2
-      example.event
-      example.should be_state3
-    end
 
-    it "changes state if event has all as from" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        event :other_event, :state1 => :state2
-        event :event, :all => :state3
+      it "changes state for all transitions" do
+        subject = klass.new
+        expect(subject).to be_state1
+        subject.event
+        expect(subject).to be_state2
+        subject.event
+        expect(subject).to be_state3
       end
-      example = klass.new
-      example.event
-      example.should be_state3
-      example = klass.new 'state2'
-      example.should be_state2
-      example.event
-      example.should be_state3
     end
 
-    it "changes state when state is a symbol instead of a string" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        event :event, :state1 => :state2
-      end  
-      example = klass.new :state1
-      example.state.should == :state1
-      example.send(:event)
-      example.should be_state2
+    context "given an event has multiple from states" do
+      before do
+        klass.instance_eval do
+          event :event, [:state1, :state2] => :state3
+        end
+      end
+
+      it "changes state for all from states" do
+        subject = klass.new
+        subject.event
+        expect(subject).to be_state3
+        subject = klass.new 'state2'
+        expect(subject).to be_state2
+        subject.event
+        expect(subject).to be_state3
+      end
     end
 
-    it "changes state to error_state when error can be caught" do
-      class_with_error = Class.new(@klass)
-      class_with_error.instance_eval do
-        define_method :raise_error do
-          raise RuntimeError.new
+    context "given an event has :all as from state" do
+      before do
+        klass.instance_eval do
+          event :other_event, :state1 => :state2
+          event :event, :all => :state3
         end
-        event :raise_error, :state1 => :state2, RuntimeError => :failed
       end
-      example = class_with_error.new
-      example.should be_state1
-      example.raise_error
-      example.should be_failed
+
+      it "changes state from all states" do
+        subject = klass.new
+        subject.event
+        expect(subject).to be_state3
+        subject = klass.new 'state2'
+        expect(subject).to be_state2
+        subject.event
+        expect(subject).to be_state3
+      end
     end
-    
-    it "raises an error if an invalid state_transition is called" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        event :event,  :state1 => :state2
-        event :event2, :state2 => :state3
-      end  
-      example = klass.new
-      lambda { example.event2 }.should raise_error(SimpleStateMachine::IllegalStateTransitionError, "You cannot 'event2' when state is 'state1'")
+
+    context "given state is a symbol instead of a string" do
+      before do
+        klass.instance_eval do
+          event :event, :state1 => :state2
+        end
+      end
+
+      it "changes state" do
+        subject = klass.new :state1
+        expect(subject.state).to eq(:state1)
+        subject.send(:event)
+        expect(subject).to be_state2
+      end
     end
 
-    it "returns what the decorated method returns" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        event :event1,  :state1 => :state2
-        define_method :event2 do
-          'event2'
+    context "given an RuntimeError begin state" do
+      it "changes state to error_state when error can be caught" do
+        class_with_error = Class.new(klass)
+        class_with_error.instance_eval do
+          define_method :raise_error do
+            raise RuntimeError.new
+          end
+          event :raise_error, :state1 => :state2, RuntimeError => :failed
         end
-        event :event2, :state2 => :state3
-      end  
-      example = klass.new
-      example.event1.should == nil
-      example.event2.should == 'event2'
+        subject = class_with_error.new
+        expect(subject).to be_state1
+        subject.raise_error
+        expect(subject).to be_failed
+      end
+
+      it "changes state to error_state when error superclass can be caught" do
+        error_subclass   = Class.new(RuntimeError)
+        class_with_error = Class.new(klass)
+        class_with_error.instance_eval do
+          define_method :raise_error do
+            raise error_subclass.new
+          end
+          event :raise_error, :state1 => :state2, RuntimeError => :failed
+        end
+        subject = class_with_error.new
+        expect(subject).to be_state1
+        subject.raise_error
+        expect(subject).to be_failed
+      end
     end
 
-    it "calls existing methods" do
-      klass = Class.new(@klass)
-      klass.instance_eval do
-        attr_accessor :event_called
-        define_method :event do
-          @event_called = true
+    context "given an invalid state_transition is called" do
+      before do
+        klass.instance_eval do
+          event :event,  :state1 => :state2
+          event :event2, :state2 => :state3
         end
-        event :event, :state1 => :state2
-      end  
-      example = klass.new
-      example.event
-      example.event_called.should == true
+      end
+
+      it "raises an IllegalStateTransitionError" do
+        subject = klass.new
+        expect { subject.event2 }.to raise_error(
+            SimpleStateMachine::IllegalStateTransitionError,
+            "You cannot 'event2' when state is 'state1'")
+      end
     end
 
   end

data/spec/spec_helper.rb

@@ -1,7 +1,20 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "rubygems"
+require "bundler"
+Bundler.require :test
+begin
+  require 'active_record'
+rescue LoadError
+  puts "Skipping ActiveRecord specs"
+end
+
+ROOT = Pathname(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+$LOAD_PATH << File.join(ROOT, 'lib')
+$LOAD_PATH << File.join(ROOT, 'spec')
+$LOAD_PATH << File.join(ROOT, 'examples')
+
 require 'simple_state_machine'
-require 'examples/conversation'
-require 'examples/lamp'
-require 'examples/traffic_light'
+require File.join(ROOT, 'examples', 'conversation.rb')
+require File.join(ROOT, 'examples', 'lamp.rb')
+require File.join(ROOT, 'examples', 'traffic_light.rb')
+require File.join(ROOT, 'examples', 'user.rb') if defined? ActiveRecord