convenient_service 0.6.0 → 0.7.0

data/lib/convenient_service/service/plugins/has_result_steps/middleware.rb

@@ -5,6 +5,9 @@ module ConvenientService
     module Plugins
       module HasResultSteps
         class Middleware < Core::MethodChainMiddleware
+          ##
+          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          #
           def next(...)
             return chain.next(...) if entity.steps.none?
 
@@ -13,11 +16,22 @@ module ConvenientService
 
           private
 
+          ##
+          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          #
           def last_step
-            ##
-            # TODO: Use `entity.steps.find { |step| step.result.tap { |result| entity.step(result) }.not_success? }` for callbacks.
-            #
-            @last_step ||= entity.steps.find(&:not_success?) || entity.steps.last
+            @last_step ||= entity.steps.find.with_index { |step, index| not_success?(step, index) } || entity.steps.last
+          end
+
+          ##
+          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          #
+          # @internal
+          #   NOTE: `entity.step(index)` is used as a hook (callbacks trigger).
+          #   IMPORTANT: `step` status MUST be checked before triggering callbacks.
+          #
+          def not_success?(step, index)
+            step.not_success?.tap { entity.step(index) }
           end
         end
       end

data/lib/convenient_service/services/run_method_in_organizer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Services
+    class RunMethodInOrganizer
+      ##
+      # @internal
+      #   TODO: Reuse parent config?
+      #
+      include Configs::Standard
+
+      attr_reader :method_name, :organizer, :kwargs
+
+      def initialize(method_name:, organizer:, **kwargs)
+        @method_name = method_name
+        @organizer = organizer
+        @kwargs = kwargs
+      end
+
+      def result
+        ##
+        # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `organizer.__send__(method_name)` body.
+        #
+        organizer.__send__(method_name)
+      end
+    end
+  end
+end

data/lib/convenient_service/services/run_own_method_in_organizer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Services
+    class RunOwnMethodInOrganizer
+      module Errors
+        class MethodForStepIsNotDefined < ConvenientService::Error
+          def initialize(service_class:, method_name:)
+            message = <<~TEXT
+              Service #{service_class} tries to use `#{method_name}` method in a step, but it NOT defined.
+
+              Did you forget to define it?
+            TEXT
+
+            super(message)
+          end
+        end
+      end
+
+      ##
+      # @internal
+      #   TODO: Reuse parent config?
+      #
+      include Configs::Standard
+
+      attr_reader :method_name, :organizer, :kwargs
+
+      def initialize(method_name:, organizer:, **kwargs)
+        @method_name = method_name
+        @organizer = organizer
+        @kwargs = kwargs
+      end
+
+      def result
+        raise Errors::MethodForStepIsNotDefined.new(service_class: organizer.class, method_name: method_name) unless own_method
+
+        ##
+        # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `own_method` body.
+        #
+        own_method.call
+      end
+
+      private
+
+      ##
+      # @return [Method, nil]
+      #
+      # @internal
+      #   TODO: A possible bottleneck. Should be removed if receives negative feedback.
+      #
+      #   NOTE: `own_method.bind(organizer).call` is logically the same as `own_method.bind_call(organizer)`.
+      #   - https://ruby-doc.org/core-2.7.1/UnboundMethod.html#method-i-bind_call
+      #   - https://blog.saeloun.com/2019/10/17/ruby-2-7-adds-unboundmethod-bind_call-method.html
+      #
+      def own_method
+        method = Utils::Module.get_own_instance_method(organizer.class, method_name, private: true)
+
+        return unless method
+
+        method.bind(organizer)
+      end
+    end
+  end
+end

data/lib/convenient_service/{service/plugins/has_result_method_steps/services.rb → services.rb}

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "services/method_step_config"
 require_relative "services/run_own_method_in_organizer"
 require_relative "services/run_method_in_organizer"

data/lib/convenient_service/support/copyable.rb

@@ -20,8 +20,12 @@ module ConvenientService
       #   NOTE: This method is NOT likely to be ever changed, that is why inline logic is preferred over command classes in this particular case.
       #
       def copy(overrides: {})
-        overrides[:args] ||= {}
-        overrides[:kwargs] ||= {}
+        defaults = {args: {}, kwargs: {}}
+
+        ##
+        # IMPORTANT: Do not mutate `overrides`.
+        #
+        overrides = defaults.merge(overrides)
 
         ##
         # TODO: Refactor runtime `respond_to?`. Investigate before refactoring.

data/lib/convenient_service/support/dependency_container/errors.rb

@@ -56,7 +56,7 @@ module ConvenientService
             message = <<~TEXT
               Module `#{mod}` does NOT export method `#{method_name}` with `#{method_scope}` scope.
 
-              Did you forget to export if from `#{mod}`? For example:
+              Did you forget to export it from `#{mod}`? For example:
 
               module #{mod}
                 export #{method_name}, scope: :#{method_scope} do |*args, **kwargs, &block|

data/lib/convenient_service/support/not_passed.rb

@@ -2,6 +2,8 @@
 
 module ConvenientService
   module Support
-    NOT_PASSED = ::Object.new
+    NOT_PASSED = ::Object.new.tap do |object|
+      object.define_singleton_method(:inspect) { "not_passed" }
+    end
   end
 end

data/lib/convenient_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConvenientService
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/convenient_service.rb

@@ -30,6 +30,12 @@ require_relative "convenient_service/common"
 require_relative "convenient_service/service"
 require_relative "convenient_service/configs"
 
+##
+# @internal
+#   Convenient Service Predefined Services.
+#
+require_relative "convenient_service/services"
+
 ##
 # @internal
 #   Convenient Service Aliases.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: convenient_service
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Marian Kostyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -294,16 +308,16 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: yard-junk
   requirement: !ruby/object:Gem::Requirement
@@ -387,6 +401,7 @@ files:
 - lib/convenient_service/common/plugins/has_attributes/using_active_model_attributes/patches/active_model_attributes.rb
 - lib/convenient_service/common/plugins/has_callbacks.rb
 - lib/convenient_service/common/plugins/has_callbacks/concern.rb
+- lib/convenient_service/common/plugins/has_callbacks/container.rb
 - lib/convenient_service/common/plugins/has_callbacks/entities.rb
 - lib/convenient_service/common/plugins/has_callbacks/entities/callback.rb
 - lib/convenient_service/common/plugins/has_callbacks/entities/callback_collection.rb
@@ -496,9 +511,11 @@ files:
 - lib/convenient_service/examples/rails/gemfile/services/format_gems_with_envs.rb
 - lib/convenient_service/examples/rails/gemfile/services/format_gems_without_envs.rb
 - lib/convenient_service/examples/rails/gemfile/services/format_header.rb
+- lib/convenient_service/examples/rails/gemfile/services/merge_sections.rb
 - lib/convenient_service/examples/rails/gemfile/services/parse_content.rb
 - lib/convenient_service/examples/rails/gemfile/services/print_shell_command.rb
 - lib/convenient_service/examples/rails/gemfile/services/read_file_content.rb
+- lib/convenient_service/examples/rails/gemfile/services/replace_file_content.rb
 - lib/convenient_service/examples/rails/gemfile/services/run_shell.rb
 - lib/convenient_service/examples/rails/gemfile/services/strip_comments.rb
 - lib/convenient_service/examples/standard/cowsay.rb
@@ -518,9 +535,11 @@ files:
 - lib/convenient_service/examples/standard/gemfile/services/format_gems_with_envs.rb
 - lib/convenient_service/examples/standard/gemfile/services/format_gems_without_envs.rb
 - lib/convenient_service/examples/standard/gemfile/services/format_header.rb
+- lib/convenient_service/examples/standard/gemfile/services/merge_sections.rb
 - lib/convenient_service/examples/standard/gemfile/services/parse_content.rb
 - lib/convenient_service/examples/standard/gemfile/services/print_shell_command.rb
 - lib/convenient_service/examples/standard/gemfile/services/read_file_content.rb
+- lib/convenient_service/examples/standard/gemfile/services/replace_file_content.rb
 - lib/convenient_service/examples/standard/gemfile/services/run_shell.rb
 - lib/convenient_service/examples/standard/gemfile/services/strip_comments.rb
 - lib/convenient_service/examples/standard/request_params.rb
@@ -559,6 +578,14 @@ files:
 - lib/convenient_service/examples/standard/request_params/utils/object.rb
 - lib/convenient_service/examples/standard/request_params/utils/object/blank.rb
 - lib/convenient_service/examples/standard/request_params/utils/object/present.rb
+- lib/convenient_service/factories.rb
+- lib/convenient_service/factories/arguments.rb
+- lib/convenient_service/factories/results.rb
+- lib/convenient_service/factories/services.rb
+- lib/convenient_service/factories/step.rb
+- lib/convenient_service/factories/step/instance.rb
+- lib/convenient_service/factories/steps.rb
+- lib/convenient_service/factory.rb
 - lib/convenient_service/logger.rb
 - lib/convenient_service/rspec.rb
 - lib/convenient_service/rspec/helpers.rb
@@ -617,6 +644,14 @@ files:
 - lib/convenient_service/rspec/matchers/custom/prepend_module.rb
 - lib/convenient_service/rspec/matchers/custom/results.rb
 - lib/convenient_service/rspec/matchers/custom/results/base.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_method_step.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_result_method_step.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/find_result_service_step.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/generate_expected_step_part.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/generate_got_step_part.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/commands/match_result_step.rb
+- lib/convenient_service/rspec/matchers/custom/results/base/errors.rb
 - lib/convenient_service/rspec/matchers/custom/results/be_error.rb
 - lib/convenient_service/rspec/matchers/custom/results/be_failure.rb
 - lib/convenient_service/rspec/matchers/custom/results/be_not_error.rb
@@ -662,6 +697,12 @@ files:
 - lib/convenient_service/service/plugins/has_result/entities/result.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/concern.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/initialize.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/initialize/middleware.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/to_kwargs.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_have_parent_result/to_kwargs/middleware.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_recalculate_result.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/can_recalculate_result/concern.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_inspect.rb
@@ -687,6 +728,12 @@ files:
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_result_short_syntax/concern/instance_methods.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/concern.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/initialize/middleware.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/to_kwargs.rb
+- lib/convenient_service/service/plugins/has_result/entities/result/plugins/has_step/to_kwargs/middleware.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/marks_result_status_as_checked.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/marks_result_status_as_checked/middleware.rb
 - lib/convenient_service/service/plugins/has_result/entities/result/plugins/raises_on_not_checked_result_status.rb
@@ -695,12 +742,7 @@ files:
 - lib/convenient_service/service/plugins/has_result/errors.rb
 - lib/convenient_service/service/plugins/has_result/middleware.rb
 - lib/convenient_service/service/plugins/has_result_method_steps.rb
-- lib/convenient_service/service/plugins/has_result_method_steps/errors.rb
 - lib/convenient_service/service/plugins/has_result_method_steps/middleware.rb
-- lib/convenient_service/service/plugins/has_result_method_steps/services.rb
-- lib/convenient_service/service/plugins/has_result_method_steps/services/method_step_config.rb
-- lib/convenient_service/service/plugins/has_result_method_steps/services/run_method_in_organizer.rb
-- lib/convenient_service/service/plugins/has_result_method_steps/services/run_own_method_in_organizer.rb
 - lib/convenient_service/service/plugins/has_result_params_validations/using_active_model_validations.rb
 - lib/convenient_service/service/plugins/has_result_params_validations/using_active_model_validations/concern.rb
 - lib/convenient_service/service/plugins/has_result_params_validations/using_active_model_validations/middleware.rb
@@ -772,6 +814,8 @@ files:
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/concern/instance_methods.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/errors.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins.rb
+- lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/can_have_parent_result.rb
+- lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/can_have_parent_result/middleware.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/plugins/has_inspect/concern.rb
 - lib/convenient_service/service/plugins/has_result_steps/entities/step/structs.rb
@@ -783,6 +827,9 @@ files:
 - lib/convenient_service/service/plugins/raises_on_double_result/middleware.rb
 - lib/convenient_service/service/plugins/wraps_result_in_db_transaction.rb
 - lib/convenient_service/service/plugins/wraps_result_in_db_transaction/middleware.rb
+- lib/convenient_service/services.rb
+- lib/convenient_service/services/run_method_in_organizer.rb
+- lib/convenient_service/services/run_own_method_in_organizer.rb
 - lib/convenient_service/specification.rb
 - lib/convenient_service/support.rb
 - lib/convenient_service/support/abstract_method.rb

data/lib/convenient_service/service/plugins/has_result_method_steps/errors.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultMethodSteps
-        module Errors
-          class MethodForStepIsNotDefined < ConvenientService::Error
-            def initialize(service_class:, method_name:)
-              message = <<~TEXT
-                Service #{service_class} tries to use `#{method_name}` method in a step, but it NOT defined.
-
-                Did you forget to define it?
-              TEXT
-
-              super(message)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/method_step_config.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultMethodSteps
-        module Services
-          module MethodStepConfig
-            include Support::Concern
-
-            # rubocop:disable Lint/ConstantDefinitionInBlock
-            included do
-              include ConvenientService::Core
-
-              concerns do
-                use ConvenientService::Service::Plugins::HasResult::Concern
-              end
-
-              middlewares :result do
-                use ConvenientService::Common::Plugins::NormalizesEnv::Middleware
-
-                use ConvenientService::Service::Plugins::HasResult::Middleware
-              end
-
-              class self::Result
-                include ConvenientService::Core
-
-                concerns do
-                  use ConvenientService::Common::Plugins::HasInternals::Concern
-                  use ConvenientService::Common::Plugins::HasConstructor::Concern
-                  use ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Concern
-                end
-
-                middlewares :initialize do
-                  use ConvenientService::Common::Plugins::NormalizesEnv::Middleware
-
-                  use ConvenientService::Service::Plugins::HasResult::Entities::Result::Plugins::HasJsendStatusAndAttributes::Middleware
-                end
-
-                class self::Internals
-                  include ConvenientService::Core
-
-                  concerns do
-                    use ConvenientService::Common::Plugins::HasInternals::Entities::Internals::Plugins::HasCache::Concern
-                  end
-                end
-              end
-            end
-            # rubocop:enable Lint/ConstantDefinitionInBlock
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/run_method_in_organizer.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultMethodSteps
-        module Services
-          class RunMethodInOrganizer
-            include MethodStepConfig
-
-            attr_reader :method_name, :organizer, :kwargs
-
-            def initialize(method_name:, organizer:, **kwargs)
-              @method_name = method_name
-              @organizer = organizer
-              @kwargs = kwargs
-            end
-
-            def result
-              ##
-              # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `organizer.__send__(method_name)` body.
-              #
-              organizer.__send__(method_name)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/convenient_service/service/plugins/has_result_method_steps/services/run_own_method_in_organizer.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module ConvenientService
-  module Service
-    module Plugins
-      module HasResultMethodSteps
-        module Services
-          class RunOwnMethodInOrganizer
-            include MethodStepConfig
-
-            attr_reader :method_name, :organizer, :kwargs
-
-            def initialize(method_name:, organizer:, **kwargs)
-              @method_name = method_name
-              @organizer = organizer
-              @kwargs = kwargs
-            end
-
-            def result
-              raise Errors::MethodForStepIsNotDefined.new(service_class: organizer.class, method_name: method_name) unless own_method
-
-              ##
-              # NOTE: `kwargs` are intentionally NOT passed, since all the corresponding methods are available inside `own_method` body.
-              #
-              own_method.call
-            end
-
-            private
-
-            ##
-            # @return [Method, nil]
-            #
-            # @internal
-            #   TODO: A possible bottleneck. Should be removed if receives negative feedback.
-            #
-            #   NOTE: `own_method.bind(organizer).call` is logically the same as `own_method.bind_call(organizer)`.
-            #   - https://ruby-doc.org/core-2.7.1/UnboundMethod.html#method-i-bind_call
-            #   - https://blog.saeloun.com/2019/10/17/ruby-2-7-adds-unboundmethod-bind_call-method.html
-            #
-            def own_method
-              method = Utils::Module.get_own_instance_method(organizer.class, method_name, private: true)
-
-              return unless method
-
-              method.bind(organizer)
-            end
-          end
-        end
-      end
-    end
-  end
-end