servactory 1.4.5 → 1.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8878b890cc7b43a45e8ea3e982a27e5873ec4d1aeff1ac91f6ce9ea77cc98e38
-  data.tar.gz: 4f2947b852d2f0e53965b79b88ce013ae442575dee4f6539b1a2684e242211a5
+  metadata.gz: eb2ed3b4e1672a4065624d3a71b210011fb793fc340319d62720502581bb9c15
+  data.tar.gz: 916e1cf10398a6d34baf87828acdacdbebdaf13a8e78736a3c60732e19149017
 SHA512:
-  metadata.gz: 437c627bef5b24d7f5a5e7b3f4c3b75e207af58d37900d6a8c6cf8b73c69e6704feb575f01233362f1ce2c40f7c640d2900d3d58e416ea12ed682c9f23fd058b
-  data.tar.gz: fc9a5f1a97cf8db5483df7be46f805a6c8f5598b559237a89c2409ee761d61204b79da375d3d0228133b88f4e60fe124c22519c6a314d39bb33dbf585cd5422a
+  metadata.gz: e75415f8a46cd15aa7a5a7943a2cef385a31ebc9f2b837f0149d5d95a0cae004fd232878e6b6fd5a0c8b539c439b2d6e3745a5e95deb349dae90566e3184943a
+  data.tar.gz: 59837e7e7339635926ce3c5bb4457b79dd9717d0bdc39ab91f9c9cb30cb30d32860a160ecf08d49504e2a3d2de136646734c5203a750bec8c3f814f3f3ba38ba

data/README.md

@@ -28,6 +28,7 @@ A set of tools for building reliable services of any complexity.
   - [Internal attributes](#internal-attributes)
   - [Stage](#stage)
   - [Failures](#failures)
+- [I18n](#i18n)
 - [Testing](#testing)
 - [Thanks](#thanks)
 - [Contributing](#contributing)
@@ -389,6 +390,12 @@ def check!
 end
 ```
 
+## I18n
+
+All texts are stored in the localization file. All texts can be changed or supplemented by new locales.
+
+[See en.yml file](https://github.com/afuno/servactory/tree/main/config/locales/en.yml)
+
 ## Testing
 
 Testing Servactory services is the same as testing regular Ruby classes.

data/config/locales/en.yml

@@ -0,0 +1,33 @@
+en:
+  servactory:
+    input_arguments:
+      checks:
+        inclusion:
+          default_error: "[%{service_class_name}] Wrong value in `%{input_name}`, must be one of `%{input_inclusion}`"
+        must:
+          default_error: "[%{service_class_name}] Input `%{input_name}` must \"%{code}\""
+          syntax_error: "[%{service_class_name}] Syntax error inside `%{code}` of `%{input_name}` input"
+        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"
+        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}`"
+      tools:
+        find_unnecessary:
+          error: "[%{service_class_name}] Unexpected attributes: `%{unnecessary_attributes}`"
+        rules:
+          error: "[%{service_class_name}] Conflict in `%{input_name}` input options: `%{conflict_code}`"
+    internal_arguments:
+      checks:
+        type:
+          default_error: "[%{service_class_name}] Wrong type of internal argument `%{internal_argument_name}`, expected `%{expected_type}`, got `%{given_type}`"
+    output_arguments:
+      checks:
+        type:
+          default_error: "[%{service_class_name}] Wrong type of output argument `%{output_argument_name}`, expected `%{expected_type}`, got `%{given_type}`"
+      tools:
+        conflicts:
+          error: "[%{service_class_name}] Conflict between internal and output attributes `%{overlapping_attributes}`"

data/lib/servactory/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Servactory
+  class Engine < Rails::Engine
+    isolate_namespace Servactory
+  end
+end

data/lib/servactory/input_arguments/checks/inclusion.rb

@@ -4,8 +4,14 @@ module Servactory
   module InputArguments
     module Checks
       class Inclusion < Base
-        DEFAULT_MESSAGE = lambda do |service_class_name:, input:|
-          "[#{service_class_name}] Wrong value in `#{input.name}`, must be one of `#{input.inclusion[:in]}`"
+        DEFAULT_MESSAGE = lambda do |service_class_name:, input:, value:|
+          I18n.t(
+            "servactory.input_arguments.checks.inclusion.default_error",
+            service_class_name: service_class_name,
+            input_name: input.name,
+            input_inclusion: input.inclusion[:in],
+            value: value
+          )
         end
 
         private_constant :DEFAULT_MESSAGE
@@ -36,7 +42,8 @@ module Servactory
           add_error(
             DEFAULT_MESSAGE,
             service_class_name: @context.class.name,
-            input: @input
+            input: @input,
+            value: @value
           )
         end
       end

data/lib/servactory/input_arguments/checks/must.rb

@@ -4,12 +4,28 @@ module Servactory
   module InputArguments
     module Checks
       class Must < Base
-        DEFAULT_MESSAGE = lambda do |service_class_name:, input:, code:|
-          "[#{service_class_name}] Input `#{input.name}` " \
-            "must \"#{code.to_s.humanize(capitalize: false, keep_id_suffix: true)}\""
+        DEFAULT_MESSAGE = lambda do |service_class_name:, input:, value:, code:|
+          I18n.t(
+            "servactory.input_arguments.checks.must.default_error",
+            service_class_name: service_class_name,
+            input_name: input.name,
+            value: value,
+            code: code
+          )
+        end
+
+        SYNTAX_ERROR_MESSAGE = lambda do |service_class_name:, input:, value:, code:, exception_message:|
+          I18n.t(
+            "servactory.input_arguments.checks.must.syntax_error",
+            service_class_name: service_class_name,
+            input_name: input.name,
+            value: value,
+            code: code,
+            exception_message: exception_message
+          )
         end
 
-        private_constant :DEFAULT_MESSAGE
+        private_constant :DEFAULT_MESSAGE, :SYNTAX_ERROR_MESSAGE
 
         def self.check(context:, input:, value:, check_key:, check_options:)
           return unless should_be_checked_for?(input, check_key)
@@ -39,9 +55,10 @@ module Servactory
             next if message.blank?
 
             add_error(
-              DEFAULT_MESSAGE,
+              message,
               service_class_name: @context.class.name,
               input: @input,
+              value: @value,
               code: code
             )
           end
@@ -58,16 +75,13 @@ module Servactory
 
           message.presence || DEFAULT_MESSAGE
         rescue StandardError => e
-          message_text =
-            "[#{@context.class.name}] Syntax error inside `#{code}` of `#{@input.name}` input"
-
-          puts "#{message_text}: #{e}"
-
           add_error(
-            message_text,
+            SYNTAX_ERROR_MESSAGE,
             service_class_name: @context.class.name,
             input: @input,
-            code: code
+            value: @value,
+            code: code,
+            exception_message: e.message
           )
         end
       end

data/lib/servactory/input_arguments/checks/required.rb

@@ -5,11 +5,14 @@ module Servactory
     module Checks
       class Required < Base
         DEFAULT_MESSAGE = lambda do |service_class_name:, input:, value:|
-          if input.array? && value.present?
-            "[#{service_class_name}] Required element in input array `#{input.name}` is missing"
-          else
-            "[#{service_class_name}] Required input `#{input.name}` is missing"
-          end
+          i18n_key = "servactory.input_arguments.checks.required.default_error."
+          i18n_key += input.array? && value.present? ? "for_array" : "default"
+
+          I18n.t(
+            i18n_key,
+            service_class_name: service_class_name,
+            input_name: input.name
+          )
         end
 
         private_constant :DEFAULT_MESSAGE

data/lib/servactory/input_arguments/checks/type.rb

@@ -13,12 +13,22 @@ module Servactory
             elsif array_message.is_a?(String) && array_message.present?
               array_message
             else
-              "[#{service_class_name}] Wrong type in input array `#{input.name}`, expected `#{expected_type}`"
+              I18n.t(
+                "servactory.input_arguments.checks.type.default_error.for_array",
+                service_class_name: service_class_name,
+                input_name: input.name,
+                expected_type: expected_type,
+                given_type: given_type
+              )
             end
           else
-            "[#{service_class_name}] Wrong type of input `#{input.name}`, " \
-              "expected `#{expected_type}`, " \
-              "got `#{given_type}`"
+            I18n.t(
+              "servactory.input_arguments.checks.type.default_error.default",
+              service_class_name: service_class_name,
+              input_name: input.name,
+              expected_type: expected_type,
+              given_type: given_type
+            )
           end
         end
 

data/lib/servactory/input_arguments/tools/find_unnecessary.rb

@@ -17,8 +17,13 @@ module Servactory
         def check!
           return if unnecessary_attributes.empty?
 
-          raise Servactory.configuration.input_argument_error_class,
-                "[#{@context.class.name}] Unexpected attributes: `#{unnecessary_attributes.join(', ')}`"
+          message_text = I18n.t(
+            "servactory.input_arguments.tools.find_unnecessary.error",
+            service_class_name: @context.class.name,
+            unnecessary_attributes: unnecessary_attributes.join(", ")
+          )
+
+          raise Servactory.configuration.input_argument_error_class, message_text
         end
 
         private

data/lib/servactory/input_arguments/tools/rules.rb

@@ -28,9 +28,14 @@ module Servactory
         end
 
         def raise_error_for(input_argument)
-          raise Servactory.configuration.input_argument_error_class,
-                "[#{@context.class.name}] Conflict in `#{input_argument.name}` input " \
-                "options: `#{input_argument.conflict_code}`"
+          message_text = I18n.t(
+            "servactory.input_arguments.tools.rules.error",
+            service_class_name: @context.class.name,
+            input_name: input_argument.name,
+            conflict_code: input_argument.conflict_code
+          )
+
+          raise Servactory.configuration.input_argument_error_class, message_text
         end
       end
     end

data/lib/servactory/internal_arguments/checks/type.rb

@@ -5,8 +5,13 @@ module Servactory
     module Checks
       class Type < Base
         DEFAULT_MESSAGE = lambda do |service_class_name:, internal_argument:, expected_type:, given_type:|
-          "The \"#{internal_argument.name}\" internal argument on \"#{service_class_name}\" must be of type " \
-            "\"#{expected_type}\" but was \"#{given_type}\""
+          I18n.t(
+            "servactory.internal_arguments.checks.type.default_error",
+            service_class_name: service_class_name,
+            internal_argument_name: internal_argument.name,
+            expected_type: expected_type,
+            given_type: given_type
+          )
         end
 
         private_constant :DEFAULT_MESSAGE

data/lib/servactory/output_arguments/checks/type.rb

@@ -5,8 +5,13 @@ module Servactory
     module Checks
       class Type < Base
         DEFAULT_MESSAGE = lambda do |service_class_name:, output_argument:, expected_type:, given_type:|
-          "The \"#{output_argument.name}\" output argument on \"#{service_class_name}\" must be of type " \
-            "\"#{expected_type}\" but was \"#{given_type}\""
+          I18n.t(
+            "servactory.output_arguments.checks.type.default_error",
+            service_class_name: service_class_name,
+            output_argument_name: output_argument.name,
+            expected_type: expected_type,
+            given_type: given_type
+          )
         end
 
         private_constant :DEFAULT_MESSAGE

data/lib/servactory/output_arguments/tools/conflicts.rb

@@ -17,9 +17,13 @@ module Servactory
         def check!
           return if overlapping_attributes.empty?
 
-          raise Servactory.configuration.output_argument_error_class,
-                "The \"#{@context.class.name}\" service contains internal attributes that " \
-                "conflict with outputs: \"#{overlapping_attributes.join(', ')}\""
+          message_text = I18n.t(
+            "servactory.output_arguments.tools.conflicts.error",
+            service_class_name: @context.class.name,
+            overlapping_attributes: overlapping_attributes.join(", ")
+          )
+
+          raise Servactory.configuration.output_argument_error_class, message_text
         end
 
         private

data/lib/servactory/version.rb

@@ -4,7 +4,7 @@ module Servactory
   module VERSION
     MAJOR = 1
     MINOR = 4
-    PATCH = 5
+    PATCH = 7
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/servactory.rb

@@ -5,7 +5,6 @@ require "zeitwerk"
 require "active_support/core_ext/string"
 
 # require "servactory/support/loader"
-# require "servactory/engine"
 
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
@@ -29,6 +28,8 @@ module Servactory
   end
 end
 
+require "servactory/engine" if defined?(Rails::Engine)
+
 # require_relative "servactory/exceptions"
 
 # require_relative "servactory/base"

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.7
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +173,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- config/locales/en.yml
 - lib/servactory.rb
 - lib/servactory/base.rb
 - lib/servactory/configuration/dsl.rb
@@ -171,6 +186,7 @@ files:
 - lib/servactory/context/workspace.rb
 - lib/servactory/context/workspace/error.rb
 - lib/servactory/context/workspace/errors.rb
+- lib/servactory/engine.rb
 - lib/servactory/errors/base.rb
 - lib/servactory/errors/failure.rb
 - lib/servactory/errors/input_argument_error.rb