convenient_service 0.1.0

data/lib/convenient_service/dependencies/extractions/ruby_middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+##
+# @internal
+#   NOTE:
+#     Copied from `Ibsciss/ruby-middleware` without any logic modification.
+#     Version: v0.4.2.
+#     Just wrapped in a namespace `ConvenientService::Dependencies::Extractions::RubyMiddleware`.
+#     Replaced `require` into `require_relative`.
+#
+#   - https://github.com/marian13/ruby-middleware/blob/v0.4.2
+#   - https://github.com/Ibsciss/ruby-middleware/blob/v0.4.2
+#   - https://github.com/Ibsciss/ruby-middleware
+#
+require_relative "ruby_middleware/middleware"

data/lib/convenient_service/dependencies/extractions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+##
+# This file load extracted dependencies.
+#
+# @internal
+#   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
+#
+require_relative "extractions/active_support_concern"
+require_relative "extractions/ruby_middleware"

data/lib/convenient_service/dependencies.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require_relative "dependencies/built_in"
+require_relative "dependencies/extractions"
+
+##
+# `ConvenientService::Dependencies` can dynamically require plugins/extensions that have external dependencies.
+#
+# @internal
+#   https://github.com/marian13/convenient_service/wiki/Docs:-Dependencies
+#
+module ConvenientService
+  module Dependencies
+    class << self
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_assigns_attributes_in_constructor_using_active_model_attribute_assignment
+        require "active_model"
+
+        require_relative "common/plugins/assigns_attributes_in_constructor/using_active_model_attribute_assignment"
+      end
+
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_assigns_attributes_in_constructor_using_dry_initializer
+        require "dry-initializer"
+
+        require_relative "common/plugins/assigns_attributes_in_constructor/using_dry_initializer"
+      end
+
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_has_attributes_using_active_model_attributes
+        require "active_model"
+
+        require_relative "common/plugins/has_attributes/using_active_model_attributes"
+      end
+
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_has_result_params_validations_using_active_model_validations
+        require "active_model"
+
+        require_relative "service/plugins/has_result_params_validations/using_active_model_validations"
+      end
+
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_has_result_params_validations_using_dry_validation
+        require "dry-validation"
+
+        require_relative "service/plugins/has_result_params_validations/using_dry_validation"
+      end
+
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from `irb`, `pry`, `spec_helper.rb`, etc.
+      #
+      def require_development_tools
+        require "awesome_print"
+        require "byebug"
+        require "paint"
+        require "rouge"
+        require "tempfile"
+
+        require_relative "dependencies/extractions/byebug_syntax_highlighting"
+        require_relative "dependencies/extractions/b"
+      end
+
+      ##
+      # Loads RSpec extensions like `be_success` matcher, `stub_service` helper, etc.
+      #
+      # @return [Boolean]
+      # @note Expected to be called from `spec_helper.rb`.
+      #
+      def require_rspec_extentions
+        require "rspec/expectations"
+        require "rspec/matchers"
+        require "rspec/mocks"
+
+        require "tempfile"
+
+        require_relative "rspec"
+      end
+
+      ##
+      # Loads standard config examples.
+      #
+      # @return [Boolean]
+      # @api private
+      #
+      def require_standard_examples
+        require "progressbar"
+
+        require_relative "examples/standard/gemfile"
+      end
+
+      ##
+      # Loads rails config examples.
+      #
+      # @return [Boolean]
+      # @api private
+      #
+      def require_rails_examples
+        require "progressbar"
+
+        require_relative "examples/rails/gemfile"
+      end
+
+      ##
+      # Loads dry config examples.
+      #
+      # @return [Boolean]
+      # @api private
+      #
+      def require_dry_examples
+        require "progressbar"
+
+        require_relative "examples/dry/gemfile"
+      end
+    end
+  end
+end

data/lib/convenient_service/error.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+##
+# Base class for all `ConvenientService` errors.
+# Can be used as a catch-all solution, for example:
+#
+#   begin
+#     any_service.result
+#   rescue ConvenientService::Error => error
+#     puts error.message
+#   end
+#
+module ConvenientService
+  class Error < ::StandardError
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+##
+# 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 DryService
+          module Config
+            def self.included(service_class)
+              service_class.class_exec do
+                include Configs::Standard
+
+                ##
+                # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
+                #
+                concerns do
+                  use Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
+                end
+
+                ##
+                # NOTE: `HasResultParamsValidations::UsingDryValidation` plugin.
+                #
+                concerns do
+                  use Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
+                end
+
+                middlewares :result do
+                  use Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class AssertFileExists
+            include DryService::Config
+
+            option :path
+
+            contract do
+              schema do
+                required(:path).value(:string)
+              end
+            end
+
+            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/dry/gemfile/services/assert_file_not_empty.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class AssertFileNotEmpty
+            include DryService::Config
+
+            option :path
+
+            contract do
+              schema do
+                required(:path).value(:string)
+              end
+            end
+
+            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/dry/gemfile/services/assert_node_available.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Dry::Gemfile::Services::AssertNodeAvailable.result
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class AssertNodeAvailable
+            include DryService::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/dry/gemfile/services/assert_npm_package_available.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+#   ConvenientService::Examples::Dry::Gemfile::Services::AssertNpmPackageAvailable.result(name: "lodash")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class AssertNpmPackageAvailable
+            include DryService::Config
+
+            option :name
+
+            contract do
+              schema do
+                required(:name).value(:string)
+              end
+            end
+
+            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

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

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

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::Gemfile::Services::Format.result(path: "Gemfile")
+# result = ConvenientService::Examples::Dry::Gemfile::Services::Format.result(path: "spec/cli/gemfile/format/fixtures/Gemfile")
+#
+module ConvenientService
+  module Examples
+    module Dry
+      module Gemfile
+        module Services
+          class Format
+            include DryService::Config
+
+            option :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}
+
+            before :result do
+              @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
+            end
+
+            after :step do |step_result|
+              @progressbar.increment
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+##
+# Usage example:
+#
+# result = ConvenientService::Examples::Dry::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 Dry
+      module Gemfile
+        module Services
+          class FormatGemsWithEnvs
+            BLOCK_END = "end"
+            BLOCK_DO = "do"
+            COMMA_WITH_SPACE = ", "
+            EMPTY_LINE = ""
+            ENTER = "\n"
+            GROUP = "group"
+            SPACE = " "
+            TAB = "  "
+
+            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_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