convenient_service 0.10.1 → 0.12.0

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/hash/string_value.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                module Hash
+                  class StringValue < Factories::Hash::Base
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                    #
+                    def create_key
+                      Entities::Key.new(key)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                    #
+                    def create_name
+                      Entities::Name.new(value)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                    #
+                    def create_caller
+                      Entities::Callers::Alias.new(value)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/hash/symbol_value.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                module Hash
+                  class SymbolValue < Factories::Hash::Base
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                    #
+                    def create_key
+                      Entities::Key.new(key)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                    #
+                    def create_name
+                      Entities::Name.new(value)
+                    end
+
+                    ##
+                    # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                    #
+                    def create_caller
+                      Entities::Callers::Alias.new(value)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/hash.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "hash/base"
+require_relative "hash/proc_value"
+require_relative "hash/raw_value"
+require_relative "hash/reassignment_value"
+require_relative "hash/string_value"
+require_relative "hash/symbol_value"

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/method.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                class Method < Factories::Base
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                  #
+                  def create_key
+                    other.key.copy
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                  #
+                  def create_name
+                    other.name.copy
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                  #
+                  def create_caller
+                    other.caller.copy
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/reassignment.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                class Reassignment < Factories::Base
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                  #
+                  def create_key
+                    Entities::Key.new(other.to_sym)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                  #
+                  def create_name
+                    Entities::Name.new(other.to_sym)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                  #
+                  def create_caller
+                    Entities::Callers::Reassignment.new(other)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/string.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                class String < Factories::Base
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                  #
+                  def create_key
+                    Entities::Key.new(other)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                  #
+                  def create_name
+                    Entities::Name.new(other)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                  #
+                  def create_caller
+                    Entities::Callers::Usual.new(other)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories/symbol.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Method
+            module Entities
+              module Factories
+                class Symbol < Factories::Base
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Key]
+                  #
+                  def create_key
+                    Entities::Key.new(other)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                  #
+                  def create_name
+                    Entities::Name.new(other)
+                  end
+
+                  ##
+                  # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Callers::Base]
+                  #
+                  def create_caller
+                    Entities::Callers::Usual.new(other)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/factories.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "factories/base"
+require_relative "factories/hash"
+require_relative "factories/method"
+require_relative "factories/reassignment"
+require_relative "factories/string"
+require_relative "factories/symbol"

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method/entities/key.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Method
             module Entities

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method/entities/name.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Method
             module Entities

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method/entities/values/reassignment.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Method
             module Entities

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method/entities.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "entities/directions"
+require_relative "entities/factories"
 require_relative "entities/callers"
 require_relative "entities/key"
 require_relative "entities/name"

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method/errors.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Method
             module Errors
@@ -67,7 +67,7 @@ module ConvenientService
                 end
               end
 
-              class OutputMethodProc < ConvenientService::Error
+              class OutputMethodProc < ::ConvenientService::Error
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Procs are not allowed for `out` methods.
@@ -77,7 +77,7 @@ module ConvenientService
                 end
               end
 
-              class OutputMethodRawValue < ConvenientService::Error
+              class OutputMethodRawValue < ::ConvenientService::Error
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Raw values are not allowed for `out` methods.
@@ -99,7 +99,7 @@ module ConvenientService
                 end
               end
 
-              class InputMethodReassignment < ConvenientService::Error
+              class InputMethodReassignment < ::ConvenientService::Error
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Reassignments are not allowed for `in` methods.
@@ -109,7 +109,7 @@ module ConvenientService
                 end
               end
 
-              class MethodIsNotInputMethod < ConvenientService::Error
+              class MethodIsNotInputMethod < ::ConvenientService::Error
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Method `#{method.name}` is NOT an `in` method.
@@ -119,7 +119,7 @@ module ConvenientService
                 end
               end
 
-              class MethodIsNotOutputMethod < ConvenientService::Error
+              class MethodIsNotOutputMethod < ::ConvenientService::Error
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Method `#{method.name}` is NOT an `out` method.
@@ -129,7 +129,7 @@ module ConvenientService
                 end
               end
 
-              class NotCompletedStep < ConvenientService::Error
+              class NotCompletedStep < ::ConvenientService::Error
                 def initialize(method_name:, step:)
                   message = <<~TEXT
                     `out` method `#{method_name}` is called before its corresponding step `#{step.printable_service}` is completed.
@@ -141,7 +141,7 @@ module ConvenientService
                 end
               end
 
-              class NotExistingStepResultDataAttribute < ConvenientService::Error
+              class NotExistingStepResultDataAttribute < ::ConvenientService::Error
                 def initialize(key:, step:)
                   message = <<~TEXT
                     Step `#{step.printable_service}` result does NOT return `#{key}` data attribute.

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/method.rb

@@ -8,7 +8,7 @@ require_relative "method/errors"
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Method
             include Concern

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/service/class_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Service
             module ClassMethods

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/service.rb

@@ -5,7 +5,7 @@ require_relative "service/class_methods"
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           ##
           # NOTE: Service is a wrapper for a service class (klass). For example:

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/commands/cast_params.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Commands

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/commands/extract_params.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Commands

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/concern/instance_methods.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Concern

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/concern.rb

@@ -5,7 +5,7 @@ require_relative "concern/instance_methods"
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Concern

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Step
+            module Errors
+              class StepHasNoOrganizer < ::ConvenientService::Error
+                def initialize(step:)
+                  message = <<~TEXT
+                    Step `#{step.service}` has not assigned organizer.
+
+                    Did you forget to set it?
+                  TEXT
+
+                  super(message)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/plugins/aliases.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Plugins
+    Step = ::ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Plugins
+  end
+end

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/plugins/can_have_parent_result/middleware.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Plugins

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/plugins/has_inspect/concern.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Plugins

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/plugins.rb

@@ -2,3 +2,5 @@
 
 require_relative "plugins/can_have_parent_result"
 require_relative "plugins/has_inspect"
+
+require_relative "plugins/aliases"

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step/structs/params.rb

@@ -3,7 +3,7 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             module Structs

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/entities/step.rb

@@ -9,7 +9,7 @@ require_relative "step/structs"
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         module Entities
           class Step
             include Concern

data/lib/convenient_service/service/plugins/can_have_steps/entities/step_collection.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class StepCollection
+            include ::Enumerable
+
+            ##
+            # @!attribute [r] steps
+            #   @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step>]
+            #
+            attr_reader :steps
+
+            ##
+            # @param steps [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step>]
+            # @return [void]
+            #
+            def initialize(steps: [])
+              @steps = steps
+            end
+
+            ##
+            # @return [Boolean] true if called for the first time, false otherwise (similarly as Kernel#require).
+            #
+            # @see https://ruby-doc.org/core-3.1.2/Kernel.html#method-i-require
+            #
+            # @internal
+            #   IMPORTANT: `step.validate!` is intentionally removed from `steps.each { |step| step.validate! && step.define! }.freeze` since it is NOT idempotent.
+            #
+            #   NOTE: `step.validate!` is still useful as a `doctor` command.
+            #
+            def commit!
+              return false if committed?
+
+              steps.each(&:define!).freeze
+
+              true
+            end
+
+            ##
+            # @return [Boolean]
+            #
+            def committed?
+              steps.frozen?
+            end
+
+            ##
+            # @param block [Proc, nil]
+            # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step>, Enumerator]
+            #
+            def each(&block)
+              steps.each(&block)
+            end
+
+            ##
+            # Returns step by index.
+            #
+            # @param index [Integer]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+            #
+            # @note Works in a similar way as `Array#[]`.
+            # @see https://ruby-doc.org/core-2.7.0/Array.html#method-i-5B-5D
+            #
+            def [](index)
+              steps[index]
+            end
+
+            ##
+            # @param step [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+            # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::StepCollection]
+            #
+            def <<(step)
+              steps << step.copy(overrides: {kwargs: {index: next_available_index}})
+
+              self
+            end
+
+            ##
+            # @param other [Object] Can be any type.
+            # @return [Boolean, nil]
+            #
+            def ==(other)
+              return unless other.instance_of?(self.class)
+
+              return false if steps != other.steps
+
+              true
+            end
+
+            private
+
+            ##
+            # @return [Integer]
+            #
+            def next_available_index
+              steps.size
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/{has_result_steps → can_have_steps}/middleware.rb

@@ -3,10 +3,10 @@
 module ConvenientService
   module Service
     module Plugins
-      module HasResultSteps
+      module CanHaveSteps
         class Middleware < Core::MethodChainMiddleware
           ##
-          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
           #
           def next(...)
             return chain.next(...) if entity.steps.none?
@@ -17,14 +17,14 @@ module ConvenientService
           private
 
           ##
-          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
           #
           def last_step
             @last_step ||= entity.steps.find.with_index { |step, index| not_success?(step, index) } || entity.steps.last
           end
 
           ##
-          # @return [ConvenientService::Service::Plugins::HasResultSteps::Entities::Step]
+          # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
           #
           # @internal
           #   NOTE: `entity.step(index)` is used as a hook (callbacks trigger).