servactory 1.9.6 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 024a5ab65e8e000967f41494655da939111a0a43b4f6d4a941b28daff015def8
-  data.tar.gz: 7ae8df0285b2d9510ddabcbb92d2f0b8061ac74490b0a129793c4a389027bcc2
+  metadata.gz: a360afbf0c2646c3509ad3f37cb49e4a59453ded9f741a012965d962565285e4
+  data.tar.gz: 47a2bca86fc7622a7fa5e8a70bbb9cac4c179e3a43ee67ee050e6c5dd7b0cb21
 SHA512:
-  metadata.gz: 1a7541d4d78732b0dcbf549ca15460a96625c1e1a342bb5a6046f18f3e7b036eed2e1e2f44e90db3c70a25f2b0dfdc4ce755d7af1c73f5824d06b54e2329d8e4
-  data.tar.gz: 4cc045df6054d694587c2038de8e63a1e1eda45d93a8912ecdee2d6bfcd42b9955a196c6f8d2f49a9076b078c2dd248d816b6526307961e89fcb5e151c2c894c
+  metadata.gz: d6e1c489135e42759ee1bae986ed590aaf01164f8243a77b24a8a0b13d37056f4f5de3b86c1b741a94bbee8abe87656be6ad351818de32cc01a255af68d4db7e
+  data.tar.gz: 379633b8ddee7e378eafabacc9b97ced01375daa8612ce6b162c054674a6aac825093670602a92e2b03594c76f4f5dc22de9cbec25dcfa3770b0e73f102860fa

data/config/locales/en.yml

@@ -13,11 +13,14 @@ en:
         required:
           default_error:
             default: "[%{service_class_name}] Required input `%{input_name}` is missing"
-            for_array: "[%{service_class_name}] Required element in input array `%{input_name}` is missing"
+            for_collection: "[%{service_class_name}] Required element in input collection `%{input_name}` is missing"
         type:
           default_error:
             default: "[%{service_class_name}] Wrong type of input `%{input_name}`, expected `%{expected_type}`, got `%{given_type}`"
-            for_array: "[%{service_class_name}] Wrong type in input array `%{input_name}`, expected `%{expected_type}`"
+            for_collection:
+              wrong_element_type: "[%{service_class_name}] Wrong type in input collection `%{input_name}`, expected `%{expected_type}`, got `%{given_type}`"
+            for_hash:
+              wrong_element_type: "[%{service_class_name}] Wrong type in input hash `%{input_name}`, expected `%{expected_type}` for `%{key_name}`, got `%{given_type}`"
       tools:
         find_unnecessary:
           error: "[%{service_class_name}] Unexpected attributes: `%{unnecessary_attributes}`"
@@ -29,14 +32,26 @@ en:
         setter: "[%{service_class_name}] Undefined internal attribute `%{internal_name}`"
       checks:
         type:
-          default_error: "[%{service_class_name}] Wrong type of internal attribute `%{internal_name}`, expected `%{expected_type}`, got `%{given_type}`"
+          default_error:
+            default: "[%{service_class_name}] Wrong type of internal attribute `%{internal_name}`, expected `%{expected_type}`, got `%{given_type}`"
+            for_collection:
+              wrong_type: "[%{service_class_name}] Wrong internal attribute collection type `%{internal_name}`, expected `%{expected_type}`, got `%{given_type}`"
+              wrong_element_type: "[%{service_class_name}] Wrong element type in internal attribute collection `%{internal_name}`, expected `%{expected_type}`"
+            for_hash:
+              wrong_element_type: "[%{service_class_name}] Wrong type in internal attribute hash `%{internal_name}`, expected `%{expected_type}` for `%{key_name}`, got `%{given_type}`"
     outputs:
       undefined:
         getter: "[%{service_class_name}] Undefined output attribute `%{output_name}`"
         setter: "[%{service_class_name}] Undefined output attribute `%{output_name}`"
       checks:
         type:
-          default_error: "[%{service_class_name}] Wrong type of output attribute `%{output_name}`, expected `%{expected_type}`, got `%{given_type}`"
+          default_error:
+            default: "[%{service_class_name}] Wrong type of output attribute `%{output_name}`, expected `%{expected_type}`, got `%{given_type}`"
+            for_collection:
+              wrong_type: "[%{service_class_name}] Wrong output attribute collection type `%{output_name}`, expected `%{expected_type}`, got `%{given_type}`"
+              wrong_element_type: "[%{service_class_name}] Wrong element type in output attribute collection `%{output_name}`, expected `%{expected_type}`"
+            for_hash:
+              wrong_element_type: "[%{service_class_name}] Wrong type in output attribute hash `%{output_name}`, expected `%{expected_type}` for `%{key_name}`, got `%{given_type}`"
     methods:
       call:
         not_used: Nothing to perform. Use `make` or create a `call` method.

data/config/locales/ru.yml

@@ -6,18 +6,22 @@ ru:
         setter: "[%{service_class_name}] Неизвестный входящий атрибут `%{input_name}`"
       checks:
         inclusion:
-          default_error: "[%{service_class_name}] Неверное значение в `%{input_name}`, должно быть одним из `%{input_inclusion}`"
+          default_error: "[%{service_class_name}] Неправильное значение в `%{input_name}`, должно быть одним из `%{input_inclusion}`"
         must:
           default_error: "[%{service_class_name}] Инпут `%{input_name}` должен \"%{code}\""
           syntax_error: "[%{service_class_name}] Синтаксическая ошибка внутри `%{code}` инпута `%{input_name}`"
         required:
           default_error:
             default: "[%{service_class_name}] Обязательный инпут `%{input_name}` отсутствует"
-            for_array: "[%{service_class_name}] Обязательный элемент в инпуте-массиве `%{input_name}` отсутствует"
+            for_collection: "[%{service_class_name}] Обязательный элемент в коллекции инпута `%{input_name}` отсутствует"
         type:
           default_error:
-            default: "[%{service_class_name}] Неверный тип инпута `%{input_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
-            for_array: "[%{service_class_name}] Неверный тип инпута-массива `%{input_name}`, ожидалось `%{expected_type}`"
+            default: "[%{service_class_name}] Неправильный тип инпута `%{input_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+            for_collection:
+              wrong_element_type: "[%{service_class_name}] Неправильный тип в коллекции инпута `%{input_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+            for_hash:
+              wrong_element_type: "[%{service_class_name}] Неправильный тип в хеше инпута `%{input_name}`, для `%{key_name}` ожидалось `%{expected_type}`, получено `%{given_type}`"
+
       tools:
         find_unnecessary:
           error: "[%{service_class_name}] Неожиданные атрибуты: `%{unnecessary_attributes}`"
@@ -29,14 +33,25 @@ ru:
         setter: "[%{service_class_name}] Неизвестный внутренний атрибут `%{internal_name}`"
       checks:
         type:
-          default_error: "[%{service_class_name}] Неверный тип внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+          default_error:
+            default: "[%{service_class_name}] Неправильный тип внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+            for_collection:
+              wrong_type: "[%{service_class_name}] Неправильный тип коллекции внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+              wrong_element_type: "[%{service_class_name}] Неправильный тип элемента в коллекции внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`"
+            for_hash:
+              wrong_element_type: "[%{service_class_name}] Неправильный тип в хеше внутреннего атрибута `%{internal_name}`, для `%{key_name}` ожидалось `%{expected_type}`, получено `%{given_type}`"
     outputs:
       undefined:
         getter: "[%{service_class_name}] Неизвестный выходящий атрибут `%{output_name}`"
         setter: "[%{service_class_name}] Неизвестный выходящий атрибут `%{output_name}`"
       checks:
         type:
-          default_error: "[%{service_class_name}] Неверный тип выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+          default: "[%{service_class_name}] Неправильный тип выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+          for_collection:
+            wrong_type: "[%{service_class_name}] Неправильный тип коллекции выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+            wrong_element_type: "[%{service_class_name}] Неправильный тип элемента в коллекции выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`"
+          for_hash:
+            wrong_element_type: "[%{service_class_name}] Неправильный тип в хеше выходящего атрибута `%{output_name}`, для `%{key_name}` ожидалось `%{expected_type}`, получено `%{given_type}`"
     methods:
       call:
         not_used: Нечего исполнять. Используйте `make` или создайте метод `call`.

data/lib/servactory/{methods/method.rb → actions/action.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
-    class Method
+  module Actions
+    class Action
       attr_reader :name,
                   :position,
                   :condition,

data/lib/servactory/{methods/aliases_for_make → actions/aliases}/collection.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
-    module AliasesForMake
+  module Actions
+    module Aliases
       class Collection
         extend Forwardable
         def_delegators :@collection, :<<, :merge, :include?

data/lib/servactory/{methods/method_collection.rb → actions/collection.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
-    class MethodCollection
+  module Actions
+    class Collection
       extend Forwardable
       def_delegators :@collection, :<<, :each, :sort_by
 
@@ -11,7 +11,7 @@ module Servactory
       end
 
       def sorted_by_position
-        MethodCollection.new(sort_by(&:position))
+        Collection.new(sort_by(&:position))
       end
     end
   end

data/lib/servactory/{methods → actions}/dsl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
+  module Actions
     module DSL
       def self.included(base)
         base.extend(ClassMethods)
@@ -18,7 +18,7 @@ module Servactory
         private
 
         def stage(&block)
-          @current_stage = Stage.new(position: next_position)
+          @current_stage = Stages::Stage.new(position: next_position)
 
           instance_eval(&block)
 
@@ -56,9 +56,9 @@ module Servactory
         def make(name, position: nil, **options)
           position = position.presence || next_position
 
-          current_stage = @current_stage.presence || Stage.new(position: position)
+          current_stage = @current_stage.presence || Stages::Stage.new(position: position)
 
-          current_stage.methods << Method.new(
+          current_stage.methods << Action.new(
             name,
             position: position,
             **options
@@ -68,14 +68,14 @@ module Servactory
         end
 
         def method_missing(name, *args, &block)
-          return method_missing_for_aliases_for_make(name, *args, &block) if config.aliases_for_make.include?(name)
+          return method_missing_for_action_aliases(name, *args, &block) if config.action_aliases.include?(name)
 
-          return method_missing_for_shortcuts_for_make(name, *args, &block) if config.shortcuts_for_make.include?(name)
+          return method_missing_for_shortcuts_for_make(name, *args, &block) if config.action_shortcuts.include?(name)
 
           super
         end
 
-        def method_missing_for_aliases_for_make(_alias_name, *args, &block) # rubocop:disable Lint/UnusedMethodArgument
+        def method_missing_for_action_aliases(_alias_name, *args, &block) # rubocop:disable Lint/UnusedMethodArgument
           method_name = args.first
           method_options = args.last.is_a?(Hash) ? args.pop : {}
 
@@ -93,7 +93,7 @@ module Servactory
         end
 
         def respond_to_missing?(name, *)
-          config.aliases_for_make.include?(name) || config.shortcuts_for_make.include?(name) || super
+          config.action_aliases.include?(name) || config.action_shortcuts.include?(name) || super
         end
 
         def next_position
@@ -101,7 +101,7 @@ module Servactory
         end
 
         def collection_of_stages
-          @collection_of_stages ||= StageCollection.new
+          @collection_of_stages ||= Stages::Collection.new
         end
       end
     end

data/lib/servactory/{methods/shortcuts_for_make → actions/shortcuts}/collection.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
-    module ShortcutsForMake
+  module Actions
+    module Shortcuts
       class Collection
         extend Forwardable
         def_delegators :@collection, :<<, :each, :merge, :include?

data/lib/servactory/actions/stages/collection.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Actions
+    module Stages
+      class Collection
+        extend Forwardable
+        def_delegators :@collection, :<<, :each, :merge, :sort_by, :size, :empty?
+
+        def initialize(collection = Set.new)
+          @collection = collection
+        end
+
+        def sorted_by_position
+          Collection.new(sort_by(&:position))
+        end
+      end
+    end
+  end
+end

data/lib/servactory/actions/stages/stage.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Actions
+    module Stages
+      class Stage
+        attr_accessor :position,
+                      :wrapper,
+                      :rollback,
+                      :condition,
+                      :is_condition_opposite
+
+        def initialize(position:, wrapper: nil, rollback: nil, condition: nil)
+          @position = position
+          @wrapper = wrapper
+          @rollback = rollback
+          @condition = condition
+        end
+
+        def next_method_position
+          methods.size + 1
+        end
+
+        def methods
+          @methods ||= Collection.new
+        end
+      end
+    end
+  end
+end

data/lib/servactory/{methods → actions}/tools/runner.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
+  module Actions
     module Tools
       class Runner
         def self.run!(...)

data/lib/servactory/{methods → actions}/workspace.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Methods
+  module Actions
     module Workspace
+      private
+
       def call!(collection_of_stages:, **)
         super
 
-        Servactory::Methods::Tools::Runner.run!(self, collection_of_stages)
+        Servactory::Actions::Tools::Runner.run!(self, collection_of_stages)
       end
     end
   end

data/lib/servactory/base.rb

@@ -8,7 +8,7 @@ module Servactory
     include Inputs::DSL
     include Internals::DSL
     include Outputs::DSL
-    include Methods::DSL
+    include Actions::DSL
 
     private_class_method :new
   end

data/lib/servactory/configuration/dsl.rb

@@ -17,10 +17,12 @@ module Servactory
 
           child.config.failure_class = config.failure_class
 
+          child.config.collection_mode_class_names = config.collection_mode_class_names
+
           child.config.input_option_helpers = config.input_option_helpers
 
-          child.config.aliases_for_make = config.aliases_for_make
-          child.config.shortcuts_for_make = config.shortcuts_for_make
+          child.config.action_aliases = config.action_aliases
+          child.config.action_shortcuts = config.action_shortcuts
         end
 
         def config

data/lib/servactory/configuration/factory.rb

@@ -23,16 +23,24 @@ module Servactory
         @config.failure_class = failure_class
       end
 
+      def collection_mode_class_names(collection_mode_class_names)
+        @config.collection_mode_class_names.merge(collection_mode_class_names)
+      end
+
+      def hash_mode_class_names(hash_mode_class_names)
+        @config.hash_mode_class_names.merge(hash_mode_class_names)
+      end
+
       def input_option_helpers(input_option_helpers)
         @config.input_option_helpers.merge(input_option_helpers)
       end
 
-      def aliases_for_make(aliases_for_make)
-        @config.aliases_for_make.merge(aliases_for_make)
+      def action_aliases(action_aliases)
+        @config.action_aliases.merge(action_aliases)
       end
 
-      def shortcuts_for_make(shortcuts_for_make)
-        @config.shortcuts_for_make.merge(shortcuts_for_make)
+      def action_shortcuts(action_shortcuts)
+        @config.action_shortcuts.merge(action_shortcuts)
       end
     end
   end

data/lib/servactory/configuration/setup.rb

@@ -7,29 +7,45 @@ module Servactory
                     :internal_error_class,
                     :output_error_class,
                     :failure_class,
+                    :collection_mode_class_names,
+                    :hash_mode_class_names,
                     :input_option_helpers,
-                    :aliases_for_make,
-                    :shortcuts_for_make
+                    :action_aliases,
+                    :action_shortcuts
 
-      def initialize
+      def initialize # rubocop:disable Metrics/MethodLength
         @input_error_class = Servactory::Errors::InputError
         @internal_error_class = Servactory::Errors::InternalError
         @output_error_class = Servactory::Errors::OutputError
 
         @failure_class = Servactory::Errors::Failure
 
-        @input_option_helpers = Servactory::Inputs::OptionHelpersCollection.new(default_input_option_helpers)
+        @collection_mode_class_names =
+          Servactory::Maintenance::CollectionMode::ClassNamesCollection.new(default_collection_mode_class_names)
 
-        @aliases_for_make = Servactory::Methods::AliasesForMake::Collection.new
-        @shortcuts_for_make = Servactory::Methods::ShortcutsForMake::Collection.new
+        @hash_mode_class_names =
+          Servactory::Maintenance::HashMode::ClassNamesCollection.new(default_hash_mode_class_names)
+
+        @input_option_helpers =
+          Servactory::Maintenance::Attributes::OptionHelpersCollection.new(default_input_option_helpers)
+
+        @action_aliases = Servactory::Actions::Aliases::Collection.new
+        @action_shortcuts = Servactory::Actions::Shortcuts::Collection.new
       end
 
       private
 
+      def default_collection_mode_class_names
+        Set[Array, Set]
+      end
+
+      def default_hash_mode_class_names
+        Set[Hash]
+      end
+
       def default_input_option_helpers
         Set[
-          Servactory::Inputs::OptionHelper.new(name: :optional, equivalent: { required: false }),
-          Servactory::Inputs::OptionHelper.new(name: :as_array, equivalent: { array: true })
+          Servactory::Maintenance::Attributes::OptionHelper.new(name: :optional, equivalent: { required: false }),
         ]
       end
     end

data/lib/servactory/context/workspace/inputs.rb

@@ -4,9 +4,11 @@ module Servactory
   module Context
     module Workspace
       class Inputs
-        def initialize(context:, incoming_arguments:, collection_of_inputs:)
+        RESERVED_ATTRIBUTES = %i[type required default].freeze
+        private_constant :RESERVED_ATTRIBUTES
+
+        def initialize(context:, collection_of_inputs:)
           @context = context
-          @incoming_arguments = incoming_arguments
           @collection_of_inputs = collection_of_inputs
         end
 
@@ -44,19 +46,53 @@ module Servactory
 
           return yield if input.nil?
 
-          input_value = @incoming_arguments.fetch(input.name, nil)
-          input_value = input.default if input.optional? && input_value.blank?
+          input.value = input.default if input.optional? && input.value.blank?
+
+          if input.hash_mode? && (tmp_schema = input.schema.fetch(:is)).present?
+            input.value = prepare_hash_values_inside(object: input.value, schema: tmp_schema)
+          end
 
           input_prepare = input.prepare.fetch(:in, nil)
-          input_value = input_prepare.call(value: input_value) if input_prepare.present?
+          input.value = input_prepare.call(value: input.value) if input_prepare.present?
 
           if name.to_s.end_with?("?")
-            Servactory::Utils.query_attribute(input_value)
+            Servactory::Utils.query_attribute(input.value)
           else
-            input_value
+            input.value
+          end
+        end
+
+        def prepare_hash_values_inside(object:, schema:) # rubocop:disable Metrics/MethodLength
+          return object unless object.respond_to?(:fetch)
+
+          schema.to_h do |schema_key, schema_value|
+            attribute_type = schema_value.fetch(:type, String)
+
+            result =
+              if attribute_type == Hash
+                prepare_hash_values_inside(
+                  object: object.fetch(schema_key, {}),
+                  schema: schema_value.except(*RESERVED_ATTRIBUTES)
+                )
+              else
+                fetch_hash_values_from(
+                  value: object.fetch(schema_key, {}),
+                  schema_value: schema_value,
+                  attribute_required: schema_value.fetch(:required, true)
+                )
+              end
+
+            [schema_key, result]
           end
         end
 
+        def fetch_hash_values_from(value:, schema_value:, attribute_required:)
+          return value if attribute_required
+          return value if value.present?
+
+          schema_value.fetch(:default, nil)
+        end
+
         def raise_error_for(type, name)
           message_text = I18n.t(
             "servactory.inputs.undefined.#{type}",

data/lib/servactory/context/workspace/outputs.rb

@@ -40,7 +40,7 @@ module Servactory
         def setter_with(prepared_name:, value:, &block) # rubocop:disable Lint/UnusedMethodArgument
           return yield unless @collection_of_outputs.names.include?(prepared_name)
 
-          output = @collection_of_outputs.find_by(name: prepared_name) # ::Servactory::Outputs::Output
+          output = @collection_of_outputs.find_by(name: prepared_name)
 
           return yield if output.nil?
 

data/lib/servactory/context/workspace.rb

@@ -6,11 +6,9 @@ module Servactory
       def inputs
         @inputs ||= Inputs.new(
           context: self,
-          incoming_arguments: incoming_arguments,
           collection_of_inputs: collection_of_inputs
         )
       end
-      alias inp inputs
 
       def internals
         @internals ||= Internals.new(
@@ -18,7 +16,6 @@ module Servactory
           collection_of_internals: collection_of_internals
         )
       end
-      alias int internals
 
       def outputs
         @outputs ||= Outputs.new(
@@ -26,7 +23,6 @@ module Servactory
           collection_of_outputs: collection_of_outputs
         )
       end
-      alias out outputs
 
       def fail_input!(input_name, message:)
         raise self.class.config.input_error_class.new(

data/lib/servactory/dsl.rb

@@ -2,6 +2,8 @@
 
 module Servactory
   module DSL
+    @extensions = []
+
     def self.included(base)
       base.include(Configuration::DSL)
       base.include(Info::DSL)
@@ -9,7 +11,22 @@ module Servactory
       base.include(Inputs::DSL)
       base.include(Internals::DSL)
       base.include(Outputs::DSL)
-      base.include(Methods::DSL)
+
+      extensions.each { |extension| base.include(extension) }
+
+      base.include(Actions::DSL)
     end
+
+    def self.with_extensions(*extensions)
+      @extensions = extensions
+
+      self
+    end
+
+    def self.extensions
+      @extensions
+    end
+
+    private_class_method :extensions
   end
 end

data/lib/servactory/inputs/collection.rb

@@ -4,7 +4,7 @@ module Servactory
   module Inputs
     class Collection
       extend Forwardable
-      def_delegators :@collection, :<<, :filter, :each, :map, :to_h, :merge, :find
+      def_delegators :@collection, :<<, :filter, :each, :map, :flat_map, :to_h, :merge, :find
 
       def initialize(collection = Set.new)
         @collection = collection

data/lib/servactory/inputs/dsl.rb

@@ -21,6 +21,8 @@ module Servactory
           collection_of_inputs << Input.new(
             name,
             *helpers,
+            collection_mode_class_names: config.collection_mode_class_names,
+            hash_mode_class_names: config.hash_mode_class_names,
             option_helpers: config.input_option_helpers,
             **options
           )