state_machines 0.10.0 → 0.30.0

data/lib/state_machines/transition.rb

@@ -33,11 +33,11 @@ module StateMachines
     # Determines whether the current ruby implementation supports pausing and
     # resuming transitions
     def self.pause_supported?
-      %w(ruby maglev).include?(RUBY_ENGINE)
+      %w[ruby maglev].include?(RUBY_ENGINE)
     end
 
     # Creates a new, specific transition
-    def initialize(object, machine, event, from_name, to_name, read_state = true) #:nodoc:
+    def initialize(object, machine, event, from_name, to_name, read_state = true) # :nodoc:
       @object = object
       @machine = machine
       @args = []
@@ -136,7 +136,7 @@ module StateMachines
     #   transition = StateMachines::Transition.new(Vehicle.new, machine, :ignite, :parked, :idling)
     #   transition.attributes   # => {:object => #<Vehicle:0xb7d60ea4>, :attribute => :state, :event => :ignite, :from => 'parked', :to => 'idling'}
     def attributes
-      @attributes ||= {object: object, attribute: attribute, event: event, from: from, to: to}
+      @attributes ||= { object: object, attribute: attribute, event: event, from: from, to: to }
     end
 
     # Runs the actual transition and any before/after callbacks associated
@@ -162,16 +162,14 @@ module StateMachines
       self.args = args
 
       # Run the transition
-      !!TransitionCollection.new([self], {use_transactions: machine.use_transactions, actions: run_action}).perform
+      !!TransitionCollection.new([self], { use_transactions: machine.use_transactions, actions: run_action }).perform
     end
 
     # Runs a block within a transaction for the object being transitioned.
     # By default, transactions are a no-op unless otherwise defined by the
     # machine's integration.
-    def within_transaction
-      machine.within_transaction(object) do
-        yield
-      end
+    def within_transaction(&)
+      machine.within_transaction(object, &)
     end
 
     # Runs the before / after callbacks for this transition.  If a block is
@@ -186,7 +184,7 @@ module StateMachines
     # This will return true if all before callbacks gets executed.  After
     # callbacks will not have an effect on the result.
     def run_callbacks(options = {}, &block)
-      options = {before: true, after: true}.merge(options)
+      options = { before: true, after: true }.merge(options)
       @success = false
 
       halted = pausable { before(options[:after], &block) } if options[:before]
@@ -219,10 +217,10 @@ module StateMachines
     #
     #   vehicle.state   # => 'idling'
     def persist
-      unless @persisted
-        machine.write(object, :state, to)
-        @persisted = true
-      end
+      return if @persisted
+
+      machine.write(object, :state, to)
+      @persisted = true
     end
 
     # Rolls back changes made to the object's state via this transition.  This
@@ -265,11 +263,11 @@ module StateMachines
     # and event involved in the transition are equal
     def ==(other)
       other.instance_of?(self.class) &&
-      other.object == object &&
-      other.machine == machine &&
-      other.from_name == from_name &&
-      other.to_name == to_name &&
-      other.event == event
+        other.object == object &&
+        other.machine == machine &&
+        other.from_name == from_name &&
+        other.to_name == to_name &&
+        other.event == event
     end
 
     # Generates a nicely formatted description of this transitions's contents.
@@ -279,10 +277,10 @@ module StateMachines
     #   transition = StateMachines::Transition.new(object, machine, :ignite, :parked, :idling)
     #   transition   # => #<StateMachines::Transition attribute=:state event=:ignite from="parked" from_name=:parked to="idling" to_name=:idling>
     def inspect
-      "#<#{self.class} #{%w(attribute event from from_name to to_name).map { |attr| "#{attr}=#{send(attr).inspect}" } * ' '}>"
+      "#<#{self.class} #{%w[attribute event from from_name to to_name].map { |attr| "#{attr}=#{send(attr).inspect}" } * ' '}>"
     end
 
-  private
+    private
 
     # Runs a block that may get paused.  If the block doesn't pause, then
     # execution will continue as normal.  If the block gets paused, then it
@@ -292,13 +290,16 @@ module StateMachines
     # getting paused.
     def pausable
       begin
-        halted = !catch(:halt) { yield; true }
-      rescue => error
+        halted = !catch(:halt) do
+          yield
+          true
+        end
+      rescue StandardError => e
         raise unless @resume_block
       end
 
       if @resume_block
-        @resume_block.call(halted, error)
+        @resume_block.call(halted, e)
       else
         halted
       end
@@ -310,12 +311,12 @@ module StateMachines
     def pause
       raise ArgumentError, 'around_transition callbacks cannot be called in multiple execution contexts in java implementations of Ruby. Use before/after_transitions instead.' unless self.class.pause_supported?
 
-      unless @resume_block
-        require 'continuation' unless defined?(callcc)
-        callcc do |block|
-          @paused_block = block
-          throw :halt, true
-        end
+      return if @resume_block
+
+      require 'continuation' unless defined?(callcc)
+      callcc do |block|
+        @paused_block = block
+        throw :halt, true
       end
     end
 
@@ -372,8 +373,9 @@ module StateMachines
         @before_run = true
       end
 
-      action = {success: true}.merge(block_given? ? yield : {})
-      @result, @success = action[:result], action[:success]
+      action = { success: true }.merge(block_given? ? yield : {})
+      @result = action[:result]
+      @success = action[:success]
     end
 
     # Runs the machine's +after+ callbacks for this transition.  Only
@@ -390,17 +392,17 @@ module StateMachines
     # exception will not bubble up to the caller since +after+ callbacks
     # should never halt the execution of a +perform+.
     def after
-      unless @after_run
-        # First resume previously paused callbacks
-        if resume
-          catch(:halt) do
-            type = @success ? :after : :failure
-            machine.callbacks[type].each { |callback| callback.call(object, context, self) }
-          end
-        end
+      return if @after_run
 
-        @after_run = true
+      # First resume previously paused callbacks
+      if resume
+        catch(:halt) do
+          type = @success ? :after : :failure
+          machine.callbacks[type].each { |callback| callback.call(object, context, self) }
+        end
       end
+
+      @after_run = true
     end
 
     # Gets a hash of the context defining this unique transition (including
@@ -412,7 +414,7 @@ module StateMachines
     #   transition = StateMachines::Transition.new(Vehicle.new, machine, :ignite, :parked, :idling)
     #   transition.context    # => {:on => :ignite, :from => :parked, :to => :idling}
     def context
-      @context ||= {on: event, from: from_name, to: to_name}
+      @context ||= { on: event, from: from_name, to: to_name }
     end
   end
 end

data/lib/state_machines/transition_collection.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'options_validator'
+
 module StateMachines
   # Represents a collection of transitions in a state machine
   class TransitionCollection < Array
-
     # Whether to skip running the action for each transition's machine
     attr_reader :skip_actions
 
@@ -28,10 +29,10 @@ module StateMachines
       reject! { |transition| !transition }
 
       attributes = map { |transition| transition.attribute }.uniq
-      fail ArgumentError, 'Cannot perform multiple transitions in parallel for the same state machine attribute' if attributes.length != length
+      raise ArgumentError, 'Cannot perform multiple transitions in parallel for the same state machine attribute' if attributes.length != length
 
-      options.assert_valid_keys(:actions, :after, :use_transactions)
-      options = {actions: true, after: true, use_transactions: true}.merge(options)
+      StateMachines::OptionsValidator.assert_valid_keys!(options, :actions, :after, :use_transactions)
+      options = { actions: true, after: true, use_transactions: true }.merge(options)
       @skip_actions = !options[:actions]
       @skip_after = !options[:after]
       @use_transactions = options[:use_transactions]
@@ -74,11 +75,11 @@ module StateMachines
       end
     end
 
-  protected
+    protected
 
-    attr_reader :results #:nodoc:
+    attr_reader :results # :nodoc:
 
-  private
+    private
 
     # Is this a valid set of transitions?  If the collection was creating with
     # any +false+ values for transitions, then the the collection will be
@@ -129,7 +130,7 @@ module StateMachines
       if transition = self[index]
         throw :halt unless transition.run_callbacks(after: !skip_after) do
           run_callbacks(index + 1, &block)
-          {result: results[transition.action], success: success?}
+          { result: results[transition.action], success: success? }
         end
       else
         persist
@@ -150,13 +151,13 @@ module StateMachines
     def run_actions
       catch_exceptions do
         @success = if block_given?
-          result = yield
-          actions.each { |action| results[action] = result }
-          !!result
-        else
-          actions.compact.each { |action| !skip_actions && (results[action] = object.send(action)) }
-          results.values.all?
-        end
+                     result = yield
+                     actions.each { |action| results[action] = result }
+                     !!result
+                   else
+                     actions.compact.each { |action| !skip_actions && (results[action] = object.send(action)) }
+                     results.values.all?
+                   end
       end
     end
 
@@ -169,12 +170,10 @@ module StateMachines
     # occur will automatically result in the transition rolling back any changes
     # that were made to the object involved.
     def catch_exceptions
-      begin
-        yield
-      rescue
-        rollback
-        raise
-      end
+      yield
+    rescue StandardError
+      rollback
+      raise
     end
 
     # Runs a block within a transaction for the object being transitioned.  If
@@ -194,11 +193,11 @@ module StateMachines
   # Represents a collection of transitions that were generated from attribute-
   # based events
   class AttributeTransitionCollection < TransitionCollection
-    def initialize(transitions = [], options = {}) #:nodoc:
-      super(transitions, {use_transactions: false, actions: false}.merge(options))
+    def initialize(transitions = [], options = {}) # :nodoc:
+      super(transitions, { use_transactions: false, actions: false }.merge(options))
     end
 
-  private
+    private
 
     # Hooks into running transition callbacks so that event / event transition
     # attributes can be properly updated
@@ -214,9 +213,9 @@ module StateMachines
         # Rollback only if exceptions occur during before callbacks
         begin
           super
-        rescue
+        rescue StandardError
           rollback unless @before_run
-          @success = nil  # mimics ActiveRecord.save behavior on rollback
+          @success = nil # mimics ActiveRecord.save behavior on rollback
           raise
         end
 

data/lib/state_machines/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StateMachines
-  VERSION = '0.10.0'
+  VERSION = '0.30.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.6
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '0'
 description: Adds support for creating state machines for attributes on any Ruby class
 email:
 - terminale@gmail.com
@@ -62,7 +62,6 @@ files:
 - LICENSE.txt
 - README.md
 - lib/state_machines.rb
-- lib/state_machines/assertions.rb
 - lib/state_machines/branch.rb
 - lib/state_machines/callback.rb
 - lib/state_machines/core.rb
@@ -77,18 +76,33 @@ files:
 - lib/state_machines/integrations.rb
 - lib/state_machines/integrations/base.rb
 - lib/state_machines/machine.rb
+- lib/state_machines/machine/action_hooks.rb
+- lib/state_machines/machine/callbacks.rb
 - lib/state_machines/machine/class_methods.rb
+- lib/state_machines/machine/configuration.rb
+- lib/state_machines/machine/event_methods.rb
+- lib/state_machines/machine/helper_generators.rb
+- lib/state_machines/machine/integration.rb
+- lib/state_machines/machine/parsing.rb
+- lib/state_machines/machine/rendering.rb
+- lib/state_machines/machine/scoping.rb
+- lib/state_machines/machine/state_methods.rb
+- lib/state_machines/machine/utilities.rb
+- lib/state_machines/machine/validation.rb
 - lib/state_machines/machine_collection.rb
 - lib/state_machines/macro_methods.rb
 - lib/state_machines/matcher.rb
 - lib/state_machines/matcher_helpers.rb
 - lib/state_machines/node_collection.rb
+- lib/state_machines/options_validator.rb
 - lib/state_machines/path.rb
 - lib/state_machines/path_collection.rb
 - lib/state_machines/state.rb
 - lib/state_machines/state_collection.rb
 - lib/state_machines/state_context.rb
 - lib/state_machines/stdio_renderer.rb
+- lib/state_machines/syntax_validator.rb
+- lib/state_machines/test_helper.rb
 - lib/state_machines/transition.rb
 - lib/state_machines/transition_collection.rb
 - lib/state_machines/version.rb
@@ -99,6 +113,7 @@ metadata:
   changelog_uri: https://github.com/state-machines/state_machines/blob/master/CHANGELOG.md
   homepage_uri: https://github.com/state-machines/state_machines
   source_code_uri: https://github.com/state-machines/state_machines
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -106,14 +121,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: State machines for attributes
 test_files: []

data/lib/state_machines/assertions.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-class Hash
-  # Provides a set of helper methods for making assertions about the content
-  # of various objects
-
-  unless respond_to?(:assert_valid_keys)
-    # Validate all keys in a hash match <tt>*valid_keys</tt>, raising ArgumentError
-    # on a mismatch. Note that keys are NOT treated indifferently, meaning if you
-    # use strings for keys but assert symbols as keys, this will fail.
-    #
-    #   { name: 'Rob', years: '28' }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key: :years. Valid keys are: :name, :age"
-    #   { name: 'Rob', age: '28' }.assert_valid_keys('name', 'age') # => raises "ArgumentError: Unknown key: :name. Valid keys are: 'name', 'age'"
-    #   { name: 'Rob', age: '28' }.assert_valid_keys(:name, :age)   # => passes, raises nothing
-    # Code from ActiveSupport
-    def assert_valid_keys(*valid_keys)
-      valid_keys.flatten!
-      each_key do |k|
-        unless valid_keys.include?(k)
-          raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
-        end
-      end
-    end
-  end
-
-  # Validates that the given hash only includes at *most* one of a set of
-  # exclusive keys.  If more than one key is found, an ArgumentError will be
-  # raised.
-  #
-  # == Examples
-  #
-  #   options = {:only => :on, :except => :off}
-  #   options.assert_exclusive_keys(:only)                   # => nil
-  #   options.assert_exclusive_keys(:except)                 # => nil
-  #   options.assert_exclusive_keys(:only, :except)          # => ArgumentError: Conflicting keys: only, except
-  #   options.assert_exclusive_keys(:only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
-  def assert_exclusive_keys(*exclusive_keys)
-    conflicting_keys = exclusive_keys & keys
-    raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1
-  end
-end
-