servactory 1.8.6 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63d469613e34fcd13e27dc8fb62fa6c36fc25cf9b9e35f5b21af30013ac75993
-  data.tar.gz: e3edd5a0bfbd2b889e81be1aeeaa836f80c6e9925c65e5f4ed09ce2a35d44673
+  metadata.gz: 4195548749c897719881d14227c7526a0be6097b38123e8556470089e867958a
+  data.tar.gz: c096b1aacf6217243b1d292afad6cff733dfc955a3d720741de60c5a7d2420cc
 SHA512:
-  metadata.gz: 774bb94eb10a8695cde168e8cd7bc224ebc65804e2092c617dacf471612d1b3980dbc2f6d80b0418f9885a4697587c9d2d12c4172b176d79de4d6114f5198aed
-  data.tar.gz: 2987a6379e4404e1757e4cef6749ae3e5fd8b98712d23e630b1b0a5bde5cdac8232046089d59cc1e642b7a540a9def431dfc6708e3696a14b517ce22cd1025f7
+  metadata.gz: fff98fb471d49bb6ffda9d31d8daead860313cf12725db2251b22bf69d170bec272376bd71f1f2319ff373c962f6a06822f8e83a435140799d6698acb1454674
+  data.tar.gz: e333261e7b6a7c5fd8cfc339ac312845bcd89b373100db21d330f89119ea3994fa5c9d66066c8b9b5705e648567513cd1ddbda6907aab4389c6b05475f36ede2

data/README.md

@@ -1,9 +1,21 @@
-# Servactory
-
-A set of tools for building reliable services of any complexity.
-
-[![Gem version](https://img.shields.io/gem/v/servactory?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/servactory)
-[![Release Date](https://img.shields.io/github/release-date/afuno/servactory)](https://github.com/afuno/servactory/releases)
+<p align="center">
+  <a href="https://servactory.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/servactory/servactory/main/.github/logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/servactory/servactory/main/.github/logo-light.svg">
+      <img alt="Servactory" src="https://raw.githubusercontent.com/servactory/servactory/main/.github/logo-light.svg" width="350" height="70" style="max-width: 100%;">
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+  A set of tools for building reliable services of any complexity.
+</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>
+</p>
 
 ## Documentation
 
@@ -29,7 +41,7 @@ class UserService::Authenticate < Servactory::Base
   private
 
   def call
-    if (user = User.find_by(email: inputs.email)&.authenticate(inputs.password))
+    if (user = User.authenticate_by(email: inputs.email, password: inputs.password)).present?
       outputs.user = user
     else
       fail!(message: "Authentication failed")

data/config/locales/en.yml

@@ -28,6 +28,6 @@ en:
       checks:
         type:
           default_error: "[%{service_class_name}] Wrong type of output attribute `%{output_name}`, expected `%{expected_type}`, got `%{given_type}`"
-      tools:
-        conflicts:
-          error: "[%{service_class_name}] Conflict between internal and output attributes `%{overlapping_attributes}`"
+    methods:
+      call:
+        not_used: Nothing to perform. Use `make` or create a `call` method.

data/config/locales/ru.yml

@@ -0,0 +1,33 @@
+ru:
+  servactory:
+    inputs:
+      checks:
+        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}` отсутствует"
+        type:
+          default_error:
+            default: "[%{service_class_name}] Неверный тип инпута `%{input_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+            for_array: "[%{service_class_name}] Неверный тип инпута-массива `%{input_name}`, ожидалось `%{expected_type}`"
+      tools:
+        find_unnecessary:
+          error: "[%{service_class_name}] Неожиданные атрибуты: `%{unnecessary_attributes}`"
+        rules:
+          error: "[%{service_class_name}] Конфликт в опциях инпута `%{input_name}`: `%{conflict_code}`"
+    internals:
+      checks:
+        type:
+          default_error: "[%{service_class_name}] Неверный тип внутреннего атрибута `%{internal_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+    outputs:
+      checks:
+        type:
+          default_error: "[%{service_class_name}] Неверный тип выходящего атрибута `%{output_name}`, ожидалось `%{expected_type}`, получено `%{given_type}`"
+    methods:
+      call:
+        not_used: Нечего исполнять. Используйте `make` или создайте метод `call`.

data/lib/servactory/configuration/dsl.rb

@@ -8,10 +8,29 @@ module Servactory
       end
 
       module ClassMethods
+        def inherited(child) # rubocop:disable Metrics/AbcSize
+          super
+
+          child.config.input_error_class = config.input_error_class
+          child.config.internal_error_class = config.internal_error_class
+          child.config.output_error_class = config.output_error_class
+
+          child.config.failure_class = config.failure_class
+
+          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
+        end
+
+        def config
+          @config ||= Servactory::Configuration::Setup.new
+        end
+
         private
 
         def configuration(&block)
-          @configuration_factory ||= Factory.new
+          @configuration_factory ||= Factory.new(config)
 
           @configuration_factory.instance_eval(&block)
         end

data/lib/servactory/configuration/factory.rb

@@ -3,32 +3,36 @@
 module Servactory
   module Configuration
     class Factory
+      def initialize(config)
+        @config = config
+      end
+
       def input_error_class(input_error_class)
-        Servactory.configuration.input_error_class = input_error_class
+        @config.input_error_class = input_error_class
       end
 
       def output_error_class(output_error_class)
-        Servactory.configuration.output_error_class = output_error_class
+        @config.output_error_class = output_error_class
       end
 
       def internal_error_class(internal_error_class)
-        Servactory.configuration.internal_error_class = internal_error_class
+        @config.internal_error_class = internal_error_class
       end
 
       def failure_class(failure_class)
-        Servactory.configuration.failure_class = failure_class
+        @config.failure_class = failure_class
       end
 
       def input_option_helpers(input_option_helpers)
-        Servactory.configuration.input_option_helpers.merge(input_option_helpers)
+        @config.input_option_helpers.merge(input_option_helpers)
       end
 
       def aliases_for_make(aliases_for_make)
-        Servactory.configuration.aliases_for_make.merge(aliases_for_make)
+        @config.aliases_for_make.merge(aliases_for_make)
       end
 
       def shortcuts_for_make(shortcuts_for_make)
-        Servactory.configuration.shortcuts_for_make.merge(shortcuts_for_make)
+        @config.shortcuts_for_make.merge(shortcuts_for_make)
       end
     end
   end

data/lib/servactory/context/callable.rb

@@ -20,7 +20,7 @@ module Servactory
 
       def call(arguments = {})
         call!(arguments)
-      rescue Servactory.configuration.failure_class => e
+      rescue config.failure_class => e
         Servactory::Result.failure_for(exception: e)
       end
     end

data/lib/servactory/context/workspace.rb

@@ -29,14 +29,14 @@ module Servactory
       alias out outputs
 
       def fail_input!(input_name, message:)
-        raise Servactory.configuration.input_error_class.new(
+        raise self.class.config.input_error_class.new(
           input_name: input_name,
           message: message
         )
       end
 
       def fail!(message:, meta: nil)
-        raise Servactory.configuration.failure_class.new(message: message, meta: meta)
+        raise self.class.config.failure_class.new(message: message, meta: meta)
       end
 
       private
@@ -75,6 +75,15 @@ module Servactory
         @collection_of_outputs = collection_of_outputs
       end
 
+      def call
+        raise self.class.config.failure_class.new(
+          message: I18n.t(
+            "servactory.methods.call.not_used",
+            service_class_name: self.class.name
+          )
+        )
+      end
+
       def service_storage
         @service_storage ||= { internals: {}, outputs: {} }
       end

data/lib/servactory/dsl.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Servactory
+  module DSL
+    def self.included(base)
+      base.include(Configuration::DSL)
+      base.include(Info::DSL)
+      base.include(Context::DSL)
+      base.include(Inputs::DSL)
+      base.include(Internals::DSL)
+      base.include(Outputs::DSL)
+      base.include(Methods::DSL)
+    end
+  end
+end

data/lib/servactory/inputs/dsl.rb

@@ -21,6 +21,7 @@ module Servactory
           collection_of_inputs << Input.new(
             name,
             *helpers,
+            config: config,
             **options
           )
         end

data/lib/servactory/inputs/input.rb

@@ -8,7 +8,8 @@ module Servactory
       private_constant :ARRAY_DEFAULT_VALUE
 
       attr_reader :name,
-                  :internal_name
+                  :internal_name,
+                  :config
 
       # rubocop:disable Style/KeywordParametersOrder
       def initialize(
@@ -16,10 +17,12 @@ module Servactory
         *helpers,
         as: nil,
         type:,
+        config:,
         **options
       )
         @name = name
         @internal_name = as.present? ? as : name
+        @config = config
 
         options = apply_helpers_for_options(helpers: helpers, options: options) if helpers.present?
 
@@ -43,7 +46,7 @@ module Servactory
         prepared_options = {}
 
         helpers.each do |helper|
-          found_helper = Servactory.configuration.input_option_helpers.find_by(name: helper)
+          found_helper = config.input_option_helpers.find_by(name: helper)
 
           next if found_helper.blank?
 

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

@@ -23,7 +23,7 @@ module Servactory
             unnecessary_attributes: unnecessary_attributes.join(", ")
           )
 
-          raise Servactory.configuration.input_error_class.new(message: message_text)
+          raise @context.class.config.input_error_class.new(message: message_text)
         end
 
         private

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

@@ -35,7 +35,7 @@ module Servactory
             conflict_code: input.conflict_code
           )
 
-          raise Servactory.configuration.input_error_class.new(
+          raise @context.class.config.input_error_class.new(
             message: message_text,
             input_name: input.name
           )

data/lib/servactory/inputs/tools/validation.rb

@@ -43,7 +43,12 @@ module Servactory
           end
         end
 
-        def process_validation_classes(validation_class, input:, check_key:, check_options:)
+        def process_validation_classes(
+          validation_class,
+          input:,
+          check_key:,
+          check_options:
+        )
           validation_class.check(
             context: @context,
             input: input,
@@ -68,7 +73,7 @@ module Servactory
         def raise_errors
           return if (tmp_errors = errors.not_blank).empty?
 
-          raise Servactory.configuration.input_error_class.new(message: tmp_errors.first)
+          raise @context.class.config.input_error_class.new(message: tmp_errors.first)
         end
       end
     end

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

@@ -17,13 +17,19 @@ module Servactory
         private_constant :DEFAULT_MESSAGE
 
         def self.check(context:, input:, value:, check_key:, **)
-          return unless should_be_checked_for?(input, check_key)
+          return unless should_be_checked_for?(input, value, check_key)
 
           new(context: context, input: input, value: value).check
         end
 
-        def self.should_be_checked_for?(input, check_key)
-          check_key == :inclusion && input.inclusion_present?
+        def self.should_be_checked_for?(input, value, check_key)
+          check_key == :inclusion && (
+            input.required? || (
+              input.optional? && !input.default.nil?
+            ) || (
+              input.optional? && !value.nil?
+            )
+          )
         end
 
         ##########################################################################

data/lib/servactory/internals/validations/base.rb

@@ -9,7 +9,7 @@ module Servactory
         def raise_error_with(message, **attributes)
           message = message.call(**attributes) if message.is_a?(Proc)
 
-          raise Servactory.configuration.internal_error_class.new(message: message)
+          raise @context.class.config.internal_error_class.new(message: message)
         end
       end
     end

data/lib/servactory/methods/dsl.rb

@@ -68,13 +68,9 @@ module Servactory
         end
 
         def method_missing(name, *args, &block)
-          if Servactory.configuration.aliases_for_make.include?(name)
-            return method_missing_for_aliases_for_make(name, *args, &block)
-          end
+          return method_missing_for_aliases_for_make(name, *args, &block) if config.aliases_for_make.include?(name)
 
-          if Servactory.configuration.shortcuts_for_make.include?(name)
-            return method_missing_for_shortcuts_for_make(name, *args, &block)
-          end
+          return method_missing_for_shortcuts_for_make(name, *args, &block) if config.shortcuts_for_make.include?(name)
 
           super
         end
@@ -97,9 +93,7 @@ module Servactory
         end
 
         def respond_to_missing?(name, *)
-          Servactory.configuration.aliases_for_make.include?(name) ||
-            Servactory.configuration.shortcuts_for_make.include?(name) ||
-            super
+          config.aliases_for_make.include?(name) || config.shortcuts_for_make.include?(name) || super
         end
 
         def next_position

data/lib/servactory/methods/tools/runner.rb

@@ -14,7 +14,7 @@ module Servactory
         end
 
         def run!
-          return try_to_use_call if @collection_of_stages.empty?
+          return use_call if @collection_of_stages.empty?
 
           @collection_of_stages.sorted_by_position.each do |stage|
             call_stage(stage)
@@ -23,8 +23,8 @@ module Servactory
 
         private
 
-        def try_to_use_call
-          @context.try(:send, :call)
+        def use_call
+          @context.send(:call)
         end
 
         def call_stage(stage)

data/lib/servactory/outputs/validations/base.rb

@@ -9,7 +9,7 @@ module Servactory
         def raise_error_with(message, **attributes)
           message = message.call(**attributes) if message.is_a?(Proc)
 
-          raise Servactory.configuration.output_error_class.new(message: message)
+          raise @context.class.config.output_error_class.new(message: message)
         end
       end
     end

data/lib/servactory/version.rb

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

data/lib/servactory.rb

@@ -4,32 +4,12 @@ require "zeitwerk"
 
 require "active_support/core_ext/string"
 
-# require "servactory/support/loader"
-
 loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect(
   "dsl" => "DSL"
 )
 loader.setup
 
-module Servactory
-  module_function
-
-  def configuration
-    @configuration ||= Servactory::Configuration::Setup.new
-  end
-
-  def reset
-    @configuration = Servactory::Configuration::Setup.new
-  end
-
-  def configure
-    yield(configuration)
-  end
-end
+module Servactory; end
 
 require "servactory/engine" if defined?(Rails::Engine)
-
-# require_relative "servactory/exceptions"
-
-# require_relative "servactory/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.8.6
+  version: 1.8.8
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,6 +188,7 @@ files:
 - README.md
 - Rakefile
 - config/locales/en.yml
+- config/locales/ru.yml
 - lib/servactory.rb
 - lib/servactory/base.rb
 - lib/servactory/configuration/dsl.rb
@@ -199,6 +200,7 @@ files:
 - lib/servactory/context/workspace/inputs.rb
 - lib/servactory/context/workspace/internals.rb
 - lib/servactory/context/workspace/outputs.rb
+- lib/servactory/dsl.rb
 - lib/servactory/engine.rb
 - lib/servactory/errors/base.rb
 - lib/servactory/errors/failure.rb
@@ -276,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: A set of tools for building reliable services of any complexity