convenient_service 0.12.0 → 0.14.0

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Standard::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 Standard
+      module V1
+        class Gemfile
+          module Services
+            class FormatHeader
+              FROZEN_STRING_LITERAL = "# frozen_string_literal: true"
+              EMPTY_LINE = ""
+              ENTER = "\n"
+
+              include ConvenientService::Standard::V1::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
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class Gemfile
+          module Services
+            class MergeSections
+              include ConvenientService::Standard::V1::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 failure(header: "Header is `nil`") if header.nil?
+                return failure(header: "Header is empty") if header.empty?
+
+                success
+              end
+
+              def validate_body
+                return failure(body: "Body is `nil`") if body.nil?
+                return failure(body: "Body is empty") if body.empty?
+
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Standard::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 Standard
+      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 ConvenientService::Standard::V1::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(data: {parsed_content: parse_content})
+              end
+
+              private
+
+              def validate_content
+                return failure(content: "Content is `nil`") if content.nil?
+                return failure(content: "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
+end

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

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

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class Gemfile
+          module Services
+            class ReadFileContent
+              include ConvenientService::Standard::V1::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(data: {content: ::File.read(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/replace_file_content.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class Gemfile
+          module Services
+            class ReplaceFileContent
+              include ConvenientService::Standard::V1::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 failure(path: "Path is `nil`") if path.nil?
+                return failure(path: "Path is empty") if path.empty?
+
+                success
+              end
+
+              def validate_content
+                return failure(content: "Content is `nil`") if content.nil?
+
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class Gemfile
+          module Services
+            class RunShellCommand
+              include ConvenientService::Standard::V1::Config
+
+              attr_reader :command, :debug
+
+              step :validate_command,
+                in: :command
+
+              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(message: "#{command} returned non-zero exit code")
+                end
+              end
+
+              private
+
+              def validate_command
+                return failure(command: "Command is `nil`") if command.nil?
+                return failure(command: "Command is empty") if command.empty?
+
+                success
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+##
+# Usage:
+#
+#   ConvenientService::Examples::Standard::V1::Gemfile::Services::StripComments.result(content: "abc")
+#
+module ConvenientService
+  module Examples
+    module Standard
+      module V1
+        class Gemfile
+          module Services
+            class StripComments
+              include ConvenientService::Standard::V1::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(data: {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
+end

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

@@ -0,0 +1,20 @@
+# 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/standard/v1/gemfile.rb

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

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

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

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

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

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

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