servactory 3.1.0.rc2 → 3.1.0.rc4

data/lib/servactory/tool_kit/dynamic_options/format.rb

@@ -72,7 +72,7 @@ module Servactory
       # Specify format directly as the option value:
       #
       # ```ruby
-      # class ValidateUserService < ApplicationService::Base
+      # class Users::Validate < ApplicationService::Base
       #   input :uuid, type: String, format: :uuid
       #   input :email, type: String, format: :email
       #   input :password, type: String, format: :password
@@ -179,7 +179,7 @@ module Servactory
         #
         # @param option_name [Symbol] The option name (default: :format)
         # @param formats [Hash] Custom format definitions to merge with defaults
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :format, formats: {})
           instance = new(option_name)
           instance.assign(formats)
@@ -232,7 +232,7 @@ module Servactory
         # @param internal [Object, nil] Internal attribute if applicable
         # @param output [Object, nil] Output attribute if applicable
         # @return [Boolean, Array] true if valid, or [false, reason]
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def common_condition_with(value:, option:, input: nil, internal: nil, output: nil)
           option_value = option.value&.to_sym
 
@@ -269,7 +269,6 @@ module Servactory
           # Run validator callback.
           option.properties.fetch(:validator, format_options.fetch(:validator)).call(value:)
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ########################################################################
 

data/lib/servactory/tool_kit/dynamic_options/inclusion.rb

@@ -20,7 +20,7 @@ module Servactory
       # Use in your service definition:
       #
       # ```ruby
-      # class CreateUserService < ApplicationService::Base
+      # class Users::Create < ApplicationService::Base
       #   input :role, type: String, inclusion: { in: %w[admin user guest] }
       #   input :status, type: Symbol, inclusion: { in: [:active, :inactive] }
       #   input :level, type: Integer, inclusion: { in: [1, 2, 3, 4, 5] }
@@ -32,7 +32,7 @@ module Servactory
       # Specify inclusion values directly:
       #
       # ```ruby
-      # class CreateUserService < ApplicationService::Base
+      # class Users::Create < ApplicationService::Base
       #   input :role, type: String, inclusion: %w[admin user guest]
       #   input :status, type: Symbol, inclusion: [:active, :inactive]
       #   input :level, type: Integer, inclusion: 1..10
@@ -87,7 +87,7 @@ module Servactory
         # Creates an Inclusion validator instance.
         #
         # @param option_name [Symbol] The option name (default: :inclusion)
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :inclusion)
           instance = new(option_name, :in)
           instance.must(:be_inclusion)

data/lib/servactory/tool_kit/dynamic_options/max.rb

@@ -35,7 +35,7 @@ module Servactory
       # Use in your service definition:
       #
       # ```ruby
-      # class ProcessDataService < ApplicationService::Base
+      # class Data::Process < ApplicationService::Base
       #   input :count, type: Integer, max: 100
       #   input :name, type: String, max: 255
       #   input :items, type: Array, max: 50
@@ -47,7 +47,7 @@ module Servactory
       # Specify maximum value directly:
       #
       # ```ruby
-      # class ProcessDataService < ApplicationService::Base
+      # class Data::Process < ApplicationService::Base
       #   input :count, type: Integer, max: 100
       #   input :name, type: String, max: 255
       #   input :items, type: Array, max: 50
@@ -97,7 +97,7 @@ module Servactory
         # Creates a Max validator instance.
         #
         # @param option_name [Symbol] The option name (default: :max)
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :max)
           new(option_name).must(:be_less_than_or_equal_to)
         end

data/lib/servactory/tool_kit/dynamic_options/min.rb

@@ -35,7 +35,7 @@ module Servactory
       # Use in your service definition:
       #
       # ```ruby
-      # class ProcessDataService < ApplicationService::Base
+      # class Data::Process < ApplicationService::Base
       #   input :age, type: Integer, min: 18
       #   input :password, type: String, min: 8
       #   input :tags, type: Array, min: 1
@@ -47,7 +47,7 @@ module Servactory
       # Specify minimum value directly:
       #
       # ```ruby
-      # class ProcessDataService < ApplicationService::Base
+      # class Data::Process < ApplicationService::Base
       #   input :age, type: Integer, min: 18
       #   input :password, type: String, min: 8
       #   input :tags, type: Array, min: 1
@@ -97,7 +97,7 @@ module Servactory
         # Creates a Min validator instance.
         #
         # @param option_name [Symbol] The option name (default: :min)
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :min)
           new(option_name).must(:be_greater_than_or_equal_to)
         end

data/lib/servactory/tool_kit/dynamic_options/multiple_of.rb

@@ -35,7 +35,7 @@ module Servactory
       # Use in your service definition:
       #
       # ```ruby
-      # class ProcessOrderService < ApplicationService::Base
+      # class Orders::Process < ApplicationService::Base
       #   input :quantity, type: Integer, multiple_of: 5
       #   input :price, type: Float, multiple_of: 0.25
       #   input :batch_size, type: Integer, multiple_of: 100
@@ -47,7 +47,7 @@ module Servactory
       # Specify divisor directly:
       #
       # ```ruby
-      # class ProcessOrderService < ApplicationService::Base
+      # class Orders::Process < ApplicationService::Base
       #   input :quantity, type: Integer, multiple_of: 5
       #   input :price, type: Float, multiple_of: 0.25
       #   input :batch_size, type: Integer, multiple_of: 100
@@ -93,14 +93,22 @@ module Servactory
       # ## Important Notes
       #
       # - Divisor must be a non-zero Numeric
-      # - Uses epsilon comparison for floating point precision
+      # - Integer, Rational and BigDecimal operands are checked exactly
+      # - Float operands are accepted when the remainder is within an epsilon
+      #   tolerance of zero or of the divisor, scaled by the absolute value
+      #   of the checked value
       # - Returns false for non-numeric values
       # - Provides specific error messages for blank and zero divisors
       class MultipleOf < Must
+        # Relative tolerance for Float remainders, scaled by the absolute
+        # value of the checked value.
+        FLOAT_TOLERANCE = Float::EPSILON * 2
+        private_constant :FLOAT_TOLERANCE
+
         # Creates a MultipleOf validator instance.
         #
         # @param option_name [Symbol] The option name (default: :multiple_of)
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :multiple_of)
           new(option_name).must(:be_multiple_of)
         end
@@ -148,14 +156,34 @@ module Servactory
             return false unless option.value.is_a?(Numeric)
             return false if option.value.zero?
 
-            # Calculate remainder with epsilon tolerance for floats.
-            remainder = value % option.value
-            remainder.zero? || remainder.abs < Float::EPSILON * [value.abs, option.value.abs].max
+            multiple_of?(value, option.value)
           else
             false
           end
         end
 
+        # Checks whether value is a multiple of divisor.
+        #
+        # Exact for Integer, Rational and BigDecimal operands. When either
+        # operand is a Float, the remainder of the absolute operands counts
+        # as a multiple when it is within the tolerance of zero or of the
+        # divisor, with the tolerance scaled by the absolute value of the
+        # checked value.
+        #
+        # @param value [Numeric] Value to check
+        # @param divisor [Numeric] Non-zero divisor
+        # @return [Boolean] true if value is multiple of divisor
+        def multiple_of?(value, divisor)
+          return (value % divisor).zero? unless value.is_a?(Float) || divisor.is_a?(Float)
+
+          remainder = value.abs % divisor.abs
+          return true if remainder.zero?
+          return false unless remainder.finite? && divisor.finite?
+
+          tolerance = FLOAT_TOLERANCE * value.abs
+          remainder <= tolerance || divisor.abs - remainder <= tolerance
+        end
+
         ########################################################################
 
         # Generates error message for input validation failure.

data/lib/servactory/tool_kit/dynamic_options/must.rb

@@ -152,7 +152,7 @@ module Servactory
           @body_fallback = body_fallback
         end
 
-        # Creates an OptionHelper for registration with Servactory.
+        # Creates an option helper for registration with Servactory.
         #
         # @param name [Symbol] Internal validation name
         # @return [Servactory::Maintenance::Options::Helper]
@@ -221,7 +221,7 @@ module Servactory
         #
         # @param option [WorkOption] Parsed option data
         # @return [Proc] Lambda that generates error message
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def must_content_message_with(option)
           is_option_message_present = option.message.present?
           is_option_message_proc = option.message.is_a?(Proc) if is_option_message_present
@@ -274,7 +274,6 @@ module Servactory
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ########################################################################
 

data/lib/servactory/tool_kit/dynamic_options/schema.rb

@@ -29,7 +29,7 @@ module Servactory
       # Define schema in your service:
       #
       # ```ruby
-      # class CreateUserService < ApplicationService::Base
+      # class Users::Create < ApplicationService::Base
       #   input :user_data,
       #         type: Hash,
       #         schema: {
@@ -49,7 +49,7 @@ module Servactory
       # Specify schema definition directly:
       #
       # ```ruby
-      # class CreateUserService < ApplicationService::Base
+      # class Users::Create < ApplicationService::Base
       #   input :user_data,
       #         type: Hash,
       #         schema: {
@@ -127,8 +127,9 @@ module Servactory
         # Creates a Schema validator instance.
         #
         # @param option_name [Symbol] The option name (default: :schema)
-        # @param default_hash_mode_class_names [Array<Class>] Valid Hash-like types
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @param default_hash_mode_class_names [Servactory::Configuration::HashMode::ClassNamesCollection]
+        #   Valid Hash-like types
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :schema, default_hash_mode_class_names:)
           instance = new(option_name, :is, false)
           instance.assign(default_hash_mode_class_names)
@@ -137,7 +138,8 @@ module Servactory
 
         # Assigns the list of valid Hash-compatible class names.
         #
-        # @param default_hash_mode_class_names [Array<Class>] Hash-like types to accept
+        # @param default_hash_mode_class_names [Servactory::Configuration::HashMode::ClassNamesCollection]
+        #   Hash-like types to accept
         # @return [void]
         def assign(default_hash_mode_class_names)
           @default_hash_mode_class_names = default_hash_mode_class_names
@@ -179,13 +181,15 @@ module Servactory
         # @param value [Object] Hash value to validate
         # @param option [WorkOption] Schema configuration
         # @return [Boolean, Array] true if valid, or [false, reason, meta]
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def common_condition_with(attribute:, value:, option:)
           # Schema disabled, skip validation.
           return true if option.value == false
 
           # Attribute type must be Hash-compatible.
-          return [false, :wrong_type] unless @default_hash_mode_class_names.intersect?(attribute.types)
+          unless @default_hash_mode_class_names.intersect?(attribute.types)
+            return [false, :wrong_type, wrong_type_meta_for(attribute:)]
+          end
 
           # Skip validation for blank optional values.
           if value.blank? && ((attribute.input? && attribute.optional?) || attribute.internal? || attribute.output?)
@@ -206,7 +210,19 @@ module Servactory
 
           [is_success, reason, meta]
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        # Builds failure metadata for an attribute whose type is not Hash-compatible.
+        #
+        # @param attribute [Object] The attribute being validated
+        # @return [Hash] Metadata with the Hash-compatible types as expected
+        #   and the declared attribute types as given
+        def wrong_type_meta_for(attribute:)
+          {
+            key_name: nil,
+            expected_type: @default_hash_mode_class_names.to_a.join(", "),
+            given_type: attribute.types.join(", ")
+          }
+        end
 
         # Recursively validates object against schema definition.
         #
@@ -229,16 +245,18 @@ module Servactory
           end
 
           # Validate each schema field.
-          errors = schema.map do |schema_key, schema_value|
+          schema.each do |schema_key, schema_value|
             attribute_type = schema_value.fetch(:type, String)
 
             if attribute_type == Hash
               # Recursively validate nested Hash.
-              validate_for!(
+              result = validate_for!(
                 object: object.fetch(schema_key, {}),
                 schema: schema_value.except(*RESERVED_OPTIONS),
                 root_schema_key: schema_key
               )
+
+              return result unless result == true
             else
               is_success, given_type = validate_with(
                 object:,
@@ -250,12 +268,11 @@ module Servactory
 
               next if is_success
 
-              [false, :wrong_element_type, { key_name: schema_key, expected_type: attribute_type, given_type: }]
+              return [false, :wrong_element_type, { key_name: schema_key, expected_type: attribute_type, given_type: }]
             end
           end
 
-          # Return first error or true.
-          errors.compact.first || true
+          true
         end
 
         # Validates a single field against its type specification.
@@ -277,11 +294,11 @@ module Servactory
             return true
           end
 
-          value = object[schema_key]
+          value = object.fetch(schema_key, nil)
           prepared_value = prepare_value_from(schema_value:, value:, required: attribute_required)
 
           [
-            Array(attribute_type).uniq.any? { |type| prepared_value.is_a?(type) },
+            Array(attribute_type).any? { |type| prepared_value.is_a?(type) },
             prepared_value.class.name
           ]
         end
@@ -297,7 +314,7 @@ module Servactory
           required || (
             !required && !fetch_default_from(schema_value).nil?
           ) || (
-            !required && !object[schema_key].nil?
+            !required && !object.fetch(schema_key, nil).nil?
           )
         end
 
@@ -330,19 +347,18 @@ module Servactory
         # @param object [Hash] Object to modify
         # @param schema [Hash] Schema definition
         # @return [void]
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        # rubocop:disable-next Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def prepare_object_with!(object:, schema:)
-          schema.map do |schema_key, schema_value|
+          schema.each do |schema_key, schema_value|
             attribute_type = schema_value.fetch(:type, String)
             required = schema_value.fetch(:required, true)
-            object_value = object[schema_key]
+            object_value = object.fetch(schema_key, nil)
 
             if attribute_type == Hash
               # Apply nested Hash defaults.
-              default_value = schema_value.fetch(:default, {})
-
-              if !required && !default_value.nil? && !Servactory::Utils.value_present?(object_value)
-                object[schema_key] = default_value
+              if !required && !Servactory::Utils.value_present?(object_value)
+                default_value = schema_value.key?(:default) ? schema_value[:default].deep_dup : {}
+                object[schema_key] = default_value unless default_value.nil?
               end
 
               # Recursively prepare nested objects.
@@ -360,14 +376,13 @@ module Servactory
 
               # Execute prepare callback if defined.
               unless (input_prepare = schema_value[:prepare]).nil?
-                object[schema_key] = input_prepare.call(value: object[schema_key])
+                object[schema_key] = input_prepare.call(value: object.fetch(schema_key, nil))
               end
 
               object
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ########################################################################
         ########################################################################

data/lib/servactory/tool_kit/dynamic_options/target.rb

@@ -37,8 +37,8 @@ module Servactory
       # Use in your service definition:
       #
       # ```ruby
-      # class ProcessOrderService < ApplicationService::Base
-      #   input :service_class, type: Class, target: UserService
+      # class Orders::Process < ApplicationService::Base
+      #   input :service_class, type: Class, target: Payments::Charge
       #   input :handler_class, type: Class, target: [CreateHandler, UpdateHandler]
       # end
       # ```
@@ -48,7 +48,7 @@ module Servactory
       # Specify target class directly or as an array:
       #
       # ```ruby
-      # input :service_class, type: Class, target: UserService
+      # input :service_class, type: Class, target: Payments::Charge
       # input :handler_class, type: Class, target: [CreateHandler, UpdateHandler]
       # ```
       #
@@ -100,7 +100,7 @@ module Servactory
         # Creates a Target validator instance.
         #
         # @param option_name [Symbol] The option name (default: :target)
-        # @return [Servactory::Maintenance::Attributes::OptionHelper]
+        # @return [Servactory::Maintenance::Options::Helper]
         def self.use(option_name = :target)
           instance = new(option_name, :in)
           instance.must(:"be_#{option_name}")

data/lib/servactory/utils.rb

@@ -5,13 +5,17 @@ module Servactory
     extend self
 
     def adapt(data)
-      if defined?(Datory::Base) && data.is_a?(Datory::Base)
-        data = Servactory::Utils.send(:instance_variables_to_hash_from, data)
-      end
+      data = instance_variables_to_hash_from(data) if datory?(data)
 
       data.symbolize_keys
     end
 
+    # @param data [Object]
+    # @return [Boolean] True if #adapt accepts the data as service arguments
+    def adaptable?(data)
+      data.is_a?(Hash) || datory?(data)
+    end
+
     def define_attribute_with(input: nil, internal: nil, output: nil)
       return input if really_input?(input)
       return internal if really_internal?(internal)
@@ -108,6 +112,12 @@ module Servactory
 
     private
 
+    def datory?(data)
+      return false unless defined?(Datory::Base)
+
+      data.is_a?(Datory::Base)
+    end
+
     def instance_variables_to_hash_from(data) # rubocop:disable Metrics/MethodLength
       data.instance_variables.to_h do |key|
         value = data.instance_variable_get(key)

data/lib/servactory/version.rb

@@ -5,7 +5,7 @@ module Servactory
     MAJOR = 3
     MINOR = 1
     PATCH = 0
-    PRE = "rc2"
+    PRE = "rc4"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

data/lib/servactory.rb

@@ -2,6 +2,8 @@
 
 require "zeitwerk"
 
+require "forwardable"
+
 require "stroma"
 
 require "active_support/all"
@@ -10,16 +12,13 @@ require "uri"
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/generators")
+loader.ignore("#{__dir__}/servactory/engine.rb")
 loader.ignore("#{__dir__}/servactory/test_kit/rspec")
 loader.inflector.inflect(
   "dsl" => "DSL"
 )
 loader.setup
 
-# Eager load DSL to initialize Stroma::Registry.
-# Registry must be populated before any service class is defined.
-require_relative "servactory/dsl"
-
 module Servactory; end
 
 require "servactory/engine" if defined?(Rails::Engine)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 3.1.0.rc2
+  version: 3.1.0.rc4
 platform: ruby
 authors:
 - Anton Sokolov
@@ -43,14 +43,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +190,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
 - config/locales/de.yml
@@ -191,6 +198,7 @@ files:
 - config/locales/es.yml
 - config/locales/fr.yml
 - config/locales/it.yml
+- config/locales/ja.yml
 - config/locales/ru.yml
 - lib/generators/README.md
 - lib/generators/servactory/base.rb
@@ -290,20 +298,28 @@ files:
 - lib/servactory/test_kit/rspec/helpers/argument_matchers.rb
 - lib/servactory/test_kit/rspec/helpers/concerns/error_messages.rb
 - lib/servactory/test_kit/rspec/helpers/concerns/service_class_validation.rb
+- lib/servactory/test_kit/rspec/helpers/exception_validator.rb
 - lib/servactory/test_kit/rspec/helpers/fluent.rb
 - lib/servactory/test_kit/rspec/helpers/input_validator.rb
 - lib/servactory/test_kit/rspec/helpers/legacy.rb
 - lib/servactory/test_kit/rspec/helpers/mock_executor.rb
 - lib/servactory/test_kit/rspec/helpers/output_validator.rb
+- lib/servactory/test_kit/rspec/helpers/service_inputs_guard.rb
+- lib/servactory/test_kit/rspec/helpers/service_inputs_matcher.rb
 - lib/servactory/test_kit/rspec/helpers/service_mock_builder.rb
 - lib/servactory/test_kit/rspec/helpers/service_mock_config.rb
+- lib/servactory/test_kit/rspec/helpers/wrap_block_adapter.rb
 - lib/servactory/test_kit/rspec/matchers.rb
 - lib/servactory/test_kit/rspec/matchers/base/attribute_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/base/message_expectation.rb
 - lib/servactory/test_kit/rspec/matchers/base/submatcher.rb
 - lib/servactory/test_kit/rspec/matchers/base/submatcher_context.rb
 - lib/servactory/test_kit/rspec/matchers/base/submatcher_registry.rb
 - lib/servactory/test_kit/rspec/matchers/concerns/attribute_data_access.rb
 - lib/servactory/test_kit/rspec/matchers/concerns/error_message_builder.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/option_helper_rules.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/proc_message.rb
+- lib/servactory/test_kit/rspec/matchers/concerns/required_message.rb
 - lib/servactory/test_kit/rspec/matchers/concerns/value_comparison.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_input_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_internal_matcher.rb
@@ -357,7 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.21
 specification_version: 4
 summary: A set of tools for building reliable services of any complexity
 test_files: []