convenient_service 0.17.0 → 0.18.0

data/lib/convenient_service/examples/standard/factorial/utils/timeout.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "timeout/with_timeout"
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Factorial
-        module Utils
-          module Timeout
-            class << self
-              def with_timeout(...)
-                WithTimeout.call(...)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/factorial/utils.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "utils/timeout"

data/lib/convenient_service/examples/standard/factorial.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "factorial/services"
-require_relative "factorial/utils"
-
-##
-# @internal
-#   Usage examples:
-#
-#   result = ConvenientService::Examples::Standard::Factorial.calculate(10)
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Factorial
-        include ConvenientService::Feature::Standard::Config
-
-        entry :calculate
-
-        def calculate(number)
-          Services::Calculate[number: number]
-        end
-      end
-    end
-  end
-end

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class AssertFileExists
-            include ConvenientService::Standard::Config
-
-            attr_reader :path
-
-            def initialize(path:)
-              @path = path
-            end
-
-            def result
-              return error("Path is `nil`") if path.nil?
-              return error("Path is empty") if path.empty?
-
-              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/standard/gemfile/services/assert_file_not_empty.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class AssertFileNotEmpty
-            include ConvenientService::Standard::Config
-
-            attr_reader :path
-
-            def initialize(path:)
-              @path = path
-            end
-
-            def result
-              return error("Path is `nil`") if path.nil?
-              return error("Path is empty") if path.empty?
-
-              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/standard/gemfile/services/assert_node_available.rb

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

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Standard::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class AssertNpmPackageAvailable
-            include ConvenientService::Standard::Config
-
-            attr_reader :name
-
-            step :validate_name
-
-            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" }}
-
-            def initialize(name:)
-              @name = name
-            end
-
-            private
-
-            def validate_name
-              return error("Name is `nil`") if name.nil?
-              return error("Name is empty") if name.empty?
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class AssertValidRubySyntax
-            include ConvenientService::Standard::Config
-
-            attr_reader :content
-
-            def initialize(content:)
-              @content = content
-            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/standard/gemfile/services/format.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   result = ConvenientService::Examples::Standard::Gemfile::Services::Format.result(path: "Gemfile")
-#   result = ConvenientService::Examples::Standard::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class Format
-            include ConvenientService::Standard::Config
-
-            attr_reader :path
-
-            step :validate_path,
-              in: :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}
-
-            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
-
-            def initialize(path:)
-              @path = path
-            end
-
-            private
-
-            def validate_path
-              return error("Path is `nil`") if path.nil?
-              return error("Path is empty") if path.empty?
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      class Gemfile
-        module Services
-          class FormatBody
-            include ConvenientService::Standard::Config
-
-            attr_reader :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 initialize(parsed_content:)
-              @parsed_content = parsed_content
-            end
-
-            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

data/lib/convenient_service/examples/standard/gemfile/services/format_gems_with_envs.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      class Gemfile
-        module Services
-          class FormatGemsWithEnvs
-            BLOCK_END = "end"
-            BLOCK_DO = "do"
-            COMMA_WITH_SPACE = ", "
-            EMPTY_LINE = ""
-            ENTER = "\n"
-            GROUP = "group"
-            SPACE = " "
-            TAB = "  "
-
-            include ConvenientService::Standard::Config
-
-            attr_reader :parsed_content
-
-            def initialize(parsed_content:)
-              @parsed_content = parsed_content
-            end
-
-            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

data/lib/convenient_service/examples/standard/gemfile/services/format_gems_without_envs.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      class Gemfile
-        module Services
-          class FormatGemsWithoutEnvs
-            EMPTY_LINE = ""
-            ENTER = "\n"
-
-            include ConvenientService::Standard::Config
-
-            attr_reader :parsed_content
-
-            def initialize(parsed_content:)
-              @parsed_content = parsed_content
-            end
-
-            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

data/lib/convenient_service/examples/standard/gemfile/services/format_header.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      class Gemfile
-        module Services
-          class FormatHeader
-            FROZEN_STRING_LITERAL = "# frozen_string_literal: true"
-            EMPTY_LINE = ""
-            ENTER = "\n"
-
-            include ConvenientService::Standard::Config
-
-            attr_reader :parsed_content, :skip_frozen_string_literal
-
-            def initialize(parsed_content:, skip_frozen_string_literal: false)
-              @parsed_content = parsed_content
-              @skip_frozen_string_literal = skip_frozen_string_literal
-            end
-
-            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

data/lib/convenient_service/examples/standard/gemfile/services/merge_sections.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class MergeSections
-            include ConvenientService::Standard::Config
-
-            attr_reader :header, :body
-
-            step :validate_header,
-              in: :header
-
-            step :validate_body,
-              in: :body
-
-            step :result,
-              in: [
-                :header,
-                :body
-              ]
-
-            def initialize(header:, body:)
-              @header = header
-              @body = body
-            end
-
-            def result
-              success(merged_sections: "#{header}\n#{body}")
-            end
-
-            def validate_header
-              return error("Header is `nil`") if header.nil?
-              return error("Header is empty") if header.empty?
-
-              success
-            end
-
-            def validate_body
-              return error("Body is `nil`") if body.nil?
-              return error("Body is empty") if body.empty?
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end