finite_machine 0.11.2 → 0.14.0

data/lib/finite_machine/subscribers.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'monitor'
+require "monitor"
 
 module FiniteMachine
   # A class responsibile for storage of event subscribers

data/lib/finite_machine/threadable.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative "two_phase_lock"
 
 module FiniteMachine
   # A mixin to allow instance methods to be synchronized

data/lib/finite_machine/transition.rb

@@ -1,7 +1,21 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative "callable"
+require_relative "threadable"
 
 module FiniteMachine
   # Class describing a transition associated with a given event
+  #
+  # The {Transition} is created with the `event` helper.
+  #
+  # @example Converting event into {Transition}
+  #   event :go, :red => :green
+  #
+  #   will be translated to
+  #
+  #   Transition.new(context, :go, {states: {:red => :green}})
+  #
+  # @api private
   class Transition
     include Threadable
 
@@ -11,11 +25,8 @@ module FiniteMachine
     # Predicates before transitioning
     attr_threadsafe :conditions
 
-    # The current state machine
-    attr_threadsafe :machine
-
-    # Check if transition should be cancelled
-    attr_threadsafe :cancelled
+    # The current state machine context
+    attr_threadsafe :context
 
     # All states for this transition event
     attr_threadsafe :states
@@ -23,33 +34,25 @@ module FiniteMachine
     # Initialize a Transition
     #
     # @example
-    #   attributes = {parsed_states: {green: :yellow}}
-    #   Transition.new(machine, attributes)
+    #   attributes = {states: {green: :yellow}}
+    #   Transition.new(context, :go, attributes)
     #
-    # @param [StateMachine] machine
+    # @param [Object] context
+    #   the context this transition evaluets conditions in
     #
     # @param [Hash] attrs
     #
     # @return [Transition]
     #
     # @api public
-    def initialize(machine, attrs = {})
-      @machine     = machine
-      @name        = attrs[:name]
+    def initialize(context, name, attrs = {})
+      @context     = context
+      @name        = name
       @states      = attrs.fetch(:states, {})
       @if          = Array(attrs.fetch(:if, []))
       @unless      = Array(attrs.fetch(:unless, []))
       @conditions  = make_conditions
-      @cancelled   = attrs.fetch(:cancelled, false)
-    end
-
-    # Check if this transition is cancelled or not
-    #
-    # @return [Boolean]
-    #
-    # @api public
-    def cancelled?
-      @cancelled
+      freeze
     end
 
     # Reduce conditions
@@ -72,7 +75,7 @@ module FiniteMachine
     # @api private
     def check_conditions(*args)
       conditions.all? do |condition|
-        condition.call(machine.target, *args)
+        condition.call(context, *args)
       end
     end
 
@@ -82,7 +85,7 @@ module FiniteMachine
     #   the from state to match against
     #
     # @example
-    #   transition = Transition.new(machine, states: {:green => :red})
+    #   transition = Transition.new(context, states: {:green => :red})
     #   transition.matches?(:green) # => true
     #
     # @return [Boolean]
@@ -99,7 +102,7 @@ module FiniteMachine
     #   the from state to check
     #
     # @example
-    #   transition = Transition.new(machine, states: {:green => :red})
+    #   transition = Transition.new(context, states: {:green => :red})
     #   transition.to_state(:green) # => :red
     #
     # @return [Symbol]
@@ -107,18 +110,14 @@ module FiniteMachine
     #
     # @api public
     def to_state(from)
-      if cancelled?
-        from
-      else
-        states[from] || states[ANY_STATE]
-      end
+      states[from] || states[ANY_STATE]
     end
 
     # Return transition name
     #
     # @example
-    #   transition = Transition.new(machine, name: :go)
-    #   transition.to_s # => 'go'
+    #   transition = Transition.new(context, name: :go)
+    #   transition.to_s # => "go"
     #
     # @return [String]
     #
@@ -133,8 +132,9 @@ module FiniteMachine
     #
     # @api public
     def inspect
-      transitions = @states.map { |from, to| "#{from} -> #{to}" }.join(', ')
-      "<##{self.class} @name=#{@name}, @transitions=#{transitions}, @when=#{@conditions}>"
+      transitions = @states.map { |from, to| "#{from} -> #{to}" }.join(", ")
+      "<##{self.class} @name=#{@name}, @transitions=#{transitions}, " \
+        "@when=#{@conditions}>"
     end
   end # Transition
 end # FiniteMachine

data/lib/finite_machine/transition_builder.rb

@@ -1,8 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'finite_machine/state_parser'
-require 'finite_machine/event_definition'
-require 'finite_machine/state_definition'
+require_relative "event_definition"
+require_relative "state_definition"
+require_relative "state_parser"
+require_relative "transition"
 
 module FiniteMachine
   # A class reponsible for building transition out of parsed states
@@ -11,54 +12,44 @@ module FiniteMachine
   #
   # @api private
   class TransitionBuilder
-    include Threadable
-
-    # The current state machine
-    attr_threadsafe :machine
-
-    attr_threadsafe :attributes
-
-    attr_threadsafe :event_definition
-
-    attr_threadsafe :state_definition
-
     # Initialize a TransitionBuilder
     #
     # @example
     #   TransitionBuilder.new(machine, {})
     #
     # @api public
-    def initialize(machine, attributes = {})
-      @machine = machine
+    def initialize(machine, name, attributes = {})
+      @machine    = machine
+      @name       = name
       @attributes = attributes
+
       @event_definition = EventDefinition.new(machine)
       @state_definition = StateDefinition.new(machine)
     end
 
-    # Creates transitions for the states
+    # Converts user transitions into internal {Transition} representation
     #
     # @example
     #   transition_builder.call([:green, :yellow] => :red)
     #
-    # @param [Hash[Symbol]] states
-    #   The states to extract
+    # @param [Hash[Symbol]] transitions
+    #   The transitions to extract states from
     #
     # @return [self]
     #
     # @api public
-    def call(states)
-      StateParser.new(states).parse do |from, to|
-        attributes.merge!(states: { from => to })
-        transition = Transition.new(machine, attributes)
-        name = attributes[:name]
-        silent = attributes.fetch(:silent, false)
-
-        machine.events_chain.add(name, transition)
-
-        unless machine.respond_to?(name)
-          event_definition.apply(name, silent)
+    def call(transitions)
+      StateParser.parse(transitions) do |from, to|
+        transition = Transition.new(@machine.env.target, @name,
+                                    @attributes.merge(states: { from => to }))
+        silent = @attributes.fetch(:silent, false)
+        @machine.events_map.add(@name, transition)
+        next unless @machine.auto_methods?
+
+        unless @machine.respond_to?(@name)
+          @event_definition.apply(@name, silent)
         end
-        state_definition.apply({ from => to })
+        @state_definition.apply(from => to)
       end
       self
     end

data/lib/finite_machine/transition_event.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative "threadable"
 
 module FiniteMachine
   # A class representing a callback transition event
@@ -7,38 +9,37 @@ module FiniteMachine
   #
   # @api private
   class TransitionEvent
-    include Threadable
-
     # This event from state name
     #
     # @return [Object]
     #
     # @api public
-    attr_threadsafe :from
+    attr_reader :from
 
     # This event to state name
     #
     # @return [Object]
     #
     # @api public
-    attr_threadsafe :to
+    attr_reader :to
 
     # This event name
     #
     # @api public
-    attr_threadsafe :name
+    attr_reader :name
 
     # Build a transition event
     #
-    # @param [FiniteMachine::Transition] transition
+    # @param [String] event_name
+    # @param [String] from
+    # @param [String] to
     #
     # @return [self]
     #
     # @api private
-    # def initialize(transition, *data)
-    def initialize(hook_event, to)
-      @name = hook_event.event_name
-      @from = hook_event.from
+    def initialize(event_name, from, to)
+      @name = event_name
+      @from = from
       @to   = to
       freeze
     end

data/lib/finite_machine/two_phase_lock.rb

@@ -1,4 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "sync"
 
 module FiniteMachine
   # Mixin to provide lock to a {Threadable}
@@ -10,9 +12,10 @@ module FiniteMachine
     # @return [Sync]
     #
     # @api private
-    def sync
-      @sync = Sync.new
+    def lock
+      @lock = Sync.new
     end
+    module_function :lock
 
     # Synchronize given block of code
     #
@@ -23,9 +26,8 @@ module FiniteMachine
     #
     # @api private
     def synchronize(mode, &block)
-      sync.synchronize(mode, &block)
+      lock.synchronize(mode, &block)
     end
-
-    module_function :sync, :synchronize
+    module_function :synchronize
   end # TwoPhaseLock
 end # FiniteMachine

data/lib/finite_machine/undefined_transition.rb

@@ -1,19 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module FiniteMachine
   # Stand in for lack of matching transition.
   #
-  # Used internally by {EventsChain}
+  # Used internally by {EventsMap}
   #
   # @api private
   class UndefinedTransition
-    include Threadable
-
     # Initialize an undefined transition
     #
     # @api private
     def initialize(name)
-      self.name = name
+      @name = name
+      freeze
     end
 
     def to_state(from)
@@ -26,7 +25,7 @@ module FiniteMachine
 
     protected
 
-    attr_threadsafe :name
+    attr_reader :name
 
   end # UndefinedTransition
 end # FiniteMachine

data/lib/finite_machine/version.rb

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

metadata

@@ -1,82 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: finite_machine
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2020-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 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.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- assets/finite_machine_logo.png
-- examples/atm.rb
-- examples/bug_system.rb
-- finite_machine.gemspec
 - lib/finite_machine.rb
 - lib/finite_machine/async_call.rb
-- lib/finite_machine/async_proxy.rb
 - lib/finite_machine/callable.rb
 - lib/finite_machine/catchable.rb
 - lib/finite_machine/choice_merger.rb
+- lib/finite_machine/const.rb
 - lib/finite_machine/definition.rb
 - 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/events_map.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
@@ -90,136 +110,32 @@ 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
-- spec/unit/callable/call_spec.rb
-- spec/unit/callbacks_spec.rb
-- spec/unit/can_spec.rb
-- spec/unit/choice_spec.rb
-- spec/unit/define_spec.rb
-- spec/unit/definition_spec.rb
-- spec/unit/event_names_spec.rb
-- spec/unit/event_queue_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/events_spec.rb
-- spec/unit/events_chain/inspect_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/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
-- spec/unit/hooks/clear_spec.rb
-- spec/unit/hooks/inspect_spec.rb
-- spec/unit/hooks/register_spec.rb
-- spec/unit/if_unless_spec.rb
-- spec/unit/initial_spec.rb
-- spec/unit/inspect_spec.rb
-- spec/unit/is_spec.rb
-- spec/unit/log_transitions_spec.rb
-- spec/unit/logger_spec.rb
-- spec/unit/respond_to_spec.rb
-- spec/unit/state_parser/inspect_spec.rb
-- spec/unit/state_parser/parse_spec.rb
-- spec/unit/states_spec.rb
-- 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/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
-homepage: http://peter-murach.github.io/finite_machine/
+homepage: https://piotrmurach.github.io/finite_machine/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  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/
+  source_code_uri: https://github.com/piotrmurach/finite_machine
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 3.1.2
 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
-- spec/unit/callable/call_spec.rb
-- spec/unit/callbacks_spec.rb
-- spec/unit/can_spec.rb
-- spec/unit/choice_spec.rb
-- spec/unit/define_spec.rb
-- spec/unit/definition_spec.rb
-- spec/unit/event_names_spec.rb
-- spec/unit/event_queue_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/events_spec.rb
-- spec/unit/events_chain/inspect_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/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
-- spec/unit/hooks/clear_spec.rb
-- spec/unit/hooks/inspect_spec.rb
-- spec/unit/hooks/register_spec.rb
-- spec/unit/if_unless_spec.rb
-- spec/unit/initial_spec.rb
-- spec/unit/inspect_spec.rb
-- spec/unit/is_spec.rb
-- spec/unit/log_transitions_spec.rb
-- spec/unit/logger_spec.rb
-- spec/unit/respond_to_spec.rb
-- spec/unit/state_parser/inspect_spec.rb
-- spec/unit/state_parser/parse_spec.rb
-- spec/unit/states_spec.rb
-- 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/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: 
+test_files: []