convenient_service 0.17.0 → 0.18.0

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

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-# result = ConvenientService::Examples::Standard::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 Standard
-      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 ConvenientService::Standard::Config
-
-            attr_reader :content
-
-            step :validate_content
-            step Services::AssertValidRubySyntax, in: :content
-            step :result, in: :content, out: :parsed_content
-
-            def initialize(content:)
-              @content = content
-            end
-
-            def result
-              success(parsed_content: parse_content)
-            end
-
-            private
-
-            def validate_content
-              return error("Content is `nil`") if content.nil?
-              return error("Content is empty") if content.empty?
-
-              success
-            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

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

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage example:
-#
-#   ConvenientService::Examples::Standard::Gemfile::Services::PrintShellCommand.result(command: "ls -a")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class PrintShellCommand
-            include ConvenientService::Standard::Config
-
-            attr_reader :command, :skip, :out
-
-            def initialize(command:, skip: false, out: $stdout)
-              @command = command
-              @skip = skip
-              @out = out
-            end
-
-            def result
-              return error("Command is `nil`") if command.nil?
-              return error("Command is empty?") if command.empty?
-
-              return failure("Printing of shell command `#{command}` is skipped") if skip
-
-              out.puts
-
-              out.puts ::Paint["$ #{command}", :blue, :bold]
-
-              success
-            end
-
-            def fallback_failure_result
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class ReadFileContent
-            include ConvenientService::Standard::Config
-
-            attr_reader :path
-
-            step :validate_path, in: :path
-            step Services::AssertFileExists, in: :path
-            step Services::AssertFileNotEmpty, in: :path
-            step :result, in: :path, out: :content
-
-            def initialize(path:)
-              @path = path
-            end
-
-            def result
-              success(content: ::File.read(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/replace_file_content.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class ReplaceFileContent
-            include ConvenientService::Standard::Config
-
-            attr_reader :path, :content
-
-            step :validate_path, in: :path
-            step :validate_content, in: :content
-            step Services::AssertFileExists, in: :path
-            step :result, in: :path
-
-            def initialize(path:, content:)
-              @path = path
-              @content = content
-            end
-
-            def result
-              ::File.write(path, content)
-
-              success
-            end
-
-            private
-
-            def validate_path
-              return error("Path is `nil`") if path.nil?
-              return error("Path is empty") if path.empty?
-
-              success
-            end
-
-            def validate_content
-              return error("Content is `nil`") if content.nil?
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class RunShellCommand
-            include ConvenientService::Standard::Config
-
-            attr_reader :command, :debug
-
-            step :validate_command,
-              in: :command
-
-            step Services::PrintShellCommand,
-              in: [:command, {skip: -> { !debug }}],
-              fallback: true
-
-            step :result,
-              in: :command
-
-            def initialize(command:, debug: false)
-              @command = command
-              @debug = debug
-            end
-
-            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("#{command} returned non-zero exit code")
-              end
-            end
-
-            private
-
-            def validate_command
-              return error("Command is `nil`") if command.nil?
-              return error("Command is empty") if command.empty?
-
-              success
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-##
-# Usage:
-#
-#   ConvenientService::Examples::Standard::Gemfile::Services::StripComments.result(content: "abc")
-#
-module ConvenientService
-  module Examples
-    module Standard
-      class Gemfile
-        module Services
-          class StripComments
-            include ConvenientService::Standard::Config
-
-            attr_reader :content
-
-            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 initialize(content:)
-              @content = content
-            end
-
-            def result
-              success(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");
-
-                  /**
-                   * 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

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "services/print_shell_command"
-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/standard/gemfile.rb

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

data/lib/convenient_service/examples/standard/request_params/constants.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Constants
-          module Tags
-            EMPTY = ""
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/description.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          class Description
-            def initialize(value:)
-              @value = value
-            end
-
-            class << self
-              def cast(value)
-                case value
-                when ::String
-                  new(value: value.to_s)
-                end
-              end
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              value == other.value
-            end
-
-            def to_s
-              value
-            end
-
-            protected
-
-            attr_reader :value
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/format.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          class Format
-            def initialize(value:)
-              @value = value
-            end
-
-            class << self
-              def cast(value)
-                case value
-                when ::String
-                  new(value: value.to_s)
-                end
-              end
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              value == other.value
-            end
-
-            def to_s
-              value
-            end
-
-            protected
-
-            attr_reader :value
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/id.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          ##
-          # TODO: https://ruby-doc.org/3.1.3/stdlibs/yaml/YAML/DBM.html
-          #
-          class ID
-            def initialize(value:)
-              @value = value
-            end
-
-            class << self
-              def cast(value)
-                case value
-                when ::String, ::Integer
-                  new(value: value.to_s)
-                end
-              end
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              value == other.value
-            end
-
-            def to_i
-              value.to_i
-            end
-
-            def to_s
-              value
-            end
-
-            protected
-
-            attr_reader :value
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/logger.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          class Logger
-            class << self
-              def log(message, out: $stdout)
-                out.puts message
-
-                message
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/request.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          class Request
-            attr_reader :http_string
-
-            def initialize(http_string:)
-              @http_string = http_string
-            end
-
-            def to_s
-              http_string
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/examples/standard/request_params/entities/source.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Examples
-    module Standard
-      class RequestParams
-        module Entities
-          class Source
-            def initialize(value:)
-              @value = value
-            end
-
-            class << self
-              def cast(value)
-                case value
-                when ::String
-                  new(value: value.to_s)
-                end
-              end
-            end
-
-            def ==(other)
-              return unless other.instance_of?(self.class)
-
-              value == other.value
-            end
-
-            def to_s
-              value
-            end
-
-            protected
-
-            attr_reader :value
-          end
-        end
-      end
-    end
-  end
-end