convenient_service 0.17.0 → 0.19.0

data/docker/3.1/Dockerfile

@@ -1,73 +0,0 @@
-##
-# Ruby 3.1 with Node.js 16.x.
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/3.1/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.3.1
-#   docker build . -f docker/3.1/Dockerfile -t convenient_service:3.1
-#   # or `task docker:build:ruby_3.1`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:3.1 bash
-#   # or `task docker:bash:ruby_3.1`
-#
-# 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.1/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.1-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.1
-
-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.2/Dockerfile

@@ -1,73 +0,0 @@
-##
-# Ruby 3.2 with Node.js 16.x.
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/3.2/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.3.2
-#   docker build . -f docker/3.2/Dockerfile -t convenient_service:3.2
-#   # or `task docker:build:ruby_3.2`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:3.2 bash
-#   # or `task docker:bash:ruby_3.2`
-#
-# 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.2/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.2-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.2
-
-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/jruby-9.4/Dockerfile

@@ -1,88 +0,0 @@
-##
-# JRuby 9.4 (CRuby 3.1 compatible) with Node.js 16.x.
-# - https://www.jruby.org/download
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/jruby-9.4/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.jruby-9.4
-#   docker build . -f docker/jruby-9.4/Dockerfile -t convenient_service:jruby-9.4
-#   # or `task docker:build:jruby_9.4`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:jruby-9.4 bash
-#   # or `task docker:bash:jruby_9.4`
-#
-# 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.
-# `jruby:9.4` uses Ubuntu under the hood.s
-# - https://hub.docker.com/_/jruby/tags
-# - https://github.com/jruby/docker-jruby/blob/master/9.4/jre8/Dockerfile
-# - https://github.com/adoptium/containers/blob/main/19/jdk/ubuntu/jammy/Dockerfile.releases.full#L20
-#
-# NOTE: Gallium means Node.js 16.x.
-# https://github.com/nodejs/Release
-#
-FROM jruby:9.4
-
-##
-# NOTE: `git` is `bundle install` dependency.
-#
-# NOTE: `curl` and `gnupg2` are Node.js 16.x dependencies.
-# https://github.com/timbru31/docker-ruby-node/blob/master/3.2/16/slim/Dockerfile
-#
-RUN apt-get update -qq \
-  && apt-get install --no-install-recommends -y git \
-  && apt-get install --no-install-recommends -y curl \
-  && apt-get install --no-install-recommends -y gnupg2 \
-  && 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-koverride-gemfile-for-local-development
-#
-ENV BUNDLE_GEMFILE=Gemfile.jruby-9.4
-
-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: Intalls Node.js 16.x and `yarn`.
-# https://github.com/timbru31/docker-ruby-node/blob/master/3.2/16/slim/Dockerfile
-#
-RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -\
-  && apt-get update -qq \
-  && apt-get install -qq --no-install-recommends nodejs \
-  && apt-get upgrade -qq \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*\
-  && npm install -g yarn@1
-
-##
-# 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/truffleruby-22.3/Dockerfile

@@ -1,91 +0,0 @@
-##
-# TruffleRuby 22.3 (CRuby 3.1 compatible) with Node.js 16.x.
-# - https://github.com/graalvm/container/blob/master/truffleruby/README.md
-# - https://github.com/oracle/truffleruby/blob/master/doc/user/compatibility.md
-#
-# NOTE: Linted by hadolint.
-#
-#   docker run --rm -i ghcr.io/hadolint/hadolint < docker/truffleruby-22.3/Dockerfile
-#
-# NOTE: A command to build image.
-#
-#   cd convenient_service
-#   cp Gemfile Gemfile.truffleruby-22.3
-#   docker build . -f docker/truffleruby-22.3/Dockerfile -t convenient_service:truffleruby-22.3
-#   # or `task docker:build:jruby_9.4`
-#
-# NOTE: A command to run bash in container.
-#
-#   cd convenient_service
-#   docker run --rm -it -v $(pwd):/gem convenient_service:truffleruby-22.3 bash
-#   # or `task docker:bash:jruby_9.4`
-#
-# 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.
-# `ghcr.io/graalvm/truffleruby:debian-22.3` uses Debian (that is similar to Ubuntu) under the hood.
-# - https://github.com/graalvm/container/pkgs/container/truffleruby/65464856?tag=debian-22.3
-# - https://github.com/graalvm/container/blob/master/truffleruby/Dockerfile.debian#L6
-# - https://www.graalvm.org/latest/docs/getting-started/container-images/
-#
-# NOTE: Gallium means Node.js 16.x.
-# https://github.com/nodejs/Release
-#
-FROM ghcr.io/graalvm/truffleruby:debian-22.3
-
-##
-# NOTE: `git`, `make`, `gcc` are `bundle install` dependencies.
-#
-# NOTE: `curl` and `gnupg2` are Node.js 16.x dependencies.
-# https://github.com/timbru31/docker-ruby-node/blob/master/3.2/16/slim/Dockerfile
-#
-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 install --no-install-recommends -y curl \
-  && apt-get install --no-install-recommends -y gnupg2 \
-  && 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-koverride-gemfile-for-local-development
-#
-ENV BUNDLE_GEMFILE=Gemfile.truffleruby-22.3
-
-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: Intalls Node.js 16.x and `yarn`.
-# https://github.com/timbru31/docker-ruby-node/blob/master/3.2/16/slim/Dockerfile
-#
-RUN curl -sL https://deb.nodesource.com/setup_16.x | bash -\
-  && apt-get update -qq \
-  && apt-get install -qq --no-install-recommends nodejs \
-  && apt-get upgrade -qq \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*\
-  && npm install -g yarn@1
-
-##
-# 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/env.rb

@@ -1,23 +0,0 @@
-##
-# NOTE: Appraisal sets `BUNDLE_GEMFILE` env variable.
-# This is how appraisals can be differentiated from each other.
-# https://github.com/thoughtbot/appraisal/blob/v2.4.1/lib/appraisal/command.rb#L36
-#
-# If `BUNDLE_GEMFILE` is an empty string, then `APPRAISAL_NAME` is resolved to an empty string as well.
-# User passed `APPRAISAL_NAME` has a precedence.
-#
-# IMPORTANT: `APPRAISAL_NAME` env variable should be initialized as far as it is possible.
-#
-# IMPORTANT: ENV variables declared in this file should NOT be used inside the lib folder.
-#
-ENV["APPRAISAL_NAME"] ||= ENV["BUNDLE_GEMFILE"].to_s.then(&File.method(:basename)).then { |name| name.end_with?(".gemfile") ? name.delete_suffix(".gemfile") : "" }
-
-puts "ENV[\"APPRAISAL_NAME\"] -> `#{ENV["APPRAISAL_NAME"]}`"
-
-##
-# NOTE: Ruby version may be set by docker.
-# https://github.com/docker-library/ruby/blob/master/3.1/alpine3.16/Dockerfile#L30
-#
-ENV["RUBY_VERSION"] ||= ::RUBY_VERSION
-
-puts "ENV[\"RUBY_VERSION\"] -> `#{ENV["RUBY_VERSION"]}`"

data/lib/convenient_service/common/plugins/has_callbacks/container.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module HasCallbacks
-        module Container
-          include Support::DependencyContainer::Export
-
-          export :"entities.Callback" do
-            Entities::Callback
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/normalizes_env/middleware.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Common
-    module Plugins
-      module NormalizesEnv
-        ##
-        # - Single splat `*` converts `nil` to empty array.
-        # - Double splat `**` raises on `nil`.
-        # - Umpersand `&` converts `nil` to `nil`.
-        #
-        # The following middleware converts `env[:kwargs]` to a hash.
-        # This way `stack.call(*env[:args], **env[:kwargs], &env[:block])` won't fail even if a user passes `nil` as `kwargs`.
-        #
-        # Check the following link for more details:
-        # - https://bugs.ruby-lang.org/issues/8507
-        #
-        class Middleware < MethodClassicMiddleware
-          intended_for any_method, scope: any_scope, entity: any_entity
-
-          def call(env = nil)
-            env = env.to_h
-            env = env.merge(args: env[:args].to_a, kwargs: env[:kwargs].to_h, block: env[:block])
-
-            stack.call(env)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/common/plugins/normalizes_env.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "normalizes_env/middleware"

data/lib/convenient_service/examples/dry/gemfile/dry_service/config.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Dry::Gemfile.format(path: "Gemfile")
-# result = ConvenientService::Examples::Dry::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        class DryService
-          module Config
-            include Support::Concern
-
-            included do
-              include ConvenientService::Standard::Config
-
-              ##
-              # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
-              #
-              concerns do
-                use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
-              end
-
-              ##
-              # NOTE: `HasJSendResultParamsValidations::UsingDryValidation` plugin.
-              #
-              concerns do
-                use ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Concern
-              end
-
-              middlewares :result do
-                insert_before \
-                  ConvenientService::Plugins::Service::RaisesOnNotResultReturnValue::Middleware,
-                  ConvenientService::Plugins::Service::HasJSendResultParamsValidations::UsingDryValidation::Middleware
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/dry_service.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "dry_service/config"

data/lib/convenient_service/examples/dry/gemfile/services/assert_file_exists.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class AssertFileExists
-            include DryService::Config
-
-            option :path
-
-            contract do
-              schema do
-                required(:path).filled(:string)
-              end
-            end
-
-            def result
-              return failure("File with path `#{path}` does NOT exist") unless ::File.exist?(path)
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/services/assert_file_not_empty.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class AssertFileNotEmpty
-            include DryService::Config
-
-            option :path
-
-            contract do
-              schema do
-                required(:path).filled(:string)
-              end
-            end
-
-            def result
-              return failure("File with path `#{path}` is empty") if ::File.zero?(path)
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/services/assert_node_available.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Dry::Gemfile::Services::AssertNodeAvailable.result
-#
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class AssertNodeAvailable
-            include DryService::Config
-
-            ##
-            # NOTE: `> /dev/null 2>&1` is used to hide output.
-            # https://unix.stackexchange.com/a/119650/394253
-            #
-            step Services::RunShellCommand, in: {command: -> { "which node > /dev/null 2>&1" }}
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/services/assert_npm_package_available.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Dry::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
-#
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class AssertNpmPackageAvailable
-            include DryService::Config
-
-            option :name
-
-            contract do
-              schema do
-                required(:name).filled(:string)
-              end
-            end
-
-            step Services::AssertNodeAvailable
-
-            ##
-            # NOTE: `> /dev/null 2>&1` is used to hide output.
-            # https://unix.stackexchange.com/a/119650/394253
-            #
-            # NOTE: For `npm list` and its options docs, see
-            # https://docs.npmjs.com/cli/v7/commands/npm-ls
-            #
-            step Services::RunShellCommand, in: {command: -> { "npm list #{name} --depth=0 > /dev/null 2>&1" }}
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/services/assert_valid_ruby_syntax.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class AssertValidRubySyntax
-            include DryService::Config
-
-            option :content
-
-            contract do
-              schema do
-                required(:content).value(:string)
-              end
-            end
-
-            def result
-              ##
-              # NOTE: `> /dev/null 2>&1` is used to hide output.
-              # https://unix.stackexchange.com/a/119650/394253
-              #
-              check_ruby_syntax_result = Services::RunShellCommand.result(command: "ruby -c #{file.path} > /dev/null 2>&1")
-
-              return error("`#{content}` contains invalid Ruby syntax") unless check_ruby_syntax_result.success?
-
-              success
-            end
-
-            private
-
-            def file
-              @file ||= ::Tempfile.new.tap { |tempfile| tempfile.write(content) }.tap(&:close)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/gemfile/services/format.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Dry::Gemfile::Services::Format.result(path: "Gemfile")
-# result = ConvenientService::Examples::Dry::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Dry
-      class Gemfile
-        module Services
-          class Format
-            include DryService::Config
-
-            option :path
-
-            step Services::ReadFileContent, in: :path, out: :content
-            step Services::StripComments, in: :content, out: :content_without_comments
-            step Services::ParseContent, in: {content: :content_without_comments}, out: :parsed_content
-            step Services::FormatHeader, in: :parsed_content, out: {formatted_content: :formatted_header_content}
-            step Services::FormatBody, in: :parsed_content, out: {formatted_content: :formatted_body_content}
-
-            before :result do
-              @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
-            end
-
-            after :step do |step_result|
-              @progressbar.increment
-            end
-          end
-        end
-      end
-    end
-  end
-end