finite_machine 0.13.0 → 0.14.0

data/lib/finite_machine.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
-require_relative 'finite_machine/const'
-require_relative 'finite_machine/logger'
-require_relative 'finite_machine/definition'
-require_relative 'finite_machine/state_machine'
-require_relative 'finite_machine/version'
+require_relative "finite_machine/const"
+require_relative "finite_machine/logger"
+require_relative "finite_machine/definition"
+require_relative "finite_machine/state_machine"
+require_relative "finite_machine/version"
 
 module FiniteMachine
   # Default state name

data/lib/finite_machine/catchable.rb

@@ -33,7 +33,7 @@ module FiniteMachine
         if block_given?
           options[:with] = block
         else
-          raise ArgumentError, 'Need to provide error handler.'
+          raise ArgumentError, "Need to provide error handler."
         end
       end
       evaluate_exceptions(exceptions, options)
@@ -71,7 +71,7 @@ module FiniteMachine
     #
     # @api private
     def extract_const(class_name)
-      class_name.split('::').reduce(FiniteMachine) do |constant, part|
+      class_name.split("::").reduce(FiniteMachine) do |constant, part|
         constant.const_get(part)
       end
     end
@@ -85,9 +85,9 @@ module FiniteMachine
         target.method(handler)
       when Proc
         if handler.arity.zero?
-          proc { instance_exec(&handler) }
+          -> { instance_exec(&handler) }
         else
-          proc { |_exception| instance_exec(_exception, &handler) }
+          ->(exception) { instance_exec(exception, &handler) }
         end
       end
     end
@@ -101,16 +101,24 @@ module FiniteMachine
     # @api private
     def evaluate_exceptions(exceptions, options)
       exceptions.each do |exception|
-        key = if exception.is_a?(Class) && exception <= Exception
-          exception.name
-        elsif exception.is_a?(String)
-          exception
-        else
-          raise ArgumentError, "#{exception} isn't an Exception"
-        end
-
+        key = extract_exception_name(exception)
         error_handlers << [key, options[:with]]
       end
     end
+
+    # Extract exception name
+    #
+    # @param [Class,Exception,String] exception
+    #
+    # @api private
+    def extract_exception_name(exception)
+      if exception.is_a?(Class) && exception <= Exception
+        exception.name
+      elsif exception.is_a?(String)
+        exception
+      else
+        raise ArgumentError, "#{exception} isn't an Exception"
+      end
+    end
   end # Catchable
 end # FiniteMachine

data/lib/finite_machine/choice_merger.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'transition_builder'
+require_relative "transition_builder"
 
 module FiniteMachine
   # A class responsible for merging choice options
@@ -39,6 +39,6 @@ module FiniteMachine
                                                  @transitions.merge(conditions))
       transition_builder.call(@transitions[:from] => to)
     end
-    alias_method :default, :choice
+    alias default choice
   end # ChoiceMerger
 end # FiniteMachine

data/lib/finite_machine/definition.rb

@@ -49,7 +49,7 @@ module FiniteMachine
     def self.inherited(subclass)
       super
 
-      self.deferreds.each { |d| subclass.add_deferred(d) }
+      deferreds.each { |d| subclass.add_deferred(d) }
     end
 
     # Delay lookup of DSL method

data/lib/finite_machine/dsl.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative 'choice_merger'
-require_relative 'safety'
-require_relative 'transition_builder'
+require_relative "choice_merger"
+require_relative "safety"
+require_relative "transition_builder"
 
 module FiniteMachine
   # A generic DSL for describing the state machine
@@ -38,6 +38,13 @@ module FiniteMachine
       end
     end
 
+    # Check if message can be handled by this DSL
+    #
+    # @api private
+    def respond_to_missing?(method_name, include_private = false)
+      @machine.respond_to?(method_name) || super
+    end
+
     # Configure state machine properties
     #
     # @api private
@@ -65,6 +72,29 @@ module FiniteMachine
       log_transitions(@attrs.fetch(:log_transitions, false))
     end
 
+    # Add aliases for the target object
+    #
+    # @example
+    #   FiniteMachine.define do
+    #     target_alias :engine
+    #
+    #     on_transition do |event|
+    #       engine.state = event.to
+    #     end
+    #   end
+    #
+    # @param [Array<Symbol>] aliases
+    #   the names for target alias
+    #
+    # @api public
+    def alias_target(*aliases)
+      aliases.each do |alias_name|
+        next if env.aliases.include?(alias_name)
+
+        env.aliases << alias_name
+      end
+    end
+
     # Define initial state
     #
     # @param [Symbol] value
@@ -197,8 +227,8 @@ module FiniteMachine
     #
     # @api private
     def raise_missing_state
-      fail MissingInitialStateError,
-           'Provide state to transition :to for the initial event'
+      raise MissingInitialStateError,
+            "Provide state to transition :to for the initial event"
     end
   end # DSL
 end # FiniteMachine

data/lib/finite_machine/env.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'threadable'
+require_relative "threadable"
 
 module FiniteMachine
   # Holds references to targets and aliases

data/lib/finite_machine/events_map.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
-require 'forwardable'
+require "concurrent/map"
+require "forwardable"
 
-require_relative 'threadable'
-require_relative 'undefined_transition'
+require_relative "threadable"
+require_relative "undefined_transition"
 
 module FiniteMachine
   # A class responsible for storing mappings between event namess and
@@ -182,8 +182,7 @@ module FiniteMachine
     # @api public
     def match_transition_with(name, from_state, *conditions)
       find(name).find do |trans|
-        trans.matches?(from_state) &&
-        trans.check_conditions(*conditions)
+        trans.matches?(from_state) && trans.check_conditions(*conditions)
       end
     end
 

data/lib/finite_machine/hook_event.rb

@@ -29,7 +29,7 @@ module FiniteMachine
     #
     # @api public
     def self.event_name
-      name.split('::').last.downcase.to_sym
+      name.split("::").last.downcase.to_sym
     end
 
     # String representation

data/lib/finite_machine/hooks.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'concurrent/map'
+require "concurrent/map"
 
-require_relative 'hook_event'
+require_relative "hook_event"
 
 module FiniteMachine
   # A class reponsible for registering callbacks

data/lib/finite_machine/message_queue.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'listener'
-require 'thread'
+require_relative "listener"
+require "thread"
 
 module FiniteMachine
   # Allows for storage of asynchronous messages such as events
@@ -31,6 +31,7 @@ module FiniteMachine
     # @api private
     def start
       return if running?
+
       @mutex.synchronize { spawn_thread }
     end
 
@@ -114,6 +115,7 @@ module FiniteMachine
     # @api public
     def join(timeout = nil)
       return unless @thread
+
       timeout.nil? ? @thread.join : @thread.join(timeout)
     end
 
@@ -126,7 +128,7 @@ module FiniteMachine
     #
     # @api public
     def shutdown
-      fail EventQueueDeadError, 'event queue already dead' if @dead
+      raise EventQueueDeadError, "event queue already dead" if @dead
 
       queue = []
       @mutex.synchronize do
@@ -184,6 +186,7 @@ module FiniteMachine
           end
           event = @queue.pop
           break unless event
+
           notify_listeners(event)
           event.dispatch
         end

data/lib/finite_machine/observer.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'async_call'
-require_relative 'callable'
-require_relative 'hook_event'
-require_relative 'hooks'
-require_relative 'message_queue'
-require_relative 'safety'
-require_relative 'transition_event'
+require_relative "async_call"
+require_relative "callable"
+require_relative "hook_event"
+require_relative "hooks"
+require_relative "message_queue"
+require_relative "safety"
+require_relative "transition_event"
 
 module FiniteMachine
   # A class responsible for observing state changes

data/lib/finite_machine/safety.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'hook_event'
+require_relative "hook_event"
 
 module FiniteMachine
   # Module responsible for safety checks against known methods
@@ -39,7 +39,7 @@ module FiniteMachine
           name: event_name,
           type: :instance,
           method: method_name,
-          source: 'FiniteMachine'
+          source: "FiniteMachine"
         }
       end
     end
@@ -89,8 +89,8 @@ module FiniteMachine
     # @api private
     def wrong_event_name?(name, event_type)
       machine.states.include?(name) &&
-      !machine.events.include?(name) &&
-      event_type < HookEvent::Anyaction
+        !machine.events.include?(name) &&
+        event_type < HookEvent::Anyaction
     end
 
     # Check if state name exists
@@ -104,8 +104,8 @@ module FiniteMachine
     # @api private
     def wrong_state_name?(name, event_type)
       machine.events.include?(name) &&
-      !machine.states.include?(name) &&
-      event_type < HookEvent::Anystate
+        !machine.states.include?(name) &&
+        event_type < HookEvent::Anystate
     end
 
     def raise_invalid_callback_error(message)

data/lib/finite_machine/state_machine.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'forwardable'
+require "forwardable"
 
-require_relative 'catchable'
-require_relative 'dsl'
-require_relative 'env'
-require_relative 'events_map'
-require_relative 'hook_event'
-require_relative 'observer'
-require_relative 'threadable'
-require_relative 'subscribers'
+require_relative "catchable"
+require_relative "dsl"
+require_relative "env"
+require_relative "events_map"
+require_relative "hook_event"
+require_relative "observer"
+require_relative "threadable"
+require_relative "subscribers"
 
 module FiniteMachine
   # Base class for state machine
@@ -64,7 +64,8 @@ module FiniteMachine
     # Allow or not logging of transitions
     attr_threadsafe :log_transitions
 
-    def_delegators :dsl, :initial, :terminal, :event, :trigger_init
+    def_delegators :dsl, :initial, :terminal, :event, :trigger_init,
+                   :alias_target
 
     # Initialize state machine
     #
@@ -194,7 +195,7 @@ module FiniteMachine
     #   fsm.can?(:go) # => true
     #
     # @example
-    #   fsm.can?(:go, 'Piotr')  # checks condition with parameter 'Piotr'
+    #   fsm.can?(:go, "Piotr")  # checks condition with parameter "Piotr"
     #
     # @param [String] event
     #
@@ -202,7 +203,7 @@ module FiniteMachine
     #
     # @api public
     def can?(*args)
-      event_name  = args.shift
+      event_name = args.shift
       events_map.can_perform?(event_name, current, *args)
     end
 
@@ -284,7 +285,7 @@ module FiniteMachine
       else
         exception = InvalidStateError
         catch_error(exception) ||
-          fail(exception, "inappropriate current state '#{current}'")
+          raise(exception, "inappropriate current state '#{current}'")
 
         false
       end
@@ -390,8 +391,10 @@ module FiniteMachine
     # @api public
     def inspect
       sync_shared do
-        "<##{self.class}:0x#{object_id.to_s(16)} @states=#{states}, " \
-        "@events=#{events}, " \
+        "<##{self.class}:0x#{object_id.to_s(16)} " \
+        "@current=#{current.inspect} " \
+        "@states=#{states} " \
+        "@events=#{events} " \
         "@transitions=#{events_map.state_transitions}>"
       end
     end
@@ -407,7 +410,7 @@ module FiniteMachine
     #
     # @api private
     def raise_transition_error(error)
-      fail TransitionError, Logger.format_error(error)
+      raise TransitionError, Logger.format_error(error)
     end
 
     # Forward the message to observer or self

data/lib/finite_machine/state_parser.rb

@@ -7,7 +7,9 @@ module FiniteMachine
   #
   # @api private
   class StateParser
-    BLACKLIST = [:name, :if, :unless, :silent].freeze
+    NON_STATE_KEYS = %i[name if unless silent].freeze
+
+    STATE_KEYS = %i[from to].freeze
 
     # Extract states from user defined attributes
     #
@@ -35,7 +37,7 @@ module FiniteMachine
     # @api private
     def self.ensure_only_states!(attrs)
       attributes = attrs.dup
-      BLACKLIST.each { |key| attributes.delete(key) }
+      NON_STATE_KEYS.each { |key| attributes.delete(key) }
       raise_not_enough_transitions unless attributes.any?
       attributes
     end
@@ -69,7 +71,7 @@ module FiniteMachine
     #
     # @api public
     def self.contains_from_to_keys?(attrs)
-      [:from, :to].any? { |key| attrs.keys.include?(key) }
+      STATE_KEYS.any? { |key| attrs.keys.include?(key) }
     end
     private_class_method :contains_from_to_keys?
 
@@ -79,9 +81,8 @@ module FiniteMachine
     #
     # @api private
     def self.convert_from_to_attributes_to_states_hash(attrs)
-      Array(attrs[:from] || ANY_STATE).reduce({}) do |hash, state|
+      Array(attrs[:from] || ANY_STATE).each_with_object({}) do |state, hash|
         hash[state] = attrs[:to] || state
-        hash
       end
     end
     private_class_method :convert_from_to_attributes_to_states_hash
@@ -99,13 +100,12 @@ module FiniteMachine
     #
     # @api private
     def self.convert_attributes_to_states_hash(attrs)
-      attrs.reduce({}) do |hash, (k, v)|
+      attrs.each_with_object({}) do |(k, v), hash|
         if k.respond_to?(:to_ary)
           k.each { |el| hash[el] = v }
         else
           hash[k] = v
         end
-        hash
       end
     end
     private_class_method :convert_attributes_to_states_hash
@@ -119,7 +119,7 @@ module FiniteMachine
     #
     # @api private
     def self.raise_not_enough_transitions
-      raise NotEnoughTransitionsError, 'please provide state transitions'
+      raise NotEnoughTransitionsError, "please provide state transitions"
     end
     private_class_method :raise_not_enough_transitions
   end # StateParser