finite_machine 0.10.2 → 0.11.0

data/spec/unit/hook_event/build_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::HookEvent, '#build' do
+  it "builds action event" do
+    hook_event = FiniteMachine::HookEvent::Before.build(:green, :go, :red)
+    expect(hook_event.name).to eq(:go)
+  end
+
+  it "builds state event" do
+    hook_event = FiniteMachine::HookEvent::Enter.build(:green, :go, :red)
+    expect(hook_event.name).to eq(:green)
+  end
+end

data/spec/unit/hook_event/eql_spec.rb

@@ -4,11 +4,10 @@ require 'spec_helper'
 
 RSpec.describe FiniteMachine::HookEvent, 'eql?' do
   let(:name)       { :green }
-  let(:transition) { double(:transition) }
-  let(:data)       { [:foo, :bar] }
+  let(:event_name) { :go }
   let(:object)     { described_class }
 
-  subject(:hook) { object.new(name, transition, *data) }
+  subject(:hook) { object.new(name, event_name, name) }
 
   context 'with the same object' do
    let(:other) { hook }
@@ -28,7 +27,7 @@ RSpec.describe FiniteMachine::HookEvent, 'eql?' do
 
   context "with an object having different name" do
     let(:other_name) { :red }
-    let(:other) { object.new(other_name, transition, *data) }
+    let(:other) { object.new(other_name, event_name, other_name) }
 
     it "doesn't equal" do
       expect(hook).not_to eql(other)

data/spec/unit/hook_event/initialize_spec.rb

@@ -2,21 +2,24 @@
 
 require 'spec_helper'
 
-RSpec.describe FiniteMachine::HookEvent, 'new' do
-  let(:name)       { :green }
-  let(:transition) { double(:transition) }
-  let(:data)       { [:foo, :bar] }
-  let(:object)     { described_class }
+RSpec.describe FiniteMachine::HookEvent, '#new' do
+  it "reads event name" do
+    hook_event = described_class.new(:green, :go, :green)
+    expect(hook_event.name).to eql(:green)
+  end
 
-  subject(:hook) { object.new(name, transition, *data) }
+  it "reads event type" do
+    hook_event = described_class.new(:green, :go, :green)
+    expect(hook_event.type).to eql(FiniteMachine::HookEvent)
+  end
 
-  it "exposes readers" do
-    expect(hook.name).to eql(name)
-    expect(hook.data).to eql(data)
-    expect(hook.type).to eql(object)
+  it "reads the from state" do
+    hook_event = described_class.new(:green, :go, :red)
+    expect(hook_event.from).to eql(:red)
   end
 
   it "freezes object" do
-    expect { hook.name = :red }.to raise_error(RuntimeError)
+    hook_event = described_class.new(:green, :go, :green)
+    expect { hook_event.name = :red }.to raise_error(RuntimeError)
   end
 end

data/spec/unit/hook_event/notify_spec.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::HookEvent, '.notify' do
+  it "emits event on the subscriber" do
+    subscriber = spy(:subscriber)
+    hook_event = described_class.new(:green, :go, :red)
+
+    hook_event.notify(subscriber, 1, 2)
+
+    expect(subscriber).to have_received(:emit).with(hook_event, 1, 2)
+  end
+end

data/spec/unit/{initialize_spec.rb → initial_spec.rb}

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe FiniteMachine, 'initialize' do
+RSpec.describe FiniteMachine, 'initial' do
 
   before(:each) {
     stub_const("DummyLogger", Class.new do

data/spec/unit/inspect_spec.rb

@@ -12,6 +12,6 @@ RSpec.describe FiniteMachine, '#inspect' do
         event :stop,  :yellow => :red
       }
     end
-    expect(fsm.inspect).to match(/^<#FiniteMachine::StateMachine:0x#{fsm.object_id.to_s(16)} @states=\[:none, :green, :yellow, :red\], @events=\[:init, :slow, :stop\], @transitions=.*$/)
+    expect(fsm.inspect).to match(/^<#FiniteMachine::StateMachine:0x#{fsm.object_id.to_s(16)} @states=\[:none, :green, :yellow, :red\], @events=\[:init, :slow, :stop\], @transitions=\[{:none=>:green}, {:green=>:yellow}, {:yellow=>:red}\]>$/)
   end
 end

data/spec/unit/logger_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 RSpec.describe FiniteMachine::Logger do
   let(:message) { 'error' }
-  let(:log) { double }
+  let(:log) { spy }
 
   subject(:logger) { described_class }
 
@@ -31,9 +31,8 @@ RSpec.describe FiniteMachine::Logger do
   end
 
   it "reports transition" do
-    expect(log).to receive(:info).with("Transition: @event=go red -> green")
-    machine = double(:machine, current: :green)
-    transition = double(:transition, name: "go", from_state: :red, machine: machine)
-    logger.report_transition(transition)
+    logger.report_transition(:go, :red, :green)
+
+    expect(log).to have_received(:info).with("Transition: @event=go red -> green")
   end
 end

data/spec/unit/subscribers_spec.rb

@@ -3,29 +3,40 @@
 require 'spec_helper'
 
 RSpec.describe FiniteMachine::Subscribers do
-  let(:machine)  { double }
-  let(:event)    { double }
   let(:listener) { double }
 
-  subject(:subscribers) { described_class.new(machine) }
-
-  before { subscribers.subscribe(listener) }
-
   it "checks if any subscribers exist" do
-    expect(subscribers.empty?).to be(false)
+    subscribers = described_class.new
+    expect(subscribers.empty?).to eq(true)
+    subscribers.subscribe(listener)
+    expect(subscribers.empty?).to eq(false)
+  end
+
+  it "allows to subscribe multiple listeners" do
+    subscribers = described_class.new
+    subscribers.subscribe(listener, listener)
+    expect(subscribers.size).to eq(2)
   end
 
   it "returns index for the subscriber" do
+    subscribers = described_class.new
+    subscribers.subscribe(listener)
     expect(subscribers.index(listener)).to eql(0)
   end
 
   it "visits all subscribed listeners for the event" do
-    expect(event).to receive(:notify).with(listener)
+    subscribers = described_class.new
+    subscribers.subscribe(listener)
+    event = spy(:event)
     subscribers.visit(event)
+    expect(event).to have_received(:notify).with(listener)
   end
 
   it "resets the subscribers" do
+    subscribers = described_class.new
+    subscribers.subscribe(listener)
+    expect(subscribers.empty?).to eq(false)
     subscribers.reset
-    expect(subscribers.empty?).to be(true)
+    expect(subscribers.empty?).to eq(true)
   end
 end

data/spec/unit/transition/check_conditions_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::Transition, '.check_conditions' do
+  it "verifies all conditions pass" do
+    exec_conditions = 0
+    ok_condition = -> { exec_conditions += 1; return true }
+    fail_condition = -> { exec_conditions += 1; return false }
+    machine = double(:machine, target: Object.new)
+
+    transition = described_class.new(machine, if: [ok_condition, fail_condition])
+
+    expect(transition.check_conditions).to eql(false)
+    expect(exec_conditions).to eq(2)
+  end
+
+  it "verifies 'if' and 'unless' conditions" do
+    machine = double(:machine, target: Object.new)
+    exec_conditions = 0
+    ok_condition = -> { exec_conditions += 1; return true }
+    fail_condition = -> { exec_conditions += 1; return false }
+
+    transition = described_class.new(machine, if: [ok_condition], unless: [fail_condition])
+
+    expect(transition.check_conditions).to eql(true)
+    expect(exec_conditions).to eq(2)
+  end
+
+  it "verifies condition with arguments" do
+    machine = double(:machine, target: Object.new)
+    condition = lambda { |target, arg| arg == 1 }
+
+    transition = described_class.new(machine, if: [condition])
+
+    expect(transition.check_conditions(2)).to eql(false)
+    expect(transition.check_conditions(1)).to eql(true)
+  end
+
+  it "verifies condition on target" do
+    stub_const("Car", Class.new do
+      def engine_on?
+        true
+      end
+    end)
+    target = Car.new
+    machine = double(:machine, target: target)
+    condition = lambda { |car| car.engine_on? }
+
+    transition = described_class.new(machine, if: condition)
+
+    expect(transition.check_conditions).to eql(true)
+  end
+end

data/spec/unit/transition/inspect_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe FiniteMachine::Transition, '#inspect' do
   subject(:transition) { described_class.new(machine, attrs) }
 
   context 'when inspecting' do
-    let(:attrs) { {name: :start, parsed_states: { :foo => :bar, :baz => :daz } } }
+    let(:attrs) { {name: :start, states: { :foo => :bar, :baz => :daz } } }
 
     it "displays name and transitions" do
       expect(transition.inspect).to eql("<#FiniteMachine::Transition @name=start, @transitions=foo -> bar, baz -> daz, @when=[]>")
@@ -16,7 +16,7 @@ RSpec.describe FiniteMachine::Transition, '#inspect' do
   end
 
   context 'when converting to string' do
-    let(:attrs) { {name: :start, parsed_states: { :foo => :bar } } }
+    let(:attrs) { {name: :start, states: { :foo => :bar } } }
 
     it "displays name and transitions" do
       expect(transition.to_s).to eql("start")

data/spec/unit/transition/matches_spec.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::Transition, '.matches?' do
+  let(:machine) { double(:machine) }
+
+  it "matches from state" do
+    states = {:green => :red}
+    transition = described_class.new(machine, states: states)
+
+    expect(transition.matches?(:green)).to eq(true)
+    expect(transition.matches?(:red)).to eq(false)
+  end
+
+  it "matches any state" do
+    states = {:any => :red}
+    transition = described_class.new(machine, states: states)
+
+    expect(transition.matches?(:green)).to eq(true)
+  end
+end
+

data/spec/unit/transition/states_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::Transition, '.states' do
+  let(:machine) { double(:machine) }
+
+  it "groups states with :to key only" do
+    attrs = {states: {:any => :red}}
+    transition = FiniteMachine::Transition.new(machine, attrs)
+    expect(transition.states).to eql({any: :red})
+  end
+
+  it "groups states when from array" do
+    attrs = {states: { :green => :red, :yellow => :red}}
+    transition = FiniteMachine::Transition.new(machine, attrs)
+    expect(transition.states.keys).to match_array([:green, :yellow])
+    expect(transition.states.values).to eql([:red, :red])
+  end
+
+
+  it "groups states when hash of states" do
+    attrs = {states: {
+              :initial => :low,
+              :low     => :medium,
+              :medium  => :high }}
+    transition = FiniteMachine::Transition.new(machine, attrs)
+    expect(transition.states.keys).to match_array([:initial, :low, :medium])
+    expect(transition.states.values).to eql([:low, :medium, :high])
+  end
+end

data/spec/unit/transition/to_state_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::Transition, '.to_state' do
+  let(:machine) { double(:machine) }
+
+  it "finds to state" do
+    states = {:green => :red}
+    transition = described_class.new(machine, states: states)
+
+    expect(transition.to_state(:green)).to eq(:red)
+  end
+
+  it "finds to state for transition from any state" do
+    states = {:any => :red}
+    transition = described_class.new(machine, states: states)
+
+    expect(transition.to_state(:green)).to eq(:red)
+  end
+
+  it "returns from state for cancelled transition" do
+    transition = described_class.new(machine, cancelled: true)
+
+    expect(transition.to_state(:green)).to eq(:green)
+  end
+end

data/spec/unit/trigger_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::StateMachine, '.trigger' do
+  it "triggers event manually" do
+    called = []
+    fsm = FiniteMachine.define do
+      initial :red
+
+      events {
+        event :start, :red   => :green, if: proc { |_, name| called << name; true }
+        event :stop,  :green => :red
+      }
+    end
+
+    expect(fsm.current).to eq(:red)
+    fsm.trigger(:start, 'Piotr')
+    expect(fsm.current).to eq(:green)
+    expect(called).to eq(['Piotr'])
+  end
+end

data/spec/unit/undefined_transition/eql_spec.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+RSpec.describe FiniteMachine::UndefinedTransition, '#==' do
+  it "is true with the same name" do
+    expect(described_class.new(:go)).to eq(described_class.new(:go))
+  end
+
+  it "is false with a different name" do
+    expect(described_class.new(:go)).to_not eq(described_class.new(:other))
+  end
+
+  it "is false with another object" do
+    expect(described_class.new(:go)).to_not eq(:other)
+  end
+end

data/tasks/console.rake

@@ -8,3 +8,4 @@ task :console do
   ARGV.clear
   IRB.start
 end
+task :c => :console

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/finite_machine_logo.png
 - examples/atm.rb
 - examples/bug_system.rb
 - finite_machine.gemspec
@@ -55,7 +56,6 @@ files:
 - lib/finite_machine/definition.rb
 - lib/finite_machine/dsl.rb
 - lib/finite_machine/env.rb
-- lib/finite_machine/event.rb
 - lib/finite_machine/event_definition.rb
 - lib/finite_machine/event_queue.rb
 - lib/finite_machine/events_chain.rb
@@ -65,6 +65,7 @@ files:
 - lib/finite_machine/logger.rb
 - lib/finite_machine/observer.rb
 - lib/finite_machine/safety.rb
+- lib/finite_machine/state_definition.rb
 - lib/finite_machine/state_machine.rb
 - lib/finite_machine/state_parser.rb
 - lib/finite_machine/subscribers.rb
@@ -74,6 +75,7 @@ files:
 - lib/finite_machine/transition_builder.rb
 - lib/finite_machine/transition_event.rb
 - lib/finite_machine/two_phase_lock.rb
+- lib/finite_machine/undefined_transition.rb
 - lib/finite_machine/version.rb
 - spec/spec_helper.rb
 - spec/unit/alias_target_spec.rb
@@ -84,26 +86,28 @@ files:
 - spec/unit/choice_spec.rb
 - spec/unit/define_spec.rb
 - spec/unit/definition_spec.rb
-- spec/unit/event/add_spec.rb
-- spec/unit/event/eql_spec.rb
-- spec/unit/event/initialize_spec.rb
-- spec/unit/event/inspect_spec.rb
-- spec/unit/event/next_transition_spec.rb
+- spec/unit/event_names_spec.rb
 - spec/unit/event_queue_spec.rb
-- spec/unit/events_chain/check_choice_conditions_spec.rb
+- spec/unit/events_chain/add_spec.rb
+- spec/unit/events_chain/cancel_transitions_spec.rb
+- spec/unit/events_chain/choice_transition_spec.rb
 - spec/unit/events_chain/clear_spec.rb
-- spec/unit/events_chain/insert_spec.rb
+- spec/unit/events_chain/events_spec.rb
 - spec/unit/events_chain/inspect_spec.rb
-- spec/unit/events_chain/select_transition_spec.rb
+- spec/unit/events_chain/match_transition_spec.rb
+- spec/unit/events_chain/move_to_spec.rb
+- spec/unit/events_chain/states_for_spec.rb
 - spec/unit/events_spec.rb
 - spec/unit/handlers_spec.rb
+- spec/unit/hook_event/build_spec.rb
 - spec/unit/hook_event/eql_spec.rb
 - spec/unit/hook_event/initialize_spec.rb
+- spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb
 - spec/unit/hooks/inspect_spec.rb
 - spec/unit/hooks/register_spec.rb
 - spec/unit/if_unless_spec.rb
-- spec/unit/initialize_spec.rb
+- spec/unit/initial_spec.rb
 - spec/unit/inspect_spec.rb
 - spec/unit/is_spec.rb
 - spec/unit/log_transitions_spec.rb
@@ -115,8 +119,13 @@ files:
 - spec/unit/subscribers_spec.rb
 - spec/unit/target_spec.rb
 - spec/unit/terminated_spec.rb
+- spec/unit/transition/check_conditions_spec.rb
 - spec/unit/transition/inspect_spec.rb
-- spec/unit/transition/parse_states_spec.rb
+- spec/unit/transition/matches_spec.rb
+- spec/unit/transition/states_spec.rb
+- spec/unit/transition/to_state_spec.rb
+- spec/unit/trigger_spec.rb
+- spec/unit/undefined_transition/eql_spec.rb
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
@@ -154,26 +163,28 @@ test_files:
 - spec/unit/choice_spec.rb
 - spec/unit/define_spec.rb
 - spec/unit/definition_spec.rb
-- spec/unit/event/add_spec.rb
-- spec/unit/event/eql_spec.rb
-- spec/unit/event/initialize_spec.rb
-- spec/unit/event/inspect_spec.rb
-- spec/unit/event/next_transition_spec.rb
+- spec/unit/event_names_spec.rb
 - spec/unit/event_queue_spec.rb
-- spec/unit/events_chain/check_choice_conditions_spec.rb
+- spec/unit/events_chain/add_spec.rb
+- spec/unit/events_chain/cancel_transitions_spec.rb
+- spec/unit/events_chain/choice_transition_spec.rb
 - spec/unit/events_chain/clear_spec.rb
-- spec/unit/events_chain/insert_spec.rb
+- spec/unit/events_chain/events_spec.rb
 - spec/unit/events_chain/inspect_spec.rb
-- spec/unit/events_chain/select_transition_spec.rb
+- spec/unit/events_chain/match_transition_spec.rb
+- spec/unit/events_chain/move_to_spec.rb
+- spec/unit/events_chain/states_for_spec.rb
 - spec/unit/events_spec.rb
 - spec/unit/handlers_spec.rb
+- spec/unit/hook_event/build_spec.rb
 - spec/unit/hook_event/eql_spec.rb
 - spec/unit/hook_event/initialize_spec.rb
+- spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb
 - spec/unit/hooks/inspect_spec.rb
 - spec/unit/hooks/register_spec.rb
 - spec/unit/if_unless_spec.rb
-- spec/unit/initialize_spec.rb
+- spec/unit/initial_spec.rb
 - spec/unit/inspect_spec.rb
 - spec/unit/is_spec.rb
 - spec/unit/log_transitions_spec.rb
@@ -185,6 +196,11 @@ test_files:
 - spec/unit/subscribers_spec.rb
 - spec/unit/target_spec.rb
 - spec/unit/terminated_spec.rb
+- spec/unit/transition/check_conditions_spec.rb
 - spec/unit/transition/inspect_spec.rb
-- spec/unit/transition/parse_states_spec.rb
+- spec/unit/transition/matches_spec.rb
+- spec/unit/transition/states_spec.rb
+- spec/unit/transition/to_state_spec.rb
+- spec/unit/trigger_spec.rb
+- spec/unit/undefined_transition/eql_spec.rb
 has_rdoc: