convenient_service 0.17.0 → 0.18.0

data/lib/convenient_service/examples/dry/v1/gemfile/services/parse_content.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Dry::V1::Gemfile::Services::ParseContent.result(
-#   content:     <<~'RUBY'
-#     ruby "3.0.1"
-#     source "https://rubygems.org"
-
-#     git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-#     gem "bootsnap", ">= 1.4.4", require: false
-
-#     group :development do
-#       gem "listen", "~> 3.3"
-#     end
-
-#     group :development, :test do
-#       gem "rspec-rails"
-#     end
-#   RUBY
-# )
-#
-# NOTE: Check the corresponding spec file to see more examples.
-#
-module ConvenientService
-  module Examples
-    module Dry
-      module V1
-        class Gemfile
-          module Services
-            class ParseContent
-              RUBY_REGEX = /\A\s*ruby/
-              SOURCE_REGEX = /\A\s*source/
-              GIT_SOURCE_REGEX = /\A\s*git_source/
-              GROUP_REGEX = /\A\s*group/
-              GEM_REGEX = /\A\s*gem/
-              BLOCK_END_REGEX = /\A\s*end/
-              ENV_SCAN_REGEX = /:(\w+)/
-
-              include DryService::Config
-
-              option :content
-
-              contract do
-                schema do
-                  required(:content).filled(:string)
-                end
-              end
-
-              step Services::AssertValidRubySyntax, in: :content
-              step :result, in: :content, out: :parsed_content
-
-              def result
-                success(data: {parsed_content: parse_content})
-              end
-
-              def parse_content
-                hash = ::Hash.new { |h, k| h[k] = [] }
-
-                ::StringIO.open(content) do |io|
-                  envs = []
-
-                  until io.eof?
-                    line = io.readline.rstrip
-
-                    case line
-                    when RUBY_REGEX
-                      hash[:ruby] << line
-                    when SOURCE_REGEX
-                      hash[:source] << line
-                    when GIT_SOURCE_REGEX
-                      hash[:git_source] << line
-                    when GROUP_REGEX
-                      envs = line.scan(ENV_SCAN_REGEX).map(&:first).map(&:to_sym)
-                    when GEM_REGEX
-                      hash[:gems] << {envs: envs, line: line.lstrip}
-                    when BLOCK_END_REGEX
-                      envs = []
-                    else
-                      hash[:rest] << line
-                    end
-                  end
-                end
-
-                hash
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/v1/gemfile/services/read_file_content.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Dry
-      module V1
-        class Gemfile
-          module Services
-            class ReadFileContent
-              include DryService::Config
-
-              option :path
-
-              contract do
-                schema do
-                  required(:path).filled(:string)
-                end
-              end
-
-              step Services::AssertFileExists, in: :path
-              step Services::AssertFileNotEmpty, in: :path
-              step :result, in: :path, out: :content
-
-              def result
-                success(data: {content: ::File.read(path)})
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/v1/gemfile/services/run_shell_command.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Dry
-      module V1
-        class Gemfile
-          module Services
-            class RunShellCommand
-              include DryService::Config
-
-              option :command
-              option :debug, default: -> { false }
-
-              contract do
-                schema do
-                  required(:command).filled(:string)
-                  optional(:debug).value(:bool)
-                end
-              end
-
-              step :result,
-                in: :command
-
-              def result
-                ##
-                # NOTE: When the command exit code is 0, `system` return `true`, and `false` otherwise.
-                # - https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-system
-                # - https://stackoverflow.com/a/37329716/12201472
-                #
-                if system(command)
-                  success
-                else
-                  error(message: "#{command} returned non-zero exit code")
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/dry/v1/gemfile/services/strip_comments.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage:
-#
-#   ConvenientService::Examples::Dry::V1::Gemfile::Services::StripComments.result(content: "abc")
-#
-module ConvenientService
-  module Examples
-    module Dry
-      module V1
-        class Gemfile
-          module Services
-            class StripComments
-              include DryService::Config
-
-              option :content
-
-              contract do
-                schema do
-                  required(:content).filled(:string)
-                end
-              end
-
-              alias_method :content_with_comments, :content
-
-              step Services::AssertNpmPackageAvailable, in: {name: -> { "strip-comments" }}
-              step Services::RunShellCommand, in: {command: -> { "node -e '#{js_script}' #{file_with_comments.path} #{file_without_comments.path}" }}
-              step :result, in: :file_without_comments, out: :content_without_comments
-
-              def result
-                success(data: {content_without_comments: file_without_comments.read})
-              end
-
-              private
-
-              ##
-              # NOTE: When you have no time to do something well, delegate that task to someone who already works with it all the time.
-              # That is why `strip-comments` npm package is used to remove comments.
-              #
-              def js_script
-                ##
-                # NOTE: `main` function is created in order to have an ability to use early returns.
-                #
-                # IMPORTANT: Use only double quotes inside this JS script, since it is later consumed by `node -e` option wrapped by single quoutes.
-                #
-                # TODO: Consider to use WeakRef if memory is a concern.
-                # https://ruby-doc.org/stdlib-2.5.1/libdoc/weakref/rdoc/WeakRef.html
-                #
-                # TODO: Jest tests for JS script.
-                #
-                @js_script ||= <<~JAVASCRIPT.gsub(/\n\s*/, " ")
-                  const main = () => {
-                    const process = require("process");
-                    const fs = require("fs");
-                    const strip = require("strip-comments");
-
-                    const fileWithCommentsPath = process.argv[1];
-                    const fileWithoutCommentsPath = process.argv[2];
-                    const language = process.argv[3] || "ruby";
-
-                    if (!fileWithCommentsPath) {
-                      console.log("Error: Input file path is NOT passed.");
-
-                      process.exit(1);
-                    }
-
-                    if (!fileWithoutCommentsPath) {
-                      console.log("Error: Output file path is NOT passed.");
-
-                      process.exit(1);
-                    }
-
-                    if (!["ruby", "javascript"].includes(language)) {
-                      console.log("Error: Language " + language + " is NOT supported.");
-
-                      process.exit(1);
-                    }
-
-                    const fileWithCommentsContent = fs.readFileSync(fileWithCommentsPath, { encoding: "utf8" });
-                    const fileWithoutCommentsContent = strip(fileWithCommentsContent, { language });
-
-                    fs.writeFileSync(fileWithoutCommentsPath, fileWithoutCommentsContent, { encoding: "utf8" });
-
-                    process.exit(0);
-                  };
-
-                  main();
-                JAVASCRIPT
-              end
-
-              def file_with_comments
-                ##
-                # NOTE: Tempfile is used to avoid issues with escaping of quotes inside JS script.
-                #
-                @file_with_comments ||= ::Tempfile.new.tap { |tempfile| tempfile.write(content_with_comments) }.tap(&:close)
-              end
-
-              def file_without_comments
-                ##
-                # NOTE: JS script tries to fill content of the file without comments.
-                #
-                @file_without_comments ||= ::Tempfile.new
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/run_shell_command"
-
-require_relative "services/assert_file_exists"
-require_relative "services/assert_file_not_empty"
-require_relative "services/assert_node_available"
-require_relative "services/assert_npm_package_available"
-require_relative "services/assert_valid_ruby_syntax"
-require_relative "services/read_file_content"
-require_relative "services/strip_comments"
-require_relative "services/parse_content"
-require_relative "services/format_header"
-require_relative "services/format_gems_without_envs"
-require_relative "services/format_gems_with_envs"
-require_relative "services/format_body"
-require_relative "services/format"

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "gemfile/dry_service"
-require_relative "gemfile/services"
-
-##
-# @internal
-#   Usage example:
-#
-#   result = ConvenientService::Examples::Dry::V1::Gemfile.format("Gemfile")
-#   result = ConvenientService::Examples::Dry::V1::Gemfile.format("spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Dry
-      module V1
-        class Gemfile
-          include ConvenientService::Feature::Standard::Config
-
-          entry :format
-
-          def format(path)
-            Services::Format[path: path]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/gemfile/rails_service/config.rb

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

data/lib/convenient_service/examples/rails/gemfile/rails_service.rb

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

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class AssertFileExists
-            include RailsService::Config
-
-            attribute :path, :string
-
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-            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/rails/gemfile/services/assert_file_not_empty.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class AssertFileNotEmpty
-            include RailsService::Config
-
-            attribute :path, :string
-
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-            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/rails/gemfile/services/assert_node_available.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Rails::Gemfile::Services::AssertNodeAvailable.result
-#
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class AssertNodeAvailable
-            include RailsService::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/rails/gemfile/services/assert_npm_package_available.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Rails::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class AssertNpmPackageAvailable
-            include RailsService::Config
-
-            attribute :name, :string
-
-            validates :name, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-            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/rails/gemfile/services/assert_valid_ruby_syntax.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class AssertValidRubySyntax
-            include RailsService::Config
-
-            attribute :content, :string
-
-            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/rails/gemfile/services/format.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::Gemfile::Services::Format.result(path: "Gemfile")
-# result = ConvenientService::Examples::Rails::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class Format
-            include RailsService::Config
-
-            attribute :path, :string
-
-            validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-            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}
-
-            step Services::MergeSections,
-              in: [
-                {header: :formatted_header_content},
-                {body: :formatted_body_content}
-              ],
-              out: :merged_sections
-
-            step Services::ReplaceFileContent,
-              in: [
-                :path,
-                {content: :merged_sections}
-              ]
-
-            before :result do
-              @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
-            end
-
-            after :step do |step|
-              @progressbar.increment
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/gemfile/services/format_body.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::Gemfile::Services::FormatBody.result(
-#   parsed_content: {
-#     gems: [
-#       {
-#         envs: [],
-#         line: %(gem "bootsnap", ">= 1.4.4", require: false)
-#       },
-#       {
-#         envs: [],
-#         line: %(gem "pg")
-#       },
-#       {
-#         envs: [:development],
-#         line: %(gem "listen", "~> 3.3")
-#       },
-#       {
-#         envs: [:development],
-#         line: %(gem "web-console", ">= 4.1.0")
-#       },
-#       {
-#         envs: [:development, :test],
-#         line: %(gem "rspec-rails")
-#       },
-#       {
-#         envs: [:test],
-#         line: %(gem "simplecov", require: false)
-#       },
-#       {
-#         envs: [],
-#         line: %(gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby])
-#       }
-#     ]
-#   }
-# )
-#
-# NOTE: Check the corresponding spec file to see more examples.
-#
-module ConvenientService
-  module Examples
-    module Rails
-      class Gemfile
-        module Services
-          class FormatBody
-            include RailsService::Config
-
-            attr_accessor :parsed_content
-
-            step Services::FormatGemsWithoutEnvs,
-              in: :parsed_content,
-              out: [{formatted_content: :formatted_gems_without_envs_content}]
-
-            step Services::FormatGemsWithEnvs,
-              in: :parsed_content,
-              out: [{formatted_content: :formatted_gems_with_envs_content}]
-
-            step :result,
-              in: [:formatted_gems_without_envs_content, :formatted_gems_with_envs_content],
-              out: :formatted_content
-
-            def result
-              success(formatted_content: format_content)
-            end
-
-            private
-
-            def format_content
-              [formatted_gems_without_envs_content, formatted_gems_with_envs_content].reject(&:empty?).join("\n")
-            end
-          end
-        end
-      end
-    end
-  end
-end