convenient_service 0.1.0

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::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 Dry
+      module Gemfile
+        module Services
+          class FormatGemsWithoutEnvs
+            EMPTY_LINE = ""
+            ENTER = "\n"
+
+            include DryService::Config
+
+            option :parsed_content
+
+            contract do
+              schema do
+                required(:parsed_content).hash do
+                  optional(:gems).array(:hash) do
+                    ##
+                    # NOTE: required(:envs).array(:symbol) raises `Dry::Container::KeyError: key not found: "{:type?=>Symbol}"`.
+                    #
+                    required(:envs).array(type?: ::Symbol)
+                    required(:line).value(:string)
+                  end
+                end
+              end
+            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/dry/gemfile/services/format_header.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::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 Dry
+      module Gemfile
+        module Services
+          class FormatHeader
+            FROZEN_STRING_LITERAL = "# frozen_string_literal: true"
+            EMPTY_LINE = ""
+            ENTER = "\n"
+
+            include DryService::Config
+
+            option :parsed_content
+            option :skip_frozen_string_literal, default: -> { false }
+
+            contract do
+              schema do
+                required(:parsed_content).hash do
+                  optional(:ruby).array(:string)
+                  optional(:source).array(:string)
+                  optional(:git_source).array(:string)
+                end
+
+                optional(:skip_frozen_string_literal).value(:bool?)
+              end
+            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/dry/gemfile/services/parse_content.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::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 Dry
+      module 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 DryService::Config
+
+            option :content
+
+            contract do
+              schema do
+                required(:content).value(:string)
+              end
+            end
+
+            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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Dry::Gemfile::Services::PrintShellCommand.result(text: "ls -a")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class PrintShellCommand
+            include DryService::Config
+
+            option :text
+            option :out, default: -> { $stdout }
+
+            contract do
+              schema do
+                required(:text).value(:string)
+              end
+            end
+
+            def result
+              out.puts
+
+              out.puts ::Paint["$ #{text}", :blue, :bold]
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class ReadFileContent
+            include DryService::Config
+
+            option :path
+
+            contract do
+              schema do
+                required(:path).value(:string)
+              end
+            end
+
+            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

data/lib/convenient_service/examples/dry/gemfile/services/run_shell.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class RunShell
+            include DryService::Config
+
+            option :command
+            option :debug, default: -> { false }
+
+            contract do
+              schema do
+                required(:command).value(:string)
+                optional(:debug).value(:bool)
+              end
+            end
+
+            def result
+              Services::PrintShellCommand.result(text: command) if debug
+
+              ##
+              # 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

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+##
+# Usage:
+#
+#   ConvenientService::Examples::Dry::Gemfile::Services::StripComments.result(content: "abc")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class StripComments
+            include DryService::Config
+
+            option :content
+
+            contract do
+              schema do
+                required(:content).value(:string)
+              end
+            end
+
+            alias_method :content_with_comments, :content
+
+            step Services::AssertNpmPackageAvailable, in: {name: -> { "strip-comments" }}
+            step Services::RunShell, 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
+
+            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");
+                  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/dry/gemfile/services.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "services/run_shell"
+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/read_file_content"
+require_relative "services/strip_comments"
+require_relative "services/parse_content"
+require_relative "services/print_shell_command"
+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/format"

data/lib/convenient_service/examples/dry/gemfile.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "gemfile/dry_service"
+require_relative "gemfile/services"
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::Gemfile.format(path: "Gemfile")
+# result = ConvenientService::Examples::Dry::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        class << self
+          def format
+            Services::Format[path: path]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/rails/gemfile/rails_service/config.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Rails::Gemfile.format(path: "Gemfile")
+# result = ConvenientService::Examples::Rails::Gemfile.format(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        class RailsService
+          module Config
+            def self.included(service_class)
+              service_class.class_exec do
+                include Configs::Standard
+
+                ##
+                # NOTE: `AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment` plugin.
+                #
+                concerns do
+                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
+                end
+
+                middlewares :initialize do
+                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
+                end
+
+                ##
+                # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
+                #
+                concerns do
+                  use Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
+                end
+
+                ##
+                # NOTE: `HasResultParamsValidations::UsingActiveModelValidations` plugin.
+                #
+                concerns do
+                  use Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
+                end
+
+                middlewares :result do
+                  use Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rails_service/config"

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class AssertFileExists
+            include RailsService::Config
+
+            attribute :path, :string
+
+            validates :path, presence: true
+
+            def result
+              return error("File with path `#{path}` does NOT exist") unless ::File.exist?(path)
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/rails/gemfile/services/assert_file_not_empty.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class AssertFileNotEmpty
+            include RailsService::Config
+
+            attribute :path, :string
+
+            validates :path, presence: true
+
+            def result
+              return error(message: "File with path `#{path}` is empty") if ::File.zero?(path)
+
+              success
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/rails/gemfile/services/assert_node_available.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Rails::Gemfile::Services::AssertNodeAvailable.result
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class AssertNodeAvailable
+            include RailsService::Config
+
+            ##
+            # NOTE: `> /dev/null 2>&1` is used to hide output.
+            # https://unix.stackexchange.com/a/119650/394253
+            #
+            step Services::RunShell, in: {command: -> { "which node > /dev/null 2>&1" }}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/examples/rails/gemfile/services/assert_npm_package_available.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Rails::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
+#
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class AssertNpmPackageAvailable
+            include RailsService::Config
+
+            attribute :name, :string
+
+            validates :name, presence: true
+
+            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::RunShell, in: {command: -> { "npm list #{name} --depth=0 > /dev/null 2>&1" }}
+          end
+        end
+      end
+    end
+  end
+end