convenient_service 0.6.0 → 0.8.0

data/lib/convenient_service/configs/standard.rb

@@ -2,208 +2,133 @@
 
 module ConvenientService
   module Configs
+    ##
+    # Default configuration for the user-defined services.
+    #
     module Standard
       include Support::Concern
 
       ##
-      # IMPORTANT: Order of plugins matters.
+      # @internal
+      #   IMPORTANT: Order of plugins matters.
       #
-      # NOTE: `class_exec` (that is used under the hood by `included`) defines `class Result` in the global namespace.
-      # That is why `class self::Result` is used.
-      #
-      # https://stackoverflow.com/a/51965126/12201472
+      #   NOTE: `class_exec` (that is used under the hood by `included`) defines `class Result` in the global namespace.
+      #   That is why `class self::Result` is used.
+      #   - https://stackoverflow.com/a/51965126/12201472
       #
       # rubocop:disable Lint/ConstantDefinitionInBlock
       included do
-        include Core
+        include Configs::Minimal
 
         concerns do
-          use Plugins::Common::HasInternals::Concern
-          use Plugins::Common::HasConstructor::Concern
-          use Plugins::Common::HasConstructorWithoutInitialize::Concern
-
           use Plugins::Common::CachesConstructorParams::Concern
           use Plugins::Common::CanBeCopied::Concern
-          use Plugins::Service::HasResult::Concern
-          use Plugins::Service::HasResultShortSyntax::Concern
-          use Plugins::Service::HasResultSteps::Concern
           use Plugins::Service::CanRecalculateResult::Concern
+          use Plugins::Service::HasResultShortSyntax::Concern
           use Plugins::Service::HasResultStatusCheckShortSyntax::Concern
 
           use Plugins::Common::HasCallbacks::Concern
           use Plugins::Common::HasAroundCallbacks::Concern
-
-          use Plugins::Service::HasInspect::Concern
-          ##
-          # NOTE: Optional plugins.
-          # TODO: Specs.
-          #
-          #   use Plugins::Common::HasConfig::Concern
-          #
         end
 
         middlewares :initialize do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Common::CachesConstructorParams::Middleware
         end
 
         middlewares :result do
-          use Plugins::Common::NormalizesEnv::Middleware
+          insert_before \
+            Plugins::Service::HasResult::Middleware,
+            Plugins::Common::HasCallbacks::Middleware
 
-          use Plugins::Service::HasResult::Middleware
-
-          use Plugins::Service::HasResultSteps::Middleware
-
-          use Plugins::Common::HasCallbacks::Middleware
-          use Plugins::Common::HasAroundCallbacks::Middleware
+          insert_after \
+            Plugins::Common::HasCallbacks::Middleware,
+            Plugins::Common::HasAroundCallbacks::Middleware
 
           use Plugins::Service::RaisesOnDoubleResult::Middleware
 
           use Plugins::Common::CachesReturnValue::Middleware
         end
 
-        middlewares :success do
-          use Plugins::Common::NormalizesEnv::Middleware
+        middlewares :step do
+          use Plugins::Common::HasCallbacks::Middleware
+          use Plugins::Common::HasAroundCallbacks::Middleware
+        end
 
+        middlewares :success do
           use Plugins::Service::HasResultShortSyntax::Success::Middleware
         end
 
         middlewares :failure do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultShortSyntax::Failure::Middleware
         end
 
         middlewares :error do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultShortSyntax::Error::Middleware
         end
 
-        middlewares :result, scope: :class do
-          use Plugins::Common::NormalizesEnv::Middleware
-        end
-
         middlewares :step, scope: :class do
-          use Plugins::Common::NormalizesEnv::Middleware
-
           use Plugins::Service::HasResultMethodSteps::Middleware
         end
 
-        class self::Internals
-          include Core
-
-          concerns do
-            use Plugins::Internals::HasCache::Concern
-          end
-        end
-
         class self::Result
-          include Core
-
           concerns do
-            use Plugins::Common::HasInternals::Concern
-            use Plugins::Common::HasConstructor::Concern
-
-            use Plugins::Result::HasJsendStatusAndAttributes::Concern
-
             use Plugins::Result::HasResultShortSyntax::Concern
             use Plugins::Result::CanRecalculateResult::Concern
 
-            use Plugins::Result::HasInspect::Concern
+            use Plugins::Result::HasStep::Concern
+            use Plugins::Result::CanHaveParentResult::Concern
           end
 
           middlewares :initialize do
-            use Plugins::Common::NormalizesEnv::Middleware
-
-            use Plugins::Result::HasJsendStatusAndAttributes::Middleware
+            use Plugins::Result::HasStep::Initialize::Middleware
+            use Plugins::Result::CanHaveParentResult::Initialize::Middleware
           end
 
           middlewares :success? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :failure? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :error? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_success? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_failure? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :not_error? do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::MarksResultStatusAsChecked::Middleware
           end
 
           middlewares :data do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
           middlewares :message do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
           middlewares :code do
-            use Plugins::Common::NormalizesEnv::Middleware
-
             use Plugins::Result::RaisesOnNotCheckedResultStatus::Middleware
           end
 
-          class self::Internals
-            include Core
-
-            concerns do
-              use Plugins::Internals::HasCache::Concern
-            end
+          middlewares :to_kwargs do
+            use Plugins::Result::HasStep::ToKwargs::Middleware
+            use Plugins::Result::CanHaveParentResult::ToKwargs::Middleware
           end
         end
 
         class self::Step
-          include Core
-
-          concerns do
-            use Plugins::Common::HasInternals::Concern
-
-            use Plugins::Step::HasInspect::Concern
-          end
-
-          middlewares :result do
-            use Plugins::Common::NormalizesEnv::Middleware
-
-            use Plugins::Common::CachesReturnValue::Middleware
-          end
-
-          class self::Internals
-            include Core
-
-            concerns do
-              use Plugins::Internals::HasCache::Concern
-            end
+          middlewares :calculate_result do
+            use Plugins::Step::CanHaveParentResult::Middleware
           end
         end
 

data/lib/convenient_service/configs.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "configs/minimal"
 require_relative "configs/standard"
 
 require_relative "configs/aliases"

data/lib/convenient_service/dependencies.rb

@@ -75,6 +75,14 @@ module ConvenientService
         require_relative "service/plugins/has_result_params_validations/using_dry_validation"
       end
 
+      ##
+      # @return [Boolean]
+      # @note Expected to be called from app entry points like `initializers` in Rails.
+      #
+      def require_rescues_result_unhandled_exceptions
+        require_relative "service/plugins/rescues_result_unhandled_exceptions"
+      end
+
       ##
       # @return [Boolean]
       # @note Expected to be called from `irb`, `pry`, `spec_helper.rb`, etc.
@@ -106,6 +114,18 @@ module ConvenientService
         require_relative "rspec"
       end
 
+      ##
+      # Loads test factory.
+      #
+      # @return [Boolean]
+      # @note Expected to be called from `spec_helper.rb`.
+      #
+      def require_factory
+        require "faker"
+
+        require_relative "factory"
+      end
+
       ##
       # Loads standard config examples.
       #

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

@@ -16,26 +16,26 @@ module ConvenientService
 
             included do |service_class|
               service_class.class_exec do
-                include Configs::Standard
+                include ConvenientService::Standard::Config
 
                 ##
                 # NOTE: `AssignsAttributesInConstructor::UsingDryInitializer` plugin.
                 #
                 concerns do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingDryInitializer::Concern
                 end
 
                 ##
                 # NOTE: `HasResultParamsValidations::UsingDryValidation` plugin.
                 #
                 concerns do
-                  use Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
+                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
                 end
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResultSteps::Middleware,
-                    Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
+                    ConvenientService::Plugins::Service::HasResult::Middleware,
+                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
                 end
               end
             end

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

@@ -16,37 +16,37 @@ module ConvenientService
 
             included do |service_class|
               service_class.class_exec do
-                include Configs::Standard
+                include ConvenientService::Standard::Config
 
                 ##
                 # NOTE: `AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment` plugin.
                 #
                 concerns do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
                 end
 
                 middlewares :initialize do
-                  use Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
+                  use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
                 end
 
                 ##
                 # NOTE: `HasAttributes::UsingActiveModelAttributes` plugin.
                 #
                 concerns do
-                  use Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
+                  use ConvenientService::Plugins::Common::HasAttributes::UsingActiveModelAttributes::Concern
                 end
 
                 ##
                 # NOTE: `HasResultParamsValidations::UsingActiveModelValidations` plugin.
                 #
                 concerns do
-                  use Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
+                  use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
                 end
 
                 middlewares :result do
                   insert_before \
-                    Plugins::Service::HasResultSteps::Middleware,
-                    Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
+                    ConvenientService::Plugins::Service::HasResult::Middleware,
+                    ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
                 end
               end
             end

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

@@ -16,17 +16,46 @@ module ConvenientService
 
             attribute :path, :string
 
-            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}
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            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}
+
+            step Services::MergeSections,
+              in: [
+                {header: :formatted_header_content},
+                {body: :formatted_body_content}
+              ],
+              out: :merged_sections
+
+            step Services::ReplaceFileContent,
+              in: [
+                :path,
+                {content: :merged_sections}
+              ]
 
             before :result do
               @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
             end
 
-            after :step do |step_result|
+            after :step do |step|
               @progressbar.increment
             end
           end

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

@@ -38,8 +38,7 @@ module ConvenientService
             #
             # TODO: Implement custom types.
             #
-            attr_accessor :parsed_content
-
+            attribute :parsed_content
             attribute :skip_frozen_string_literal, :boolean, default: false
 
             def result

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class MergeSections
+            include RailsService::Config
+
+            attribute :header, :string
+            attribute :body, :string
+
+            validates :header, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+            validates :body, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            def result
+              success(merged_sections: "#{header}\n#{body}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Rails
+      module Gemfile
+        module Services
+          class ReplaceFileContent
+            include RailsService::Config
+
+            attribute :path, :string
+            attribute :content, :string
+
+            validates :path, presence: true if ConvenientService::Dependencies.support_has_result_params_validations_using_active_model_validations?
+
+            validate :content_not_nil if ConvenientService::Dependencies.support_has_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

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

@@ -1,17 +1,21 @@
 # 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/merge_sections"
+require_relative "services/parse_content"
+require_relative "services/print_shell_command"
+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/services/format.rb

@@ -16,23 +16,62 @@ module ConvenientService
 
             attr_reader :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}
+            step :validate_path,
+              in: :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}
+
+            step Services::MergeSections,
+              in: [
+                {header: :formatted_header_content},
+                {body: :formatted_body_content}
+              ],
+              out: :merged_sections
+
+            step Services::ReplaceFileContent,
+              in: [
+                :path,
+                {content: :merged_sections}
+              ]
 
             before :result do
               @progressbar = ::ProgressBar.create(title: "Formatting", total: steps.count)
             end
 
-            after :step do |step_result|
+            after :step do |step|
               @progressbar.increment
             end
 
             def initialize(path:)
               @path = 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

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Examples
+    module Standard
+      module Gemfile
+        module Services
+          class MergeSections
+            include ConvenientService::Standard::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

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

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