convenient_service 0.17.0 → 0.18.0

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

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Rails::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 Rails
-      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 RailsService::Config
-
-              attribute :content, :string
-
-              validates :content, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              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/rails/v1/gemfile/services/read_file_content.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class ReadFileContent
-              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::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/rails/v1/gemfile/services/replace_file_content.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class ReplaceFileContent
-              include RailsService::Config
-
-              attribute :path, :string
-              attribute :content, :string
-
-              validates :path, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              validate :content_not_nil if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              step Services::AssertFileExists, in: :path
-              step :result, in: :path
-
-              def result
-                ::File.write(path, content)
-
-                success
-              end
-
-              private
-
-              def content_not_nil
-                errors.add(:content, "can't be nil") if content.nil?
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class RunShellCommand
-              include RailsService::Config
-
-              attribute :command, :string
-              attribute :debug, :boolean, default: false
-
-              validates :command, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              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/rails/v1/gemfile/services/strip_comments.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage:
-#
-#   ConvenientService::Examples::Rails::V1::Gemfile::Services::StripComments.result(content: "abc")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      module V1
-        class Gemfile
-          module Services
-            class StripComments
-              include RailsService::Config
-
-              attribute :content, :string
-
-              validates :content, presence: true if ConvenientService::Dependencies.support_has_j_send_result_params_validations_using_active_model_validations?
-
-              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
-
-              ##
-              # 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");
-
-                    /**
-                     * TODO: try/catch when "strip-comments" is not available.
-                     */
-                    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/rails/v1/gemfile/services.rb

@@ -1,20 +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/format_header"
-require_relative "services/format_gems_without_envs"
-require_relative "services/format_gems_with_envs"
-require_relative "services/format_body"
-require_relative "services/merge_sections"
-require_relative "services/parse_content"
-require_relative "services/read_file_content"
-require_relative "services/replace_file_content"
-require_relative "services/strip_comments"
-
-require_relative "services/format"

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

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "gemfile/rails_service"
-require_relative "gemfile/services"
-
-##
-# @internal
-#   Usage example:
-#
-#   result = ConvenientService::Examples::Rails::V1::Gemfile.format("Gemfile")
-#   result = ConvenientService::Examples::Rails::V1::Gemfile.format("spec/cli/gemfile/format/fixtures/Gemfile")
-#
-module ConvenientService
-  module Examples
-    module Rails
-      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/standard/cowsay/services/build_cloud.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Cowsay
-        module Services
-          class BuildCloud
-            include ConvenientService::Standard::Config
-
-            attr_reader :text
-
-            def initialize(text: "Hello World!")
-              @text = text
-            end
-
-            def result
-              success(cloud: cloud)
-            end
-
-            private
-
-            ##
-            # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
-            #
-            def cloud
-              <<~HEREDOC
-                 #{border(text, "_")}
-                < #{text} >
-                 #{border(text, "-")}
-              HEREDOC
-            end
-
-            def border(text, char)
-              char * (text.length + 2)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/cowsay/services/build_cow.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Cowsay
-        module Services
-          class BuildCow
-            include ConvenientService::Standard::Config
-
-            def result
-              success(cow: cow)
-            end
-
-            private
-
-            ##
-            # Copied with ❤️ from https://github.com/gaborbata/rosetta-cow
-            #
-            def cow
-              <<~'HEREDOC'.split("\n").map { |line| offset(line) }.join("\n")
-                \   ^__^
-                 \  (oo)\_______
-                    (__)\       )\/\
-                        ||----w |
-                        ||     ||
-              HEREDOC
-            end
-
-            def offset(line)
-              " " * 10 + line
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/cowsay/services/print.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Cowsay
-        module Services
-          class Print
-            include ConvenientService::Standard::Config
-
-            attr_reader :text, :out
-
-            step Services::BuildCloud, in: :text, out: :cloud
-            step Services::BuildCow, out: :cow
-            step :result
-
-            def initialize(text: "Hello World!", out: $stdout)
-              @text = text
-              @out = out
-            end
-
-            def result
-              out.puts cloud + cow
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/cowsay/services.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/build_cloud"
-require_relative "services/build_cow"
-require_relative "services/print"

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "cowsay/services"
-
-##
-# @internal
-#   Usage examples:
-#
-#   result = ConvenientService::Examples::Standard::Cowsay.print("Hello")
-#   result = ConvenientService::Examples::Standard::Cowsay.print("Hi")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Cowsay
-        include ConvenientService::Feature::Standard::Config
-
-        entry :print
-
-        def print(text = "Hello World!", out: $stdout)
-          Services::Print[text: text, out: out]
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/date_time/services/safe_parse.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class DateTime
-        module Services
-          class SafeParse
-            include ConvenientService::Standard::Config
-
-            attr_reader :string, :format
-
-            def initialize(string:, format:)
-              @string = string
-              @format = format
-            end
-
-            def result
-              success(date_time: ::DateTime.strptime(string, format))
-            rescue ::Date::Error => exception
-              error(
-                data: {exception: exception},
-                message: "Failed to parse `DateTime` object from `#{string}` with `#{format}`"
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

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

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   result = ConvenientService::Examples::Standard::Factorial::Services::Calculate.result(number: 10)
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Factorial
-        module Services
-          class Calculate
-            include ConvenientService::Standard::Config
-            include ConvenientService::AwesomePrintInspect::Config
-
-            attr_reader :number, :timeout_seconds
-
-            def initialize(number:, timeout_seconds: 10)
-              @number = number
-              @timeout_seconds = timeout_seconds
-            end
-
-            def result
-              return error("is `nil`") if number.nil?
-              return error("is NOT an integer") unless number.instance_of?(::Integer)
-              return error("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

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

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

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      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