simply_fsm 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b86e3a94184036d2ba485db8452bcf2c4ad3c8314e71b56b481f1a428d253ad
-  data.tar.gz: 445b68adba6dc1d0376473288af06a04026bdeb055616c0ef3a31acb6f1b068d
+  metadata.gz: e86bd7cca4df06c4ada7a53528e2e0f5853fc9055bf0bb808c4cd029b552ad37
+  data.tar.gz: 6ad8c2cfe781b729316f0df6707be5c10c17e0ed4e865a7042c22504e2039e0c
 SHA512:
-  metadata.gz: c754997ecccc818fab23c9079cf6f4f274cd8ab484ea56af7eee49ebc69ce97985814cb0ef0910088e339e8839b6fc4ab8f07848b014313c1106f8f8f310cdb0
-  data.tar.gz: e11e94844f8a0e6dcad77b4cc8dc642afeced63c31678d1ac0278d19825e7e194062fa3d569381bac36be9465f85ccf1f500355a08681372cf455a43f03dbbf9
+  metadata.gz: c3dea4db713c9cc75ef314ba8c536d7a0847fa396f12af0e69b951eb78a2bb20c3ed6f620aa1c11cb26f23087c93891ccf6d5cc78fd17abc4e2f0ab130819748
+  data.tar.gz: 659bf78f96bf5bd41cc9cf03c50387d165c04148de5cfc6ea89955f18707f72ab2cfec271d36e2424622a528783b6a13dd88222ee695ce65497d0e930f8df603

data/.gitignore

@@ -3,6 +3,7 @@
 /_yardoc/
 /coverage/
 /doc/
+/rdoc/
 /pkg/
 /spec/reports/
 /tmp/

data/.rubocop.yml

@@ -1,6 +1,10 @@
 AllCops:
   TargetRubyVersion: 2.7
 
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -11,3 +15,13 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 256
+  
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+- None right now
+
+## [0.1.2] - 2022-02-28
+
+- Cleaned up source with smaller clearer methods
+- Added `rdoc` support, include `rake rdoc` task
+
 ## [0.1.1] - 2022-02-21
 
 - Separated version file, fixed URLs in Gem spec, added badge to README

data/Gemfile.lock

@@ -11,8 +11,12 @@ GEM
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
+    psych (4.0.3)
+      stringio
     rainbow (3.1.1)
     rake (13.0.6)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -40,6 +44,7 @@ GEM
     rubocop-ast (1.15.2)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
+    stringio (3.0.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -47,6 +52,7 @@ PLATFORMS
 
 DEPENDENCIES
   rake (~> 13.0)
+  rdoc
   rspec (~> 3.0)
   rubocop (~> 1.21)
   simply_fsm!

data/Rakefile

@@ -7,6 +7,16 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 
+require "rdoc/task"
+# require "simply_fsm/version"
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "simply_fsm #{SimplyFSM::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]

data/lib/simply_fsm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimplyFSM
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/simply_fsm.rb

@@ -1,19 +1,29 @@
 # frozen_string_literal: true
 
-require 'simply_fsm/version'
+require "simply_fsm/version"
 
+##
+# Defines the `SimplyFSM` module
 module SimplyFSM
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  ##
+  # Defines the constructor for defining a state machine
   module ClassMethods
+    ##
+    # Declare a state machine called +name+ which can then be defined
+    # by a DSL defined by the methods of `StateMachine`, with the following +opts+:
+    # - an optional +fail+ lambda that is called when any event fails to transition)
     def state_machine(name, opts = {}, &block)
       fsm = StateMachine.new(name, self, fail: opts[:fail])
       fsm.instance_eval(&block)
     end
   end
 
+  ##
+  # The DSL for defining a state machine
   class StateMachine
     attr_reader :initial_state, :states, :events, :name, :full_name
 
@@ -29,93 +39,111 @@ module SimplyFSM
       setup_base_methods
     end
 
+    ##
+    # Declare a supported +state_name+, and optionally specify one as the +initial+ state.
     def state(state_name, initial: false)
-      unless state_name.nil? || @states.include?(state_name)
-        status = state_name.to_sym
-        state_machine_name = @name
-        @states << status
-        @initial_state = status if initial
-
-        make_owner_method "#{state_name}?", lambda {
-          send(state_machine_name) == status
-        }
-      end
+      return if state_name.nil? || @states.include?(state_name)
+
+      status = state_name.to_sym
+      state_machine_name = @name
+      @states << status
+      @initial_state = status if initial
+
+      make_owner_method "#{state_name}?", lambda {
+        send(state_machine_name) == status
+      }
     end
 
+    ##
+    # Define an event by +event_name+ and
+    # - its +transition+ as a hash with a +from+ state or array of states and the +to+ state,
+    # - an optional +guard+ lambda which must return true for the transition to occur,
+    # - an optional +fail+ lambda that is called when the transition fails (overrides top-level fail handler), and
+    # - an optional do block that is called +after+ the transition succeeds
     def event(event_name, transition:, guard: nil, fail: nil, &after)
-      if event_name && transition
-        @events << event_name
-        from = transition[:from]
-        to = transition[:to]
-        state_machine_name = @name
-        var_name = "@#{state_machine_name}"
-        may_event_name = "may_#{event_name}?"
-        fail = @fail_handler if fail.nil?
-
-        setup_may_event_method may_event_name, from, to, guard
-
-        #
-        # Setup the event method to attempt to make the state
-        # transition or report failure
-        make_owner_method event_name, lambda {
-          if send(may_event_name)
-            instance_variable_set(var_name, to)
-            instance_exec(&after) if after
-            return true
-          end
-          # unable to satisfy pre-conditions for the event
-          if fail
-            if fail.is_a?(String) || fail.is_a?(Symbol)
-              send(fail, event_name)
-            else
-              instance_exec(event_name, &fail)
-            end
-          end
-          false
-        }
+      return unless event_exists?(event_name) && transition
 
-      end
+      @events << event_name
+      to = transition[:to]
+      may_event_name = "may_#{event_name}?"
+
+      setup_may_event_method may_event_name, transition[:from], to, guard
+      setup_event_method event_name, var_name: "@#{@name}",
+                                     may_event_name: may_event_name, to: to,
+                                     fail: fail || @fail_handler, &after
     end
 
     private
 
+    def event_exists?(event_name)
+      event_name && !@events.include?(event_name)
+    end
+
+    def setup_event_method(event_name, var_name:, may_event_name:, to:, fail:, &after)
+      method_lambda = lambda {
+        if send(may_event_name)
+          instance_variable_set(var_name, to)
+          instance_exec(&after) if after
+          return true
+        end
+        # unable to satisfy pre-conditions for the event
+        if fail
+          if fail.is_a?(String) || fail.is_a?(Symbol)
+            send(fail, event_name)
+          else
+            instance_exec(event_name, &fail)
+          end
+        end
+        false
+      }
+      make_owner_method event_name, method_lambda
+    end
+
     def setup_may_event_method(may_event_name, from, _to, guard)
       state_machine_name = @name
       #
-      # Instead of one "may_event?" method that checks all variations
-      # every time it's called, here we check the event definition and
-      # define the most optimal lambda to ensure the check is as fast as
-      # possible
+      # Instead of one "may_event?" method that checks all variations every time it's called, here we check
+      # the event definition and define the most optimal lambda to ensure the check is as fast as possible
       method_lambda = if from == :any && !guard
                         -> { true } # unguarded transition from any state
                       elsif from == :any
-                        guard         # guarded transition from any state
+                        guard # guarded transition from any state
                       elsif !guard
-                        if from.is_a?(Array)
-                          lambda {    # unguarded transition from choice of states
-                            current = send(state_machine_name)
-                            from.include?(current)
-                          }
-                        else
-                          lambda {    # unguarded transition from one state
-                            current = send(state_machine_name)
-                            from == current
-                          }
-                        end
-                      elsif from.is_a?(Array)
-                        lambda {    # guarded transition from choice of states
-                          current = send(state_machine_name)
-                          from.include?(current) && instance_exec(&guard)
-                        }
+                        guardless_may_event_lambda(from, state_machine_name)
                       else
-                        lambda {    # guarded transition from one state
-                          current = send(state_machine_name)
-                          from == current && instance_exec(&guard)
-                        }
+                        guarded_may_event_lambda(from, guard, state_machine_name)
                       end
       make_owner_method may_event_name, method_lambda
     end
 
+    def guarded_may_event_lambda(from, guard, state_machine_name)
+      if from.is_a?(Array)
+        lambda { # guarded transition from choice of states
+          current = send(state_machine_name)
+          from.include?(current) && instance_exec(&guard)
+        }
+      else
+        lambda { # guarded transition from one state
+          current = send(state_machine_name)
+          from == current && instance_exec(&guard)
+        }
+      end
+    end
+
+    def guardless_may_event_lambda(from, state_machine_name)
+      if from.is_a?(Array)
+        lambda {    # unguarded transition from choice of states
+          current = send(state_machine_name)
+          from.include?(current)
+        }
+      else
+        lambda {    # unguarded transition from one state
+          current = send(state_machine_name)
+          from == current
+        }
+      end
+    end
+
     def setup_base_methods
       var_name = "@#{name}"
       fsm = self

data/simply_fsm.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   # no deployment dependencies
 
   # development
+  spec.add_development_dependency "rdoc"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: simply_fsm
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - nogginly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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
@@ -76,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Simple finite state mechine (FSM) data-type mixin for Ruby objects.