servactory 2.1.0 → 2.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd508e1e2a77b4d74acb00666dbc5149009fdb11f927144554f3d4d66a63887
-  data.tar.gz: ac3cd518c70d56f1089e2975afffedca41983555e4c54fc5d815d94ea0d1fa4c
+  metadata.gz: 5c12708849de24be4c1dc728185784afde60fa4cddad681d52d591561b4acacd
+  data.tar.gz: d1d5d7334b5e6b1ecc7f92b526faa60f67521fc73a3f33ab4d30f8b2e2b94f5c
 SHA512:
-  metadata.gz: bcf0363a0d2d83cfd6ddffd4ea19254a51c2cf93eb33b83f79ee6129f7e38a8fe1bbedfc19cde97d3cfc78ee3d48d8550afa39c7d1d78488a10bfb8d7be609e8
-  data.tar.gz: 5ad30d0c89119bd1a9ccfc6b536c14276cd6197f28ef2d449f0f38a3ce3c962bba6bea7a60c4b365ff76adaa1bd284a8ddc0908b6319dc3bd895458f5d7d8ddd
+  metadata.gz: ccf9a3ae3d9a1d9336ff447018c5aa17dc62348a19b37184d18296ca2eb03174fe90c37ff30d85d70ac31236f4efc8903e594afcd87f5b0ddbd10b188b8c75d7
+  data.tar.gz: 0fac6ae21c307e87ce9b022c6e0c140162d8c8536325586df72022eb72e8545516c4a988224b554b9bc0af4a89895b796848614572ad42429f323c84c45b19a2

data/README.md

@@ -13,15 +13,15 @@
 </p>
 
 <p align="center">
-    <a href="https://rubygems.org/gems/servactory"><img src="https://img.shields.io/gem/v/servactory?logo=rubygems&logoColor=fff" alt="Gem version"></a>
-    <a href="https://github.com/afuno/servactory/releases"><img src="https://img.shields.io/github/release-date/afuno/servactory" alt="Release Date"></a>
+  <a href="https://rubygems.org/gems/servactory"><img src="https://img.shields.io/gem/v/servactory?logo=rubygems&logoColor=fff" alt="Gem version"></a>
+  <a href="https://github.com/afuno/servactory/releases"><img src="https://img.shields.io/github/release-date/afuno/servactory" alt="Release Date"></a>
 </p>
 
 ## Documentation
 
 See [servactory.com](https://servactory.com) for documentation.
 
-## Example
+## Quick Start
 
 ### Installation
 
@@ -29,7 +29,7 @@ See [servactory.com](https://servactory.com) for documentation.
 gem "servactory"
 ```
 
-### Service
+### Define service
 
 ```ruby
 class UserService::Authenticate < Servactory::Base
@@ -50,7 +50,7 @@ class UserService::Authenticate < Servactory::Base
 end
 ```
 
-### Usage
+### Usage in controller
 
 ```ruby
 class SessionsController < ApplicationController

data/config/locales/en.yml

@@ -1,5 +1,12 @@
 en:
   servactory:
+    common:
+      undefined_local_variable_or_method: "[%{service_class_name}] Undefined local variable or method `%{method_name}`"
+      undefined_method:
+        missing_name: "[%{service_class_name}] Undefined method `%{method_name}` for `%{missing_name}`"
+    methods:
+      call:
+        not_used: "[%{service_class_name}] Nothing to perform. Use `make` or create a `call` method."
     inputs:
       undefined:
         getter: "[%{service_class_name}] Undefined input attribute `%{input_name}`"
@@ -31,12 +38,17 @@ en:
         getter: "[%{service_class_name}] Undefined internal attribute `%{internal_name}`"
         setter: "[%{service_class_name}] Undefined internal attribute `%{internal_name}`"
       validations:
+        inclusion:
+          default_error: "[%{service_class_name}] Wrong value in `%{internal_name}`, must be one of `%{internal_inclusion}`"
+        must:
+          default_error: "[%{service_class_name}] Internal attribute `%{internal_name}` must \"%{code}\""
+          syntax_error: "[%{service_class_name}] Syntax error inside `%{code}` of `%{internal_name}` internal attribute"
         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}`"
+              wrong_element_type: "[%{service_class_name}] Wrong element type in internal attribute collection `%{internal_name}`, expected `%{expected_type}`, got `%{given_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:
@@ -44,14 +56,16 @@ en:
         getter: "[%{service_class_name}] Undefined output attribute `%{output_name}`"
         setter: "[%{service_class_name}] Undefined output attribute `%{output_name}`"
       validations:
+        inclusion:
+          default_error: "[%{service_class_name}] Wrong value in `%{output_name}`, must be one of `%{output_inclusion}`"
+        must:
+          default_error: "[%{service_class_name}] Output attribute `%{output_name}` must \"%{code}\""
+          syntax_error: "[%{service_class_name}] Syntax error inside `%{code}` of `%{output_name}` output attribute"
         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}`"
+              wrong_element_type: "[%{service_class_name}] Wrong element type in output attribute collection `%{output_name}`, expected `%{expected_type}`, got `%{given_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

@@ -1,5 +1,12 @@
 ru:
   servactory:
+    common:
+      undefined_local_variable_or_method: "[%{service_class_name}] Неопределенная локальная переменная или метод `%{method_name}`"
+      undefined_method:
+        missing_name: "[%{service_class_name}] Неопределенный метод `%{method_name}` для `%{missing_name}`"
+    methods:
+      call:
+        not_used: "[%{service_class_name}] Нечего выполнять. Используйте `make` или создайте метод `call`."
     inputs:
       undefined:
         getter: "[%{service_class_name}] Неизвестный входящий атрибут `%{input_name}`"
@@ -32,12 +39,17 @@ ru:
         getter: "[%{service_class_name}] Неизвестный внутренний атрибут `%{internal_name}`"
         setter: "[%{service_class_name}] Неизвестный внутренний атрибут `%{internal_name}`"
       validations:
+        inclusion:
+          default_error: "[%{service_class_name}] Неправильное значение в `%{internal_name}`, должно быть одним из `%{internal_inclusion}`"
+        must:
+          default_error: "[%{service_class_name}] Внутренний атрибут `%{internal_name}` должен \"%{code}\""
+          syntax_error: "[%{service_class_name}] Синтаксическая ошибка внутри `%{code}` внутреннего атрибута `%{internal_name}`"
         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}`"
+              wrong_element_type: "[%{service_class_name}] Неправильный тип элемента в коллекции внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
             for_hash:
               wrong_element_type: "[%{service_class_name}] Неправильный тип в хеше внутреннего атрибута `%{internal_name}`, для `%{key_name}` ожидалось `%{expected_type}`, получено `%{given_type}`"
     outputs:
@@ -45,13 +57,15 @@ ru:
         getter: "[%{service_class_name}] Неизвестный выходящий атрибут `%{output_name}`"
         setter: "[%{service_class_name}] Неизвестный выходящий атрибут `%{output_name}`"
       validations:
+        inclusion:
+          default_error: "[%{service_class_name}] Неправильное значение в `%{output_name}`, должно быть одним из `%{output_inclusion}`"
+        must:
+          default_error: "[%{service_class_name}] Выходящий атрибут `%{output_name}` должен \"%{code}\""
+          syntax_error: "[%{service_class_name}] Синтаксическая ошибка внутри `%{code}` выходящего атрибута `%{output_name}`"
         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}`"
+            wrong_element_type: "[%{service_class_name}] Неправильный тип элемента в коллекции выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`, получено `%{given_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/actions/tools/runner.rb

@@ -51,10 +51,18 @@ module Servactory
           methods.each do |method|
             next if unnecessary_for_make?(method)
 
-            @context.send(method.name)
+            call_method(method)
           end
         end
 
+        def call_method(method)
+          @context.send(method.name)
+        rescue NoMethodError => e
+          rescue_no_method_error_with(exception: e)
+        rescue NameError
+          rescue_name_error_with(method: method)
+        end
+
         def unnecessary_for_stage?(stage)
           condition = stage.condition
           is_condition_opposite = stage.is_condition_opposite
@@ -79,6 +87,37 @@ module Servactory
 
           !condition.call(context: @context)
         end
+
+        ########################################################################
+
+        def rescue_no_method_error_with(exception:) # rubocop:disable Metrics/MethodLength
+          raise @context.class.config.failure_class.new(
+            type: :base,
+            message: I18n.t(
+              "servactory.common.undefined_method.missing_name",
+              service_class_name: @context.class.name,
+              method_name: exception.name,
+              missing_name: if exception.missing_name.nil?
+                              exception.missing_name.inspect
+                            elsif exception.missing_name == "NilClass"
+                              nil.inspect
+                            else
+                              exception.missing_name
+                            end
+            )
+          )
+        end
+
+        def rescue_name_error_with(method:)
+          raise @context.class.config.failure_class.new(
+            type: :base,
+            message: I18n.t(
+              "servactory.common.undefined_local_variable_or_method",
+              service_class_name: @context.class.name,
+              method_name: method.name
+            )
+          )
+        end
       end
     end
   end

data/lib/servactory/configuration/dsl.rb

@@ -15,6 +15,7 @@ module Servactory
           child.config.internal_error_class = config.internal_error_class
           child.config.output_error_class = config.output_error_class
 
+          child.config.success_class = config.success_class
           child.config.failure_class = config.failure_class
 
           child.config.collection_mode_class_names = config.collection_mode_class_names

data/lib/servactory/configuration/setup.rb

@@ -6,10 +6,13 @@ module Servactory
       attr_accessor :input_error_class,
                     :internal_error_class,
                     :output_error_class,
+                    :success_class,
                     :failure_class,
                     :collection_mode_class_names,
                     :hash_mode_class_names,
                     :input_option_helpers,
+                    :internal_option_helpers,
+                    :output_option_helpers,
                     :action_aliases,
                     :action_shortcuts
 
@@ -18,6 +21,7 @@ module Servactory
         @internal_error_class = Servactory::Errors::InternalError
         @output_error_class = Servactory::Errors::OutputError
 
+        @success_class = Servactory::Exceptions::Success
         @failure_class = Servactory::Errors::Failure
 
         @collection_mode_class_names =
@@ -29,6 +33,12 @@ module Servactory
         @input_option_helpers =
           Servactory::Maintenance::Attributes::OptionHelpersCollection.new(default_input_option_helpers)
 
+        @internal_option_helpers =
+          Servactory::Maintenance::Attributes::OptionHelpersCollection.new
+
+        @output_option_helpers =
+          Servactory::Maintenance::Attributes::OptionHelpersCollection.new
+
         @action_aliases = Servactory::Actions::Aliases::Collection.new
         @action_shortcuts = Servactory::Actions::Shortcuts::Collection.new
       end

data/lib/servactory/context/callable.rb

@@ -3,7 +3,7 @@
 module Servactory
   module Context
     module Callable
-      def call!(arguments = {})
+      def call!(arguments = {}) # rubocop:disable Metrics/MethodLength
         context = send(:new)
 
         context.send(
@@ -16,6 +16,8 @@ module Servactory
         )
 
         Servactory::Result.success_for(context: context)
+      rescue config.success_class => e
+        Servactory::Result.success_for(context: e.context)
       end
 
       def call(arguments = {})

data/lib/servactory/context/workspace.rb

@@ -2,7 +2,7 @@
 
 module Servactory
   module Context
-    module Workspace
+    module Workspace # rubocop:disable Metrics/ModuleLength
       def inputs
         @inputs ||= Inputs.new(
           context: self,
@@ -25,6 +25,10 @@ module Servactory
         )
       end
 
+      def success!
+        raise self.class.config.success_class.new(context: self)
+      end
+
       def fail_input!(input_name, message:)
         raise self.class.config.input_error_class.new(
           input_name: input_name,
@@ -32,8 +36,22 @@ module Servactory
         )
       end
 
-      def fail!(message:, meta: nil)
-        raise self.class.config.failure_class.new(message: message, meta: meta)
+      def fail_internal!(internal_name, message:)
+        raise self.class.config.internal_error_class.new(
+          internal_name: internal_name,
+          message: message
+        )
+      end
+
+      def fail_output!(output_name, message:)
+        raise self.class.config.output_error_class.new(
+          output_name: output_name,
+          message: message
+        )
+      end
+
+      def fail!(type = :base, message:, meta: nil)
+        raise self.class.config.failure_class.new(type: type, message: message, meta: meta)
       end
 
       def fail_result!(service_result)
@@ -78,6 +96,7 @@ module Servactory
 
       def call
         raise self.class.config.failure_class.new(
+          type: :base,
           message: I18n.t(
             "servactory.methods.call.not_used",
             service_class_name: self.class.name

data/lib/servactory/errors/failure.rb

@@ -2,11 +2,13 @@
 
 module Servactory
   module Errors
-    class Failure < Base
-      attr_reader :message,
+    class Failure < Servactory::Exceptions::Base
+      attr_reader :type,
+                  :message,
                   :meta
 
-      def initialize(message:, meta: nil)
+      def initialize(type:, message:, meta: nil)
+        @type = type
         @message = message
         @meta = meta
 

data/lib/servactory/errors/input_error.rb

@@ -2,7 +2,7 @@
 
 module Servactory
   module Errors
-    class InputError < Base
+    class InputError < Servactory::Exceptions::Base
       attr_reader :message,
                   :input_name
 

data/lib/servactory/errors/internal_error.rb

@@ -2,11 +2,13 @@
 
 module Servactory
   module Errors
-    class InternalError < Base
-      attr_reader :message
+    class InternalError < Servactory::Exceptions::Base
+      attr_reader :message,
+                  :internal_name
 
-      def initialize(message:)
+      def initialize(message:, internal_name: nil)
         @message = message
+        @internal_name = internal_name&.to_sym
 
         super(message)
       end

data/lib/servactory/errors/output_error.rb

@@ -2,11 +2,13 @@
 
 module Servactory
   module Errors
-    class OutputError < Base
-      attr_reader :message
+    class OutputError < Servactory::Exceptions::Base
+      attr_reader :message,
+                  :output_name
 
-      def initialize(message:)
+      def initialize(message:, output_name: nil)
         @message = message
+        @output_name = output_name&.to_sym
 
         super(message)
       end

data/lib/servactory/{errors → exceptions}/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Servactory
-  module Errors
+  module Exceptions
     class Base < StandardError
     end
   end

data/lib/servactory/exceptions/success.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Exceptions
+    class Success < Base
+      attr_reader :context
+
+      def initialize(context:)
+        @context = context
+
+        super
+      end
+    end
+  end
+end

data/lib/servactory/inputs/translator/required.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Inputs
+    module Translator
+      module Required
+        module_function
+
+        def default_message
+          lambda do |service_class_name:, input:, value:|
+            i18n_key = "servactory.inputs.validations.required.default_error."
+            i18n_key += input.collection_mode? && value.present? ? "for_collection" : "default"
+
+            I18n.t(
+              i18n_key,
+              service_class_name: service_class_name,
+              input_name: input.name
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/servactory/inputs/validations/required.rb

@@ -4,19 +4,6 @@ module Servactory
   module Inputs
     module Validations
       class Required < Base
-        DEFAULT_MESSAGE = lambda do |service_class_name:, input:, value:|
-          i18n_key = "servactory.inputs.validations.required.default_error."
-          i18n_key += input.collection_mode? && value.present? ? "for_collection" : "default"
-
-          I18n.t(
-            i18n_key,
-            service_class_name: service_class_name,
-            input_name: input.name
-          )
-        end
-
-        private_constant :DEFAULT_MESSAGE
-
         def self.check(context:, attribute:, value:, check_key:, **)
           return unless should_be_checked_for?(attribute, check_key)
 
@@ -39,7 +26,7 @@ module Servactory
 
         def check
           if @input.collection_mode? && Servactory::Utils.value_present?(@value)
-            return if @value.respond_to?(:all?) && @value.all?(&:present?)
+            return if collection_valid?
           elsif Servactory::Utils.value_present?(@value)
             return
           end
@@ -51,9 +38,17 @@ module Servactory
 
         private
 
+        def collection_valid?
+          collection_valid_for?(values: @value)
+        end
+
+        def collection_valid_for?(values:)
+          values.respond_to?(:all?) && values.flatten.all?(&:present?)
+        end
+
         def add_error_with(message)
           add_error(
-            message: message.presence || DEFAULT_MESSAGE,
+            message: message.presence || Servactory::Inputs::Translator::Required.default_message,
             service_class_name: @context.class.name,
             input: @input,
             value: @value

data/lib/servactory/internals/dsl.rb

@@ -16,11 +16,13 @@ module Servactory
 
         private
 
-        def internal(name, **options)
+        def internal(name, *helpers, **options)
           collection_of_internals << Internal.new(
             name,
+            *helpers,
             collection_mode_class_names: config.collection_mode_class_names,
             hash_mode_class_names: config.hash_mode_class_names,
+            option_helpers: config.internal_option_helpers,
             **options
           )
         end

data/lib/servactory/internals/internal.rb

@@ -8,15 +8,18 @@ module Servactory
 
       def initialize(
         name,
+        *helpers,
         collection_mode_class_names:,
         hash_mode_class_names:,
+        option_helpers:,
         **options
       )
         @name = name
         @collection_mode_class_names = collection_mode_class_names
         @hash_mode_class_names = hash_mode_class_names
+        @option_helpers = option_helpers
 
-        register_options(options: options)
+        register_options(helpers: helpers, options: options)
       end
 
       def method_missing(name, *args, &block)
@@ -31,7 +34,9 @@ module Servactory
         @collection_of_options.names.include?(name) || super
       end
 
-      def register_options(options:) # rubocop:disable Metrics/MethodLength
+      def register_options(helpers:, options:) # rubocop:disable Metrics/MethodLength
+        options = apply_helpers_for_options(helpers: helpers, options: options) if helpers.present?
+
         options_registrar = Servactory::Maintenance::Attributes::Options::Registrar.register(
           attribute: self,
           collection_mode_class_names: @collection_mode_class_names,
@@ -40,13 +45,29 @@ module Servactory
           features: {
             types: true,
             collection: true,
-            hash: true
+            hash: true,
+            inclusion: true,
+            must: true
           }
         )
 
         @collection_of_options = options_registrar.collection
       end
 
+      def apply_helpers_for_options(helpers:, options:)
+        prepared_options = {}
+
+        helpers.each do |helper|
+          found_helper = @option_helpers.find_by(name: helper)
+
+          next if found_helper.blank?
+
+          prepared_options.merge!(found_helper.equivalent)
+        end
+
+        options.merge(prepared_options)
+      end
+
       def options_for_checks
         @collection_of_options.options_for_checks
       end

data/lib/servactory/maintenance/attributes/option_helpers_collection.rb

@@ -7,7 +7,7 @@ module Servactory
         extend Forwardable
         def_delegators :@collection, :<<, :find, :merge
 
-        def initialize(collection)
+        def initialize(collection = Set.new)
           @collection = collection
         end
 

data/lib/servactory/maintenance/attributes/translator/inclusion.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Maintenance
+    module Attributes
+      module Translator
+        module Inclusion
+          module_function
+
+          def default_message
+            lambda do |service_class_name:, value:, input: nil, internal: nil, output: nil|
+              attribute = Servactory::Utils.define_attribute_with(input: input, internal: internal, output: output)
+
+              I18n.t(
+                "servactory.#{attribute.i18n_name}.validations.inclusion.default_error",
+                service_class_name: service_class_name,
+                "#{attribute.system_name}_name": attribute.name,
+                "#{attribute.system_name}_inclusion": attribute.inclusion[:in],
+                value: value
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/servactory/maintenance/attributes/translator/must.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Maintenance
+    module Attributes
+      module Translator
+        module Must
+          module_function
+
+          def default_message
+            lambda do |service_class_name:, value:, code:, input: nil, internal: nil, output: nil|
+              attribute = Servactory::Utils.define_attribute_with(input: input, internal: internal, output: output)
+
+              I18n.t(
+                "servactory.#{attribute.i18n_name}.validations.must.default_error",
+                service_class_name: service_class_name,
+                "#{attribute.system_name}_name": attribute.name,
+                value: value,
+                code: code
+              )
+            end
+          end
+
+          def syntax_error_message # rubocop:disable Metrics/MethodLength
+            lambda do |service_class_name:, value:, code:, exception_message:, input: nil, internal: nil, output: nil|
+              attribute = Servactory::Utils.define_attribute_with(input: input, internal: internal, output: output)
+
+              I18n.t(
+                "servactory.#{attribute.i18n_name}.validations.must.syntax_error",
+                service_class_name: service_class_name,
+                "#{attribute.system_name}_name": attribute.name,
+                value: value,
+                code: code,
+                exception_message: exception_message
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end