lite-command 1.0.8 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4084a5f3eb0c1fa527bf77fe30ea4bee37dc6d39b78e39b430f217c523cb59ef
-  data.tar.gz: b5a15fab4f5ce31f88de912d4896209906ab111b86f39e899ff5e5473aef8301
+  metadata.gz: 8276865933176a07427bd4a80d4d3bcdf256feb6eaccb7826853f66a5dabc3a0
+  data.tar.gz: 623626a014811b47eddc3a2adbe757444083c0d0ec98a5aad30b50a5b5b9e606
 SHA512:
-  metadata.gz: 4598cb719b2e06eb190a1adfcb2e3c6c0c70685dcc64597afc9d49b53725ee6d0901b73dca3c1e5a4a8dba63b0f83ed80e89494e8c5896da2f007ded0e71362e
-  data.tar.gz: 05a7ec0137f15ed0dcf57403a799d144bae8971230c4d72c26037a30cfaa2202f54777b81fc0232bd559a24794c9d9afd3827f06c46135db03f92a136594b636
+  metadata.gz: b215647faddd4a9ffe954f4a439cfcc6cf59c60d5719541abe2b74c544e0eaee9a425833009eefc31c664e5c38f9d972e0e0e8490328d0612f2f357d7f21e81a
+  data.tar.gz: ce6049235be9c026c1ce070e22bb3dd5ca740bed64a15f5fc5f25f007b398aefa17de2e6118376bf6a437326735ee0ec384615b725e774f055818f2aa7d128fe

data/.rubocop.yml

@@ -1,12 +1,16 @@
 require:
   - rubocop-performance
+  - rubocop-rake
   - rubocop-rspec
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+  NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
-LineLength:
-  Max: 100
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
 Layout/EmptyLinesAroundBlockBody:
   Exclude:
     - 'spec/**/**/*'
@@ -14,6 +18,14 @@ Layout/EmptyLinesAroundClassBody:
   EnforcedStyle: empty_lines_except_namespace
 Layout/EmptyLinesAroundModuleBody:
   EnforcedStyle: empty_lines_except_namespace
+Layout/LineLength:
+  Max: 100
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'

data/.travis.yml

@@ -4,6 +4,7 @@ cache: bundler
 rvm:
 - 2.5
 - 2.6
+- 2.7
 - ruby-head
 matrix:
   fast_finish: true

data/CHANGELOG.md

@@ -6,6 +6,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.0] - 2021-02-04
+### Changed
+- Add failed_steps to procedure
+
+## [1.1.1] - 2019-12-08
+### Changed
+- Improve procedure error merging
+
+## [1.1.0] - 2019-12-06
+### Added
+- Added procedure support for running multiple commands
+
+## [1.0.10] - 2019-12-21
+### Added
+- Added Ruby 2.7 support
+### Removed
+- Removed generator empty directory check
+
+## [1.0.9] - 2019-12-20
+### Removed
+- Removed lite-command generator
+- Removed rspec file from rails generator
+
 ## [1.0.8] - 2019-09-16
 ### Changed
 - Changed create propagation to check errors instead of persistence

data/Gemfile.lock

@@ -1,118 +1,133 @@
 PATH
   remote: .
   specs:
-    lite-command (1.0.8)
+    lite-command (1.2.0)
       lite-errors
       lite-memoize
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    ast (2.4.0)
-    builder (3.2.3)
+      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.5)
-    crass (1.0.4)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    fasterer (0.6.0)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    fasterer (0.8.3)
       colorize (~> 0.7)
-      ruby_parser (>= 3.13.0)
+      ruby_parser (>= 3.14.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    i18n (1.6.0)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
     lite-errors (1.0.1)
     lite-memoize (1.0.3)
-    loofah (2.2.3)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.4.1)
-      ast (~> 2.4.0)
-    rack (2.0.7)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (6.0.0)
-      actionpack (= 6.0.0)
-      activesupport (= 6.0.0)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.9.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
-      rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.13.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.15.1)
       sexp_processor (~> 4.9)
-    sexp_processor (4.12.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.1.10)
+    sexp_processor (4.15.2)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -128,8 +143,9 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rake
   rubocop-rspec
   sqlite3
 
 BUNDLED WITH
-   2.0.1
+   2.2.8

data/README.md

@@ -27,18 +27,21 @@ Or install it yourself as:
 * [Setup](#setup)
 * [Simple](#simple)
 * [Complex](#complex)
+* [Procedure](#procedure)
 * [Extensions](#extensions)
 
 ## Setup
 
-`rails g lite:command:install` will generate the following file:
-`../app/commands/application_command.rb`
+`rails g command NAME` will generate the following file:
 
-```ruby
-class ApplicationCommand < Lite::Command::Complex
-end
+```erb
+app/commands/[NAME]_command.rb
 ```
 
+If a `ApplicationCommand` file in the `app/commands` directory is available, the
+generator will create file that inherit from `ApplicationCommand` if not it will
+fallback to `Lite::Command::Complex`.
+
 ## Simple
 
 Simple commands build quick class based calls but cannot be extended.
@@ -47,13 +50,9 @@ This is more of a traditional command service call as it only exposes a `call` m
 ```ruby
 class SearchMovies < Lite::Command::Simple
 
-  class << self
-    private
-
-    # NOTE: This class method is required
-    def execute(*args)
-      { generate_fingerprint => movies_by_name }
-    end
+  # NOTE: This class method is required
+  def self.execute(*args)
+    { generate_fingerprint => movies_by_name }
   end
 
 end
@@ -62,8 +61,7 @@ end
 **Caller**
 
 ```ruby
-command = SearchMovies.call('Toy Story')
-command.call
+SearchMovies.call('Toy Story')
 ```
 
 ## Complex
@@ -71,9 +69,6 @@ command.call
 Complex commands can be used in instance and class based calls and
 extended with access to errors and memoization.
 
-Use `rails g decorator NAME` will generate the following file:
-`../app/decorators/[name]_decorator.rb`
-
 You will then need to fill this class with the required `execute` method as shown below:
 
 ```ruby
@@ -135,9 +130,40 @@ command.recall! #=> Clears the call, cache, errors, and then re-performs the cal
 command.result  #=> { 'fingerprint_2' => [ 'Toy Story 2', ... ] }
 ```
 
+## Procedure
+
+Procedures 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.
+
+```ruby
+class SearchChannels < Lite::Command::Procedure; end
+
+procedure = SearchChannels.call(
+  DisneyChannel.new,
+  EspnChannel.new(current_station),
+  MtvChannel.new
+)
+
+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
+)
+
+procedure.exit_on_failure = true
+procedure.call
+procedure.result #=> ['disney: #3']
+procedure.failed_steps #=> [{ index: 1, step: 2, name: 'ErrorChannel', args: [current_station], errors: ['field error message'] }]
+```
+
 ## Extensions
 
-Extend complex base command with any of the following extensions:
+Extend complex (and procedures) base command with any of the following extensions:
 
 ### Errors (optional)
 

data/lib/generators/rails/USAGE

@@ -6,4 +6,3 @@ Example:
 
     This will create:
         - app/commands/[name]_command.rb
-        - spec/commands/[name]_command_spec.rb

data/lib/generators/rails/command_generator.rb

@@ -10,16 +10,9 @@ module Rails
 
     def copy_files
       path = File.join('app', 'commands', class_path, "#{file_name}_command.rb")
-      empty_directory('app/commands')
       template('command.rb.tt', path)
     end
 
-    def copy_specs
-      path = File.join('spec', 'commands', class_path, "#{file_name}_command_spec.rb")
-      empty_directory('spec/commands')
-      template('spec.rb.tt', path)
-    end
-
     private
 
     def file_name

data/lib/generators/rails/templates/command.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>Command < ApplicationCommand
+class <%= class_name %>Command < <%= ApplicationCommand.to_s rescue 'Lite::Command::Complex' %>
 end
 <% end -%>

data/lib/lite/command.rb

@@ -6,9 +6,8 @@ require 'lite/command/version'
   require "lite/command/extensions/#{name}"
 end
 
-%w[exceptions states complex simple].each do |name|
+%w[exceptions states simple complex procedure].each do |name|
   require "lite/command/#{name}"
 end
 
-require 'generators/lite/command/install_generator'
 require 'generators/rails/command_generator'

data/lib/lite/command/complex.rb

@@ -21,7 +21,7 @@ module Lite
 
       end
 
-      attr_reader :result
+      attr_reader :args, :result
 
       def initialize(*args)
         @args = args

data/lib/lite/command/exceptions.rb

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

data/lib/lite/command/procedure.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Lite
+  module Command
+    class Procedure < Complex
+
+      include Lite::Command::Extensions::Errors
+
+      attr_accessor :exit_on_failure
+
+      def execute
+        steps.each_with_object([]).with_index do |(command, results), i|
+          command.call
+
+          if command.respond_to?(:errors) && command.failure?
+            failed_steps << failed_step(i, command)
+            merge_errors!(command) if respond_to?(:errors)
+            break results if exit_on_failure?
+          else
+            results << command.result
+          end
+        end
+      end
+
+      def exit_on_failure?
+        @exit_on_failure ||= false
+      end
+
+      def failed_steps
+        @failed_steps ||= []
+      end
+
+      def steps
+        @steps ||= @args.flatten
+      end
+
+      private
+
+      def failed_step(index, command)
+        {
+          index: index,
+          step: index + 1,
+          name: command.class.name,
+          args: command.args,
+          errors: command&.errors&.full_messages
+        }
+      end
+
+    end
+  end
+end

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION ||= '1.0.8'
+    VERSION = '1.2.0'
 
   end
 end

data/lite-command.gemspec

@@ -49,6 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.2.0
 platform: ruby
 authors:
 - Juan Gomez
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2021-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lite-errors
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - j.gomez@drexed.com
 executables: []
@@ -215,18 +229,16 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
-- lib/generators/lite/command/install_generator.rb
-- lib/generators/lite/command/templates/install.rb
 - lib/generators/rails/USAGE
 - lib/generators/rails/command_generator.rb
 - lib/generators/rails/templates/command.rb.tt
-- lib/generators/rails/templates/spec.rb.tt
 - lib/lite/command.rb
 - lib/lite/command/complex.rb
 - lib/lite/command/exceptions.rb
 - lib/lite/command/extensions/errors.rb
 - lib/lite/command/extensions/memoize.rb
 - lib/lite/command/extensions/propagation.rb
+- lib/lite/command/procedure.rb
 - lib/lite/command/simple.rb
 - lib/lite/command/states.rb
 - lib/lite/command/version.rb
@@ -235,7 +247,7 @@ homepage: http://drexed.github.io/lite-command
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -250,8 +262,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.2.8
+signing_key:
 specification_version: 4
 summary: Ruby Command based framework (aka service objects)
 test_files: []

data/lib/generators/lite/command/install_generator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-module Lite
-  module Command
-    class InstallGenerator < Rails::Generators::Base
-
-      source_root File.expand_path('../templates', __FILE__)
-
-      def copy_application_query_file
-        copy_file('install.rb', 'app/commands/application_command.rb')
-      end
-
-    end
-  end
-end

data/lib/generators/lite/command/templates/install.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class ApplicationCommand < Lite::Command::Complex
-end

data/lib/generators/rails/templates/spec.rb.tt

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe <%= class_name %>Command, type: :command do
-  pending "add some examples to (or delete) #{__FILE__}"
-end