finite_machine 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d61855a6c9bcf4a134d260eed0b9926250c165e2
-  data.tar.gz: 8700fa2dccb31e106fa9fa7769466d4a4b22fc24
+  metadata.gz: 75abd57820e49c51d189b0a338477694f8ec7059
+  data.tar.gz: 5d983ca01af05a88d06626a2cd9f27207c87ad0d
 SHA512:
-  metadata.gz: 199260fd23c214d00e371a803178ee8693fb9f236ca3e68f08a59f181f8d8f251e9a5e340f60deb2b5894358517bf892a8410e6f97e80a717b12ca280c3e50b6
-  data.tar.gz: 53371bc2d260b5c9e2cf48c03769891540227b967f85039aa878731a9efe6b3be68dffce30a2b45375be409486449d410f3d521eb691fa8b9bc3296982c58402
+  metadata.gz: ecd18ac6229dd4293ef77c02f8390f1ad012840680526ff434a72b6dedb107fb85c237cdf028ef0c24574a376041becebeb49b0312ccf1a09a1307aafc74026e
+  data.tar.gz: de118ce61f3dce393546528420918b6d042b298f0c54a7d92baa853e54763e685e6deadc143954b6e894d004e4a8458f8ff1f23113f646c3a0bbf6009f52438b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v0.11.2] - 2015-12-30
+
+### Added
+* Add infering of state or event name based off hook type
+
+### Changed
+* Remove ThreadContext for global queue synchronization
+* Change EventQueue to use Threadable module to sync access
+
+### Fixed
+* Fix bug with two state machines locking up on callback events due to race condition with help from @domokos
+
 ## [v0.11.1] - 2015-12-17
 
 ### Fixed
@@ -225,6 +237,7 @@
 ### Fixed
 * Fix bug - callback event object returns correct from state
 
+[v0.11.2]: https://github.com/peter-murach/finite_machine/compare/v0.11.1...v0.11.2
 [v0.11.1]: https://github.com/peter-murach/finite_machine/compare/v0.11.0...v0.11.1
 [v0.11.0]: https://github.com/peter-murach/finite_machine/compare/v0.10.2...v0.11.0
 [v0.10.2]: https://github.com/peter-murach/finite_machine/compare/v0.10.1...v0.10.2

data/finite_machine.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = [""]
   spec.description   = %q{A minimal finite state machine with a straightforward syntax. You can quickly model states, add callbacks and use object-oriented techniques to integrate with ORMs.}
   spec.summary       = %q{A minimal finite state machine with a straightforward syntax.}
-  spec.homepage      = "https://github.com/peter-murach/finite_machine"
+  spec.homepage      = "http://peter-murach.github.io/finite_machine/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/finite_machine.rb

@@ -8,7 +8,6 @@ require "forwardable"
 require "finite_machine/version"
 require "finite_machine/threadable"
 require "finite_machine/safety"
-require "finite_machine/thread_context"
 require "finite_machine/callable"
 require "finite_machine/catchable"
 require "finite_machine/choice_merger"

data/lib/finite_machine/event_queue.rb

@@ -3,6 +3,8 @@
 module FiniteMachine
   # A class responsible for running asynchronous events
   class EventQueue
+    include Threadable
+
     # Initialize an event queue
     #
     # @example
@@ -11,7 +13,6 @@ module FiniteMachine
     # @api public
     def initialize
       @queue     = Queue.new
-      @mutex     = Mutex.new
       @dead      = false
       @listeners = []
 
@@ -26,7 +27,7 @@ module FiniteMachine
     #
     # @api private
     def next_event
-      @queue.pop
+      sync_shared { @queue.pop }
     end
 
     # Add asynchronous event to the event queue
@@ -40,7 +41,7 @@ module FiniteMachine
     #
     # @api public
     def <<(event)
-      @mutex.synchronize { @queue << event }
+      sync_exclusive { @queue << event }
       self
     end
 
@@ -48,9 +49,11 @@ module FiniteMachine
     #
     # @api public
     def subscribe(*args, &block)
-      listener = Listener.new(*args)
-      listener.on_delivery(&block)
-      @listeners << listener
+      sync_exclusive do
+        listener = Listener.new(*args)
+        listener.on_delivery(&block)
+        @listeners << listener
+      end
     end
 
     # Check if there are any events to handle
@@ -60,7 +63,7 @@ module FiniteMachine
     #
     # @api public
     def empty?
-      @queue.empty?
+      sync_shared { @queue.empty? }
     end
 
     # Check if the event queue is alive
@@ -72,7 +75,7 @@ module FiniteMachine
     #
     # @api public
     def alive?
-      !@dead
+      sync_shared { !@dead }
     end
 
     # Join the event queue from current thread
@@ -85,8 +88,8 @@ module FiniteMachine
     # @return [nil, Thread]
     #
     # @api public
-    def join(timeout)
-      @thread.join timeout
+    def join(timeout = nil)
+      timeout.nil? ? @thread.join : @thread.join(timeout)
     end
 
     # Shut down this event queue and clean it up
@@ -100,15 +103,13 @@ module FiniteMachine
     def shutdown
       fail EventQueueDeadError, 'event queue already dead' if @dead
 
-      @mutex.lock
-      begin
+      queue = []
+      sync_exclusive do
         queue = @queue
         @queue.clear
         @dead = true
-      ensure
-        @mutex.unlock rescue nil
       end
-      while(!queue.empty?)
+      while !queue.empty?
         Logger.debug "Discarded message: #{queue.pop}"
       end
       true
@@ -123,7 +124,7 @@ module FiniteMachine
     #
     # @api public
     def size
-      @mutex.synchronize { @queue.size }
+      sync_shared { @queue.size }
     end
 
     private
@@ -134,7 +135,9 @@ module FiniteMachine
     #
     # @api private
     def notify_listeners(event)
-      @listeners.each { |listener| listener.handle_delivery(event) }
+      sync_shared do
+        @listeners.each { |listener| listener.handle_delivery(event) }
+      end
     end
 
     # Process all the events

data/lib/finite_machine/hook_event.rb

@@ -74,6 +74,18 @@ module FiniteMachine
       new(state_or_action, event_name, from)
     end
 
+    # Deduce default name based on even type
+    #
+    # @param [HookEvent] event_type
+    #
+    # @return [Symbol]
+    #   out of :any or :any_event
+    #
+    # @api public
+    def self.infer_default_name(event_type)
+      event_type < Anyaction ? ANY_EVENT : ANY_STATE
+    end
+
     # Notify subscriber about this event
     #
     # @param [Observer] subscriber

data/lib/finite_machine/hooks.rb

@@ -30,6 +30,9 @@ module FiniteMachine
     # @example
     #   hooks.register HookEvent::Enter, :green do ... end
     #
+    # @example
+    #   hooks.register HookEvent::Before, :any do ... end
+    #
     # @return [Hash]
     #
     # @api public

data/lib/finite_machine/observer.rb

@@ -30,33 +30,34 @@ module FiniteMachine
       instance_eval(&block)
     end
 
-    # Register callback for a given event type
+    # Register callback for a given hook type
     #
-    # @param [Symbol, FiniteMachine::HookEvent] event_type
-    # @param [Array] args
-    # @param [Proc]  callback
+    # @param [HookEvent] hook_type
+    # @param [Symbol] state_or_event_name
+    # @param [Proc] callback
+    #
+    # @example
+    #   observer.on HookEvent::Enter, :green
     #
     # @api public
-    # TODO: throw error if event type isn't handled
-    def on(event_type = HookEvent, *args, &callback)
+    def on(hook_type, state_or_event_name = nil, async = nil, &callback)
       sync_exclusive do
-        name, async, _ = args
-        if name.nil?
-          name = event_type < HookEvent::Anyaction ? ANY_EVENT : ANY_STATE
+        if state_or_event_name.nil?
+          state_or_event_name = HookEvent.infer_default_name(hook_type)
         end
         async = false if async.nil?
-        ensure_valid_callback_name!(event_type, name)
+        ensure_valid_callback_name!(hook_type, state_or_event_name)
         callback.extend(Async) if async == :async
-        hooks.register event_type, name, callback
+        hooks.register(hook_type, state_or_event_name, callback)
       end
     end
 
     # Unregister callback for a given event
     #
     # @api public
-    def off(event_type, name = ANY_STATE, &callback)
+    def off(hook_type, name = ANY_STATE, &callback)
       sync_exclusive do
-        hooks.unregister event_type, name, callback
+        hooks.unregister hook_type, name, callback
       end
     end
 
@@ -116,11 +117,11 @@ module FiniteMachine
     # @api public
     def emit(event, *data)
       sync_exclusive do
-        [event.type].each do |event_type|
+        [event.type].each do |hook_type|
           [event.name, ANY_STATE, ANY_EVENT].each do |event_name|
-            hooks.call(event_type, event_name) do |hook|
+            hooks.call(hook_type, event_name) do |hook|
               handle_callback(hook, event, *data)
-              off(event_type, event_name, &hook) if hook.is_a?(Once)
+              off(hook_type, event_name, &hook) if hook.is_a?(Once)
             end
           end
         end

data/lib/finite_machine/state_machine.rb

@@ -5,7 +5,6 @@ module FiniteMachine
   class StateMachine
     include Threadable
     include Catchable
-    include ThreadContext
     extend Forwardable
 
     # Initial state, defaults to :none
@@ -58,6 +57,13 @@ module FiniteMachine
     # @api private
     attr_threadsafe :subscribers
 
+    # The queue for asynchronoous events
+    #
+    # @return [EventQueue]
+    #
+    # @api private
+    attr_threadsafe :event_queue
+
     # Allow or not logging of transitions
     attr_threadsafe :log_transitions
 
@@ -71,8 +77,8 @@ module FiniteMachine
     # @api private
     def initialize(*args, &block)
       attributes     = args.last.is_a?(Hash) ? args.pop : {}
-      self.event_queue = EventQueue.new
 
+      @event_queue   = EventQueue.new
       @initial_state = DEFAULT_STATE
       @async_proxy   = AsyncProxy.new(self)
       @subscribers   = Subscribers.new

data/lib/finite_machine/threadable.rb

@@ -4,7 +4,6 @@ module FiniteMachine
   # A mixin to allow instance methods to be synchronized
   module Threadable
     module InstanceMethods
-
       # Exclusive lock
       #
       # @return [nil]

data/lib/finite_machine/two_phase_lock.rb

@@ -11,13 +11,13 @@ module FiniteMachine
     #
     # @api private
     def sync
-      @sync ||= Sync.new
+      @sync = Sync.new
     end
 
     # Synchronize given block of code
     #
     # @param [Symbol] mode
-    #   the synchronization mode out of :SH and :EX
+    #   the lock mode out of :SH, :EX, :UN
     #
     # @return [nil]
     #

data/lib/finite_machine/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module FiniteMachine
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

data/spec/integration/system_spec.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+RSpec.describe FiniteMachine, 'system' do
+
+  it "doesn't share state between machine callbacks" do
+    callbacks = []
+    stub_const("FSM_A", Class.new(FiniteMachine::Definition) do
+      events {
+        event :init, :none => :green
+        event :green, :any => :green
+      }
+      callbacks {
+        on_before do |event|
+          callbacks << "fsmA on_before(#{event.to})"
+        end
+        on_enter_green do |event|
+          target.fire
+          callbacks << "fsmA on_enter_green"
+        end
+        once_on_enter_green do |event|
+          callbacks << "fsmA once_on_enter_green"
+        end
+      }
+    end)
+
+    stub_const("FSM_B", Class.new(FiniteMachine::Definition) do
+      events {
+        event :init,  :none    => :stopped
+        event :start, :stopped => :started
+      }
+      callbacks {
+        on_before do |event|
+          callbacks << "fsmB on_before(#{event.to})"
+        end
+        on_enter_started do |event|
+          callbacks << "fsmB on_enter_started"
+        end
+      }
+    end)
+
+    class Backend
+      def initialize
+        @fsmB = FSM_B.new
+        @fsmB.init
+        @signal = Mutex.new
+      end
+
+      def operate
+        @signal.unlock if @signal.locked?
+        @worker = Thread.new do
+          while !@signal.locked? do
+            sleep 0.01
+          end
+          Thread.current.abort_on_exception = true
+          @fsmB.start
+        end
+      end
+
+      def stopit
+        @signal.lock
+        @worker.join
+      end
+    end
+
+    class Fire
+      def initialize
+        @fsmA = FSM_A.new
+        @fsmA.target(self)
+
+        @backend = Backend.new
+        @backend.operate
+      end
+
+      def fire
+        @backend.stopit
+      end
+
+      def operate
+        @fsmA.green
+      end
+    end
+
+    fire = Fire.new
+    fire.operate
+
+    expect(callbacks).to match_array([
+      'fsmA on_before(green)',
+      'fsmA on_enter_green',
+      'fsmA once_on_enter_green',
+      'fsmB on_before(stopped)',
+      'fsmB on_before(started)',
+      'fsmB on_enter_started'
+    ])
+  end
+end

data/spec/unit/async_events_spec.rb

@@ -56,13 +56,13 @@ RSpec.describe FiniteMachine, 'async_events' do
     end
     expect(fsm.current).to eql(:none)
     fsm.async.go(:foo)
-    fsm.event_queue.join 0.01
+    fsm.event_queue.join 0.02
     expect(fsm.current).to eql(:green)
     expect(called).to eql(["cond_none_green(#{fsm},foo)"])
 
     expect(fsm.current).to eql(:green)
     fsm.async.stop(:bar)
-    fsm.event_queue.join 0.01
+    fsm.event_queue.join 0.02
     expect(fsm.current).to eql(:red)
     expect(called).to match_array([
       "cond_none_green(#{fsm},foo)",
@@ -97,7 +97,8 @@ RSpec.describe FiniteMachine, 'async_events' do
       fsmBar.async.slow(:bar)
     }
     ThreadsWait.all_waits(foo_thread, bar_thread)
-    sleep 0.01
+    fsmFoo.event_queue.join(0.01)
+    fsmBar.event_queue.join(0.01)
     expect(called).to match_array([
       '(foo)on_enter_yellow_foo',
       '(bar)on_enter_yellow_bar'

data/spec/unit/define_spec.rb

@@ -52,6 +52,4 @@ RSpec.describe FiniteMachine, 'define' do
       expect(called).to match_array(['on_enter_yellow', 'error_handler'])
     end
   end
-
-  xit "creates multiple machines"
 end

data/spec/unit/event_queue_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe FiniteMachine::EventQueue do
     expect(event_queue.size).to be_zero
     event_queue << event1
     event_queue << event2
-    sleep 0.001
+    event_queue.join(0.001)
     expect(called).to match_array(['event1_dispatched', 'event2_dispatched'])
   end
 
@@ -21,7 +21,7 @@ RSpec.describe FiniteMachine::EventQueue do
     event = double(:event)
     expect(FiniteMachine::Logger).to receive(:error)
     event_queue << event
-    sleep 0.01
+    event_queue.join(0.01)
     expect(event_queue).to be_empty
   end
 
@@ -32,7 +32,8 @@ RSpec.describe FiniteMachine::EventQueue do
     event3 = double(:event3, dispatch: true)
     event_queue.subscribe(:listener1) { |event| called << event }
     event_queue << event1 << event2 << event3
-    sleep 0.01
+    event_queue.join(0.02)
+    event_queue.shutdown
     expect(called).to match_array([event1, event2, event3])
   end
 
@@ -45,7 +46,7 @@ RSpec.describe FiniteMachine::EventQueue do
     event_queue << event2
     event_queue.shutdown
     event_queue << event3
-    sleep 0.001
+    event_queue.join(0.001)
     expect(event_queue.alive?).to be(false)
   end
 end

data/spec/unit/hook_event/infer_default_name_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+RSpec.describe FiniteMachine::HookEvent, '#infer_default_name' do
+  it "infers default name for state" do
+    hook_event = described_class::Enter
+    expect(described_class.infer_default_name(hook_event)).to eq(:any)
+  end
+
+  it "infers default name for event" do
+    hook_event = described_class::Before
+    expect(described_class.infer_default_name(hook_event)).to eq(:any_event)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,6 @@ files:
 - lib/finite_machine/state_machine.rb
 - lib/finite_machine/state_parser.rb
 - lib/finite_machine/subscribers.rb
-- lib/finite_machine/thread_context.rb
 - lib/finite_machine/threadable.rb
 - lib/finite_machine/transition.rb
 - lib/finite_machine/transition_builder.rb
@@ -91,6 +90,7 @@ files:
 - lib/finite_machine/two_phase_lock.rb
 - lib/finite_machine/undefined_transition.rb
 - lib/finite_machine/version.rb
+- spec/integration/system_spec.rb
 - spec/spec_helper.rb
 - spec/unit/alias_target_spec.rb
 - spec/unit/async_events_spec.rb
@@ -115,6 +115,7 @@ files:
 - spec/unit/handlers_spec.rb
 - spec/unit/hook_event/build_spec.rb
 - spec/unit/hook_event/eql_spec.rb
+- spec/unit/hook_event/infer_default_name_spec.rb
 - spec/unit/hook_event/initialize_spec.rb
 - spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb
@@ -144,7 +145,7 @@ files:
 - tasks/console.rake
 - tasks/coverage.rake
 - tasks/spec.rake
-homepage: https://github.com/peter-murach/finite_machine
+homepage: http://peter-murach.github.io/finite_machine/
 licenses:
 - MIT
 metadata: {}
@@ -169,6 +170,7 @@ signing_key:
 specification_version: 4
 summary: A minimal finite state machine with a straightforward syntax.
 test_files:
+- spec/integration/system_spec.rb
 - spec/spec_helper.rb
 - spec/unit/alias_target_spec.rb
 - spec/unit/async_events_spec.rb
@@ -193,6 +195,7 @@ test_files:
 - spec/unit/handlers_spec.rb
 - spec/unit/hook_event/build_spec.rb
 - spec/unit/hook_event/eql_spec.rb
+- spec/unit/hook_event/infer_default_name_spec.rb
 - spec/unit/hook_event/initialize_spec.rb
 - spec/unit/hook_event/notify_spec.rb
 - spec/unit/hooks/call_spec.rb

data/lib/finite_machine/thread_context.rb

@@ -1,17 +0,0 @@
-# encoding: utf-8
-
-module FiniteMachine
-  # A mixin to allow sharing of thread context
-  module ThreadContext
-
-    # @api public
-    def event_queue
-      Thread.current[:finite_machine_event_queue]
-    end
-
-    # @api public
-    def event_queue=(value)
-      Thread.current[:finite_machine_event_queue] = value
-    end
-  end # ThreadContext
-end # FiniteMachine