convenient_service 0.12.0 → 0.13.0

data/Taskfile.yml

@@ -15,7 +15,96 @@ version: '3'
 tasks:
   default:
     cmds:
-      - task: rspec
+      - task: test
+
+  ##
+  # NOTE: `task console` is also aliased as `task playground`.
+  #
+  console:
+    cmds:
+      - bundle exec rake playground
+    interactive: true
+
+  ##
+  # NOTE: `task console:all` is also aliased as `task playground:all`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:all:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "all"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:dry` is also aliased as `task playground:dry`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:dry:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "dry"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:rails_5.2` is also aliased as `task playground:rails_5.2`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:rails_5.2:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_5.2"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:rails_6.0` is also aliased as `task playground:rails_6.0`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:rails_6.0:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.0"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:rails_6.1` is also aliased as `task playground:rails_6.1`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:rails_6.1:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.1"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:rails_7.0` is also aliased as `task playground:rails_7.0`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:rails_7.0:
+    cmds:
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_7.0"].join("_")'
+    interactive: true
+
+  ##
+  # NOTE: `task console:standard` is also aliased as `task playground:standard`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
+  console:standard:
+    cmds:
+      - bundle exec rake playground
+    interactive: true
 
   coverage:lcov:merge:
     cmds:
@@ -32,6 +121,9 @@ tasks:
     cmds:
       - task: deps:install
 
+  ##
+  # NOTE: `task deps:install` is also aliased as `task install`.
+  #
   deps:install:
     cmds:
       - bundle install
@@ -43,6 +135,18 @@ tasks:
       - rm Gemfile*.lock
       - rm -rf gemfiles
 
+  ##
+  # NOTE: JRuby 9.4 aims CRuby 3.1 compatibility.
+  # - https://www.jruby.org/download
+  #
+  docker:bash:jruby_9.4:
+    cmds:
+      - docker run --rm -it -v $(pwd):/gem convenient_service:jruby-9.4 bash
+    interactive: true
+    preconditions:
+      - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
+        msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
+
   docker:bash:ruby_2.7:
     cmds:
       - docker run --rm -it -v $(pwd):/gem convenient_service:2.7 bash
@@ -75,18 +179,6 @@ tasks:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
         msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
 
-  ##
-  # NOTE: JRuby 9.4 aims CRuby 3.1 compatibility.
-  # - https://www.jruby.org/download
-  #
-  docker:bash:jruby_9.4:
-    cmds:
-      - docker run --rm -it -v $(pwd):/gem convenient_service:jruby-9.4 bash
-    interactive: true
-    preconditions:
-      - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
-        msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
-
   ##
   # NOTE: TruffleRuby 22.3 aims CRuby 3.1 compatibility.
   # - https://github.com/oracle/truffleruby/blob/master/doc/user/compatibility.md
@@ -111,6 +203,27 @@ tasks:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
         msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
 
+  ##
+  # NOTE: JRuby 9.4 aims CRuby 3.1 compatibility.
+  # - https://www.jruby.org/download
+  #
+  docker:build:jruby_9.4:
+    cmds:
+      ##
+      # NOTE: Meaning of `|| 2> /dev/null`.
+      # https://stackoverflow.com/a/10250395/12201472
+      #
+      # NOTE: Meaning of `|| true`.
+      # https://superuser.com/a/887349/1180656
+      #
+      - rm Gemfile.jruby-9.4 2> /dev/null || true
+      - rm Gemfile.jruby-9.4.lock 2> /dev/null || true
+      - cp Gemfile Gemfile.jruby-9.4
+      - docker build . -f docker/jruby-9.4/Dockerfile -t convenient_service:jruby-9.4
+    preconditions:
+      - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
+        msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
+
   docker:build:ruby_2.7:
     cmds:
       ##
@@ -179,27 +292,6 @@ tasks:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
         msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
 
-  ##
-  # NOTE: JRuby 9.4 aims CRuby 3.1 compatibility.
-  # - https://www.jruby.org/download
-  #
-  docker:build:jruby_9.4:
-    cmds:
-      ##
-      # NOTE: Meaning of `|| 2> /dev/null`.
-      # https://stackoverflow.com/a/10250395/12201472
-      #
-      # NOTE: Meaning of `|| true`.
-      # https://superuser.com/a/887349/1180656
-      #
-      - rm Gemfile.jruby-9.4 2> /dev/null || true
-      - rm Gemfile.jruby-9.4.lock 2> /dev/null || true
-      - cp Gemfile Gemfile.jruby-9.4
-      - docker build . -f docker/jruby-9.4/Dockerfile -t convenient_service:jruby-9.4
-    preconditions:
-      - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
-        msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
-
   ##
   # NOTE: TruffleRuby 22.3 aims CRuby 3.1 compatibility.
   # - https://github.com/oracle/truffleruby/blob/master/doc/user/compatibility.md
@@ -229,13 +321,6 @@ tasks:
     cmds:
       - open -a Docker
 
-  ##
-  # NOTE: Dev only command.
-  #
-  editor:open:
-    cmds:
-      - code .
-
   ##
   # NOTE: `sdoc` (wrapper for `rdoc`) is replaced by `yard`, since you have a feeling like every time is a first time with `rdoc`.
   # - https://kapeli.com/cheat_sheets/Yard.docset/Contents/Resources/Documents/index
@@ -263,8 +348,7 @@ tasks:
 
   docs:lint:
     cmds:
-      - mkdir -p docs
-      - bundle exec yard-junk --text --html docs/junk-yard.html
+      - task: yard_junk
 
   docs:missed:
     cmds:
@@ -280,6 +364,13 @@ tasks:
       - sh: '[ "${IN_DOCKER_CONTAINER}" != "true" ]'
         msg: This task can be invoked only from the host operating system (https://www.ibm.com/cloud/learn/containerization)
 
+  ##
+  # NOTE: Dev only command.
+  #
+  editor:open:
+    cmds:
+      - code .
+
   ##
   # NOTE: A trailing "/**" matches everything inside.
   # https://git-scm.com/docs/gitignore
@@ -296,46 +387,120 @@ tasks:
     cmds:
       - open -na "Google Chrome" --args --new-window --incognito "https://github.com/marian13/convenient_service"
 
+  ##
+  # NOTE: `task install` is also aliased as `task deps:install`.
+  #
+  install:
+    cmds:
+      - task: deps:install
+
   lint:
     cmds:
       - task: rubocop
       - task: docs:lint
 
+  lint:autocorrect:
+    cmds:
+      - task: rubocop:autocorrect
+
+  ##
+  # TODO: Add to CI.
+  #
+  minitest:
+    cmds:
+      - bundle exec ruby minitest.rb
+
+  ##
+  # - https://github.com/mbj/mutant/blob/main/docs/mutant-rspec.md#run-through-example
+  #
+  mutant:
+    cmds:
+      - bundle exec mutant run --include lib --require convenient_service --integration rspec -- 'ConvenientService*'
+
+  ##
+  # NOTE: `task playground` is also aliased as `task console`.
+  #
   playground:
     cmds:
       - bundle exec rake playground
     interactive: true
 
+  ##
+  # NOTE: `task playground:all` is also aliased as `task console:all`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:all:
     cmds:
-      - bundle exec appraisal all rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "all"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:dry` is also aliased as `task console:dry`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:dry:
     cmds:
-      - bundle exec appraisal dry rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "dry"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:rails_5.2` is also aliased as `task console:rails_5.2`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:rails_5.2:
     cmds:
-      - bundle exec appraisal rails_5.2 rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_5.2"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:rails_6.0` is also aliased as `task console:rails_6.0`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:rails_6.0:
     cmds:
-      - bundle exec appraisal rails_6.0 rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.0"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:rails_6.1` is also aliased as `task console:rails_6.1`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:rails_6.1:
     cmds:
-      - bundle exec appraisal rails_6.1 rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.1"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:rails_7.0` is also aliased as `task console:rails_7.0`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:rails_7.0:
     cmds:
-      - bundle exec appraisal rails_7.0 rake playground
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rake playground
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_7.0"].join("_")'
     interactive: true
 
+  ##
+  # NOTE: `task playground:standard` is also aliased as `task console:standard`.
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   playground:standard:
     cmds:
       - bundle exec rake playground
@@ -367,9 +532,15 @@ tasks:
       - task: rspec:rails_7.0:staged
       - task: rspec:dry:staged
 
+  ##
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   rspec:dry:
     cmds:
-      - bundle exec appraisal dry rspec --format progress --require dry_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rspec --format progress --require dry_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "dry"].join("_")'
 
   rspec:dry:staged:
     - task: rspec:dry
@@ -380,9 +551,15 @@ tasks:
           #
           sh: task git:staged:specs --silent
 
+  ##
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   rspec:rails_5.2:
     cmds:
-      - bundle exec appraisal rails_5.2 rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_5.2"].join("_")'
 
   rspec:rails_5.2:staged:
     - task: rspec:rails_5.2
@@ -393,9 +570,15 @@ tasks:
           #
           sh: task git:staged:specs --silent
 
+  ##
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   rspec:rails_6.0:
     cmds:
-      - bundle exec appraisal rails_6.0 rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.0"].join("_")'
 
   rspec:rails_6.0:staged:
     - task: rspec:rails_6.0
@@ -406,9 +589,15 @@ tasks:
           #
           sh: task git:staged:specs --silent
 
+  ##
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   rspec:rails_6.1:
     cmds:
-      - bundle exec appraisal rails_6.1 rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_6.1"].join("_")'
 
   rspec:rails_6.1:staged:
     - task: rspec:rails_6.1
@@ -419,9 +608,15 @@ tasks:
           #
           sh: task git:staged:specs --silent
 
+  ##
+  # NOTE: `APPRAISAL_NAME` should be kept in sync with `Appraisals` file.
+  #
   rspec:rails_7.0:
     cmds:
-      - bundle exec appraisal rails_7.0 rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+      - bundle exec appraisal {{.APPRAISAL_NAME}} rspec --format progress --require rails_helper {{.GIT_STAGED_SPEC_FILES}} {{.CLI_ARGS}}
+    vars:
+      APPRAISAL_NAME:
+        sh: ruby -e 'print [::RUBY_ENGINE, ::RUBY_VERSION, "rails_7.0"].join("_")'
 
   rspec:rails_7.0:staged:
     - task: rspec:rails_7.0
@@ -450,13 +645,23 @@ tasks:
     cmds:
       - bundle exec rubocop --config .rubocop.yml {{.CLI_ARGS}}
 
-  rubocop:format:
+  rubocop:autocorrect:
     cmds:
       - bundle exec rubocop --config .rubocop.yml -A {{.CLI_ARGS}}
 
+  test:
+    cmds:
+      - task: rspec
+      - task: minitest
+
   ##
   # NOTE: Dev only command.
   #
   tmuxinator:start:
     cmds:
       - tmuxinator start convenient_service --project-config=.dev/.tmuxinator.yml
+
+  yard_junk:
+    cmds:
+      - mkdir -p docs
+      - bundle exec yard-junk --text --html docs/junk-yard.html

data/benchmark/commit_config/ips.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "convenient_service"
+require "benchmark/ips"
+
+class Service
+  include ConvenientService::Standard::Config
+end
+
+Service.commit_config! # Warmup.
+
+Benchmark.ips do |x|
+  x.time = 10 # Seconds.
+  x.warmup = 0 # No additional warmup required. It is already performed outside.
+
+  x.report("`.commit_config?`") { Service.commit_config! }
+end

data/benchmark/commit_config/profile.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "convenient_service"
+require "stackprof"
+
+class Service
+  include ConvenientService::Standard::Config
+end
+
+Service.commit_config!
+
+##
+# Quotes:
+# - stackprof will tell you what is impeding your progress.
+# - The assumption is the more times something shows up in the sample the more time it is taking.
+#
+# Docs:
+# - https://www.johnnunemaker.com/how-to-benchmark-your-ruby-gem
+# - https://github.com/tmm1/stackprof
+#
+profile = StackProf.run(mode: :wall, interval: 1_000) do
+  2_000_000.times { Service.commit_config! }
+end
+
+result = StackProf::Report.new(profile)
+puts
+result.print_text
+puts "\n\n\n"
+result.print_method(/commit_config!/)

data/benchmark/empty_service/ips.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "service_actor"
+require "interactor"
+require "trailblazer/operation"
+require "active_interaction"
+require "light-service"
+require "mutations"
+require "convenient_service"
+require "benchmark/ips"
+
+##
+# Imaginary no gem service. Used as unattainable standard.
+#
+class NoGemService
+  Result = Struct.new(:success?, :data)
+
+  def self.result(**kwargs)
+    new(**kwargs).result
+  end
+
+  def result
+    Result.new
+  end
+
+  private
+
+  def success(**kwargs)
+    Result.new(success?: true, data: kwargs)
+  end
+end
+
+##
+# ServiceActor - Composable Ruby service objects.
+# - https://github.com/sunny/actor
+#
+class ActorService < Actor
+  def call
+  end
+end
+
+##
+# Interactor - Interactor provides a common interface for performing complex user interactions.
+# - https://github.com/collectiveidea/interactor
+#
+class InteractorService
+  include Interactor
+
+  def call
+  end
+end
+
+##
+# Trailblazer-operation - Trailblazer's Operation implementation.
+# - https://trailblazer.to/2.1/docs/operation.html#operation-overview
+# - https://github.com/trailblazer/trailblazer-operation
+#
+class TrailblazerService < Trailblazer::Operation
+  step :result
+
+  def result(options, *)
+  end
+end
+
+##
+# ActiveInteraction - Manage application specific business logic.
+# - https://github.com/AaronLasseigne/active_interaction
+#
+class ActiveInteractionService < ActiveInteraction::Base
+  def execute
+  end
+end
+
+##
+# LightService - Series of Actions with an emphasis on simplicity.
+# - https://github.com/adomokos/light-service
+#
+class LightServiceService
+  extend ::LightService::Action
+
+  executed do |context|
+  end
+end
+
+##
+# Mutations - Compose your business logic into commands that sanitize and validate input.
+# - https://github.com/cypriss/mutations
+#
+class MutationsService < Mutations::Command
+  def execute
+  end
+end
+
+##
+# Convenient Service - Service object pattern implementation in Ruby.
+# - https://github.com/marian13/convenient_service
+#
+class ConvenientServiceService
+  include ConvenientService::Standard::Config
+
+  def result
+    success
+  end
+end
+
+ConvenientServiceService.commit_config! # Warmup.
+
+Benchmark.ips do |x|
+  x.time = 10 # Seconds.
+  x.warmup = 0 # No additional warmup required. It is already performed outside.
+
+  x.report("Empty service - Without any gem") { NoGemService.result }
+  x.report("Empty service - With Actor") { ActorService.call }
+  x.report("Empty service - With Interactor") { InteractorService.call }
+  x.report("Empty service - With Trailblazer Operation") { TrailblazerService.call }
+  x.report("Empty service - With ActiveInteraction") { ActiveInteractionService.run! }
+  x.report("Empty service - With LightService") { LightServiceService.execute }
+  x.report("Empty service - With Mutations") { MutationsService.run }
+  x.report("Empty service - With Convenient Service") { ConvenientServiceService.result }
+
+  x.compare!(order: :baseline)
+end