lite-command 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db69c57c2f2a1dbc5df71aac409ce0941225ac7cafa475fc2644b2598a0878c6
-  data.tar.gz: 83f5bd351a8f8ff270a3a27b561c19cae7a30478dbf1dff2f76b08c2bbe89dcd
+  metadata.gz: 86f89baebccec981ab697dbe02cc25cae4f143f881b4a765719147eb832b9ae5
+  data.tar.gz: 39b8e5010d1b4c107be5b6f2396e86730f85c2d115a8ee6f3e8585daf8754543
 SHA512:
-  metadata.gz: 9b945016a9fa3a9548def3c5a47e519ee53d2f5751699c95ed1041737682bcdd80fa1450d6deaec40fa3501b6c2bd2ace8e117331103009493985b08cb8a53bf
-  data.tar.gz: 8d0f91b8f9273528114b65afe9855ad3fa83aececccdfc3dedba70c94bc70e9d3b0d5798c6594dcf0e656719711d3d0cebb32fab0c0696ae8d1830536cd5981d
+  metadata.gz: dab8d3533ec7efa114f6119dff6ec6e172c1de828a8bcfe9f968939d227e98bfc3f6607f5d0de621a49cdd0edf17dbe4b893739720a9ae768d8eae9f8de6331a
+  data.tar.gz: e116e71fe7c0c895579e7d8bcc22b444c3cb681fe634cc435fb286ca5917bb6bb96a6c88848a3aa6e34c20a16efe0956605188448ef408b8cc0746637b1047ae

data/.rubocop.yml

@@ -7,6 +7,8 @@ AllCops:
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
+Gemspec/RequireMFA:
+  Enabled: false
 Gemspec/RequiredRubyVersion:
   Enabled: false
 Layout/EmptyLinesAroundAttributeAccessor:

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.0] - 2022-04-19
+### Changed
+- Update docs
+- Rename internal variables for more clarity
+- Improved spec checkers
+
 ## [1.4.1] - 2021-09-04
 ### Changed
 - Fixed nil issue with `assign_and_return!`

data/Gemfile.lock

@@ -1,41 +1,40 @@
 PATH
   remote: .
   specs:
-    lite-command (1.4.1)
+    lite-command (1.5.0)
       lite-errors
       lite-memoize
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activerecord (6.1.4.1)
-      activemodel (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     database_cleaner (2.0.1)
       database_cleaner-active_record (~> 2.0.0)
@@ -43,7 +42,7 @@ GEM
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     erubi (1.10.0)
     fasterer (0.9.0)
       colorize (~> 0.7)
@@ -51,23 +50,23 @@ GEM
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     lite-errors (1.2.1)
     lite-memoize (1.1.1)
-    loofah (2.12.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    nokogiri (1.12.4)
-      mini_portile2 (~> 2.6.1)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.2)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -76,58 +75,58 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.4.1)
-      actionpack (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.20.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.5)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    ruby_parser (3.17.0)
-      sexp_processor (~> 4.15, >= 4.15.1)
-    sexp_processor (4.15.3)
+    ruby_parser (3.19.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
     sqlite3 (1.4.2)
-    thor (1.1.0)
+    thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -148,4 +147,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.26
+   2.3.11

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/drexed/lite-command.svg?branch=master)](https://travis-ci.org/drexed/lite-command)
 
 Lite::Command provides an API for building simple and complex command based service objects.
-It provides mixins for handling errors and memoization to improve your object workflow productivity.
+It provides extensions for handling errors and memoization to improve your object workflow productivity.
 
 ## Installation
 
@@ -44,41 +44,49 @@ fallback to `Lite::Command::Complex`.
 
 ## Simple
 
-Simple commands build quick class based calls but cannot be extended.
-This is more of a traditional command service call as it only exposes a `call` method.
+Simple commands are a traditional command service call objects.
+It only exposes a `call` method that returns a value.
+
+**Setup**
 
 ```ruby
-class SearchMovies < Lite::Command::Simple
+class CalculatePower < Lite::Command::Simple
 
-  # NOTE: This class method is required
-  def self.execute(*args)
-    { generate_fingerprint => movies_by_name }
+  # NOTE: This `execute` class method is required to use with call
+  def self.execute(a, b)
+    a**b
   end
 
 end
 ```
 
-**Caller**
+**Callers**
 
 ```ruby
-SearchMovies.call('Toy Story')
+CalculatePower.execute(2, 2) #=> 4
+
+# - or -
+
+CalculatePower.call(2, 3) #=> 8
 ```
 
 ## Complex
 
-Complex commands can be used in instance and class based calls and
-extended with access to errors and memoization.
+Complex commands are powerful command service call objects.
+It can be extended to use error, memoization, and propagation mixins.
 
-You will then need to fill this class with the required `execute` method as shown below:
+**Setup**
 
 ```ruby
 class SearchMovies < Lite::Command::Complex
 
+  attr_reader :name
+
   def initialize(name)
     @name = name
   end
 
-  # NOTE: This instance method is required
+  # NOTE: This `execute` instance method is required to use with call
   def execute
     { generate_fingerprint => movies_by_name }
   end
@@ -86,7 +94,7 @@ class SearchMovies < Lite::Command::Complex
   private
 
   def movies_by_name
-    HTTP.get("http://movies.com?title=#{title}")
+    HTTP.get("http://movies.com?title=#{name}")
   end
 
   def generate_fingerprint
@@ -99,6 +107,10 @@ end
 **Caller**
 
 ```ruby
+SearchMovies.execute('Toy Story') #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
+
+# - or -
+
 command = SearchMovies.new('Toy Story')
 command.called? #=> false
 command.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
@@ -109,12 +121,6 @@ command.called? #=> true
 command = SearchMovies.call('Toy Story')
 command.called? #=> true
 command.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
-
-# - or -
-
-# Useful when you are not using the Errors mixin as its a one time access call.
-# Very similar to the simple command builder.
-SearchMovies.execute('Toy Story') #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
 ```
 
 **Result**
@@ -126,35 +132,33 @@ command.result  #=> nil
 command.call    #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
 command.result  #=> { 'fingerprint_1' => [ 'Toy Story 1', ... ] }
 
-command.recall! #=> Clears the call, cache, errors, and then re-performs the call
+command.recall! #=> Clears the `call`, `cache`, `errors` variables and then re-performs the call
 command.result  #=> { 'fingerprint_2' => [ 'Toy Story 2', ... ] }
 ```
 
 ## Procedure
 
-Procedures run a collection of commands. It uses the the complex procedure API
+Procedures are used to run a collection of commands. It uses the the complex procedure API
 so it has access to all the methods. The `execute` method is already defined to
 handle most common procedure steps. It can be use directly or subclassed.
 
+**Setup**
+
 ```ruby
 class SearchChannels < Lite::Command::Procedure; end
+```
 
-procedure = SearchChannels.call(
-  DisneyChannel.new,
-  EspnChannel.new(current_station),
-  MtvChannel.new
-)
+```ruby
+commands = [DisneyChannel.new, EspnChannel.new(current_station), MtvChannel.new]
 
+procedure = SearchChannels.call(*commands)
 procedure.result #=> ['disney: #3', 'espn: #59', 'mtv: #212']
 procedure.steps  #=> [<DisneyChannel  @result="...">, <EspnChannel @result="...">, <MtvChannel  @result="...">]
 
-# If the errors extension is added you can stop the procedure at first failure.
-procedure = SearchChannels.new(
-  DisneyChannel.new,
-  ErrorChannel.new(current_station),
-  MtvChannel.new
-)
+# - or -
 
+# If the errors extension is added you can stop the procedure at first failure.
+procedure = SearchChannels.new(*commands)
 procedure.exit_on_failure = true
 procedure.call
 procedure.result #=> ['disney: #3']
@@ -169,6 +173,8 @@ Extend complex (and procedures) base command with any of the following extension
 
 Learn more about using [Lite::Errors](https://github.com/drexed/lite-errors)
 
+**Setup**
+
 ```ruby
 class SearchMovies < Lite::Command::Complex
   include Lite::Command::Extensions::Errors
@@ -177,28 +183,21 @@ class SearchMovies < Lite::Command::Complex
 
   private
 
-  # Add a fingerprint error to the error pool
+  # Add a explicit and/or exception errors to the error pool
   def generate_fingerprint
-    errors.add(:fingerprint, 'invalid md5 request value') if movies_by_name.nil?
-    Digest::MD5.hexdigest(movies_by_name)
-  rescue ArgumentError => e
-    merge_exception!(e, key: :custom_key)
+    if movies_by_name.nil?
+      errors.add(:fingerprint, 'invalid md5 request value')
+    else
+      Digest::MD5.hexdigest(movies_by_name)
+    end
+  rescue ArgumentError => exception
+    merge_exception!(exception, key: :custom_error_key)
   end
 
 end
 ```
 
-**Callers**
-
-```ruby
-# Useful for controllers or actions that depend on states.
-SearchMovies.perform('Toy Story') do |result, success, failure|
-  success.call { redirect_to(movie_path, notice: "Movie can be found at: #{result}") }
-  failure.call { redirect_to(root_path, notice: "Movie cannot be found at: #{result}") }
-end
-```
-
-**Methods**
+**Instance Callers**
 
 ```ruby
 command = SearchMovies.call('Toy Story')
@@ -220,6 +219,16 @@ command.merge_errors!(command_2)
 user_model.merge_errors!(command, direction: :to)
 ```
 
+**Block Callers**
+
+```ruby
+# Useful for controllers or actions that depend on states.
+SearchMovies.perform('Toy Story') do |result, success, failure|
+  success.call { redirect_to(movie_path, notice: "Movie can be found at: #{result}") }
+  failure.call { redirect_to(root_path, notice: "Movie cannot be found at: #{result}") }
+end
+```
+
 ### Propagation (optional)
 
 Propagation methods help you perform an action on an object. If successful is
@@ -232,6 +241,8 @@ propagation methods are:
   - `archive_and_return!(object)` (if using Lite::Archive)
   - `save_and_return!(object)`
 
+**Setup**
+
 ```ruby
 class SearchMovies < Lite::Command::Complex
   include Lite::Command::Extensions::Errors
@@ -250,6 +261,8 @@ end
 
 Learn more about using [Lite::Memoize](https://github.com/drexed/lite-memoize)
 
+**Setup**
+
 ```ruby
 class SearchMovies < Lite::Command::Complex
   include Lite::Command::Extensions::Memoize
@@ -262,7 +275,7 @@ class SearchMovies < Lite::Command::Complex
   # Subsequent method calls gets the cached value
   # This saves you the extra external HTTP.get call
   def movies_by_name
-    cache.memoize { HTTP.get("http://movies.com?title=#{title}") }
+    cache.memoize { HTTP.get("http://movies.com?title=#{name}") }
   end
 
   # Gets the value in the cache
@@ -273,7 +286,7 @@ class SearchMovies < Lite::Command::Complex
 end
 ```
 
-**Methods**
+**Callers**
 
 ```ruby
 command = SearchMovies.call('Toy Story')

data/lib/lite/command/complex.rb

@@ -7,16 +7,17 @@ module Lite
       class << self
 
         def call(*args, **kwargs, &block)
-          klass = new(*args, **kwargs, &block)
-          raise Lite::Command::NotImplementedError unless klass.respond_to?(:execute)
+          instance = new(*args, **kwargs, &block)
 
-          klass.call
-          klass
+          raise Lite::Command::NotImplementedError unless instance.respond_to?(:execute)
+
+          instance.call
+          instance
         end
 
         def execute(*args, **kwargs, &block)
-          klass = call(*args, **kwargs, &block)
-          klass.result
+          instance = call(*args, **kwargs, &block)
+          instance.result
         end
 
       end
@@ -29,6 +30,7 @@ module Lite
 
       def call
         raise Lite::Command::NotImplementedError unless defined?(execute)
+
         return @result if called?
 
         @called = true
@@ -41,7 +43,7 @@ module Lite
 
       def recall!
         @called = false
-        %i[cache errors].each { |mixin| send(mixin).clear if respond_to?(mixin) }
+        %i[cache errors].each { |method_name| send(method_name).clear if respond_to?(method_name) }
         call
       end
 

data/lib/lite/command/exceptions.rb

@@ -4,7 +4,6 @@ module Lite
   module Command
 
     class NotImplementedError < StandardError; end
-
     class ValidationError < StandardError; end
 
   end

data/lib/lite/command/extensions/errors.rb

@@ -10,12 +10,12 @@ module Lite
         module ClassMethods
 
           def perform(*args, **kwargs, &block)
-            klass = call(*args, **kwargs, &block)
+            instance = call(*args, **kwargs, &block)
 
-            if klass.success?
-              yield(klass.result, Lite::Command::Success, Lite::Command::Failure)
+            if instance.success?
+              yield(instance.result, Lite::Command::Success, Lite::Command::Failure)
             else
-              yield(klass.result, Lite::Command::Failure, Lite::Command::Success)
+              yield(instance.result, Lite::Command::Failure, Lite::Command::Success)
             end
           end
 
@@ -45,10 +45,10 @@ module Lite
           called? && errored?
         end
 
-        def merge_errors!(klass, direction: :from)
+        def merge_errors!(instance, direction: :from)
           case direction
-          when :from then errors.merge!(klass.errors)
-          when :to then klass.errors.merge!(errors)
+          when :from then errors.merge!(instance.errors)
+          when :to then instance.errors.merge!(errors)
           end
 
           nil

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = '1.4.1'
+    VERSION = '1.5.0'
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lite-errors
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Ruby Command based framework (aka service objects)