finite_machine 0.11.2 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75abd57820e49c51d189b0a338477694f8ec7059
-  data.tar.gz: 5d983ca01af05a88d06626a2cd9f27207c87ad0d
+  metadata.gz: 64b466f571e5b537fe1836ce548cc742ffee4dfc
+  data.tar.gz: fbbc424571e422139ca7896cfd2465023ddab2ca
 SHA512:
-  metadata.gz: ecd18ac6229dd4293ef77c02f8390f1ad012840680526ff434a72b6dedb107fb85c237cdf028ef0c24574a376041becebeb49b0312ccf1a09a1307aafc74026e
-  data.tar.gz: de118ce61f3dce393546528420918b6d042b298f0c54a7d92baa853e54763e685e6deadc143954b6e894d004e4a8458f8ff1f23113f646c3a0bbf6009f52438b
+  metadata.gz: aa9c41cfd27257a3ae5f896bf00fd582ad5586e2e064632c93490173800c85fd6b9bb033a2d0ac5c10850b1ad86b12f79419e425f74497656a40bf85425332f4
+  data.tar.gz: 635d68e625689ac0b0c7adbdf04d50e6abf7c8f000d67e4e263d498693f7fb44d8b55f72dc79e6cb026189fc9a3b6a97f584add2b7e6154bf96afb24c92bae62

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  - 2.3.0
   - ruby-head
   - rbx-2
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [v0.11.3] - 2016-03-04
+
+### Added
+* Add performance tests & memory usage benchmarks
+
+### Changed
+* Change EventQueue to MessageQueue for handling generic asynchronous messages
+* Split async behaviour to use CallbackQueue for observed callbacks and EventQueue for async event triggers.
+* Change AsyncProxy and Observer to lazy load message queue
+
+### Fixed
+* Fix memory leak - issue #42 with help from @craiglittle
+
 ## [v0.11.2] - 2015-12-30
 
 ### Added
@@ -237,6 +250,7 @@
 ### Fixed
 * Fix bug - callback event object returns correct from state
 
+[v0.11.3]: https://github.com/peter-murach/finite_machine/compare/v0.11.2...v0.11.3
 [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

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 group :development do
   gem 'pry',   '~> 0.10.1'
   gem 'rspec', '~> 3.4.0'
+  gem 'rspec-benchmark', '~> 0.1.0'
   gem 'yard',  '~> 0.8.7'
 end
 

data/README.md

@@ -559,6 +559,7 @@ fm = FiniteMachine.define do
                  :low     => :medium,
                  :medium  => :high
   }
+end
 ```
 
 The same can be more naturally rewritten also as:
@@ -572,6 +573,7 @@ fm = FiniteMachine.define do
     event :bump, :low     => :medium
     event :bump, :medium  => :high
   }
+end
 ```
 
 ### 2.7 Silent transitions
@@ -1441,4 +1443,4 @@ Creating a standalone **FiniteMachine** brings a number of benefits, one of them
 
 ## Copyright
 
-Copyright (c) 2014-2015 Piotr Murach. See LICENSE for further details.
+Copyright (c) 2014-2016 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -5,4 +5,4 @@ require "bundler/gem_tasks"
 FileList['tasks/**/*.rake'].each(&method(:import))
 
 desc 'Run all specs'
-task ci: %w[ spec ]
+task ci: %w[ spec spec:perf ]

data/benchmarks/memory_usage.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'finite_machine'
+
+3.times do
+  puts
+
+  GC.start
+
+  before = GC.stat
+  p ObjectSpace.count_objects
+
+  1_000.times do
+    FiniteMachine.define
+  end
+
+  p ObjectSpace.count_objects
+  after = GC.stat
+
+  p "GC count: #{after[:count] - before[:count]}"
+end

data/finite_machine.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
+  spec.add_development_dependency 'rake'
 end

data/lib/finite_machine.rb

@@ -15,7 +15,7 @@ require "finite_machine/async_proxy"
 require "finite_machine/async_call"
 require "finite_machine/hook_event"
 require "finite_machine/env"
-require "finite_machine/event_queue"
+require "finite_machine/message_queue"
 require "finite_machine/events_chain"
 require "finite_machine/logger"
 require "finite_machine/transition"
@@ -66,7 +66,7 @@ module FiniteMachine
   MissingInitialStateError = Class.new(::StandardError)
 
   # Raised when event queue is already dead
-  EventQueueDeadError = Class.new(::StandardError)
+  MessageQueueDeadError = Class.new(::StandardError)
 
   # Raised when argument is already defined
   AlreadyDefinedError = Class.new(::ArgumentError)

data/lib/finite_machine/async_proxy.rb

@@ -2,11 +2,20 @@
 
 module FiniteMachine
   # An asynchronous messages proxy
+  #
+  # @api private
   class AsyncProxy
     include Threadable
 
     attr_threadsafe :context
 
+    # The queue for asynchronoous events
+    #
+    # @return [EventQueue]
+    #
+    # @api private
+    attr_threadsafe :event_queue
+
     # Initialize an AsynxProxy
     #
     # @param [Object] context
@@ -14,7 +23,10 @@ module FiniteMachine
     #
     # @api private
     def initialize(context)
-      self.context = context
+      self.context     = context
+      self.event_queue = MessageQueue.new
+
+      ObjectSpace.define_finalizer(self, self.class.cleanup(event_queue))
     end
 
     # Delegate asynchronous event to event queue
@@ -24,7 +36,20 @@ module FiniteMachine
       callable   = Callable.new(method_name)
       async_call = AsyncCall.new(context, callable, *args, &block)
 
+      event_queue.start unless event_queue.running?
       context.event_queue << async_call
     end
+
+    # Clean up event queue
+    #
+    # @api private
+    def self.cleanup(queue)
+      proc do
+        begin
+          queue && queue.shutdown
+        rescue MessageQueueDeadError
+        end
+      end
+    end
   end # AsyncProxy
 end # FiniteMachine

data/lib/finite_machine/{event_queue.rb → message_queue.rb}

@@ -1,26 +1,44 @@
 # encoding: utf-8
 
 module FiniteMachine
-  # A class responsible for running asynchronous events
-  class EventQueue
+  # Allows for storage of asynchronous messages such as events
+  # and callbacks.
+  #
+  # Used internally by {Observer} and {StateMachine}
+  #
+  # @api private
+  class MessageQueue
     include Threadable
 
     # Initialize an event queue
     #
     # @example
-    #  EventQueue.new
+    #   MessageQueue.new
     #
     # @api public
     def initialize
       @queue     = Queue.new
       @dead      = false
       @listeners = []
+      @thread    = nil
+    end
+
+    # Start a new thread with a queue of callback events to run
+    #
+    # @api private
+    def start
+      return if running?
 
       @thread = Thread.new do
+        Thread.current.abort_on_exception = true
         process_events
       end
     end
 
+    def running?
+      !@thread.nil? && alive?
+    end
+
     # Retrieve the next event
     #
     # @return [AsyncCall]
@@ -41,7 +59,13 @@ module FiniteMachine
     #
     # @api public
     def <<(event)
-      sync_exclusive { @queue << event }
+      sync_exclusive do
+        if @dead
+          discard_message(event)
+        else
+          @queue << event
+        end
+      end
       self
     end
 
@@ -89,6 +113,7 @@ module FiniteMachine
     #
     # @api public
     def join(timeout = nil)
+      return unless @thread
       timeout.nil? ? @thread.join : @thread.join(timeout)
     end
 
@@ -110,7 +135,7 @@ module FiniteMachine
         @dead = true
       end
       while !queue.empty?
-        Logger.debug "Discarded message: #{queue.pop}"
+        discard_message(queue.pop)
       end
       true
     end
@@ -127,6 +152,10 @@ module FiniteMachine
       sync_shared { @queue.size }
     end
 
+    def inspect
+      "#<#{self.class}:#{object_id.to_s(16)} @size=#{size}, @dead=#{@dead}>"
+    end
+
     private
 
     # Notify consumers about process event
@@ -154,5 +183,9 @@ module FiniteMachine
     rescue Exception => ex
       Logger.error "Error while running event: #{Logger.format_error(ex)}"
     end
+
+    def discard_message(message)
+      Logger.debug "Discarded message: #{message}" if $DEBUG
+    end
   end # EventQueue
 end # FiniteMachine

data/lib/finite_machine/observer.rb

@@ -16,11 +16,17 @@ module FiniteMachine
 
     # Initialize an Observer
     #
+    # @param [StateMachine] machine
+    #   reference to the current machine
+    #
     # @api public
     def initialize(machine)
-      @machine = machine
+      @machine        = machine
+      @hooks          = FiniteMachine::Hooks.new
+      @callback_queue = MessageQueue.new
+
       @machine.subscribe(self)
-      @hooks = FiniteMachine::Hooks.new
+      ObjectSpace.define_finalizer(self, self.class.cleanup(@callback_queue))
     end
 
     # Evaluate in current context
@@ -130,24 +136,6 @@ module FiniteMachine
 
     private
 
-    # Defer callback execution
-    #
-    # @api private
-    def defer(callable, trans_event, *data)
-      async_call = AsyncCall.new(machine, callable, trans_event, *data)
-      machine.event_queue << async_call
-    end
-
-    # Create callable instance
-    #
-    # @api private
-    def create_callable(hook)
-      callback = proc do |trans_event, *data|
-        machine.instance_exec(trans_event, *data, &hook)
-      end
-      Callable.new(callback)
-    end
-
     # Handle callback and decide if run synchronously or asynchronously
     #
     # @param [Proc] :hook
@@ -177,6 +165,25 @@ module FiniteMachine
       end
     end
 
+    # Defer callback execution
+    #
+    # @api private
+    def defer(callable, trans_event, *data)
+      async_call = AsyncCall.new(machine, callable, trans_event, *data)
+      @callback_queue.start unless @callback_queue.running?
+      @callback_queue << async_call
+    end
+
+    # Create callable instance
+    #
+    # @api private
+    def create_callable(hook)
+      callback = proc do |trans_event, *data|
+        machine.instance_exec(trans_event, *data, &hook)
+      end
+      Callable.new(callback)
+    end
+
     # Callback names including all states and events
     #
     # @return [Array[Symbol]]
@@ -218,5 +225,17 @@ module FiniteMachine
       *_, callback_name = *method_name.to_s.match(/^(\w*?on_\w+?)_(\w+)$/)
       callback_name && callback_names.include?(:"#{callback_name}")
     end
+
+    # Clean up callback queue
+    #
+    # @api private
+    def self.cleanup(queue)
+      proc do
+        begin
+          queue && queue.shutdown
+        rescue MessageQueueDeadError
+        end
+      end
+    end
   end # Observer
 end # FiniteMachine

data/lib/finite_machine/state_machine.rb

@@ -57,13 +57,6 @@ 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
 
@@ -72,13 +65,14 @@ module FiniteMachine
 
     def_delegator :events_dsl, :event
 
+    def_delegator :@async_proxy, :event_queue
+
     # Initialize state machine
     #
     # @api private
     def initialize(*args, &block)
       attributes     = args.last.is_a?(Hash) ? args.pop : {}
 
-      @event_queue   = EventQueue.new
       @initial_state = DEFAULT_STATE
       @async_proxy   = AsyncProxy.new(self)
       @subscribers   = Subscribers.new
@@ -120,7 +114,7 @@ module FiniteMachine
     # @api public
     def async(method_name = nil, *args, &block)
       if method_name
-        @async_proxy.method_missing method_name, *args, &block
+        @async_proxy.method_missing(method_name, *args, &block)
       else
         @async_proxy
       end

data/lib/finite_machine/version.rb

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

data/spec/performance/benchmark_spec.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+RSpec.describe FiniteMachine do
+  include RSpec::Benchmark::Matchers
+
+  class Measurement
+    attr_reader :steps, :loops
+
+    def initialize
+      @steps = 0
+      @loops = 0
+    end
+
+    def inc_step
+      @steps += 1
+    end
+
+    def inc_loop
+      @loops += 1
+    end
+  end
+
+  it "correctly loops through events" do
+    measurement = Measurement.new
+
+    fsm = FiniteMachine.define do
+      initial :green
+
+      target(measurement)
+
+      events {
+        event :next, :green => :yellow,
+                     :yellow => :red,
+                     :red => :green
+      }
+
+      callbacks {
+        on_enter do |event| target.inc_step; true end
+        on_enter :red do |event| target.inc_loop; true end
+      }
+    end
+
+    100.times { fsm.next }
+
+    expect(measurement.steps).to eq(100)
+    expect(measurement.loops).to eq(100 / 3)
+  end
+
+  it "performs at least 300 ips" do
+    fsm = FiniteMachine.define do
+      initial :green
+
+      events {
+        event :next, :green => :yellow,
+                     :yellow => :red,
+                     :red => :green
+      }
+    end
+
+    expect { fsm.next }.to perform_at_least(400).ips
+  end
+end

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@ end
 
 require 'finite_machine'
 require 'thwait'
+require 'rspec-benchmark'
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

data/spec/unit/async_callbacks_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+RSpec.describe FiniteMachine, 'async callbacks' do
+
+  it "permits async callback" do
+    called = []
+    fsm = FiniteMachine.define do
+      initial :green, silent: false
+
+      events {
+        event :slow,  :green  => :yellow
+        event :go,    :yellow => :green
+      }
+
+      callbacks {
+        on_enter  :green,  :async  do |event| called << 'on_enter_green' end
+        on_before :slow,   :async  do |event| called << 'on_before_slow'  end
+        on_exit   :yellow, :async  do |event| called << 'on_exit_yellow' end
+        on_after  :go,     :async  do |event| called << 'on_after_go'     end
+      }
+    end
+    fsm.slow
+    fsm.go
+    sleep 0.1
+    expect(called).to match_array([
+      'on_enter_green',
+      'on_before_slow',
+      'on_exit_yellow',
+      'on_enter_green',
+      'on_after_go'
+    ])
+  end
+end

data/spec/unit/async_events_spec.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe FiniteMachine, 'async_events' do
+RSpec.describe FiniteMachine, 'async events' do
 
   it 'runs events asynchronously' do
     called = []
@@ -106,33 +104,4 @@ RSpec.describe FiniteMachine, 'async_events' do
     expect(fsmFoo.current).to eql(:yellow)
     expect(fsmBar.current).to eql(:yellow)
   end
-
-  it "permits async callback" do
-    called = []
-    fsm = FiniteMachine.define do
-      initial :green, silent: false
-
-      events {
-        event :slow,  :green  => :yellow
-        event :go,    :yellow => :green
-      }
-
-      callbacks {
-        on_enter  :green,  :async  do |event| called << 'on_enter_green' end
-        on_before :slow,   :async  do |event| called << 'on_before_slow'  end
-        on_exit   :yellow, :async  do |event| called << 'on_exit_yellow' end
-        on_after  :go,     :async  do |event| called << 'on_after_go'     end
-      }
-    end
-    fsm.slow
-    fsm.go
-    sleep 0.1
-    expect(called).to match_array([
-      'on_enter_green',
-      'on_before_slow',
-      'on_exit_yellow',
-      'on_enter_green',
-      'on_after_go'
-    ])
-  end
 end

data/spec/unit/event_queue_spec.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
 
-require 'spec_helper'
-
-RSpec.describe FiniteMachine::EventQueue do
+RSpec.describe FiniteMachine::MessageQueue do
 
   subject(:event_queue) { described_class.new }
 
   it "dispatches all events" do
+    event_queue.start
     called = []
     event1 = double(:event1, dispatch: called << 'event1_dispatched')
     event2 = double(:event2, dispatch: called << 'event2_dispatched')
@@ -18,7 +17,9 @@ RSpec.describe FiniteMachine::EventQueue do
   end
 
   it "logs error" do
-    event = double(:event)
+    event_queue.start
+    event = spy(:event)
+    allow(event).to receive(:dispatch) { raise }
     expect(FiniteMachine::Logger).to receive(:error)
     event_queue << event
     event_queue.join(0.01)
@@ -26,6 +27,7 @@ RSpec.describe FiniteMachine::EventQueue do
   end
 
   it "notifies listeners" do
+    event_queue.start
     called = []
     event1 = double(:event1, dispatch: true)
     event2 = double(:event2, dispatch: true)
@@ -38,6 +40,7 @@ RSpec.describe FiniteMachine::EventQueue do
   end
 
   it "allows to shutdown event queue" do
+    event_queue.start
     event1 = double(:event1, dispatch: true)
     event2 = double(:event2, dispatch: true)
     event3 = double(:event3, dispatch: true)

data/tasks/spec.rake

@@ -18,6 +18,11 @@ begin
     RSpec::Core::RakeTask.new(:integration) do |task|
       task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
     end
+
+    desc 'Run performance specs'
+    RSpec::Core::RakeTask.new(:perf) do |task|
+      task.pattern = 'spec/performance{,/*/**}/*_spec.rb'
+    end
   end
 
 rescue LoadError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.11.3
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -49,8 +55,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .ruby-gemset
-- .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -58,6 +62,7 @@ files:
 - README.md
 - Rakefile
 - assets/finite_machine_logo.png
+- benchmarks/memory_usage.rb
 - examples/atm.rb
 - examples/bug_system.rb
 - finite_machine.gemspec
@@ -71,12 +76,12 @@ files:
 - lib/finite_machine/dsl.rb
 - lib/finite_machine/env.rb
 - lib/finite_machine/event_definition.rb
-- lib/finite_machine/event_queue.rb
 - lib/finite_machine/events_chain.rb
 - lib/finite_machine/hook_event.rb
 - lib/finite_machine/hooks.rb
 - lib/finite_machine/listener.rb
 - lib/finite_machine/logger.rb
+- lib/finite_machine/message_queue.rb
 - lib/finite_machine/observer.rb
 - lib/finite_machine/safety.rb
 - lib/finite_machine/state_definition.rb
@@ -91,8 +96,10 @@ files:
 - lib/finite_machine/undefined_transition.rb
 - lib/finite_machine/version.rb
 - spec/integration/system_spec.rb
+- spec/performance/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/unit/alias_target_spec.rb
+- spec/unit/async_callbacks_spec.rb
 - spec/unit/async_events_spec.rb
 - spec/unit/callable/call_spec.rb
 - spec/unit/callbacks_spec.rb
@@ -171,8 +178,10 @@ specification_version: 4
 summary: A minimal finite state machine with a straightforward syntax.
 test_files:
 - spec/integration/system_spec.rb
+- spec/performance/benchmark_spec.rb
 - spec/spec_helper.rb
 - spec/unit/alias_target_spec.rb
+- spec/unit/async_callbacks_spec.rb
 - spec/unit/async_events_spec.rb
 - spec/unit/callable/call_spec.rb
 - spec/unit/callbacks_spec.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-finite_machine

data/.ruby-version

@@ -1 +0,0 @@
-2.0.0