convenient_service 0.19.0 → 0.20.0

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -26,150 +31,6 @@ module ConvenientService
                 end
               end
 
-              class InputMethodIsNotDefinedInContainer < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    `in` method `#{method.name}` is NOT defined in `#{container.klass}`.
-
-                    Did you forget to define it?
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class OutputMethodIsDefinedInContainer < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    `out` method `#{method.name}` is already defined in `#{container.klass}`.
-
-                    Did you forget to remove it?
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class AliasInputMethodIsNotDefinedInContainer < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Alias `in` method `#{method.name}` is NOT defined in `#{container.klass}`.
-
-                    Did you forget to define it?
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class AliasOutputMethodIsDefinedInContainer < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Alias `out` method `#{method.name}` is already defined in `#{container.klass}`.
-
-                    Did you forget to remove it?
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class OutputMethodProc < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Procs are not allowed for `out` methods.
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class OutputMethodRawValue < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Raw values are not allowed for `out` methods.
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class CallerCanNotCalculateReassignment < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:)
-                  message = <<~TEXT
-                    Method caller failed to calculate reassignment for `#{method.name}`.
-
-                    Method callers can calculate only `in` methods, while reassignments are always `out` methods.
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class InputMethodReassignment < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Reassignments are not allowed for `in` methods.
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
-              class MethodIsNotInputMethod < ::ConvenientService::Exception
-                ##
-                # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]
-                # @param container [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
-                # @return [void]
-                #
-                def initialize_with_kwargs(method:, container:)
-                  message = <<~TEXT
-                    Method `#{method.name}` is NOT an `in` method.
-                  TEXT
-
-                  initialize(message)
-                end
-              end
-
               class MethodIsNotOutputMethod < ::ConvenientService::Exception
                 ##
                 # @param method [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method]

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "method/commands"
 require_relative "method/concern"
 require_relative "method/entities"

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -14,28 +19,10 @@ module ConvenientService
                 #
                 def cast(other)
                   case other
-                  when ::Class then cast_klass(other)
-                  when Service then cast_service(other)
+                  when ::Class then new(other)
+                  when Service then new(other.klass)
                   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

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -33,6 +38,13 @@ module ConvenientService
                   @klass = klass
                 end
 
+                ##
+                # @return [Mutex]
+                #
+                def lock
+                  klass.__convenient_service_config__.lock
+                end
+
                 ##
                 # @param method [String, Symbol]
                 # @return [Boolean]

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "concern/instance_methods"
 require_relative "concern/class_methods"
 

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "service/concern"
 
 module ConvenientService

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/commands/cast_params.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -27,9 +32,10 @@ module ConvenientService
                 #
                 def call
                   Structs::Params.new(
-                    service: service,
+                    action: action,
                     inputs: inputs,
                     outputs: outputs,
+                    strict: strict,
                     index: index,
                     container: container,
                     organizer: organizer,
@@ -38,27 +44,31 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
+                # @return [Object] Can be any type.
                 #
-                def service
-                  @service ||= Entities::Service.cast!(original_params.service)
+                def action
+                  @action ||= original_params.action
                 end
 
                 ##
                 # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
                 #
-                # @internal
-                #   TODO: `cast_many`, `cast_many!`.
-                #
                 def inputs
-                  @inputs ||= original_params.inputs.map { |input| Entities::Method.cast!(input, direction: :input) }
+                  @inputs ||= cast_inputs
                 end
 
                 ##
                 # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
                 #
                 def outputs
-                  @outputs ||= original_params.outputs.map { |output| Entities::Method.cast!(output, direction: :output) }
+                  @outputs ||= cast_outputs
+                end
+
+                ##
+                # @return [Boolean]
+                #
+                def strict
+                  Utils.memoize_including_falsy_values(self, :@strict) { Utils.to_bool(original_params.strict) }
                 end
 
                 ##
@@ -76,10 +86,10 @@ module ConvenientService
                 end
 
                 ##
-                # @return [ConvenientService::Service]
+                # @return [ConvenientService::Service, nil]
                 #
                 def organizer
-                  @organizer ||= original_params.organizer
+                  Utils.memoize_including_falsy_values(self, :@organizer) { original_params.organizer }
                 end
 
                 ##
@@ -88,6 +98,49 @@ module ConvenientService
                 def extra_kwargs
                   @extra_kwargs ||= original_params.extra_kwargs
                 end
+
+                private
+
+                ##
+                # @param methods [Array<Symbol, Hash>]
+                # @return [Array<Symbol, Hash>]
+                #
+                # @internal
+                #   NOTE:
+                #     Currently, hash `inputs` and `outputs` do NOT support extra keys.
+                #     Update `size` condition once they start to support them.
+                #
+                def flatten_methods(methods)
+                  return methods unless methods.last.instance_of?(::Hash)
+                  return methods if methods.last.keys.size < 2
+
+                  methods.dup.tap(&:pop).concat(methods.last.map { |key, value| {key => value} })
+                end
+
+                ##
+                # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
+                #
+                # @internal
+                #   TODO: `cast_many`, `cast_many!`.
+                #
+                def cast_inputs
+                  inputs = flatten_methods(original_params.inputs)
+                  inputs = inputs.map { |input| Entities::Method.cast!(input, direction: :input) }
+                  inputs = inputs.map { |input| input.copy(overrides: {kwargs: {organizer: organizer}}) } if organizer
+
+                  inputs
+                end
+
+                ##
+                # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
+                #
+                def cast_outputs
+                  outputs = flatten_methods(original_params.outputs)
+                  outputs = outputs.map { |output| Entities::Method.cast!(output, direction: :output) }
+                  outputs = outputs.map { |output| output.copy(overrides: {kwargs: {organizer: organizer}}) } if organizer
+
+                  outputs
+                end
               end
             end
           end

data/lib/convenient_service/service/plugins/can_have_steps/entities/step/commands/extract_params.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -8,22 +13,41 @@ module ConvenientService
           class Step
             module Commands
               class ExtractParams < Support::Command
-                attr_reader :args, :kwargs
+                ##
+                # @!attribute [r] args
+                #   @return [Array<Object>]
+                #
+                attr_reader :args
+
+                ##
+                # @!attribute [r] kwargs
+                #   @return [Hash{Symbol => Object}]
+                #
+                attr_reader :kwargs
 
+                ##
+                # @param args [Array<Object>]
+                # @param kwargs [Hash{Symbol => Object}]
+                # @return [void]
+                #
                 def initialize(args:, kwargs:)
                   @args = args
                   @kwargs = kwargs
                 end
 
+                ##
+                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Params]
+                #
                 def call
                   Structs::Params.new(
-                    service: args.first,
+                    action: args.first,
                     inputs: Utils::Array.wrap(kwargs[:in]),
                     outputs: Utils::Array.wrap(kwargs[:out]),
+                    strict: kwargs[:strict],
                     index: kwargs[:index],
                     container: kwargs[:container],
                     organizer: kwargs[:organizer],
-                    extra_kwargs: Utils::Hash.except(kwargs, [:in, :out, :index, :container, :organizer])
+                    extra_kwargs: Utils::Hash.except(kwargs, [:in, :out, :strict, :index, :container, :organizer])
                   )
                 end
               end

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

@@ -1,4 +1,9 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 require_relative "commands/extract_params"
 require_relative "commands/cast_params"

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

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+##
+# @author Marian Kostyk <mariankostyk13895@gmail.com>
+# @license LGPLv3 <https://www.gnu.org/licenses/lgpl-3.0.html>
+##
+
 module ConvenientService
   module Service
     module Plugins
@@ -15,6 +20,18 @@ module ConvenientService
                 include Support::Copyable
                 include Support::Delegate
 
+                ##
+                # @!attribute [r] args
+                #   @return [Array]
+                #
+                attr_reader :args
+
+                ##
+                # @!attribute [r] kwargs
+                #   @return [Hash]
+                #
+                attr_reader :kwargs
+
                 ##
                 # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result::Plugins::HasJSendStatusAndAttributes::Entities::Status]
                 #
@@ -53,16 +70,19 @@ module ConvenientService
                 ##
                 # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Service]
                 #
-                # @internal
-                #   TODO: Return service instance to be compatible with result.
-                #
-                delegate :service, to: :params
+                delegate :action, to: :params
 
                 ##
+                # @api public
+                #
                 # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
                 #
-                # @internal
-                #   TODO: Create dedicated classes for input and output methods.
+                delegate :inputs, to: :params
+
+                ##
+                # @api public
+                #
+                # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
                 #
                 delegate :outputs, to: :params
 
@@ -154,21 +174,15 @@ module ConvenientService
                   @organizer
                 end
 
-                ##
-                # @api public
-                #
-                # @return [Array<ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method>]
-                #
-                def inputs
-                  @inputs ||= params.inputs.map { |input| input.copy(overrides: {kwargs: {organizer: organizer(raise_when_missing: false)}}) }
-                end
-
                 ##
                 # @api public
                 #
                 # @return [Hash{Symbol => Object}]
                 # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
                 #
+                # @internal
+                #   TODO: Refactor to `input_arguments` to support args and block via `step`?
+                #
                 def input_values
                   @input_values ||= calculate_input_values
                 end
@@ -183,16 +197,6 @@ module ConvenientService
                   @output_values ||= calculate_output_values
                 end
 
-                ##
-                # @api public
-                #
-                # @return [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Method, nil]
-                # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
-                #
-                def reassignment(name)
-                  outputs.find { |output| output.reassignment?(name) }
-                end
-
                 ##
                 # @api private
                 #
@@ -207,34 +211,8 @@ module ConvenientService
                 #
                 # @return [String]
                 #
-                def printable_service
-                  Utils::Class.display_name(service.klass)
-                end
-
-                ##
-                # @api private
-                #
-                # @return [ConvenientService::Service::Plugins::HasJSendResult::Entities::Result]
-                # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
-                #
-                # @note `service_result` has middlewares.
-                #
-                # @internal
-                #   IMPORTANT: `service.result(**input_values)` is the reason, why services should have only kwargs as arguments.
-                #
-                #   NOTE: `service_result` returns a foreign result that is later converted to own result by `HasResult` middleware.
-                #
-                def service_result
-                  @service_result ||= service.klass.result(**input_values)
-                end
-
-                ##
-                # @api private
-                #
-                # @return [Class]
-                #
-                def service_class
-                  service.klass
+                def printable_action
+                  action.instance_of?(::Class) ? Utils::Class.display_name(action) : action.inspect
                 end
 
                 ##
@@ -250,20 +228,9 @@ module ConvenientService
                 # @api public
                 #
                 # @return [Boolean]
-                # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
                 #
-                def has_reassignment?(name)
-                  outputs.any? { |output| output.reassignment?(name) }
-                end
-
-                ##
-                # @api private
-                #
-                # @return [void]
-                # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]
-                #
-                def trigger_callback
-                  organizer.step(index)
+                def strict?
+                  params.strict
                 end
 
                 ##
@@ -291,20 +258,6 @@ module ConvenientService
                   copy(overrides: {kwargs: {organizer: organizer}})
                 end
 
-                ##
-                # @api private
-                #
-                # @return [void]
-                # @raise [ConvenientService::Error]
-                #
-                def validate!
-                  inputs.each { |input| input.validate_as_input_for_container!(container) }
-
-                  outputs.each { |output| output.validate_as_output_for_container!(container) }
-
-                  true
-                end
-
                 ##
                 # @api private
                 #
@@ -325,12 +278,12 @@ module ConvenientService
                 def ==(other)
                   return unless other.instance_of?(self.class)
 
-                  return false if service != other.service
-                  return false if inputs != other.inputs
-                  return false if outputs != other.outputs
-                  return false if index != other.index
+                  return false if action != other.action
                   return false if container != other.container
+                  return false if index != other.index
                   return false if organizer(raise_when_missing: false) != other.organizer(raise_when_missing: false)
+                  return false if inputs != other.inputs
+                  return false if outputs != other.outputs
                   return false if extra_kwargs != other.extra_kwargs
 
                   true
@@ -340,10 +293,10 @@ module ConvenientService
                 # @return [String]
                 #
                 # @internal
-                #   TODO: Remove `printable_service` completely. Leave only `to_s`.
+                #   TODO: Remove `printable_action` completely. Leave only `to_s`.
                 #
                 def to_s
-                  printable_service
+                  printable_action
                 end
 
                 ##
@@ -370,23 +323,11 @@ module ConvenientService
                 # @return [ConveninentService::Support::Arguments]
                 #
                 def to_arguments
-                  Support::Arguments.new(service, **kwargs.merge(in: inputs, out: outputs, index: index, container: container, organizer: organizer(raise_when_missing: false), **extra_kwargs))
+                  Support::Arguments.new(action, **kwargs.merge(in: inputs, out: outputs, index: index, container: container, organizer: organizer(raise_when_missing: false), **extra_kwargs))
                 end
 
                 private
 
-                ##
-                # @!attribute [r] args
-                #   @return [Array]
-                #
-                attr_reader :args
-
-                ##
-                # @!attribute [r] kwargs
-                #   @return [Hash]
-                #
-                attr_reader :kwargs
-
                 ##
                 # @return [Hash{Symbol => Object}]
                 # @raise [ConvenientService::Service::Plugins::CanHaveSteps::Entities::Step::Exceptions::StepHasNoOrganizer]