simple_state_machine 0.5.2 → 0.6.1

data/spec/state_machine_definition_spec.rb

@@ -1,25 +1,25 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe SimpleStateMachine::StateMachineDefinition do
 
-  before do
-    @klass = Class.new do
+  let(:klass) do
+    Class.new do
       extend SimpleStateMachine
       def initialize(state = 'state1')
         @state = state
       end
-      event :event1, :state1 => :state2, :state2 => :state3      
+      event :event1, :state1 => :state2, :state2 => :state3
     end
-    @smd = @klass.state_machine_definition
   end
+  let(:smd) { klass.state_machine_definition }
 
   it "is inherited by subclasses" do
-    example = Class.new(@klass).new
-    example.should be_state1
-    example.event1
-    example.should be_state2
-    example.event1
-    example.should be_state3
+    subject = Class.new(klass).new
+    expect(subject).to be_state1
+    subject.event1
+    expect(subject).to be_state2
+    subject.event1
+    expect(subject).to be_state3
   end
 
   describe '#state_method' do
@@ -39,51 +39,65 @@ describe SimpleStateMachine::StateMachineDefinition do
     end
 
     it "is used when changing state" do
-      subject.ssm_state.should == 'state1'
+      expect(subject.ssm_state).to eq('state1')
       subject.event1
-      subject.ssm_state.should == 'state2'
+      expect(subject.ssm_state).to eq('state2')
       subject.event2
-      subject.ssm_state.should == 'state3'
+      expect(subject.ssm_state).to eq('state3')
     end
 
     it "works with state helper methods" do
-      subject.should be_state1
+      expect(subject).to be_state1
       subject.event1
-      subject.should be_state2
+      expect(subject).to be_state2
       subject.event2
-      subject.should be_state3
+      expect(subject).to be_state3
     end
-    
+
     it "raise an error if an invalid state_transition is called" do
-      lambda { subject.event2 }.should raise_error(SimpleStateMachine::IllegalStateTransitionError, "You cannot 'event2' when state is 'state1'")
+      expect { subject.event2 }.to raise_error(SimpleStateMachine::IllegalStateTransitionError, "You cannot 'event2' when state is 'state1'")
     end
 
   end
 
-  describe "#transitions" do
-    it "has a list of transitions" do
-      @smd.transitions.should be_a(Array)
-      @smd.transitions.first.should be_a(SimpleStateMachine::Transition)
+  describe '#default_error_state' do
+    subject do
+      klass = Class.new do
+        attr_reader :state
+        extend SimpleStateMachine
+        state_machine_definition.default_error_state = :failed
+
+        def initialize(state = 'state1')
+          @state = state
+        end
+
+        def event1
+          raise "Some error during event"
+        end
+        event :event1, :state1 => :state2
+      end
+      klass.new
     end
-  end
 
-  describe "#to_s" do
-    it "converts to readable string format" do
-      @smd.to_s.should =~ Regexp.new("state1.event1! => state2")
+    it "is set when an error occurs during an event" do
+      expect(subject.state).to eq('state1')
+      subject.event1
+      expect(subject.state).to eq('failed')
     end
   end
 
-  describe "#to_graphiz_dot" do
-    it "converts to graphiz dot format" do
-      @smd.to_graphiz_dot.should ==  %("state1"->"state2"[label=event1];"state2"->"state3"[label=event1])
+  describe "#transitions" do
+    it "has a list of transitions" do
+      expect(smd.transitions).to be_a(Array)
+      expect(smd.transitions.first).to be_a(SimpleStateMachine::Transition)
     end
   end
 
-  describe "#google_chart_url" do
-    it "shows the state and event dependencies as a Google chart" do
-      puts "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape @smd.to_graphiz_dot}}"
-      @smd.google_chart_url.should == "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape @smd.to_graphiz_dot}}"
+  describe "#to_s" do
+    it "converts to readable string format" do
+      expect(smd.to_s).to match(Regexp.new("state1.event1! => state2"))
     end
   end
+
 end
 

data/spec/state_machine_spec.rb

@@ -14,11 +14,45 @@ describe SimpleStateMachine::StateMachine do
     end
 
     it "returns the next state for the event and current state" do
-      subject.next_state('event1').should == 'state2'
+      expect(subject.next_state('event1')).to eq('state2')
     end
 
     it "returns nil if no next state for the event and current state exists" do
-      subject.next_state('event2').should be_nil
+      expect(subject.next_state('event2')).to be_nil
+    end
+  end
+
+  describe "#raised_error" do
+    context "given an error can be caught" do
+      let(:class_with_error) do
+        Class.new do
+          extend SimpleStateMachine
+          def initialize(state = 'state1'); @state = state; end
+          def raise_error
+            raise "Something went wrong"
+          end
+          event :raise_error, :state1 => :state2,
+                RuntimeError => :failed
+          event :retry,  :failed => :success
+        end
+      end
+
+      subject do
+        class_with_error.new.tap{|i| i.raise_error }
+      end
+
+      it "the raised error is accessible" do
+        raised_error = subject.state_machine.raised_error
+        expect(raised_error).to be_a(RuntimeError)
+        expect(raised_error.message).to eq("Something went wrong")
+      end
+
+      it "the raised error is set to nil on the next transition" do
+        expect(subject.state_machine.raised_error).to be
+        subject.retry
+        expect(subject.state_machine.raised_error).not_to be
+      end
+
     end
   end
 

data/spec/tools/graphviz_spec.rb

@@ -0,0 +1,30 @@
+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
+      expect(@smd.to_graphviz_dot).to eq(%(digraph G {\n"state1"->"state2"[label=event1];\n"state2"->"state3"[label=event1]\n}))
+    end
+  end
+
+  describe "#google_chart_url" do
+    it "shows the state and event dependencies as a Google chart" do
+      graph = @smd.transitions.map { |t| t.to_graphviz_dot }.sort.join(";")
+      expect(@smd.google_chart_url).to eq("http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape graph}}")
+    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
+      expect(@klass.new.begin_states).to eq([: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
+      expect(@klass.new.end_states).to eq([: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
+      expect(@klass.new.states.map(&:to_s).sort).to eq(%w{state1 state2 state3})
+    end
+  end
+
+end
+
+

metadata

@@ -1,176 +1,102 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple_state_machine
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 2
-  version: 0.5.2
+version: !ruby/object:Gem::Version
+  version: 0.6.1
 platform: ruby
-authors: 
+authors:
 - Marek de Heus
 - Petrik de Heus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2011-03-06 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ZenTest
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 3
-        - 5
-        version: 2.3.5
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: sqlite3-ruby
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id005
-description: Simple State Machine is a state machine that focuses on events instead of states
-email: 
+date: 2021-12-15 00:00:00.000000000 Z
+dependencies: []
+description: A simple DSL to decorate existing methods with state transition guards.
+email:
 - FIX@example.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.rdoc
-files: 
-- .gitignore
-- .rspec
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.rdoc
 - Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- autotest/discover.rb
 - examples/conversation.rb
 - examples/lamp.rb
 - examples/relationship.rb
 - examples/traffic_light.rb
 - examples/user.rb
+- gemfiles/Gemfile.activerecord-5.2.x
+- gemfiles/Gemfile.activerecord-6.0.x
+- gemfiles/Gemfile.activerecord-6.1.x
+- gemfiles/Gemfile.activerecord-main.x
+- gemfiles/Gemfile.basic
 - lib/simple_state_machine.rb
+- lib/simple_state_machine/.DS_Store
 - lib/simple_state_machine/active_record.rb
+- lib/simple_state_machine/decorator/active_record.rb
+- lib/simple_state_machine/decorator/default.rb
 - lib/simple_state_machine/rails2_task_loader.rb
 - lib/simple_state_machine/railtie.rb
 - lib/simple_state_machine/simple_state_machine.rb
+- lib/simple_state_machine/state_machine.rb
+- lib/simple_state_machine/state_machine_definition.rb
+- lib/simple_state_machine/tools/graphviz.rb
+- lib/simple_state_machine/tools/inspector.rb
+- lib/simple_state_machine/transition.rb
 - lib/simple_state_machine/version.rb
-- lib/tasks/graphiz.rake
-- rails/graphiz.rake
+- lib/tasks/graphviz.rake
 - simple_state_machine.gemspec
+- spec/.DS_Store
 - spec/active_record_spec.rb
-- spec/decorator_spec.rb
+- spec/decorator/default_spec.rb
 - spec/examples_spec.rb
 - spec/mountable_spec.rb
 - spec/simple_state_machine_spec.rb
 - spec/spec_helper.rb
 - spec/state_machine_definition_spec.rb
 - spec/state_machine_spec.rb
-has_rdoc: true
+- spec/tools/graphviz_spec.rb
+- spec/tools/inspector_spec.rb
 homepage: http://github.com/mdh/ssm
 licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.2
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
 summary: A simple DSL to decorate existing methods with logic that guards state transitions.
-test_files: 
+test_files:
 - spec/active_record_spec.rb
-- spec/decorator_spec.rb
+- spec/decorator/default_spec.rb
 - spec/examples_spec.rb
 - spec/mountable_spec.rb
 - spec/simple_state_machine_spec.rb
 - spec/spec_helper.rb
 - spec/state_machine_definition_spec.rb
 - spec/state_machine_spec.rb
+- spec/tools/graphviz_spec.rb
+- spec/tools/inspector_spec.rb

data/autotest/discover.rb

@@ -1 +0,0 @@
-Autotest.add_discovery { "rspec2" }

data/lib/tasks/graphiz.rake

@@ -1,13 +0,0 @@
-namespace :ssm do
-  namespace :graph do
-    desc 'Generate a url for a google chart for [class]'
-    task :url => :environment do
-      puts ENV['class'].constantize.state_machine_definition.google_chart_url
-    end
-
-    desc 'Opens the google chart in the browser for [class]'
-    task :open => :environment do
-      `open '#{::CGI.unescape(ENV['class'].constantize.state_machine_definition.google_chart_url)}'`
-    end
-  end
-end

data/rails/graphiz.rake

@@ -1,16 +0,0 @@
-namespace :ssm do
-
-  namespace :graph do
-    
-    desc 'url'
-    task 'url' do |t|
-    end
-
-    desc 'image'
-    task 'image' do |t|
-    end
-
-  end
-
-end
-