lite-command 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e91e41adc24a79e5b834c8633ab65645f86e208bbd0d23dbd2e49a4462a17c
-  data.tar.gz: 699f3dbdef6befb271880d31d30063f10ed97517bf14ea3418574494ee2a2878
+  metadata.gz: 7d33153b2a39998b16565b6a486c71ac29ce975b784b9e7f0a0c1c053712d703
+  data.tar.gz: 261fa88f0032d58d169d35e141bc76ca0770486b8fe0bc7fd65a3dbc5e269905
 SHA512:
-  metadata.gz: aad63061e1145000153053df04cac575065f1220bb77e09db6521e8a0f85a99c7347d049c0b941bd77c97d34c95495877dfc9066798ea278459a6df4111e4e91
-  data.tar.gz: 1da794d70ca0c441cc0de1b37161b02774035a4e9bff07a56f908551dc7bac751689da47e8903326c61bfc662d52d8a0036ba06ce7a0155294a9b66c294ce921
+  metadata.gz: 2899e8d37519cb9a896f5573f230323141f24b99598f4a0674580fd795d51e92f2c7bbd32b875e6755779f6cfead9aacd81851ba2cfbaa8652b318c2849a924e
+  data.tar.gz: f4e9b2bb0eaec8320c0e18f2c75768479369ae8f2cec0b1fce0812b0814b0e4e2a442189fb207fa34031557839b42aa4580590d39b8c87faaa8ca41b17803787

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+on:
+  pull_request:
+    branches: [ master ]
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3.5'
+          bundler-cache: true
+      - name: RSpec
+        run: bundle exec rspec
+      - name: Rubocop
+        run: bundle exec rubocop --parallel

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   NewCops: enable
   DisplayCopNames: true
   DisplayStyleGuide: true
+  TargetRubyVersion: 3.3.5
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
 Gemspec/RequiredRubyVersion:

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.3] - 2024-10-08
+### Changed
+- Move super in inheritance
+
+## [2.1.2] - 2024-10-08
+### Added
+- Allow `filled` to pass `{ empty: false }` to check if value is empty
+
 ## [2.1.1] - 2024-10-06
 ### Added
 - Added on_status hook to `execute!`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-command (2.1.1)
+    lite-command (2.1.3)
       ostruct
 
 GEM
@@ -45,8 +45,6 @@ GEM
     diff-lcs (1.5.1)
     drb (2.2.1)
     erubi (1.13.0)
-    fasterer (0.11.0)
-      ruby_parser (>= 3.19.1)
     generator_spec (0.10.0)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
@@ -138,11 +136,7 @@ GEM
     rubocop-rspec (3.1.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    ruby_parser (3.21.1)
-      racc (~> 1.5)
-      sexp_processor (~> 4.16)
     securerandom (0.3.1)
-    sexp_processor (4.17.2)
     sqlite3 (2.1.0)
       mini_portile2 (~> 2.8.0)
     stringio (3.1.1)
@@ -159,7 +153,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  fasterer
   generator_spec
   lite-command!
   rake

data/README.md

@@ -8,8 +8,8 @@ Lite::Command provides an API for building simple and complex command based serv
 
 Add this line to your application's Gemfile:
 
-> [!NOTE]
-> Gem versions `2.0.0`, `2.0.1`, `2.0.2`, and `2.0.3` are borked.
+> [!WARNING]
+> Gem versions `~> 2.0` are borked.
 > Version `~> 2.1.0` is the suggested working version.
 
 ```ruby
@@ -48,7 +48,8 @@ Or install it yourself as:
 
 ## Setup
 
-Defining a command is as simple as adding a call method to a command object (required).
+Defining a command is as simple as inheriting the base class and
+adding a `call` method to a command object (required).
 
 ```ruby
 class CalculatePower < Lite::Command::Base
@@ -133,7 +134,7 @@ class CalculatePower < Lite::Command::Base
 end
 
 CalculatePower.call!(...)
-#=> raises CalculatePower::Fault
+#=> raises CalculatePower::Failure
 ```
 
 ## Context
@@ -142,6 +143,9 @@ Accessing the call arguments can be done through its internal context.
 It can be used as internal storage to be accessed by it self and any
 of its children commands.
 
+> [!NOTE]
+> Attributes that do **NOT** exist on the context will return `nil`.
+
 ```ruby
 class CalculatePower < Lite::Command::Base
 
@@ -152,8 +156,9 @@ class CalculatePower < Lite::Command::Base
 
 end
 
-command = CalculatePower.call(a: 2, b: 3)
-command.context.result #=> 8
+cmd = CalculatePower.call(a: 2, b: 3)
+cmd.context.result #=> 8
+cmd.ctx.fake       #=> nil
 ```
 
 ### Attributes
@@ -167,7 +172,7 @@ method which automatically delegates to `context`.
 | `from`     | Symbol, String | `:context` | The object containing the attribute. |
 | `types`    | Symbol, String, Array, Proc | | The allowed class types of the attribute value. |
 | `required` | Symbol, String, Boolean, Proc | `false` | The attribute must be passed to the context or delegatable (no matter the value). |
-| `filled`   | Symbol, String, Boolean, Proc | `false` | The attribute value must be not be `nil`. |
+| `filled`   | Symbol, String, Boolean, Proc, Hash | `false` | The attribute value must be not be `nil`. Prevent empty values using `{ empty: false }` |
 
 > [!NOTE]
 > If optioned with some similar to `filled: true, types: [String, NilClass]`
@@ -180,7 +185,7 @@ class CalculatePower < Lite::Command::Base
 
   attribute :a, :b
   attribute :c, :d, from: :remote_storage, types: [Integer, Float]
-  attribute :x, :y, from: :local_storage, if: :signed_in?
+  attribute :x, :y, from: :local_storage, filled: { empty: false }, if: :signed_in?
 
   def call
     context.result =
@@ -202,20 +207,20 @@ class CalculatePower < Lite::Command::Base
 end
 
 # With valid options:
-storage = RemoteStorage.new(c: 2, d: 2, j: 99)
-command = CalculatePower.call(a: 2, b: 2, remote_storage: storage)
-command.status         #=> "success"
-command.context.result #=> 6
-
-# With invalid options
-command = CalculatePower.call
-command.status   #=> "invalid"
-command.reason   #=> "Invalid context attributes"
-command.metadata #=> {
-                 #=>   context: ["a is required", "remote_storage must be filled"],
-                 #=>   remote_storage: ["d type invalid"]
-                 #=>   local_storage: ["is not defined or an attribute"]
-                 #=> }
+rs  = RemoteStorage.new(c: 2, d: 2, j: 99)
+cmd = CalculatePower.call(a: 2, b: 2, remote_storage: rs)
+cmd.status         #=> "success"
+cmd.context.result #=> 6
+
+# With invalid options:
+cmd = CalculatePower.call
+cmd.status   #=> "invalid"
+cmd.reason   #=> "Invalid context attributes"
+cmd.metadata #=> {
+             #=>   context: ["a is required", "remote_storage must be filled"],
+             #=>   remote_storage: ["d type invalid"]
+             #=>   local_storage: ["is not defined or an attribute"]
+             #=> }
 ```
 
 ## States
@@ -232,18 +237,16 @@ command.metadata #=> {
 > States are automatically transitioned and should **NEVER** be altered manually.
 
 ```ruby
-class CalculatePower < Lite::Command::Base
+cmd = CalculatePower.call
+cmd.state        #=> "complete"
 
-  def call
-    # ...
-  end
-
-end
+cmd.pending?     #=> false
+cmd.executing?   #=> false
+cmd.complete?    #=> true
+cmd.interrupted? #=> false
 
-command = CalculatePower.call(a: 1, b: 3)
-command.state     #=> "executed"
-command.pending?  #=> false
-command.executed? #=> false
+# `complete` or `interrupted`
+cmd.executed?
 ```
 
 ## Statuses
@@ -285,14 +288,25 @@ class CalculatePower < Lite::Command::Base
 
 end
 
-command = CalculatePower.call(a: 1, b: 3)
-command.ctx.result #=> nil
-command.status     #=> "noop"
-command.reason     #=> "Anything to the power of 1 is 1"
-command.metadata   #=> { i18n: "some.key" }
-command.invalid?   #=> false
-command.noop?      #=> true
-command.noop?("Anything to the power of 1 is 1") #=> true
+cmd = CalculatePower.call(a: 1, b: 3)
+cmd.status   #=> "noop"
+cmd.reason   #=> "Anything to the power of 1 is 1"
+cmd.metadata #=> { i18n: "some.key" }
+
+cmd.success? #=> false
+cmd.noop?    #=> true
+cmd.noop?("Other reason") #=> false
+cmd.invalid? #=> false
+cmd.failure? #=> false
+cmd.error?   #=> false
+
+# `success` or `noop`
+cmd.ok?      #=> true
+cmd.ok?("Other reason") #=> false
+
+# NOT `success`
+cmd.fault?   #=> true
+cmd.fault?("Other reason") #=> false
 ```
 
 ## Callbacks
@@ -423,7 +437,8 @@ that it gains automated indexing and the parents `cmd_id`.
 class CalculatePower < Lite::Command::Base
 
   def call
-    CalculateSqrt.call(context.merge!(some_other: "required value"))
+    context.merge!(some_other: "required value")
+    CalculateSqrt.call(context)
   end
 
 end
@@ -434,7 +449,8 @@ end
 Throwing faults allows you to bubble up child faults up to the parent.
 Use it to create branches within your logic and create clean tracing
 of your command results. You can use `throw!` as a catch-all or any
-of the bang status method `failure!`.
+of the bang status method `failure!`. Any `reason` and `metadata` will
+be bubbled up from the original fault.
 
 ```ruby
 class CalculatePower < Lite::Command::Base
@@ -443,10 +459,10 @@ class CalculatePower < Lite::Command::Base
     command = CalculateSqrt.call(context.merge!(some_other: "required value"))
 
     if command.noop?("Sqrt of 1 is 1")
-      # Manually throw any fault you want
+      # Manually throw a specific fault
       invalid!(command)
     elsif command.fault?
-      # Automatically throws a matching fault type
+      # Automatically throws a matching fault
       throw!(command)
     else
       # Success, do nothing
@@ -467,6 +483,10 @@ This is useful for composing multiple steps into one call.
 > so its no different than just passing the context forward. To change
 > this behavior, just override the `ok?` method with you logic, eg: just `success`
 
+> [!IMPORTANT]
+> Do **NOT** define a call method in this class. The sequence logic is
+> automatically defined by the sequence class.
+
 ```ruby
 class ProcessCheckout < Lite::Command::Sequence
 
@@ -477,8 +497,7 @@ class ProcessCheckout < Lite::Command::Sequence
   step SendConfirmationEmail, SendConfirmationText
   step NotifyWarehouse, unless: proc { ctx.invoice.fullfilled_by_amazon? }
 
-  # Do NOT set a call method.
-  # Its defined by Lite::Command::Sequence
+  # Do NOT define a call method.
 
   private
 
@@ -488,7 +507,7 @@ class ProcessCheckout < Lite::Command::Sequence
 
 end
 
-sequence = ProcessCheckout.call(...)
+seq = ProcessCheckout.call(...)
 # <ProcessCheckout ...>
 ```
 

data/lib/lite/command/attribute.rb

@@ -82,8 +82,17 @@ module Lite
         @errors << "#{method_name} type invalid"
       end
 
+      def empty?
+        r = Utils.try(options[:filled], :[], :empty)
+        return false if r.nil? || r == true
+        return false unless value.respond_to?(:empty?)
+
+        value.empty?
+      end
+
       def validate_attribute_filled!
-        return unless filled? && value.nil?
+        return unless filled?
+        return unless value.nil? || empty?
 
         @errors << "#{method_name} must be filled"
       end

data/lib/lite/command/base.rb

@@ -5,6 +5,8 @@ module Lite
     class Base
 
       def self.inherited(base)
+        super
+
         base.include Lite::Command::Internals::Context
         base.include Lite::Command::Internals::Call
         base.include Lite::Command::Internals::Execute
@@ -21,8 +23,6 @@ module Lite
           #{base}::Failure = Class.new(#{base}::Fault)
           #{base}::Error   = Class.new(#{base}::Fault)
         RUBY
-
-        super
       end
 
       attr_reader :context

data/lib/lite/command/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Command
 
-    VERSION = "2.1.1"
+    VERSION = "2.1.3"
 
   end
 end

data/lite-command.gemspec

@@ -40,7 +40,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ostruct"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "fasterer"
   spec.add_development_dependency "generator_spec"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-command
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Juan Gomez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-06 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ostruct
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: fasterer
-  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: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -171,12 +157,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".fasterer.yml"
 - ".gitattributes"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile

data/.fasterer.yml

@@ -1,19 +0,0 @@
-speedups:
-  block_vs_symbol_to_proc: true
-  each_with_index_vs_while: false
-  fetch_with_argument_vs_block: true
-  for_loop_vs_each: true
-  getter_vs_attr_reader: true
-  gsub_vs_tr: true
-  hash_merge_bang_vs_hash_brackets: true
-  keys_each_vs_each_key: true
-  map_flatten_vs_flat_map: true
-  module_eval: true
-  proc_call_vs_yield: true
-  rescue_vs_respond_to: true
-  reverse_each_vs_reverse_each: true
-  select_first_vs_detect: true
-  select_last_vs_reverse_detect: true
-  setter_vs_attr_writer: true
-  shuffle_first_vs_sample: true
-  sort_vs_sort_by: true

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-- 2.5
-- 2.6
-- 2.7
-- ruby-head
-matrix:
-  fast_finish: true
-  allow_failures:
-  - rvm: ruby-head
-before_install:
-- gem update --system
-- gem install bundler
-install:
-- bundle install --jobs=3 --retry=3
-script:
-- bundle exec rspec
-- bundle exec rubocop
-- bundle exec fasterer
-notifications:
-  email: false
-  slack:
-    secure: 2PptrBf+yl8evd/WA4XKg0tzJqSdEn5TaAhuHR90o5X6Rd0MA4SES+QZQn9A81CPuJk//V8Dur8NQQzrcAivVOsmC+JbIHZV1MS8v32Uvoy28Vr8omAne4Ec3so6rXCIMniREGcHtKeXHdNYO61VZPPjgxd7RTwajvTC7KS0ViuKBPct+hq+WfJmX6Xp2vxTHImNVurExBrFZkJyPtV+UG1tJ6mB+kF8MQ1+t3ZBtU4+6eVviADYi7FBEeP0j9gdKBCzU7aPoE+XLMWcP0tI9ibaP9crEMKi05JNDLzm5f6PGvGJWEQSCeh3CxNhaEF7eog3BAw6mUXkKI0hvFfrZeyG+VkDU6T9rAG8u55BrREi4mRNJl0c0rS2J45bFRmYOlvDNn9xrhMkkfFn8SMX3etYJYqHNBxdF2TX4SzpDrshd3hcm2btmkThn/Ua/mYUWs9OF3O/ZSu0zB+/g83zrAsjMyfqJ1PE5ZiiMD2Rjrzb/fyYcsNeVhncwRdse9LtJRqz1KpOh/r5LBrWfRRCQwlVNwMtBdFxQ7Ytl9dz/dfJmGKgM8zsdJdI6ZyV+lwa0jPaql6Y8wXjox1wwN3IRCyvoVsgxmiQAV8jnWD2lf6I/Ea5yXCImGluuRAyRrAizElXGBNubhAVtQwQinHWfaYO+mJElScBwrxTVXuzQUI=