convenient_service 0.17.0 → 0.19.0

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::Gemfile.format(path: "Gemfile")
-# result = ConvenientService::Examples::Rails::V1::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          class RailsService
-            module Config
-              include Support::Concern
-
-              included do
-                include ConvenientService::Standard::V1::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.with(status: :failure)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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 error("File with path `#{path}` does NOT exist") unless ::File.exist?(path)
-
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/assert_file_not_empty.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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 error(message: "File with path `#{path}` is empty") if ::File.zero?(path)
-
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/assert_node_available.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Rails::V1::Gemfile::Services::AssertNodeAvailable.result
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/assert_npm_package_available.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Rails::V1::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/assert_valid_ruby_syntax.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/format.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::Format.result(path: "Gemfile")
-# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        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
-end

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::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
-      module V1
-        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
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/format_gems_with_envs.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::FormatGemsWithEnvs.result(
-#   parsed_content: {
-#     gems: [
-#       {
-#         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)
-#       }
-#     ]
-#   }
-# )
-#
-# NOTE: Check the corresponding spec file to see more examples.
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class FormatGemsWithEnvs
-              BLOCK_END = "end"
-              BLOCK_DO = "do"
-              COMMA_WITH_SPACE = ", "
-              EMPTY_LINE = ""
-              ENTER = "\n"
-              GROUP = "group"
-              SPACE = " "
-              TAB = "  "
-
-              include RailsService::Config
-
-              attr_accessor :parsed_content
-
-              def result
-                success(formatted_content: format_content)
-              end
-
-              private
-
-              def format_content
-                return "" if gems_with_envs.none?
-
-                gems_with_envs
-                  .group_by { |gem| gem[:envs] }
-                  .sort
-                  .map { |envs, gems|
-                    content = EMPTY_LINE.dup
-
-                    content << GROUP << SPACE << envs.map { |env| ":#{env}" }.join(COMMA_WITH_SPACE) << SPACE << BLOCK_DO << ENTER
-
-                    content << gems.map { |gem| "#{TAB}#{gem[:line]}#{ENTER}" }.join
-
-                    content << BLOCK_END << ENTER
-                  }
-                  .join(ENTER)
-              end
-
-              def gems_with_envs
-                @gems_with_envs ||= parsed_content[:gems].to_a.select { |gem| gem[:envs].any? }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/format_gems_without_envs.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::FormatGemsWithoutEnvs.result(
-#   parsed_content: {
-#     gems: [
-#       {
-#         envs: [],
-#         line: %(gem "bootsnap", ">= 1.4.4", require: false)
-#       },
-#       {
-#         envs: [],
-#         line: %(gem "pg")
-#       },
-#       {
-#         envs: [],
-#         line: %(gem "rails", "~> 6.1.3", ">= 6.1.3.2")
-#       },
-#       {
-#         envs: [],
-#         line: %(gem "webpacker", "~> 5.0")
-#       },
-#       {
-#         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
-      module V1
-        class Gemfile
-          module Services
-            class FormatGemsWithoutEnvs
-              EMPTY_LINE = ""
-              ENTER = "\n"
-
-              include RailsService::Config
-
-              attr_accessor :parsed_content
-
-              def result
-                success(formatted_content: format_content)
-              end
-
-              private
-
-              def format_content
-                return "" if gems_without_envs.none?
-
-                gems_without_envs
-                  .map { |gem| gem[:line] }
-                  .reduce(EMPTY_LINE.dup) { |content, line| content << line << ENTER }
-              end
-
-              def gems_without_envs
-                @gems_without_envs ||= parsed_content[:gems].to_a.select { |gem| gem[:envs].none? }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/format_header.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::V1::Gemfile::Services::FormatHeader.result(
-#   parsed_content: {
-#     ruby: [
-#       %(ruby "3.0.1")
-#     ],
-#     source: [
-#       %(source "https://rubygems.org")
-#     ],
-#     git_source: [
-#       %(git_source(:github) { |repo| "https://github.com/\#{repo}.git" })
-#     ]
-#   },
-#   skip_frozen_string_literal: true
-# )
-#
-# NOTE: Check the corresponding spec file to see more examples.
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class FormatHeader
-              FROZEN_STRING_LITERAL = "# frozen_string_literal: true"
-              EMPTY_LINE = ""
-              ENTER = "\n"
-
-              include RailsService::Config
-
-              ##
-              # NOTE: `attribute` has no `hash` type.
-              # https://github.com/rails/rails/blob/v7.0.4/activemodel/lib/active_model/type.rb#L42
-              #
-              # TODO: Implement custom types.
-              #
-              attribute :parsed_content
-              attribute :skip_frozen_string_literal, :boolean, default: false
-
-              def result
-                success(formatted_content: format_content)
-              end
-
-              private
-
-              def format_content
-                content = EMPTY_LINE.dup
-
-                content << FROZEN_STRING_LITERAL << ENTER << ENTER unless skip_frozen_string_literal
-
-                parsed_content.slice(:source, :git_source, :ruby).each do |_group, lines|
-                  content << lines.join(ENTER) << ENTER << ENTER
-                end
-
-                content.chomp!
-
-                content
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/rails/v1/gemfile/services/merge_sections.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class MergeSections
-              include RailsService::Config
-
-              attribute :header, :string
-              attribute :body, :string
-
-              validates :header, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-              validates :body, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              def result
-                success(merged_sections: "#{header}\n#{body}")
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end