convenient_service 0.17.0 → 0.18.0

data/lib/convenient_service/examples/standard/v1/date_time.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "date_time/services"
-
-##
-# @internal
-#   Usage examples:
-#
-#   result = ConvenientService::Examples::Standard::V1::DateTime.safe_parse("24-02-2024", "%d-%m-%Y")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class DateTime
-          include ConvenientService::Feature::Standard::Config
-
-          entry :safe_parse do |string, format|
-            Services::SafeParse[string: string, format: format]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/v1/factorial/services/calculate.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Factorial
-          module Services
-            class Calculate
-              include ConvenientService::Standard::V1::Config
-
-              attr_reader :number, :timeout_seconds
-
-              def initialize(number:, timeout_seconds: 10)
-                @number = number
-                @timeout_seconds = timeout_seconds
-              end
-
-              def result
-                return failure(number: "is `nil`") if number.nil?
-                return failure(number: "is NOT an integer") unless number.instance_of?(::Integer)
-                return failure(number: "is lower than `0`") if number < 0
-
-                return error("Timeout (`#{timeout_seconds}` seconds) is exceeded for `#{number}`") if factorial.timeout?
-
-                success(factorial: factorial.value)
-              end
-
-              private
-
-              def factorial
-                @factorial ||= Utils::Timeout.with_timeout(timeout_seconds) { calculate_factorial }
-              end
-
-              ##
-              # @internal
-              #   NOTE: What is a Factorial?
-              #   - https://en.wikipedia.org/wiki/Factorial
-              #
-              def calculate_factorial
-                return 1 if [0, 1].include?(number)
-
-                1.upto(number).reduce(1) { |prev_value, next_value| prev_value * next_value }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/calculate"

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

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Factorial
-          module Utils
-            module Timeout
-              class WithTimeout < ConvenientService::Command
-                ReturnStruct = ::Struct.new(:timeout?, :value, keyword_init: true)
-
-                attr_reader :seconds, :block
-
-                def initialize(seconds, &block)
-                  @seconds = seconds
-                  @block = block
-                end
-
-                ##
-                # @internal
-                #   NOTE: Prefer to avoid `Timeout.timeout` if you are NOT absolutely 100% sure what you are doing. See the following articles for details.
-                #   - https://github.com/ruby/timeout/blob/master/lib/timeout.rb
-                #   - https://adamhooper.medium.com/in-ruby-dont-use-timeout-77d9d4e5a001
-                #   - https://flushentitypacket.github.io/ruby/2015/02/21/ruby-timeout-how-does-it-even-work.html
-                #   - https://www.exceptionalcreatures.com/bestiary/Timeout/Error
-                #   - https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts#regexp
-                #
-                def call
-                  return struct(timeout?: false, value: block.call) if seconds.nil?
-                  return struct(timeout?: true, value: nil) if seconds.zero?
-
-                  begin
-                    struct(timeout?: false, value: ::Timeout.timeout(seconds, &block))
-                  rescue ::Timeout::Error
-                    struct(timeout?: true, value: nil)
-                  end
-                end
-
-                private
-
-                def struct(**kwargs)
-                  ReturnStruct.new(**kwargs)
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

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

data/lib/convenient_service/examples/standard/v1/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::V1::Factorial.calculate(10)
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Factorial
-          include ConvenientService::Feature::Standard::Config
-
-          entry :calculate do |number|
-            Services::Calculate[number: number]
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Standard::V1::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Gemfile
-          module Services
-            class AssertNpmPackageAvailable
-              include ConvenientService::Standard::V1::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 failure(name: "Name is `nil`") if name.nil?
-                return failure(name: "Name is empty") if name.empty?
-
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Gemfile
-          module Services
-            class AssertValidRubySyntax
-              include ConvenientService::Standard::V1::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
-end

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

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::V1::Gemfile::Services::Format.result(path: "Gemfile")
-# result = ConvenientService::Examples::Standard::V1::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      module V1
-        class Gemfile
-          module Services
-            class Format
-              include ConvenientService::Standard::V1::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 failure(path: "Path is `nil`") if path.nil?
-                return failure(path: "Path is empty") if path.empty?
-
-                success
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      module V1
-        class Gemfile
-          module Services
-            class FormatBody
-              include ConvenientService::Standard::V1::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
-end

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

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