finite_machine 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d4822c18a4beea1845f39a33e910051412c7fea3479783b361897ecbc60b006
-  data.tar.gz: ec4f8663f7ede7eb0357b9404b814ca670a523923f6c0b4435c2f09acd6c2e32
+  metadata.gz: d237cab6b48c16f3dbf2832706984e2b511f412085a11968504e23d154448e21
+  data.tar.gz: 48c5b0536832254ea609fd0047cb30efbd129b68b091ab462abb170a435b4fd8
 SHA512:
-  metadata.gz: 57bdadc9ea5349045fe6711983dae949e8a8e78d569dbe7e91ac410b7afec7f1a2cfbb95f6b400b068ffcb1a7c4f783e84575f0680c2956ec5dc8473d91ee312
-  data.tar.gz: b71c1fe3d0f8701fff5060b8dd6882fa9682e2a79dddbfda865d6d553c9130b896690ad16b4607a567e4d03f95a5dd0b4d33517cf008883e7dd1eab1851e411e
+  metadata.gz: f27fb87731702dc2df9b24d7a4da1525ec7bce7b432a49b278947010d4ff132bdd5d4c41002aebe39cbb354e03beda1c35cfabd4a2cc7f56872521688dfd3dd8
+  data.tar.gz: e7f3348c118d77359639ad5909048404bcdb7abbc14e775288cb07f8f7681141cb5a6252a4f0c377a7f9e32dc5d5f447a40c1e734f58397ef713809936e1207c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## [v0.14.1] - 2023-10-08
+
+### Fixed
+* Fix defining object finalizer in Ruby 3.1 to reference a UUID string
+  by Vadim Kononov(@vkononov)
+* Fix message queue shutdown to raise valid error
+* Fix any_event and any_state methods in the define method and definition class
+* Fix hooks_map initialization to be fully thread-safe
+  by Maciej Mensfeld(@mensfeld)
+
 ## [v0.14.0] - 2020-09-12
 
 ### Added
@@ -312,27 +322,28 @@
 
 * Initial release
 
-[v0.14.0]: https://github.com/peter-murach/finite_machine/compare/v0.13.0...v0.14.0
-[v0.13.0]: https://github.com/peter-murach/finite_machine/compare/v0.12.1...v0.13.0
-[v0.12.1]: https://github.com/peter-murach/finite_machine/compare/v0.12.0...v0.12.1
-[v0.12.0]: https://github.com/peter-murach/finite_machine/compare/v0.11.3...v0.12.0
-[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
-[v0.10.2]: https://github.com/peter-murach/finite_machine/compare/v0.10.1...v0.10.2
-[v0.10.1]: https://github.com/peter-murach/finite_machine/compare/v0.10.0...v0.10.1
-[v0.10.0]: https://github.com/peter-murach/finite_machine/compare/v0.9.2...v0.10.0
-[v0.9.2]: https://github.com/peter-murach/finite_machine/compare/v0.9.1...v0.9.2
-[v0.9.1]: https://github.com/peter-murach/finite_machine/compare/v0.9.0...v0.9.1
-[v0.9.0]: https://github.com/peter-murach/finite_machine/compare/v0.8.1...v0.9.0
-[v0.8.1]: https://github.com/peter-murach/finite_machine/compare/v0.8.0...v0.8.1
-[v0.8.0]: https://github.com/peter-murach/finite_machine/compare/v0.7.1...v0.8.0
-[v0.7.1]: https://github.com/peter-murach/finite_machine/compare/v0.7.0...v0.7.1
-[v0.7.0]: https://github.com/peter-murach/finite_machine/compare/v0.6.1...v0.7.0
-[v0.6.1]: https://github.com/peter-murach/finite_machine/compare/v0.6.0...v0.6.1
-[v0.6.0]: https://github.com/peter-murach/finite_machine/compare/v0.5.0...v0.6.0
-[v0.5.0]: https://github.com/peter-murach/finite_machine/compare/v0.4.0...v0.5.0
-[v0.4.0]: https://github.com/peter-murach/finite_machine/compare/v0.3.0...v0.4.0
-[v0.3.0]: https://github.com/peter-murach/finite_machine/compare/v0.2.0...v0.3.0
-[v0.2.0]: https://github.com/peter-murach/finite_machine/compare/v0.1.0...v0.2.0
+[v0.14.1]: https://github.com/piotrmurach/finite_machine/compare/v0.14.0...v0.14.1
+[v0.14.0]: https://github.com/piotrmurach/finite_machine/compare/v0.13.0...v0.14.0
+[v0.13.0]: https://github.com/piotrmurach/finite_machine/compare/v0.12.1...v0.13.0
+[v0.12.1]: https://github.com/piotrmurach/finite_machine/compare/v0.12.0...v0.12.1
+[v0.12.0]: https://github.com/piotrmurach/finite_machine/compare/v0.11.3...v0.12.0
+[v0.11.3]: https://github.com/piotrmurach/finite_machine/compare/v0.11.2...v0.11.3
+[v0.11.2]: https://github.com/piotrmurach/finite_machine/compare/v0.11.1...v0.11.2
+[v0.11.1]: https://github.com/piotrmurach/finite_machine/compare/v0.11.0...v0.11.1
+[v0.11.0]: https://github.com/piotrmurach/finite_machine/compare/v0.10.2...v0.11.0
+[v0.10.2]: https://github.com/piotrmurach/finite_machine/compare/v0.10.1...v0.10.2
+[v0.10.1]: https://github.com/piotrmurach/finite_machine/compare/v0.10.0...v0.10.1
+[v0.10.0]: https://github.com/piotrmurach/finite_machine/compare/v0.9.2...v0.10.0
+[v0.9.2]: https://github.com/piotrmurach/finite_machine/compare/v0.9.1...v0.9.2
+[v0.9.1]: https://github.com/piotrmurach/finite_machine/compare/v0.9.0...v0.9.1
+[v0.9.0]: https://github.com/piotrmurach/finite_machine/compare/v0.8.1...v0.9.0
+[v0.8.1]: https://github.com/piotrmurach/finite_machine/compare/v0.8.0...v0.8.1
+[v0.8.0]: https://github.com/piotrmurach/finite_machine/compare/v0.7.1...v0.8.0
+[v0.7.1]: https://github.com/piotrmurach/finite_machine/compare/v0.7.0...v0.7.1
+[v0.7.0]: https://github.com/piotrmurach/finite_machine/compare/v0.6.1...v0.7.0
+[v0.6.1]: https://github.com/piotrmurach/finite_machine/compare/v0.6.0...v0.6.1
+[v0.6.0]: https://github.com/piotrmurach/finite_machine/compare/v0.5.0...v0.6.0
+[v0.5.0]: https://github.com/piotrmurach/finite_machine/compare/v0.4.0...v0.5.0
+[v0.4.0]: https://github.com/piotrmurach/finite_machine/compare/v0.3.0...v0.4.0
+[v0.3.0]: https://github.com/piotrmurach/finite_machine/compare/v0.2.0...v0.3.0
+[v0.2.0]: https://github.com/piotrmurach/finite_machine/compare/v0.1.0...v0.2.0

data/README.md

@@ -5,7 +5,7 @@
 # FiniteMachine
 
 [![Gem Version](https://badge.fury.io/rb/finite_machine.svg)][gem]
-[![Build Status](https://secure.travis-ci.org/piotrmurach/finite_machine.svg?branch=master)][travis]
+[![Actions CI](https://github.com/piotrmurach/finite_machine/workflows/CI/badge.svg?branch=master)][gh_actions_ci]
 [![Build status](https://ci.appveyor.com/api/projects/status/8ho4ijacpr7b4f4t?svg=true)][appveyor]
 [![Code Climate](https://codeclimate.com/github/piotrmurach/finite_machine/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/github/piotrmurach/finite_machine/badge.svg?branch=master)][coverage]
@@ -13,7 +13,7 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
 
 [gem]: http://badge.fury.io/rb/finite_machine
-[travis]: http://travis-ci.org/piotrmurach/finite_machine
+[gh_actions_ci]: https://github.com/piotrmurach/finite_machine/actions?query=workflow%3ACI
 [appveyor]: https://ci.appveyor.com/project/piotrmurach/finite-machine
 [codeclimate]: https://codeclimate.com/github/piotrmurach/finite_machine
 [coverage]: https://coveralls.io/github/piotrmurach/finite_machine?branch=master
@@ -1494,6 +1494,10 @@ Creating a standalone **FiniteMachine** brings a number of benefits, one of them
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+## Code of Conduct
+
+Everyone interacting in the FiniteMachine project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/finite_machine/blob/master/CODE_OF_CONDUCT.md).
+
 ## Copyright
 
 Copyright (c) 2014 Piotr Murach. See LICENSE for further details.

data/lib/finite_machine/definition.rb

@@ -1,30 +1,38 @@
 # frozen_string_literal: true
 
 module FiniteMachine
-  # A class responsible for defining standalone state machine
+  # Responsible for defining a standalone state machine
+  #
+  # @api public
   class Definition
-    # The machine deferreds
+    # The any event constant
     #
-    # @return [Array[Proc]]
+    # @example
+    #   on_before(any_event) { ... }
     #
-    # @api private
-    def self.deferreds
-      @deferreds ||= []
+    # @return [FiniteMachine::Const]
+    #
+    # @api public
+    def self.any_event
+      ANY_EVENT
     end
 
-    # Add deferred
+    # The any state constant
     #
-    # @param [Proc] deferred
-    #   the deferred execution
+    # @example
+    #   event :go, any_state => :green
     #
-    # @return [Array[Proc]]
+    # @example
+    #   on_enter(any_state) { ... }
     #
-    # @api private
-    def self.add_deferred(deferred)
-      deferreds << deferred
+    # @return [FiniteMachine::Const]
+    #
+    # @api public
+    def self.any_state
+      ANY_STATE
     end
 
-    # Instantiate a new Definition
+    # Initialize a StateMachine
     #
     # @example
     #   class Engine < FiniteMachine::Definition
@@ -43,7 +51,12 @@ module FiniteMachine
       end
     end
 
-    # Set deferrerd methods on the subclass
+    # Add deferred methods to the subclass
+    #
+    # @param [Class] subclass
+    #   the inheriting subclass
+    #
+    # @return [void]
     #
     # @api private
     def self.inherited(subclass)
@@ -52,11 +65,35 @@ module FiniteMachine
       deferreds.each { |d| subclass.add_deferred(d) }
     end
 
+    # The state machine deferreds
+    #
+    # @return [Array<Proc>]
+    #
+    # @api private
+    def self.deferreds
+      @deferreds ||= []
+    end
+
+    # Add deferred
+    #
+    # @param [Proc] deferred
+    #   the deferred execution
+    #
+    # @return [Array<Proc>]
+    #
+    # @api private
+    def self.add_deferred(deferred)
+      deferreds << deferred
+    end
+
     # Delay lookup of DSL method
     #
     # @param [Symbol] method_name
+    #   the method name
+    # @param [Array] arguments
+    #   the method arguments
     #
-    # @return [nil]
+    # @return [void]
     #
     # @api private
     def self.method_missing(method_name, *arguments, &block)

data/lib/finite_machine/hooks.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "concurrent/array"
 require "concurrent/map"
 
 require_relative "hook_event"
@@ -12,13 +13,17 @@ module FiniteMachine
     # Initialize a hooks_map of hooks
     #
     # @example
-    #   Hoosk.new(machine)
+    #   Hooks.new
     #
     # @api public
     def initialize
       @hooks_map = Concurrent::Map.new do |events_hash, hook_event|
-        events_hash[hook_event] = Concurrent::Map.new do |state_hash, name|
-          state_hash[name] = []
+        events_hash.compute_if_absent(hook_event) do
+          Concurrent::Map.new do |state_hash, name|
+            state_hash.compute_if_absent(name) do
+              Concurrent::Array.new
+            end
+          end
         end
       end
     end

data/lib/finite_machine/message_queue.rb

@@ -4,17 +4,17 @@ require_relative "listener"
 require "thread"
 
 module FiniteMachine
-  # Allows for storage of asynchronous messages such as events
+  # Responsible for storage of asynchronous messages such as events
   # and callbacks.
   #
-  # Used internally by {Observer} and {StateMachine}
+  # Used internally by {Observer}
   #
   # @api private
   class MessageQueue
-    # Initialize an event queue in separate thread
+    # Initialize a MessageQueue
     #
     # @example
-    #   MessageQueue.new
+    #   message_queue = FiniteMachine::MessageQueue.new
     #
     # @api public
     def initialize
@@ -28,6 +28,11 @@ module FiniteMachine
 
     # Start a new thread with a queue of callback events to run
     #
+    # @example
+    #   message_queue.start
+    #
+    # @return [Thread, nil]
+    #
     # @api private
     def start
       return if running?
@@ -35,7 +40,9 @@ module FiniteMachine
       @mutex.synchronize { spawn_thread }
     end
 
-    # Spawn new background thread
+    # Spawn a new background thread
+    #
+    # @return [Thread]
     #
     # @api private
     def spawn_thread
@@ -45,18 +52,27 @@ module FiniteMachine
       end
     end
 
+    # Check whether or not the message queue is running
+    #
+    # @example
+    #   message_queue.running?
+    #
+    # @return [Boolean]
+    #
+    # @api public
     def running?
       !@thread.nil? && alive?
     end
 
-    # Add asynchronous event to the event queue to process
+    # Add an asynchronous event to the message queue to process
     #
     # @example
-    #   event_queue << AsyncCall.build(...)
+    #   message_queue << AsyncCall.build(...)
     #
-    # @param [AsyncCall] event
+    # @param [FiniteMachine::AsyncCall] event
+    #   the event to add
     #
-    # @return [nil]
+    # @return [void]
     #
     # @api public
     def <<(event)
@@ -70,7 +86,12 @@ module FiniteMachine
       end
     end
 
-    # Add listener to the queue to receive messages
+    # Add a listener for the message queue to receive notifications
+    #
+    # @example
+    #   message_queue.subscribe { |event| ... }
+    #
+    # @return [void]
     #
     # @api public
     def subscribe(*args, &block)
@@ -81,20 +102,20 @@ module FiniteMachine
       end
     end
 
-    # Check if there are any events to handle
+    # Check whether or not there are any messages to handle
     #
     # @example
-    #   event_queue.empty?
+    #   message_queue.empty?
     #
     # @api public
     def empty?
       @mutex.synchronize { @queue.empty? }
     end
 
-    # Check if the event queue is alive
+    # Check whether or not the message queue is alive
     #
     # @example
-    #   event_queue.alive?
+    #   message_queue.alive?
     #
     # @return [Boolean]
     #
@@ -103,14 +124,15 @@ module FiniteMachine
       @mutex.synchronize { !@dead }
     end
 
-    # Join the event queue from current thread
+    # Join the message queue from the current thread
     #
     # @param [Fixnum] timeout
+    #   the time limit
     #
     # @example
-    #   event_queue.join
+    #   message_queue.join
     #
-    # @return [nil, Thread]
+    # @return [Thread, nil]
     #
     # @api public
     def join(timeout = nil)
@@ -119,16 +141,18 @@ module FiniteMachine
       timeout.nil? ? @thread.join : @thread.join(timeout)
     end
 
-    # Shut down this event queue and clean it up
+    # Shut down this message queue and clean it up
     #
     # @example
-    #   event_queue.shutdown
+    #   message_queue.shutdown
+    #
+    # @raise [FiniteMachine::MessageQueueDeadError]
     #
     # @return [Boolean]
     #
     # @api public
     def shutdown
-      raise EventQueueDeadError, "event queue already dead" if @dead
+      raise MessageQueueDeadError, "message queue already dead" if @dead
 
       queue = []
       @mutex.synchronize do
@@ -144,10 +168,10 @@ module FiniteMachine
       true
     end
 
-    # Get number of events waiting for processing
+    # The number of messages waiting for processing
     #
     # @example
-    #   event_queue.size
+    #   message_queue.size
     #
     # @return [Integer]
     #
@@ -156,6 +180,14 @@ module FiniteMachine
       @mutex.synchronize { @queue.size }
     end
 
+    # Inspect this message queue
+    #
+    # @example
+    #   message_queue.inspect
+    #
+    # @return [String]
+    #
+    # @api public
     def inspect
       @mutex.synchronize do
         "#<#{self.class}:#{object_id.to_s(16)} @size=#{size}, @dead=#{@dead}>"
@@ -164,9 +196,12 @@ module FiniteMachine
 
     private
 
-    # Notify consumers about process event
+    # Notify listeners about the event
+    #
+    # @param [FiniteMachine::AsyncCall] event
+    #   the event to notify listeners about
     #
-    # @param [AsyncCall] event
+    # @return [void]
     #
     # @api private
     def notify_listeners(event)
@@ -195,6 +230,14 @@ module FiniteMachine
       Logger.error "Error while running event: #{Logger.format_error(ex)}"
     end
 
+    # Log discarded message
+    #
+    # @param [FiniteMachine::AsyncCall] message
+    #   the message to discard
+    #
+    # @return [void]
+    #
+    # @api private
     def discard_message(message)
       Logger.debug "Discarded message: #{message}" if $DEBUG
     end

data/lib/finite_machine/observer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 require_relative "async_call"
 require_relative "callable"
 require_relative "hook_event"
@@ -13,20 +15,6 @@ module FiniteMachine
   class Observer < GenericDSL
     include Safety
 
-    # Clean up callback queue
-    #
-    # @api private
-    def self.cleanup_callback_queue
-      proc do
-        begin
-          if callback_queue.alive?
-            callback_queue.shutdown
-          end
-        rescue MessageQueueDeadError
-        end
-      end
-    end
-
     # The current state machine
     attr_reader :machine
 
@@ -44,11 +32,6 @@ module FiniteMachine
       @hooks   = Hooks.new
 
       @machine.subscribe(self)
-      ObjectSpace.define_finalizer(self, self.class.cleanup_callback_queue)
-    end
-
-    def callback_queue
-      @callback_queue ||= MessageQueue.new
     end
 
     # Evaluate in current context
@@ -204,6 +187,35 @@ module FiniteMachine
       callback_queue << async_call
     end
 
+    # Get an existing callback queue or create a new one
+    #
+    # @return [FiniteMachine::MessageQueue]
+    #
+    # @api private
+    def callback_queue
+      @callback_queue ||= MessageQueue.new.tap do
+        @queue_id = SecureRandom.uuid
+        ObjectSpace.define_finalizer(@queue_id, proc do
+          cleanup_callback_queue
+        end)
+      end
+    end
+
+    # Clean up the callback queue
+    #
+    # @return [Boolean, nil]
+    #
+    # @api private
+    def cleanup_callback_queue
+      ObjectSpace.undefine_finalizer(@queue_id) if @queue_id
+      return unless @callback_queue && callback_queue.alive?
+
+      begin
+        callback_queue.shutdown
+      rescue MessageQueueDeadError
+      end
+    end
+
     # Create callable instance
     #
     # @api private

data/lib/finite_machine/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FiniteMachine
-  VERSION = "0.14.0"
+  VERSION = "0.14.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-12 00:00:00.000000000 Z
+date: 2023-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -115,11 +115,13 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/finite_machine/issues
   changelog_uri: https://github.com/piotrmurach/finite_machine/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/finite_machine
   homepage_uri: https://piotrmurach.github.io/finite_machine/
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/piotrmurach/finite_machine
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A minimal finite state machine with a straightforward syntax.
 test_files: []