lib/transitions/state_transition.rb in transitions-1.0.0 vs lib/transitions/state_transition.rb in transitions-1.0.1

@@ -1,18 +1,47 @@
 module Transitions
   class StateTransition
-    attr_reader :from, :to, :options
+    attr_reader :from, :to, :guard, :on_transition
+    # TODO: `from` and `to` should be private as well
+    private :guard, :on_transition
 
     def initialize(opts)
-      @from, @to, @guard, @on_transition = opts[:from], opts[:to], opts[:guard], opts[:on_transition]
+      @from = opts[:from]
+      @to = opts[:to]
+      @guard = opts[:guard]
+      @on_transition = opts[:on_transition]
       @options = opts
     end
 
+    #
+    # @param obj [Any] - the subject
+    # @param args [Array<Symbol>] - any arguments passed into the transition method
+    #   E.g. something like
+    #     car.drive!(:fast, :now)
+    #   with `car` being the subject and `drive` the transition method would result
+    #   in `args` looking like this:
+    #     [:fast, :now]
+    #
+    # @return [Bool]
+    #
     def executable?(obj, *args)
       [@guard].flatten.all? { |g| perform_guard(obj, g, *args) }
     end
 
+    #
+    # @param obj [Any] - the subject
+    # @param args [Array<Symbol>] - any arguments passed into the transition method
+    #   E.g. something like
+    #     car.drive!(:fast, :now)
+    #   with `car` being the subject and `drive` the transition method would result
+    #   in `args` looking like this:
+    #     [:fast, :now]
+    #
+    # @return [void]
+    #
+    # rubocop:disable Metrics/MethodLength
+    #
     def execute(obj, *args)
       case @on_transition
       when Symbol, String
         obj.send(@on_transition, *args)
       when Proc
@@ -22,16 +51,18 @@
           # Yes, we're passing always the same parameters for each callback in here.
           # We should probably drop args altogether in case we get an array.
           obj.send(callback, *args)
         end
       else
-        # TODO We probably should check for this in the constructor and not that late.
-        fail ArgumentError, "You can only pass a Symbol, a String, a Proc or an Array to 'on_transition' - got #{@on_transition.class}." unless @on_transition.nil?
+        # TODO: We probably should check for this in the constructor and not that late.
+        fail ArgumentError,
+             "You can only pass a Symbol, a String, a Proc or an Array to 'on_transition'"\
+             " - got #{@on_transition.class}." unless @on_transition.nil?
       end
     end
 
-    def ==(obj)
-      @from == obj.from && @to == obj.to
+    def ==(other)
+      @from == other.from && @to == other.to
     end
 
     def from?(value)
       @from == value
     end