servactory 2.6.3 → 2.8.0

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

@@ -10,11 +10,11 @@ module Servactory
           def default_message
             lambda do |service:, attribute:, key_name:, expected_type:, given_type:, **|
               if attribute.hash_mode? && key_name.present?
-                for_hash_mode_with(service: service, attribute: attribute, key_name: key_name,
-                                   expected_type: expected_type, given_type: given_type)
+                for_hash_mode_with(service:, attribute:, key_name:,
+                                   expected_type:, given_type:)
               else
-                for_others_with(service: service, attribute: attribute,
-                                expected_type: expected_type, given_type: given_type)
+                for_others_with(service:, attribute:,
+                                expected_type:, given_type:)
               end
             end
           end
@@ -27,9 +27,9 @@ module Servactory
             if hash_message.is_a?(Proc)
               hash_message.call(
                 **Servactory::Utils.fetch_hash_with_desired_attribute(attribute),
-                key_name: key_name,
-                expected_type: expected_type,
-                given_type: given_type
+                key_name:,
+                expected_type:,
+                given_type:
               )
             elsif hash_message.is_a?(String) && hash_message.present?
               hash_message
@@ -37,9 +37,9 @@ module Servactory
               service.translate(
                 "#{attribute.i18n_name}.validations.type.default_error.for_hash.wrong_element_type",
                 "#{attribute.system_name}_name": attribute.name,
-                key_name: key_name,
-                expected_type: expected_type,
-                given_type: given_type
+                key_name:,
+                expected_type:,
+                given_type:
               )
             end
           end
@@ -48,8 +48,8 @@ module Servactory
             service.translate(
               "#{attribute.i18n_name}.validations.type.default_error.default",
               "#{attribute.system_name}_name": attribute.name,
-              expected_type: expected_type,
-              given_type: given_type
+              expected_type:,
+              given_type:
             )
           end
         end

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

@@ -8,7 +8,7 @@ module Servactory
           def self.check(context:, attribute:, value:, check_key:, **)
             return unless should_be_checked_for?(attribute, value, check_key)
 
-            new(context: context, attribute: attribute, value: value).check
+            new(context:, attribute:, value:).check
           end
 
           # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

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

@@ -8,7 +8,7 @@ module Servactory
           def self.check(context:, attribute:, value:, check_key:, check_options:)
             return unless should_be_checked_for?(attribute, check_key)
 
-            new(context: context, attribute: attribute, value: value, check_options: check_options).check
+            new(context:, attribute:, value:, check_options:).check
           end
 
           def self.should_be_checked_for?(attribute, check_key)
@@ -64,23 +64,23 @@ module Servactory
 
           def add_error_with(message, code, reason)
             add_error(
-              message: message,
+              message:,
               service: @context.send(:servactory_service_info),
               **Servactory::Utils.fetch_hash_with_desired_attribute(@attribute),
               value: @value,
-              code: code,
-              reason: reason
+              code:,
+              reason:
             )
           end
 
           def add_syntax_error_with(message, code, exception_message)
             add_error(
-              message: message,
+              message:,
               service: @context.send(:servactory_service_info),
               **Servactory::Utils.fetch_hash_with_desired_attribute(@attribute),
               value: @value,
-              code: code,
-              exception_message: exception_message
+              code:,
+              exception_message:
             )
           end
         end

data/lib/servactory/maintenance/attributes/validations/type.rb

@@ -8,7 +8,7 @@ module Servactory
           def self.check(context:, attribute:, value:, check_key:, **)
             return unless should_be_checked_for?(attribute, value, check_key)
 
-            new(context: context, attribute: attribute, value: value).check
+            new(context:, attribute:, value:).check
           end
 
           # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

data/lib/servactory/maintenance/validations/object_schema.rb

@@ -49,10 +49,10 @@ module Servactory
               )
             else
               is_success = validate_with(
-                object: object,
-                schema_key: schema_key,
-                schema_value: schema_value,
-                attribute_type: attribute_type,
+                object:,
+                schema_key:,
+                schema_value:,
+                attribute_type:,
                 attribute_required: schema_value.fetch(:required, true)
               )
 
@@ -69,16 +69,16 @@ module Servactory
 
         def validate_with(object:, schema_key:, schema_value:, attribute_type:, attribute_required:) # rubocop:disable Metrics/MethodLength
           unless should_be_checked_for?(
-            object: object,
-            schema_key: schema_key,
-            schema_value: schema_value,
+            object:,
+            schema_key:,
+            schema_value:,
             required: attribute_required
           ) # do
             return true
           end
 
           value = object.fetch(schema_key, nil)
-          prepared_value = prepare_value_from(schema_value: schema_value, value: value, required: attribute_required)
+          prepared_value = prepare_value_from(schema_value:, value:, required: attribute_required)
 
           Array(attribute_type).any? { |type| prepared_value.is_a?(type) }
         end
@@ -105,9 +105,9 @@ module Servactory
 
         def add_error(key_name:, expected_type:, given_type:)
           @errors << {
-            key_name: key_name,
-            expected_type: expected_type,
-            given_type: given_type
+            key_name:,
+            expected_type:,
+            given_type:
           }
         end
       end

data/lib/servactory/outputs/output.rb

@@ -36,11 +36,11 @@ module Servactory
         @hash_mode_class_names = hash_mode_class_names
         @option_helpers = option_helpers
 
-        register_options(helpers: helpers, options: options)
+        register_options(helpers:, options:)
       end
 
       def method_missing(name, *args, &block)
-        option = @collection_of_options.find_by(name: name)
+        option = @collection_of_options.find_by(name:)
 
         return super if option.nil?
 
@@ -54,13 +54,13 @@ module Servactory
       def register_options(helpers:, options:) # rubocop:disable Metrics/MethodLength
         advanced_helpers = options.except(*Servactory::Maintenance::Attributes::Options::Registrar::RESERVED_OPTIONS)
 
-        options = apply_helpers_for_options(helpers: helpers, options: options) if helpers.present?
-        options = apply_helpers_for_options(helpers: advanced_helpers, options: options) if advanced_helpers.present?
+        options = apply_helpers_for_options(helpers:, options:) if helpers.present?
+        options = apply_helpers_for_options(helpers: advanced_helpers, options:) if advanced_helpers.present?
 
         options_registrar = Servactory::Maintenance::Attributes::Options::Registrar.register(
           attribute: self,
           hash_mode_class_names: @hash_mode_class_names,
-          options: options,
+          options:,
           features: {
             types: true,
             hash: true,

data/lib/servactory/result.rb

@@ -27,12 +27,15 @@ module Servactory
 
     ############################################################################
 
+    STATE_PREDICATE_NAMES = %i[success? failure?].freeze
+    private_constant :STATE_PREDICATE_NAMES
+
     def self.success_for(context:)
-      new(context: context).send(:as_success)
+      new(context:).send(:as_success)
     end
 
     def self.failure_for(context:, exception:)
-      new(context: context, exception: exception).send(:as_failure)
+      new(context:, exception:).send(:as_failure)
     end
 
     def initialize(context:, exception: nil)
@@ -40,18 +43,26 @@ module Servactory
       @exception = exception
     end
 
+    def to_h
+      filtered = methods(false).filter do |key|
+        !key.in?(STATE_PREDICATE_NAMES) && !key.to_s.end_with?("?")
+      end
+
+      filtered.to_h { |key| [key, public_send(key)] }.compact
+    end
+
     def inspect
       "#<#{self.class.name} #{draw_result}>"
     end
 
     def on_success
-      yield(outputs: outputs) if success?
+      yield(outputs:) if success?
 
       self
     end
 
     def on_failure(type = :all)
-      yield(outputs: outputs, exception: @exception) if failure? && [:all, @exception&.type].include?(type)
+      yield(outputs:, exception: @exception) if failure? && [:all, @exception&.type].include?(type)
 
       self
     end

data/lib/servactory/test_kit/result.rb

@@ -6,13 +6,13 @@ module Servactory
       def self.as_success(attributes = {})
         context = new(attributes)
 
-        Servactory::Result.success_for(context: context)
+        Servactory::Result.success_for(context:)
       end
 
       def self.as_failure(attributes = {}, exception: nil)
         context = new(attributes)
 
-        Servactory::Result.failure_for(context: context, exception: exception)
+        Servactory::Result.failure_for(context:, exception:)
       end
 
       def initialize(attributes = {})

data/lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/valid_with_matcher.rb

@@ -148,7 +148,7 @@ module Servactory
                 input_actor = attribute_data.fetch(:actor)
 
                 input_required_message = input_required_message.call(
-                  service: service,
+                  service:,
                   input: input_actor,
                   value: wrong_value
                 )

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

@@ -15,15 +15,15 @@ module Servactory
         end
 
         def condition_for_input_with(input:, value:, option:)
-          common_condition_with(attribute: input, value: value, option: option)
+          common_condition_with(attribute: input, value:, option:)
         end
 
         def condition_for_internal_with(internal:, value:, option:)
-          common_condition_with(attribute: internal, value: value, option: option)
+          common_condition_with(attribute: internal, value:, option:)
         end
 
         def condition_for_output_with(output:, value:, option:)
-          common_condition_with(attribute: output, value: value, option: option)
+          common_condition_with(attribute: output, value:, option:)
         end
 
         def common_condition_with(attribute:, value:, option:)
@@ -32,15 +32,13 @@ module Servactory
 
           values = value.respond_to?(:flatten) ? value&.flatten : value
 
-          validate_for!(attribute: attribute, values: values, option: option)
+          validate_for!(attribute:, values:, option:)
         end
 
         def validate_for!(attribute:, values:, option:)
           consists_of_types = Array(option.value)
 
-          if fails_presence_validation?(attribute: attribute, values: values, consists_of_types: consists_of_types)
-            return [false, :required]
-          end
+          return [false, :required] if fails_presence_validation?(attribute:, values:, consists_of_types:)
 
           return true if values.blank? && attribute.input? && attribute.optional?
 
@@ -65,7 +63,7 @@ module Servactory
 
         ########################################################################
 
-        def message_for_input_with(service:, input:, value:, option_value:, reason:, **)
+        def message_for_input_with(service:, input:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "inputs.validations.must.dynamic_options.consists_of"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
@@ -73,12 +71,13 @@ module Servactory
             i18n_key,
             service_class_name: service.class_name,
             input_name: input.name,
+            option_name:,
             expected_type: Array(option_value).uniq.join(", "),
-            given_type: given_type_for(values: value, option_value: option_value)
+            given_type: given_type_for(values: value, option_value:)
           )
         end
 
-        def message_for_internal_with(service:, internal:, value:, option_value:, reason:, **)
+        def message_for_internal_with(service:, internal:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "internals.validations.must.dynamic_options.consists_of"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
@@ -86,12 +85,13 @@ module Servactory
             i18n_key,
             service_class_name: service.class_name,
             internal_name: internal.name,
+            option_name:,
             expected_type: Array(option_value).uniq.join(", "),
-            given_type: given_type_for(values: value, option_value: option_value)
+            given_type: given_type_for(values: value, option_value:)
           )
         end
 
-        def message_for_output_with(service:, output:, value:, option_value:, reason:, **)
+        def message_for_output_with(service:, output:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "outputs.validations.must.dynamic_options.consists_of"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
@@ -99,8 +99,9 @@ module Servactory
             i18n_key,
             service_class_name: service.class_name,
             output_name: output.name,
+            option_name:,
             expected_type: Array(option_value).uniq.join(", "),
-            given_type: given_type_for(values: value, option_value: option_value)
+            given_type: given_type_for(values: value, option_value:)
           )
         end
 

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

@@ -88,7 +88,7 @@ module Servactory
 
           return [false, :unknown] unless @formats.key?(option_value)
 
-          attribute = Utils.define_attribute_with(input: input, internal: internal, output: output)
+          attribute = Utils.define_attribute_with(input:, internal:, output:)
 
           if value.blank? &&
              (
@@ -107,44 +107,47 @@ module Servactory
 
           return [false, :wrong_pattern] if format_pattern.present? && !value.match?(Regexp.compile(format_pattern))
 
-          option.properties.fetch(:validator, format_options.fetch(:validator)).call(value: value)
+          option.properties.fetch(:validator, format_options.fetch(:validator)).call(value:)
         end
         # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         ########################################################################
 
-        def message_for_input_with(service:, input:, value:, option_value:, reason:, **)
+        def message_for_input_with(service:, input:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "inputs.validations.must.dynamic_options.format"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
           service.translate(
             i18n_key,
             input_name: input.name,
-            value: value,
+            value:,
+            option_name:,
             format_name: option_value.present? ? option_value : option_value.inspect
           )
         end
 
-        def message_for_internal_with(service:, internal:, value:, option_value:, reason:, **)
+        def message_for_internal_with(service:, internal:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "internals.validations.must.dynamic_options.format"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
           service.translate(
             i18n_key,
             internal_name: internal.name,
-            value: value,
+            value:,
+            option_name:,
             format_name: option_value.present? ? option_value : option_value.inspect
           )
         end
 
-        def message_for_output_with(service:, output:, value:, option_value:, reason:, **)
+        def message_for_output_with(service:, output:, value:, option_name:, option_value:, reason:, **)
           i18n_key = "outputs.validations.must.dynamic_options.format"
           i18n_key += reason.present? ? ".#{reason}" : ".default"
 
           service.translate(
             i18n_key,
             output_name: output.name,
-            value: value,
+            value:,
+            option_name:,
             format_name: option_value.present? ? option_value : option_value.inspect
           )
         end

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

@@ -33,30 +33,33 @@ module Servactory
 
         ########################################################################
 
-        def message_for_input_with(service:, input:, value:, option_value:, **)
+        def message_for_input_with(service:, input:, value:, option_name:, option_value:, **)
           service.translate(
             "inputs.validations.must.dynamic_options.max.default",
             input_name: input.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
 
-        def message_for_internal_with(service:, internal:, value:, option_value:, **)
+        def message_for_internal_with(service:, internal:, value:, option_name:, option_value:, **)
           service.translate(
             "internals.validations.must.dynamic_options.max.default",
             internal_name: internal.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
 
-        def message_for_output_with(service:, output:, value:, option_value:, **)
+        def message_for_output_with(service:, output:, value:, option_name:, option_value:, **)
           service.translate(
             "outputs.validations.must.dynamic_options.max.default",
             output_name: output.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
       end

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

@@ -33,30 +33,33 @@ module Servactory
 
         ########################################################################
 
-        def message_for_input_with(service:, input:, value:, option_value:, **)
+        def message_for_input_with(service:, input:, value:, option_name:, option_value:, **)
           service.translate(
             "inputs.validations.must.dynamic_options.min.default",
             input_name: input.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
 
-        def message_for_internal_with(service:, internal:, value:, option_value:, **)
+        def message_for_internal_with(service:, internal:, value:, option_name:, option_value:, **)
           service.translate(
             "internals.validations.must.dynamic_options.min.default",
             internal_name: internal.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
 
-        def message_for_output_with(service:, output:, value:, option_value:, **)
+        def message_for_output_with(service:, output:, value:, option_name:, option_value:, **)
           service.translate(
             "outputs.validations.must.dynamic_options.min.default",
             output_name: output.name,
-            value: value,
-            option_value: option_value
+            value:,
+            option_name:,
+            option_value:
           )
         end
       end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Servactory
+  module ToolKit
+    module DynamicOptions
+      class MultipleOf < Must
+        def self.use(option_name = :multiple_of)
+          new(option_name).must(:be_multiple_of)
+        end
+
+        def condition_for_input_with(...)
+          common_condition_with(...)
+        end
+
+        def condition_for_internal_with(...)
+          common_condition_with(...)
+        end
+
+        def condition_for_output_with(...)
+          common_condition_with(...)
+        end
+
+        def common_condition_with(value:, option:, **)
+          case value
+          when Integer, Float, Rational, BigDecimal
+            return false if option.value.blank?
+            return false unless [Numeric, Float, Rational, BigDecimal].any? { |c| option.value.is_a?(c) }
+            return false if option.value.zero?
+
+            (value % option.value).zero?
+          else
+            false
+          end
+        end
+
+        ########################################################################
+
+        def message_for_input_with(service:, input:, value:, option_name:, option_value:, **) # rubocop:disable Metrics/MethodLength
+          i18n_key = "inputs.validations.must.dynamic_options.multiple_of"
+
+          i18n_key += if option_value.blank?
+                        ".blank"
+                      elsif [Numeric, Float, Rational, BigDecimal].any? { |c| option_value.is_a?(c) } &&
+                            option_value.zero?
+                        ".divided_by_0"
+                      else
+                        ".default"
+                      end
+
+          service.translate(
+            i18n_key,
+            input_name: input.name,
+            value:,
+            option_name:,
+            option_value: option_value.inspect
+          )
+        end
+
+        def message_for_internal_with(service:, internal:, value:, option_name:, option_value:, **) # rubocop:disable Metrics/MethodLength
+          i18n_key = "internals.validations.must.dynamic_options.multiple_of"
+
+          i18n_key += if option_value.blank?
+                        ".blank"
+                      elsif [Numeric, Float, Rational, BigDecimal].any? { |c| option_value.is_a?(c) } &&
+                            option_value.zero?
+                        ".divided_by_0"
+                      else
+                        ".default"
+                      end
+
+          service.translate(
+            i18n_key,
+            internal_name: internal.name,
+            value:,
+            option_name:,
+            option_value: option_value.inspect
+          )
+        end
+
+        def message_for_output_with(service:, output:, value:, option_name:, option_value:, **) # rubocop:disable Metrics/MethodLength
+          i18n_key = "outputs.validations.must.dynamic_options.multiple_of"
+
+          i18n_key += if option_value.blank?
+                        ".blank"
+                      elsif [Numeric, Float, Rational, BigDecimal].any? { |c| option_value.is_a?(c) } &&
+                            option_value.zero?
+                        ".divided_by_0"
+                      else
+                        ".default"
+                      end
+
+          service.translate(
+            i18n_key,
+            output_name: output.name,
+            value:,
+            option_name:,
+            option_value: option_value.inspect
+          )
+        end
+      end
+    end
+  end
+end