convenient_service 0.12.0 → 0.14.0

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/base.rb

@@ -13,24 +13,56 @@ module ConvenientService
                   include Support::Copyable
 
                   ##
-                  # TODO: A better name for `object`. Wrapped object, `target`?
+                  # @!attribute [r] object
+                  #   @return [Object] Can be any type.
+                  #
+                  # @internal
+                  #   TODO: A better name for `object`. Wrapped object, `target`?
                   #
                   attr_reader :object
 
-                  abstract_method \
-                    :calculate_value,
-                    :validate_as_input_for_container!,
-                    :validate_as_output_for_container!,
-                    :define_output_in_container!
+                  ##
+                  # @return [Object] Can be any type.
+                  #
+                  abstract_method :calculate_value
+
+                  ##
+                  # @return [Boolean]
+                  # @raise [ConvenientService::Error]
+                  #
+                  abstract_method :validate_as_input_for_container!
+
+                  ##
+                  # @return [Boolean]
+                  # @raise [ConvenientService::Error]
+                  #
+                  abstract_method :validate_as_output_for_container!
+
+                  ##
+                  # @return [Boolean]
+                  #
+                  abstract_method :define_output_in_container!
 
+                  ##
+                  # @param object [Object] Can be any type.
+                  # @return [void]
+                  #
                   def initialize(object)
                     @object = object
                   end
 
+                  ##
+                  # @param name [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method::Entities::Name]
+                  # @return [Boolean]
+                  #
                   def reassignment?(name)
                     false
                   end
 
+                  ##
+                  # @param other [Object] Can be any type.
+                  # @return [Boolean, nil]
+                  #
                   def ==(other)
                     return unless other.instance_of?(self.class)
 
@@ -39,8 +71,18 @@ module ConvenientService
                     true
                   end
 
+                  ##
+                  # @return [Array<Object>]
+                  #
                   def to_args
-                    [object]
+                    to_arguments.args
+                  end
+
+                  ##
+                  # @return [ConveninentService::Support::Arguments]
+                  #
+                  def to_arguments
+                    Support::Arguments.new(object)
                   end
                 end
               end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/proc.rb

@@ -21,7 +21,7 @@ module ConvenientService
                     ##
                     # TODO: Better error message.
                     #
-                    raise Errors::OutputMethodProc.new(method: method, container: container)
+                    raise Exceptions::OutputMethodProc.new(method: method, container: container)
                   end
 
                   def define_output_in_container!(container, index:, method:)

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/raw.rb

@@ -21,7 +21,7 @@ module ConvenientService
                     ##
                     # TODO: Better error message.
                     #
-                    raise Errors::OutputMethodRawValue.new(container: container, method: method)
+                    raise Exceptions::OutputMethodRawValue.new(container: container, method: method)
                   end
 
                   def define_output_in_container!(container, index:, method:)

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

@@ -22,11 +22,11 @@ module ConvenientService
                   # TODO: Separate `in` and `out` methods?
                   #
                   def calculate_value(method)
-                    raise Errors::CallerCanNotCalculateReassignment.new(method: method)
+                    raise Exceptions::CallerCanNotCalculateReassignment.new(method: method)
                   end
 
                   def validate_as_input_for_container!(container, method:)
-                    raise Errors::InputMethodReassignment.new(method: method, container: container)
+                    raise Exceptions::InputMethodReassignment.new(method: method, container: container)
                   end
 
                   def validate_as_output_for_container!(container, method:)

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/callers/usual.rb

@@ -16,13 +16,13 @@ module ConvenientService
                   def validate_as_input_for_container!(container, method:)
                     return true if container.has_defined_method?(method)
 
-                    raise Errors::InputMethodIsNotDefinedInContainer.new(method: method, container: container)
+                    raise Exceptions::InputMethodIsNotDefinedInContainer.new(method: method, container: container)
                   end
 
                   def validate_as_output_for_container!(container, method:)
                     return true unless container.has_defined_method?(method)
 
-                    raise Errors::OutputMethodIsDefinedInContainer.new(method: method, container: container)
+                    raise Exceptions::OutputMethodIsDefinedInContainer.new(method: method, container: container)
                   end
 
                   def define_output_in_container!(container, index:, method:)

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/directions/base.rb

@@ -12,16 +12,39 @@ module ConvenientService
                   include Support::AbstractMethod
                   include Support::Copyable
 
-                  abstract_method \
-                    :validate_as_input_for_container!,
-                    :validate_as_output_for_container!,
-                    :define_output_in_container!
+                  ##
+                  # @return [Boolean]
+                  # @raise [ConvenientService::Error]
+                  #
+                  abstract_method :validate_as_input_for_container!
 
+                  ##
+                  # @return [Boolean]
+                  # @raise [ConvenientService::Error]
+                  #
+                  abstract_method :validate_as_output_for_container!
+
+                  ##
+                  # @return [Boolean]
+                  #
+                  abstract_method :define_output_in_container!
+
+                  ##
+                  # @param other [Object] Can be any type.
+                  # @return [Boolean, nil]
+                  #
                   def ==(other)
                     return unless other.instance_of?(self.class)
 
                     true
                   end
+
+                  ##
+                  # @return [ConvenientService::Support::Arguments]
+                  #
+                  def to_arguments
+                    Support::Arguments.new
+                  end
                 end
               end
             end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/directions/input.rb

@@ -14,11 +14,11 @@ module ConvenientService
                   end
 
                   def validate_as_output_for_container!(container, method:)
-                    raise Errors::MethodIsNotOutputMethod.new(method: method, container: container)
+                    raise Exceptions::MethodIsNotOutputMethod.new(method: method, container: container)
                   end
 
                   def define_output_in_container!(container, index:, method:)
-                    raise Errors::MethodIsNotOutputMethod.new(method: method, container: container)
+                    raise Exceptions::MethodIsNotOutputMethod.new(method: method, container: container)
                   end
                 end
               end

data/lib/convenient_service/service/plugins/can_have_steps/entities/method/entities/directions/output.rb

@@ -10,7 +10,7 @@ module ConvenientService
               module Directions
                 class Output < Base
                   def validate_as_input_for_container!(container, method:)
-                    raise Errors::MethodIsNotInputMethod.new(method: method, container: container)
+                    raise Exceptions::MethodIsNotInputMethod.new(method: method, container: container)
                   end
 
                   def validate_as_output_for_container!(container, method:)

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

@@ -21,7 +21,7 @@ module ConvenientService
                     # @return [Object] Can be any object.
                     #
                     def value
-                      Utils::Object.memoize_including_falsy_values(self, :@value) { other.values.first }
+                      Utils.memoize_including_falsy_values(self, :@value) { other.values.first }
                     end
                   end
                 end

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

@@ -11,14 +11,34 @@ module ConvenientService
                 include Support::Copyable
                 include Support::Delegate
 
+                ##
+                # @!attribute [r] value
+                #   @return [Symbol]
+                #
                 attr_reader :value
 
+                ##
+                # @return [String]
+                #
                 delegate :to_s, :to_sym, to: :value
 
+                ##
+                # @return [Symbol]
+                #
+                delegate :to_sym, to: :value
+
+                ##
+                # @param value [Symbol]
+                # @return [void]
+                #
                 def initialize(value)
                   @value = value
                 end
 
+                ##
+                # @param other [Object] Can be any type.
+                # @return [Boolean, nil]
+                #
                 def ==(other)
                   return unless other.instance_of?(self.class)
 
@@ -27,8 +47,18 @@ module ConvenientService
                   true
                 end
 
+                ##
+                # @return [Array<Object>]
+                #
                 def to_args
-                  [value]
+                  to_arguments.args
+                end
+
+                ##
+                # @return [ConveninentService::Support::Arguments]
+                #
+                def to_arguments
+                  Support::Arguments.new(value)
                 end
               end
             end

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

@@ -11,14 +11,34 @@ module ConvenientService
                 include Support::Copyable
                 include Support::Delegate
 
+                ##
+                # @!attribute [r] value
+                #   @return [Symbol]
+                #
                 attr_reader :value
 
+                ##
+                # @return [String]
+                #
                 delegate :to_s, :to_sym, to: :value
 
+                ##
+                # @return [Symbol]
+                #
+                delegate :to_sym, to: :value
+
+                ##
+                # @param value [Symbol]
+                # @return [void]
+                #
                 def initialize(value)
                   @value = value
                 end
 
+                ##
+                # @param other [Object] Can be any type.
+                # @return [Boolean, nil]
+                #
                 def ==(other)
                   return unless other.instance_of?(self.class)
 
@@ -27,8 +47,18 @@ module ConvenientService
                   true
                 end
 
+                ##
+                # @return [Array<Object>]
+                #
                 def to_args
-                  [value]
+                  to_arguments.args
+                end
+
+                ##
+                # @return [ConveninentService::Support::Arguments]
+                #
+                def to_arguments
+                  Support::Arguments.new(value)
                 end
               end
             end

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

@@ -6,11 +6,18 @@ module ConvenientService
       module CanHaveSteps
         module Entities
           class Method
-            module Errors
-              class MethodHasNoOrganizer < ::ConvenientService::Error
+            module Exceptions
+              class MethodHasNoOrganizer < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @return [void]
+                #
+                # @internal
+                #   TODO: Introduce `Method#step` for more verbose message?
+                #
                 def initialize(method:)
                   message = <<~TEXT
-                    Organizer for method `#{method.name}` is NOT assigned yet.
+                    Organizer for method `:#{method.name}` is NOT assigned yet.
 
                     Did you forget to set it?
                   TEXT
@@ -19,7 +26,12 @@ module ConvenientService
                 end
               end
 
-              class InputMethodIsNotDefinedInContainer < ::ConvenientService::Error
+              class InputMethodIsNotDefinedInContainer < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     `in` method `#{method.name}` is NOT defined in `#{container.klass}`.
@@ -31,7 +43,12 @@ module ConvenientService
                 end
               end
 
-              class OutputMethodIsDefinedInContainer < ::ConvenientService::Error
+              class OutputMethodIsDefinedInContainer < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     `out` method `#{method.name}` is already defined in `#{container.klass}`.
@@ -43,7 +60,12 @@ module ConvenientService
                 end
               end
 
-              class AliasInputMethodIsNotDefinedInContainer < ::ConvenientService::Error
+              class AliasInputMethodIsNotDefinedInContainer < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Alias `in` method `#{method.name}` is NOT defined in `#{container.klass}`.
@@ -55,7 +77,12 @@ module ConvenientService
                 end
               end
 
-              class AliasOutputMethodIsDefinedInContainer < ::ConvenientService::Error
+              class AliasOutputMethodIsDefinedInContainer < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Alias `out` method `#{method.name}` is already defined in `#{container.klass}`.
@@ -67,7 +94,12 @@ module ConvenientService
                 end
               end
 
-              class OutputMethodProc < ::ConvenientService::Error
+              class OutputMethodProc < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Procs are not allowed for `out` methods.
@@ -77,7 +109,12 @@ module ConvenientService
                 end
               end
 
-              class OutputMethodRawValue < ::ConvenientService::Error
+              class OutputMethodRawValue < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Raw values are not allowed for `out` methods.
@@ -87,7 +124,11 @@ module ConvenientService
                 end
               end
 
-              class CallerCanNotCalculateReassignment < ::ConvenientService::Error
+              class CallerCanNotCalculateReassignment < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @return [void]
+                #
                 def initialize(method:)
                   message = <<~TEXT
                     Method caller failed to calculate reassignment for `#{method.name}`.
@@ -99,7 +140,12 @@ module ConvenientService
                 end
               end
 
-              class InputMethodReassignment < ::ConvenientService::Error
+              class InputMethodReassignment < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Reassignments are not allowed for `in` methods.
@@ -109,7 +155,12 @@ module ConvenientService
                 end
               end
 
-              class MethodIsNotInputMethod < ::ConvenientService::Error
+              class MethodIsNotInputMethod < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Method `#{method.name}` is NOT an `in` method.
@@ -119,7 +170,12 @@ module ConvenientService
                 end
               end
 
-              class MethodIsNotOutputMethod < ::ConvenientService::Error
+              class MethodIsNotOutputMethod < ::ConvenientService::Exception
+                ##
+                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
+                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [void]
+                #
                 def initialize(method:, container:)
                   message = <<~TEXT
                     Method `#{method.name}` is NOT an `out` method.
@@ -129,7 +185,12 @@ module ConvenientService
                 end
               end
 
-              class NotCompletedStep < ::ConvenientService::Error
+              class NotCompletedStep < ::ConvenientService::Exception
+                ##
+                # @param method_name [Symbol]
+                # @param step [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+                # @return [void]
+                #
                 def initialize(method_name:, step:)
                   message = <<~TEXT
                     `out` method `#{method_name}` is called before its corresponding step `#{step.printable_service}` is completed.
@@ -141,7 +202,12 @@ module ConvenientService
                 end
               end
 
-              class NotExistingStepResultDataAttribute < ::ConvenientService::Error
+              class NotExistingStepResultDataAttribute < ::ConvenientService::Exception
+                ##
+                # @param key [Symbol]
+                # @param step [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+                # @return [void]
+                #
                 def initialize(key:, step:)
                   message = <<~TEXT
                     Step `#{step.printable_service}` result does NOT return `#{key}` data attribute.

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

@@ -3,7 +3,7 @@
 require_relative "method/commands"
 require_relative "method/concern"
 require_relative "method/entities"
-require_relative "method/errors"
+require_relative "method/exceptions"
 
 module ConvenientService
   module Service

data/lib/convenient_service/service/plugins/can_have_steps/entities/service/concern/class_methods.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Service
+            module Concern
+              module ClassMethods
+                ##
+                # @param other [Object] Can be any type.
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service, nil]
+                #
+                def cast(other)
+                  case other
+                  when ::Class then cast_klass(other)
+                  when Service then cast_service(other)
+                  end
+                end
+
+                private
+
+                ##
+                # @param klass [Class]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                #
+                def cast_klass(klass)
+                  new(klass)
+                end
+
+                ##
+                # @param service [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                #
+                def cast_service(service)
+                  new(service.klass)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/service/plugins/can_have_steps/entities/service/concern/instance_methods.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Service
+            module Concern
+              module InstanceMethods
+                include Support::Delegate
+
+                ##
+                # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
+                #
+                delegate :result, to: :klass
+
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step]
+                #
+                delegate :step_class, to: :klass
+
+                ##
+                # @!attribute [r] klass
+                #   @return [Class]
+                #
+                attr_reader :klass
+
+                ##
+                # @param klass [Class]
+                #
+                def initialize(klass)
+                  @klass = klass
+                end
+
+                ##
+                # @param method [String, Symbol]
+                # @return [Boolean]
+                #
+                def has_defined_method?(method)
+                  Utils::Method.defined?(method, klass, private: true)
+                end
+
+                ##
+                # @param other [Object] Can be any type.
+                # @return [Boolean, nil]
+                #
+                def ==(other)
+                  casted = cast(other)
+
+                  return unless casted
+
+                  return false if klass != casted.klass
+
+                  true
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "concern/instance_methods"
+require_relative "concern/class_methods"
+
+module ConvenientService
+  module Service
+    module Plugins
+      module CanHaveSteps
+        module Entities
+          class Service
+            module Concern
+              include Support::Concern
+
+              included do |service_klass|
+                service_klass.include Support::Castable
+
+                service_klass.include InstanceMethods
+
+                service_klass.extend ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end