state_machines 0.5.0 → 0.50.0

data/lib/state_machines/eval_helpers.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'syntax_validator'
+
 module StateMachines
   # Provides a set of helper methods for evaluating methods within the context
   # of an object.
@@ -7,80 +11,234 @@ module StateMachines
     # * Symbol
     # * Method / Proc
     # * String
-    # 
+    #
     # == Examples
-    # 
+    #
     # Below are examples of the various ways that a method can be evaluated
     # on an object:
-    # 
+    #
     #   class Person
     #     def initialize(name)
     #       @name = name
     #     end
-    #     
+    #
     #     def name
     #       @name
     #     end
     #   end
-    #   
+    #
     #   class PersonCallback
     #     def self.run(person)
     #       person.name
     #     end
     #   end
-    # 
+    #
     #   person = Person.new('John Smith')
-    #   
+    #
     #   evaluate_method(person, :name)                            # => "John Smith"
     #   evaluate_method(person, PersonCallback.method(:run))      # => "John Smith"
     #   evaluate_method(person, Proc.new {|person| person.name})  # => "John Smith"
     #   evaluate_method(person, lambda {|person| person.name})    # => "John Smith"
     #   evaluate_method(person, '@name')                          # => "John Smith"
-    # 
+    #
     # == Additional arguments
-    # 
+    #
     # Additional arguments can be passed to the methods being evaluated.  If
     # the method defines additional arguments other than the object context,
     # then all arguments are required.
-    # 
+    #
+    # For guard conditions in state machines, event arguments can be passed
+    # automatically based on the guard's arity:
+    # - Guards with arity 1 receive only the object (backward compatible)
+    # - Guards with arity -1 or > 1 receive object + event arguments
+    #
     # For example,
-    # 
+    #
     #   person = Person.new('John Smith')
-    #   
+    #
     #   evaluate_method(person, lambda {|person| person.name}, 21)                              # => "John Smith"
     #   evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21)          # => "John Smith is 21"
     #   evaluate_method(person, lambda {|person, age| "#{person.name} is #{age}"}, 21, 'male')  # => ArgumentError: wrong number of arguments (3 for 2)
-    def evaluate_method(object, method, *args, &block)
+    #
+    # With event arguments for guards:
+    #
+    #   # Single parameter guard (backward compatible)
+    #   guard = lambda {|obj| obj.valid? }
+    #   evaluate_method_with_event_args(object, guard, [arg1, arg2])  # => calls guard.call(object)
+    #
+    #   # Multi-parameter guard (receives event args)
+    #   guard = lambda {|obj, *args| obj.valid? && args[0] == :force }
+    #   evaluate_method_with_event_args(object, guard, [:force])      # => calls guard.call(object, :force)
+    def evaluate_method(object, method, *args, **, &block)
       case method
-        when Symbol
-          klass = (class << object; self; end)
-          args = [] if (klass.method_defined?(method) || klass.private_method_defined?(method)) && object.method(method).arity == 0
-          object.send(method, *args, &block)
-        when Proc, Method
-          args.unshift(object)
-          arity = method.arity
-          
-          # Procs don't support blocks in < Ruby 1.9, so it's tacked on as an
-          # argument for consistency across versions of Ruby
-          if block_given? && Proc === method && arity != 0
-            if [1, 2].include?(arity)
-              # Force the block to be either the only argument or the 2nd one
-              # after the object (may mean additional arguments get discarded)
-              args = args[0, arity - 1] + [block]
-            else
-              # Tack the block to the end of the args
-              args << block
-            end
+      in Symbol => sym
+        klass = (class << object; self; end)
+        args = [] if (klass.method_defined?(sym) || klass.private_method_defined?(sym)) && object.method(sym).arity.zero?
+        object.send(sym, *args, **, &block)
+      in Proc => proc
+        args.unshift(object)
+        arity = proc.arity
+        # Handle blocks for Procs
+        case [block_given?, arity]
+        in [true, arity] if arity != 0
+          case arity
+          in 1 | 2
+            # Force the block to be either the only argument or the second one
+            # after the object (may mean additional arguments get discarded)
+            args = args[0, arity - 1] + [block]
           else
-            # These method types are only called with 0, 1, or n arguments
-            args = args[0, arity] if [0, 1].include?(arity)
+            # insert the block to the end of the args
+            args << block
           end
-          
-          method.is_a?(Proc) ? method.call(*args) : method.call(*args, &block)
-        when String
-          eval(method, object.instance_eval {binding}, &block)
+        in [_, 0 | 1]
+          # These method types are only called with 0, 1, or n arguments
+          args = args[0, arity]
         else
-          raise ArgumentError, 'Methods must be a symbol denoting the method to call, a block to be invoked, or a string to be evaluated'
+          # No changes needed for other cases
+        end
+
+        # Call the Proc with the arguments
+        proc.call(*args, **)
+
+      in Method => meth
+        args.unshift(object)
+        arity = meth.arity
+
+        # Methods handle blocks via &block, not as arguments
+        # Only limit arguments if necessary based on arity
+        args = args[0, arity] if [0, 1].include?(arity)
+
+        # Call the Method with the arguments and pass the block
+        meth.call(*args, **, &block)
+      in String => str
+        # Input validation for string evaluation
+        validate_eval_string(str)
+
+        case [block_given?, StateMachines::Transition.pause_supported?]
+        in [true, true]
+          eval(str, object.instance_eval { binding }, &block)
+        in [true, false]
+          # Support for JRuby and Truffle Ruby, which don't support binding blocks
+          # Need to check with @headius, if jruby 10 does now.
+          eigen = class << object; self; end
+          eigen.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+                def __temp_eval_method__(*args, &b)
+                  #{str}
+                end
+          RUBY
+          result = object.__temp_eval_method__(*args, &block)
+          eigen.send(:remove_method, :__temp_eval_method__)
+          result
+        in [false, _]
+          eval(str, object.instance_eval { binding })
+        end
+      else
+        raise ArgumentError, 'Methods must be a symbol denoting the method to call, a block to be invoked, or a string to be evaluated'
+      end
+    end
+
+    # Evaluates a guard method with support for event arguments passed to transitions.
+    # This method uses arity detection to determine whether to pass event arguments
+    # to the guard, ensuring backward compatibility.
+    #
+    # == Parameters
+    # * object - The object context to evaluate within
+    # * method - The guard method/proc to evaluate
+    # * event_args - Array of arguments passed to the event (optional)
+    #
+    # == Arity-based behavior
+    # * Arity 1: Only passes the object (backward compatible)
+    # * Arity -1 or > 1: Passes object + event arguments
+    #
+    # == Examples
+    #
+    #   # Backward compatible single-parameter guard
+    #   guard = lambda {|obj| obj.valid? }
+    #   evaluate_method_with_event_args(object, guard, [:force])  # => calls guard.call(object)
+    #
+    #   # New multi-parameter guard receiving event args
+    #   guard = lambda {|obj, *args| obj.valid? && args[0] != :skip }
+    #   evaluate_method_with_event_args(object, guard, [:skip])   # => calls guard.call(object, :skip)
+    def evaluate_method_with_event_args(object, method, event_args = [])
+      case method
+      in Symbol
+        # Symbol methods currently don't support event arguments
+        # This maintains backward compatibility
+        evaluate_method(object, method)
+      in Proc => proc
+        arity = proc.arity
+
+        # Arity-based decision for backward compatibility using pattern matching
+        case arity
+        in 0
+          proc.call
+        in 1
+          proc.call(object)
+        in -1
+          # Splat parameters: object + all event args
+          proc.call(object, *event_args)
+        in arity if arity > 1
+          # Explicit parameters: object + limited event args
+          args_needed = arity - 1 # Subtract 1 for the object parameter
+          proc.call(object, *event_args[0, args_needed])
+        else
+          # Negative arity other than -1 (unlikely but handle gracefully)
+          proc.call(object, *event_args)
+        end
+      in Method => meth
+        arity = meth.arity
+
+        case arity
+        in 0
+          meth.call
+        in 1
+          meth.call(object)
+        in -1
+          meth.call(object, *event_args)
+        in arity if arity > 1
+          args_needed = arity - 1
+          meth.call(object, *event_args[0, args_needed])
+        else
+          meth.call(object, *event_args)
+        end
+      in String
+        # String evaluation doesn't support event arguments for security
+        evaluate_method(object, method)
+      else
+        # Fall back to standard evaluation
+        evaluate_method(object, method)
+      end
+    end
+
+    private
+
+    # Validates string input before eval to prevent code injection
+    # This is a basic safety check - not foolproof security
+    def validate_eval_string(method_string)
+      # Check for obviously dangerous patterns
+      dangerous_patterns = [
+        /`.*`/,           # Backticks (shell execution)
+        /system\s*\(/,    # System calls
+        /exec\s*\(/,      # Exec calls
+        /eval\s*\(/,      # Nested eval
+        /require\s+['"]/, # Require statements
+        /load\s+['"]/, # Load statements
+        /File\./,         # File operations
+        /IO\./,           # IO operations
+        /Dir\./,          # Directory operations
+        /Kernel\./        # Kernel operations
+      ]
+
+      dangerous_patterns.each do |pattern|
+        raise SecurityError, "Potentially dangerous code detected in eval string: #{method_string.inspect}" if method_string.match?(pattern)
+      end
+
+      # Basic syntax validation - but allow yield since it's valid in block context
+      begin
+        test_code = method_string.include?('yield') ? "def dummy_method; #{method_string}; end" : method_string
+        SyntaxValidator.validate!(test_code, '(eval)')
+      rescue SyntaxError => e
+        raise ArgumentError, "Invalid Ruby syntax in eval string: #{e.message}"
       end
     end
   end

data/lib/state_machines/event.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'options_validator'
+
 module StateMachines
   # An event defines an action that transitions an attribute from one state to
   # another.  The state that an attribute is transitioned to depends on the
   # branches configured for the event.
   class Event
-
     include MatcherHelpers
 
     # The state machine for which this event is defined
@@ -12,7 +15,7 @@ module StateMachines
     # The name of the event
     attr_reader :name
 
-    # The fully-qualified name of the event, scoped by the machine's namespace 
+    # The fully-qualified name of the event, scoped by the machine's namespace
     attr_reader :qualified_name
 
     # The human-readable name for the event
@@ -27,20 +30,32 @@ module StateMachines
     attr_reader :known_states
 
     # Creates a new event within the context of the given machine
-    # 
+    #
     # Configuration options:
     # * <tt>:human_name</tt> - The human-readable version of this event's name
-    def initialize(machine, name, options = {}) #:nodoc:
-      options.assert_valid_keys(:human_name)
+    def initialize(machine, name, options = nil, human_name: nil, **extra_options) # :nodoc:
+      # Handle both old hash style and new kwargs style for backward compatibility
+      case options
+      in Hash
+        # Old style: initialize(machine, name, {human_name: 'Custom Name'})
+        StateMachines::OptionsValidator.assert_valid_keys!(options, :human_name)
+        human_name = options[:human_name]
+      in nil
+        # New style: initialize(machine, name, human_name: 'Custom Name')
+        StateMachines::OptionsValidator.assert_valid_keys!(extra_options, :human_name) unless extra_options.empty?
+      else
+        # Handle unexpected options
+        raise ArgumentError, "Unexpected positional argument in Event initialize: #{options.inspect}"
+      end
 
       @machine = machine
       @name = name
       @qualified_name = machine.namespace ? :"#{name}_#{machine.namespace}" : name
-      @human_name = options[:human_name] || @name.to_s.tr('_', ' ')
+      @human_name = human_name || @name.to_s.tr('_', ' ')
       reset
 
       # Output a warning if another event has a conflicting qualified name
-      if conflict = machine.owner_class.state_machines.detect { |_other_name, other_machine| other_machine != @machine && other_machine.events[qualified_name, :qualified_name] }
+      if (conflict = machine.owner_class.state_machines.detect { |_other_name, other_machine| other_machine != @machine && other_machine.events[qualified_name, :qualified_name] })
         _name, other_machine = conflict
         warn "Event #{qualified_name.inspect} for #{machine.name.inspect} is already defined in #{other_machine.name.inspect}"
       else
@@ -50,7 +65,7 @@ module StateMachines
 
     # Creates a copy of this event in addition to the list of associated
     # branches to prevent conflicts across events within a class hierarchy.
-    def initialize_copy(orig) #:nodoc:
+    def initialize_copy(orig) # :nodoc:
       super
       @branches = @branches.dup
       @known_states = @known_states.dup
@@ -64,24 +79,24 @@ module StateMachines
 
     # Evaluates the given block within the context of this event.  This simply
     # provides a DSL-like syntax for defining transitions.
-    def context(&block)
-      instance_eval(&block)
+    def context(&)
+      instance_eval(&)
     end
 
     # Creates a new transition that determines what to change the current state
     # to when this event fires.
-    # 
+    #
     # Since this transition is being defined within an event context, you do
     # *not* need to specify the <tt>:on</tt> option for the transition.  For
     # example:
-    # 
+    #
     #  state_machine do
     #    event :ignite do
     #      transition :parked => :idling, :idling => same, :if => :seatbelt_on? # Transitions to :idling if seatbelt is on
     #      transition all => :parked, :unless => :seatbelt_on?                  # Transitions to :parked if seatbelt is off
     #    end
     #  end
-    # 
+    #
     # See StateMachines::Machine#transition for a description of the possible
     # configurations for defining transitions.
     def transition(options)
@@ -89,18 +104,18 @@ module StateMachines
 
       # Only a certain subset of explicit options are allowed for transition
       # requirements
-      options.assert_valid_keys(:from, :to, :except_from, :except_to, :if, :unless) if (options.keys - [:from, :to, :on, :except_from, :except_to, :except_on, :if, :unless]).empty?
+      StateMachines::OptionsValidator.assert_valid_keys!(options, :from, :to, :except_from, :except_to, :if, :unless, :if_state, :unless_state, :if_all_states, :unless_all_states, :if_any_state, :unless_any_state) if (options.keys - %i[from to on except_from except_to except_on if unless if_state unless_state if_all_states unless_all_states if_any_state unless_any_state]).empty?
 
-      branches << branch = Branch.new(options.merge(:on => name))
+      branches << branch = Branch.new(options.merge(on: name))
       @known_states |= branch.known_states
       branch
     end
 
     # Determines whether any transitions can be performed for this event based
     # on the current state of the given object.
-    # 
+    #
     # If the event can't be fired, then this will return false, otherwise true.
-    # 
+    #
     # *Note* that this will not take the object context into account.  Although
     # a transition may be possible based on the state machine definition,
     # object-specific behaviors (like validations) may prevent it from firing.
@@ -110,7 +125,7 @@ module StateMachines
 
     # Finds and builds the next transition that can be performed on the given
     # object.  If no transitions can be made, then this will return nil.
-    # 
+    #
     # Valid requirement options:
     # * <tt>:from</tt> - One or more states being transitioned from.  If none
     #   are specified, then this will be the object's current state.
@@ -118,24 +133,26 @@ module StateMachines
     #   specified, then this will match any to state.
     # * <tt>:guard</tt> - Whether to guard transitions with the if/unless
     #   conditionals defined for each one.  Default is true.
-    def transition_for(object, requirements = {})
-      requirements.assert_valid_keys(:from, :to, :guard)
-      requirements[:from] = machine.states.match!(object).name unless custom_from_state = requirements.include?(:from)
+    #
+    # Event arguments are passed to guard conditions if they accept multiple parameters.
+    def transition_for(object, requirements = {}, *event_args)
+      StateMachines::OptionsValidator.assert_valid_keys!(requirements, :from, :to, :guard)
+      requirements[:from] = machine.states.match!(object).name unless (custom_from_state = requirements.include?(:from))
 
       branches.each do |branch|
-        if match = branch.match(object, requirements)
-          # Branch allows for the transition to occur
-          from = requirements[:from]
-          to = if match[:to].is_a?(LoopbackMatcher)
-                 from
-               else
-                 values = requirements.include?(:to) ? [requirements[:to]].flatten : [from] | machine.states.map { |state| state.name }
-
-                 match[:to].filter(values).first
-               end
-
-          return Transition.new(object, machine, name, from, to, !custom_from_state)
-        end
+        next unless (match = branch.match(object, requirements, event_args))
+
+        # Branch allows for the transition to occur
+        from = requirements[:from]
+        to = if match[:to].is_a?(LoopbackMatcher)
+               from
+             else
+               values = requirements.include?(:to) ? [requirements[:to]].flatten : [from] | machine.states.map { |state| state.name }
+
+               match[:to].filter(values).first
+             end
+
+        return Transition.new(object, machine, name, from, to, !custom_from_state)
       end
 
       # No transition matched
@@ -145,27 +162,29 @@ module StateMachines
     # Attempts to perform the next available transition on the given object.
     # If no transitions can be made, then this will return false, otherwise
     # true.
-    # 
+    #
     # Any additional arguments are passed to the StateMachines::Transition#perform
     # instance method.
-    def fire(object, *args)
+    def fire(object, *event_args)
       machine.reset(object)
 
-      if transition = transition_for(object)
-        transition.perform(*args)
+      if (transition = transition_for(object, {}, *event_args))
+        transition.perform(*event_args)
       else
-        on_failure(object)
+        on_failure(object, *event_args)
         false
       end
     end
 
     # Marks the object as invalid and runs any failure callbacks associated with
     # this event.  This should get called anytime this event fails to transition.
-    def on_failure(object)
+    def on_failure(object, *args)
       state = machine.states.match!(object)
       machine.invalidate(object, :state, :invalid_transition, [[:event, human_name(object.class)], [:state, state.human_name(object.class)]])
 
-      Transition.new(object, machine, name, state.name, state.name).run_callbacks(:before => false)
+      transition = Transition.new(object, machine, name, state.name, state.name)
+      transition.args = args if args.any?
+      transition.run_callbacks(before: false)
     end
 
     # Resets back to the initial state of the event, with no branches / known
@@ -177,51 +196,51 @@ module StateMachines
       @known_states = []
     end
 
-
-    def draw(graph, options = {})
-      fail NotImplementedError
+    def draw(graph, options = {}, io = $stdout)
+      machine.renderer.draw_event(self, graph, options, io)
     end
 
     # Generates a nicely formatted description of this event's contents.
-    # 
+    #
     # For example,
-    # 
+    #
     #   event = StateMachines::Event.new(machine, :park)
     #   event.transition all - :idling => :parked, :idling => same
     #   event   # => #<StateMachines::Event name=:park transitions=[all - :idling => :parked, :idling => same]>
     def inspect
-      transitions = branches.map do |branch|
+      transitions = branches.flat_map do |branch|
         branch.state_requirements.map do |state_requirement|
           "#{state_requirement[:from].description} => #{state_requirement[:to].description}"
-        end * ', '
-      end
+        end
+      end.join(', ')
 
-      "#<#{self.class} name=#{name.inspect} transitions=[#{transitions * ', '}]>"
+      "#<#{self.class} name=#{name.inspect} transitions=[#{transitions}]>"
     end
 
     protected
+
     # Add the various instance methods that can transition the object using
     # the current event
     def add_actions
       # Checks whether the event can be fired on the current object
-      machine.define_helper(:instance, "can_#{qualified_name}?") do |machine, object, *args|
-        machine.event(name).can_fire?(object, *args)
+      machine.define_helper(:instance, "can_#{qualified_name}?") do |machine, object, *args, **kwargs|
+        machine.event(name).can_fire?(object, *args, **kwargs)
       end
 
       # Gets the next transition that would be performed if the event were
       # fired now
-      machine.define_helper(:instance, "#{qualified_name}_transition") do |machine, object, *args|
-        machine.event(name).transition_for(object, *args)
+      machine.define_helper(:instance, "#{qualified_name}_transition") do |machine, object, *args, **kwargs|
+        machine.event(name).transition_for(object, *args, **kwargs)
       end
 
       # Fires the event
-      machine.define_helper(:instance, qualified_name) do |machine, object, *args|
-        machine.event(name).fire(object, *args)
+      machine.define_helper(:instance, qualified_name) do |machine, object, *args, **kwargs|
+        machine.event(name).fire(object, *args, **kwargs)
       end
 
       # Fires the event, raising an exception if it fails
-      machine.define_helper(:instance, "#{qualified_name}!") do |machine, object, *args|
-        object.send(qualified_name, *args) || raise(StateMachines::InvalidTransition.new(object, machine, name))
+      machine.define_helper(:instance, "#{qualified_name}!") do |machine, object, *args, **kwargs|
+        object.send(qualified_name, *args, **kwargs) || raise(StateMachines::InvalidTransition.new(object, machine, name))
       end
     end
   end