convenient_service 0.17.0 → 0.18.0

data/benchmark/commit_config/profile.rb

@@ -1,30 +0,0 @@
-# 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

@@ -1,123 +0,0 @@
-# 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

data/benchmark/has_committed_config/ips.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "convenient_service"
-require "benchmark/ips"
-
-##
-# Introduction.
-#
-# This benchmark is checking `.has_committed_config?`. As a result, keep in mind that everything in this file should be reviewed in its context.
-# For example, there is a class called `CurrentImplementation`. Actually, it is the `ImplementationWithoutMemoizationOfHasCommittedConfigInService`.
-# Or `WithMemoizationInService` - means `ImplementationWithMemoizationOfHasCommittedConfigInService`, etc.
-#
-# For the current implementation source, see `ConvenientService::Core::Concern::ClassMethods#has_committed_config?`.
-##
-
-class CurrentImplementation
-  include ConvenientService::Standard::Config
-end
-
-class WithMemoizationInService
-  include ConvenientService::Standard::Config
-
-  class << self
-    def has_committed_config?
-      @__convenient_service_has_committed_config__ ||= super
-    end
-  end
-end
-
-##
-# Warmup.
-#
-implementations = [CurrentImplementation, WithMemoizationInService]
-
-implementations.each(&:commit_config!)
-
-##
-# Benchmarking of iterations per second.
-#
-Benchmark.ips do |x|
-  x.time = 5 # Seconds.
-  x.warmup = 0 # No additional warmup required. It is already performed outside.
-
-  x.report("`.has_committed_config?` - No memoization in service") { CurrentImplementation.has_committed_config? }
-  x.report("`.has_committed_config?` - Memoization in service") { WithMemoizationInService.has_committed_config? }
-
-  x.compare!(order: :baseline)
-end
-
-##
-# Example result.
-#
-# Calculating -------------------------------------
-# `.has_committed_config?` - No memoization in service
-#                         131.142k (± 8.9%) i/s -    220.039k in   1.777241s
-# `.has_committed_config?` - Memoization in service
-#                         131.319k (±10.5%) i/s -    216.215k in   1.763880s
-
-# Comparison:
-# `.has_committed_config?` - No memoization in service:   131142.1 i/s
-# `.has_committed_config?` - Memoization in service:   131319.1 i/s - same-ish: difference falls within error
-##
-
-##
-# Summary.
-#
-# It is one of the Convenient Service design goals to NOT pollute the end-user public interface with extra private methods, instance variables, etc.
-# Since memoization does NOT bring too big performance improvement, no extra instance variables are introduced.
-##
-
-##
-# More info.
-# - https://johnnunemaker.com/how-to-benchmark-your-ruby-gem
-# - https://github.com/evanphx/benchmark-ips
-# - https://rubydoc.info/gems/benchmark-ips/Benchmark/Compare
-# - https://en.wikipedia.org/wiki/Standard_deviation
-##

data/benchmark/has_committed_config/profile.rb

@@ -1,30 +0,0 @@
-# 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.has_committed_config? }
-end
-
-result = StackProf::Report.new(profile)
-puts
-result.print_text
-puts "\n\n\n"
-result.print_method(/has_committed_config?/)

data/convenient_service.gemspec

@@ -1,233 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/convenient_service/specification"
-require_relative "lib/convenient_service/version"
-
-##
-# NOTE:
-#   - Use `ConvenientService::Support::Ruby.jruby?` directly only in the files that do not require to load all dependencies.
-#   - Prefer `ConvenientService::Dependencies.ruby.jruby?` for the rest of the files.
-#
-require_relative "lib/convenient_service/support/ruby"
-
-Gem::Specification.new do |spec|
-  spec.name = ConvenientService::Specification::NAME
-  spec.authors = ConvenientService::Specification::AUTHORS
-  spec.email = ConvenientService::Specification::EMAIL
-  spec.homepage = ConvenientService::Specification::HOMEPAGE
-  spec.summary = ConvenientService::Specification::SUMMARY
-  spec.description = ConvenientService::Specification::DESCRIPTION
-
-  spec.version = ConvenientService::VERSION
-
-  spec.license = "MIT"
-
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-
-  spec.require_paths = ["lib"]
-
-  ##
-  # Used to run specs with multiple versions of gems.
-  # - https://github.com/thoughtbot/appraisal
-  #
-  spec.add_development_dependency "appraisal", "~> 2.5.0"
-
-  spec.add_development_dependency "awesome_print"
-
-  ##
-  # Used for benchmarking (iteration per second). See `benchmark` directory.
-  # - https://github.com/evanphx/benchmark-ips
-  # - https://www.johnnunemaker.com/how-to-benchmark-your-ruby-gem
-  #
-  spec.add_development_dependency "benchmark-ips", "~> 2.12.0"
-
-  ##
-  # Used for debugging any Ruby code (CRuby, JRuby, etc), since it written in plain Ruby.
-  # Has minimalistic interface.
-  # Does NOT support frame filtering.
-  # - https://github.com/gsamokovarov/break
-  #
-  spec.add_development_dependency "break"
-
-  ##
-  # Used for debugging CRuby code.
-  # Check `debug` if you need frame filtering.
-  # Check `break` if you need to debug JRuby.
-  # - https://github.com/deivid-rodriguez/byebug
-  #
-  # NOTE: `byebug` has C extensions, that is why it is NOT supported in JRuby.
-  # - https://github.com/deivid-rodriguez/byebug/tree/master/ext/byebug
-  # - https://github.com/deivid-rodriguez/byebug/issues/179#issuecomment-152727003
-  #
-  spec.add_development_dependency "byebug", "~> 10.0" unless ConvenientService::Support::Ruby.jruby?
-
-  ##
-  # Used for parsing Markdown in YARD docs.
-  # - https://github.com/gjtorikian/commonmarker
-  #
-  # NOTE: `commonmarker` has C extensions, that is why it is NOT supported in JRuby.
-  # - https://github.com/gjtorikian/commonmarker/tree/main/ext/commonmarker
-  #
-  # TODO: `commonmarker` v1 does NOT work with `yard-junk`.
-  #
-  spec.add_development_dependency "commonmarker", "~> 0.23.10" unless ConvenientService::Support::Ruby.jruby?
-
-  ##
-  # Used for debugging CRuby code.
-  # Has almost the same public API as `byebug`, but supports frame filtering.
-  # Check `break` if you need to debug JRuby.
-  # - https://github.com/ruby/debug
-  # - https://st0012.dev/from-byebug-to-ruby-debug
-  # - https://st0012.dev/from-byebug-to-ruby-debug#heading-configuration
-  # - https://github.com/ruby/debug#configuration
-  # - ENV["RUBY_DEBUG_SKIP_PATH"]
-  #
-  # NOTE: `debug` has C extensions, that is why it is NOT supported in JRuby.
-  # - https://github.com/ruby/debug/tree/master/ext/debug
-  #
-  spec.add_development_dependency "debug" unless ConvenientService::Support::Ruby.jruby?
-
-  spec.add_development_dependency "faker"
-
-  spec.add_development_dependency "gem-release"
-
-  spec.add_development_dependency "inch"
-
-  spec.add_development_dependency "json"
-
-  ##
-  # Used for memory profiling of Ruby code.
-  # - https://github.com/SamSaffron/memory_profiler
-  # - https://thoughtbot.com/blog/a-crash-course-in-analyzing-memory-usage-in-ruby
-  #
-  spec.add_development_dependency "memory_profiler"
-
-  ##
-  # Used for testing Ruby code outside RSpec.
-  # - https://github.com/minitest/minitest
-  # - https://semaphoreci.com/community/tutorials/getting-started-with-minitest
-  # - https://cloudbees.com/blog/getting-started-with-minitest
-  #
-  spec.add_development_dependency "minitest", "~> 5.18.0"
-
-  ##
-  # Used for mutation testing of Ruby code.
-  # - https://github.com/mbj/mutant
-  # - https://github.com/mbj/mutant/blob/main/docs/nomenclature.md
-  # - https://github.com/mbj/mutant/blob/main/docs/mutant-rspec.md
-  # - https://github.com/mbj/mutant/blob/main/docs/incremental.md
-  #
-  # NOTE: How to get a licence key?
-  # - https://github.com/mbj/mutant/issues/1396
-  #
-  if ::ENV["CONVENIENT_SERVICE_MUTANT_LICENCE_KEY"]
-    spec.add_development_dependency "mutant", "~> 0.11.21"
-    spec.add_development_dependency "mutant-rspec", "~> 0.11.21"
-  end
-
-  ##
-  # Used for coloring logs.
-  # - https://github.com/janlelis/paint
-  #
-  spec.add_development_dependency "paint"
-
-  spec.add_development_dependency "progressbar"
-
-  spec.add_development_dependency "rake", "~> 12.0"
-
-  spec.add_development_dependency "rerun"
-
-  spec.add_development_dependency "rouge"
-
-  ##
-  # Used for testing Ruby code.
-  # https://rspec.info
-  #
-  spec.add_development_dependency "rspec", "~> 3.11.0"
-
-  ##
-  # Used for performance testing with RSpec.
-  # https://github.com/piotrmurach
-  #
-  spec.add_development_dependency "rspec-benchmark", "~> 0.6.0"
-
-  ##
-  # Used for linting Ruby files.
-  # https://github.com/rubocop/rubocop
-  #
-  spec.add_development_dependency "rubocop", "~> 1.52.0"
-
-  ##
-  # Used as a set of rules for rubocop for linting RSpec files.
-  # https://github.com/rubocop/rubocop-rspec
-  #
-  spec.add_development_dependency "rubocop-rspec", "~> 2.22.0"
-
-  spec.add_development_dependency "tty-prompt"
-
-  ##
-  # Used as a set of rules for robocop for linting source files.
-  # https://github.com/testdouble/standard
-  #
-  spec.add_development_dependency "standard", "~> 1.30.1"
-
-  spec.add_development_dependency "simplecov"
-
-  spec.add_development_dependency "simplecov-lcov"
-
-  ##
-  # Used to have a simplified public API of minitest.
-  # - https://github.com/thoughtbot/shoulda-context
-  #
-  spec.add_development_dependency "shoulda-context", "~> 2.0.0"
-
-  ##
-  # Used for benchmarking (call-stack profiler). See `benchmark` directory.
-  # - https://github.com/tmm1/stackprof
-  # - https://www.johnnunemaker.com/how-to-benchmark-your-ruby-gem
-  #
-  spec.add_development_dependency "stackprof", "~> 0.2.25" unless ConvenientService::Support::Ruby.jruby?
-
-  spec.add_development_dependency "webrick"
-
-  ##
-  # Used for generation of API docs for Ruby code.
-  # - https://github.com/lsegal/yard
-  # - https://yardoc.org
-  #
-  spec.add_development_dependency "yard", "~> 0.9.34"
-
-  ##
-  # Used for linting YARD docs.
-  # - https://github.com/zverok/yard-junk
-  #
-  spec.add_development_dependency "yard-junk", "~> 0.0.9"
-
-  ##
-  # The following gems are Convenient Service alternatives.
-  # Used for performance comparisons.
-  # See `benchmark/empty_service`.
-  # - https://github.com/sunny/actor
-  # - https://github.com/collectiveidea/interactor
-  # - https://github.com/trailblazer/trailblazer-operation
-  # - https://github.com/AaronLasseigne/active_interaction
-  # - https://github.com/adomokos/light-service
-  # - https://github.com/cypriss/mutations
-  #
-  spec.add_development_dependency "service_actor", "~> 3.7.0"
-  spec.add_development_dependency "interactor", "~> 3.1.2"
-  spec.add_development_dependency "trailblazer-operation", "~> 0.10.1"
-  spec.add_development_dependency "active_interaction", "~> 5.3.0"
-  spec.add_development_dependency "light-service", "~> 0.18.0"
-  spec.add_development_dependency "mutations", "~> 0.9.1"
-end

data/docker/2.7/Dockerfile

@@ -1,73 +0,0 @@
-##
-# Ruby 2.7 with Node.js 16.x.
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/2.7/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.2.7
-#   docker build . -f docker/2.7/Dockerfile -t convenient_service:2.7
-#   # or `task docker:build:ruby_2.7`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:2.7 bash
-#   # or `task docker:bash:ruby_2.7`
-#
-# NOTE: If there are no memory, performance, or cost constraints, prefer to use as standard Linux distribution as it is possible.
-# In a general case, you simply won't have enough time to resolve all the "quirks" of more specific distributions if you are an application developer.
-# That is why a `slim` version is used instead of `alpine`.
-# Also `slim` is more similar to Ubuntu.
-# - https://github.com/timbru31/docker-ruby-node/tree/master/2.7/16
-# - https://medium.com/swlh/alpine-slim-stretch-buster-jessie-bullseye-bookworm-what-are-the-differences-in-docker-62171ed4531d
-# - https://hub.docker.com/r/timbru31/ruby-node/tags
-#
-# NOTE: Gallium means Node.js 16.x.
-# https://github.com/nodejs/Release
-#
-FROM timbru31/ruby-node:2.7-slim-gallium
-
-##
-# NOTE: `bundle install` dependencies.
-#
-RUN apt-get update -qq \
-  && apt-get install --no-install-recommends -y git \
-  && apt-get install --no-install-recommends -y make \
-  && apt-get install --no-install-recommends -y gcc \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN mkdir -p /gem
-
-WORKDIR /gem
-
-COPY . /gem
-
-##
-# NOTE: Every container has its own copy of `Gemfile`. This way a developer doesn't need to delete `Gemfile.lock` all the time when changing containers.
-# - https://docs.docker.com/engine/reference/builder/#env
-# - https://stackoverflow.com/questions/48863711/is-it-possible-to-override-gemfile-for-local-development
-#
-ENV BUNDLE_GEMFILE=Gemfile.2.7
-
-RUN bundle install
-
-RUN bundle exec appraisal install
-
-##
-# NOTE: Installs `task`.
-# https://taskfile.dev/installation/#install-script
-#
-# NOTE: `task` is installed into `~/bin`. That is why `-b /bin` is used. See `echo ${PATH}` to debug.
-#
-RUN sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /bin
-
-##
-# NOTE: Is used to check whether a command is executed inside a Docker container. See Rakefile for examples.
-# https://stackoverflow.com/a/65942222/12201472
-#
-ENV IN_DOCKER_CONTAINER=true

data/docker/3.0/Dockerfile

@@ -1,73 +0,0 @@
-##
-# Ruby 3.0 with Node.js 16.x.
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/3.0/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.3.0
-#   docker build . -f docker/3.0/Dockerfile -t convenient_service:3.0
-#   # or `task docker:build:ruby_3.0`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:3.0 bash
-#   # or `task docker:bash:ruby_3.0`
-#
-# NOTE: If there are no memory, performance, or cost constraints, prefer to use as standard Linux distribution as it is possible.
-# In a general case, you simply won't have enough time to resolve all the "quirks" of more specific distributions if you are an application developer.
-# That is why a `slim` version is used instead of `alpine`.
-# Also `slim` is more similar to Ubuntu.
-# - https://github.com/timbru31/docker-ruby-node/tree/master/3.0/16
-# - https://medium.com/swlh/alpine-slim-stretch-buster-jessie-bullseye-bookworm-what-are-the-differences-in-docker-62171ed4531d
-# - https://hub.docker.com/r/timbru31/ruby-node/tags
-#
-# NOTE: Gallium means Node.js 16.x.
-# https://github.com/nodejs/Release
-#
-FROM timbru31/ruby-node:3.0-slim-gallium
-
-##
-# NOTE: `bundle install` dependencies.
-#
-RUN apt-get update -qq \
-  && apt-get install --no-install-recommends -y git \
-  && apt-get install --no-install-recommends -y make \
-  && apt-get install --no-install-recommends -y gcc \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*
-
-RUN mkdir -p /gem
-
-WORKDIR /gem
-
-COPY . /gem
-
-##
-# NOTE: Every container has its own copy of `Gemfile`. This way a developer doesn't need to delete `Gemfile.lock` all the time when changing containers.
-# - https://docs.docker.com/engine/reference/builder/#env
-# - https://stackoverflow.com/questions/48863711/is-it-possible-to-override-gemfile-for-local-development
-#
-ENV BUNDLE_GEMFILE=Gemfile.3.0
-
-RUN bundle install
-
-RUN bundle exec appraisal install
-
-##
-# NOTE: Installs `task`.
-# https://taskfile.dev/installation/#install-script
-#
-# NOTE: `task` is installed into `~/bin`. That is why `-b /bin` is used. See `echo ${PATH}` to debug.
-#
-RUN sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /bin
-
-##
-# NOTE: Is used to check whether a command is executed inside a Docker container. See Rakefile for examples.
-# https://stackoverflow.com/a/65942222/12201472
-#
-ENV IN_DOCKER_CONTAINER=true