servactory 2.12.0.rc1 → 2.12.0.rc3

data/lib/servactory/test_kit/rspec/matchers/have_service_input_matcher.rb

@@ -84,17 +84,26 @@ module Servactory
             self
           end
 
-          def consists_of(*types) # rubocop:disable Metrics/MethodLength
-            message = block_given? ? yield : nil
-
+          def consists_of(*types)
             add_submatcher(
               HaveServiceAttributeMatchers::ConsistsOfMatcher,
               described_class,
               :input,
               input_name,
               @option_types,
-              Array(types),
-              message
+              Array(types)
+            )
+            self
+          end
+
+          def schema(data = {})
+            add_submatcher(
+              HaveServiceAttributeMatchers::SchemaMatcher,
+              described_class,
+              :input,
+              input_name,
+              @option_types,
+              data
             )
             self
           end
@@ -132,6 +141,18 @@ module Servactory
             self
           end
 
+          def message(message)
+            add_submatcher(
+              HaveServiceAttributeMatchers::MessageMatcher,
+              described_class,
+              :input,
+              input_name,
+              @last_submatcher,
+              message
+            )
+            self
+          end
+
           # NOTE: Used for delayed chain implementation
           # def not_implemented_chain(*description)
           #   Kernel.warn <<-MESSAGE.squish
@@ -162,11 +183,12 @@ module Servactory
 
           protected
 
-          attr_reader :submatchers, :missing, :subject
+          attr_reader :last_submatcher, :submatchers, :missing, :subject
 
           def add_submatcher(matcher_class, *args)
             remove_submatcher(matcher_class)
-            submatchers << matcher_class.new(*args)
+            @last_submatcher = matcher_class.new(*args)
+            submatchers << @last_submatcher
           end
 
           def remove_submatcher(matcher_class)

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

@@ -5,6 +5,7 @@ module Servactory
     module Rspec
       module Matchers
         module HaveServiceInputMatchers
+          # DEPRECATED: This chain is planned to be decommissioned.
           class ValidWithMatcher # rubocop:disable Metrics/ClassLength
             attr_reader :missing_option
 
@@ -46,12 +47,13 @@ module Servactory
                         :attribute_data,
                         :i18n_root_key
 
-            def submatcher_passes?(_subject) # rubocop:disable Metrics/CyclomaticComplexity
+            def submatcher_passes?(_subject) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
               success_passes? &&
                 failure_type_passes? &&
                 failure_required_passes? &&
                 failure_optional_passes? &&
                 failure_consists_of_passes? &&
+                failure_schema_passes? &&
                 failure_format_passes? &&
                 failure_inclusion_passes? &&
                 failure_must_passes?
@@ -116,13 +118,18 @@ module Servactory
               true
             end
 
+            def failure_schema_passes?
+              # NOTE: Checking for negative cases is not implemented for `schema`
+              true
+            end
+
             def failure_format_passes?
               # NOTE: Checking for negative cases is not implemented for `format`
               true
             end
 
             def failure_inclusion_passes? # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-              input_inclusion_in = attribute_data.fetch(:inclusion).fetch(:in)
+              input_inclusion_in = attribute_data.fetch(:inclusion, {}).fetch(:in, nil)
 
               return true if input_inclusion_in.blank?
 
@@ -135,11 +142,11 @@ module Servactory
 
               if input_required_message.nil?
                 input_required_message = I18n.t(
-                  "#{i18n_root_key}.#{attribute_type_plural}.validations.inclusion.default_error",
+                  "#{i18n_root_key}.#{attribute_type_plural}.validations.must.dynamic_options.inclusion.default",
                   service_class_name: described_class.name,
                   "#{attribute_type}_name": attribute_name,
-                  "#{attribute_type}_inclusion": input_inclusion_in,
-                  value: wrong_value
+                  "#{attribute_type}_inclusion": input_inclusion_in.inspect,
+                  value: wrong_value.inspect
                 )
               elsif input_required_message.is_a?(Proc)
                 service_class = Struct.new(:class_name, keyword_init: true)

data/lib/servactory/test_kit/rspec/matchers/have_service_internal_matcher.rb

@@ -2,8 +2,10 @@
 
 require_relative "have_service_attribute_matchers/types_matcher"
 require_relative "have_service_attribute_matchers/consists_of_matcher"
+require_relative "have_service_attribute_matchers/schema_matcher"
 require_relative "have_service_attribute_matchers/inclusion_matcher"
 require_relative "have_service_attribute_matchers/must_matcher"
+require_relative "have_service_attribute_matchers/message_matcher"
 
 module Servactory
   module TestKit
@@ -50,17 +52,26 @@ module Servactory
             self
           end
 
-          def consists_of(*types) # rubocop:disable Metrics/MethodLength
-            message = block_given? ? yield : nil
-
+          def consists_of(*types)
             add_submatcher(
               HaveServiceAttributeMatchers::ConsistsOfMatcher,
               described_class,
               :internal,
               internal_name,
               @option_types,
-              Array(types),
-              message
+              Array(types)
+            )
+            self
+          end
+
+          def schema(data = {})
+            add_submatcher(
+              HaveServiceAttributeMatchers::SchemaMatcher,
+              described_class,
+              :internal,
+              internal_name,
+              @option_types,
+              data
             )
             self
           end
@@ -87,6 +98,18 @@ module Servactory
             self
           end
 
+          def message(message)
+            add_submatcher(
+              HaveServiceAttributeMatchers::MessageMatcher,
+              described_class,
+              :internal,
+              internal_name,
+              @last_submatcher,
+              message
+            )
+            self
+          end
+
           def description
             "#{internal_name} with #{submatchers.map(&:description).join(', ')}"
           end
@@ -107,11 +130,12 @@ module Servactory
 
           protected
 
-          attr_reader :submatchers, :missing, :subject
+          attr_reader :last_submatcher, :submatchers, :missing, :subject
 
           def add_submatcher(matcher_class, *args)
             remove_submatcher(matcher_class)
-            submatchers << matcher_class.new(*args)
+            @last_submatcher = matcher_class.new(*args)
+            submatchers << @last_submatcher
           end
 
           def remove_submatcher(matcher_class)

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Servactory
+  module ToolKit
+    module DynamicOptions
+      class Inclusion < Must
+        def self.use(option_name = :inclusion)
+          instance = new(option_name, :in)
+          instance.must(:be_inclusion)
+        end
+
+        def condition_for_input_with(input:, value:, option:)
+          if input.required? || (
+            input.optional? && !input.default.nil?
+          ) || (
+            input.optional? && !value.nil?
+          ) # do
+            return option.value.include?(value)
+          end
+
+          true
+        end
+
+        def condition_for_internal_with(value:, option:, **)
+          option.value.include?(value)
+        end
+
+        def condition_for_output_with(value:, option:, **)
+          option.value.include?(value)
+        end
+
+        ########################################################################
+
+        def message_for_input_with(service:, input:, value:, option_value:, **)
+          service.translate(
+            "inputs.validations.must.dynamic_options.inclusion.default",
+            input_name: input.name,
+            value: value.inspect,
+            input_inclusion: option_value.inspect
+          )
+        end
+
+        def message_for_internal_with(service:, internal:, value:, option_value:, **)
+          service.translate(
+            "internals.validations.must.dynamic_options.inclusion.default",
+            internal_name: internal.name,
+            value: value.inspect,
+            internal_inclusion: option_value.inspect
+          )
+        end
+
+        def message_for_output_with(service:, output:, value:, option_value:, **)
+          service.translate(
+            "outputs.validations.must.dynamic_options.inclusion.default",
+            output_name: output.name,
+            value: value.inspect,
+            output_inclusion: option_value.inspect
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Servactory
   module ToolKit
     module DynamicOptions
-      class Must
+      class Must # rubocop:disable Metrics/ClassLength
         class WorkOption
           attr_reader :name,
                       :value,
@@ -34,7 +34,11 @@ module Servactory
         def must(name)
           Servactory::Maintenance::Attributes::OptionHelper.new(
             name: @option_name,
-            equivalent: equivalent_with(name)
+            equivalent: equivalent_with(name),
+            meta: {
+              type: :dynamic_option,
+              body_key: @body_key
+            }
           )
         end
 
@@ -76,24 +80,48 @@ module Servactory
           is_option_message_present = option.message.present?
           is_option_message_proc = option.message.is_a?(Proc) if is_option_message_present
 
-          lambda do |input: nil, internal: nil, output: nil, **attributes|
+          lambda do |input: nil, internal: nil, output: nil, **attributes| # rubocop:disable Metrics/BlockLength
             default_attributes = { **attributes, option_name: option.name, option_value: option.value }
 
             if Servactory::Utils.really_input?(input)
               if is_option_message_present
-                is_option_message_proc ? option.message.call(**default_attributes, input:) : option.message
+                if is_option_message_proc
+                  option.message.call(
+                    input:,
+                    **default_attributes.delete(:meta) || {},
+                    **default_attributes
+                  )
+                else
+                  option.message
+                end
               else
                 message_for_input_with(**default_attributes, input:)
               end
             elsif Servactory::Utils.really_internal?(internal)
               if is_option_message_present
-                is_option_message_proc ? option.message.call(**default_attributes, internal:) : option.message
+                if is_option_message_proc
+                  option.message.call(
+                    internal:,
+                    **default_attributes.delete(:meta) || {},
+                    **default_attributes
+                  )
+                else
+                  option.message
+                end
               else
                 message_for_internal_with(**default_attributes, internal:)
               end
             elsif Servactory::Utils.really_output?(output)
               if is_option_message_present
-                is_option_message_proc ? option.message.call(**default_attributes, output:) : option.message
+                if is_option_message_proc
+                  option.message.call(
+                    output:,
+                    **default_attributes.delete(:meta) || {},
+                    **default_attributes
+                  )
+                else
+                  option.message
+                end
               else
                 message_for_output_with(**default_attributes, output:)
               end

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

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+module Servactory
+  module ToolKit
+    module DynamicOptions
+      class Schema < Must # rubocop:disable Metrics/ClassLength
+        RESERVED_ATTRIBUTES = %i[type required default].freeze
+        private_constant :RESERVED_ATTRIBUTES
+
+        def self.use(option_name = :schema, default_hash_mode_class_names:)
+          instance = new(option_name, :is, false)
+          instance.assign(default_hash_mode_class_names)
+          instance.must(:schema)
+        end
+
+        def assign(default_hash_mode_class_names)
+          @default_hash_mode_class_names = default_hash_mode_class_names
+        end
+
+        def condition_for_input_with(input:, value:, option:)
+          common_condition_with(attribute: input, value:, option:)
+        end
+
+        def condition_for_internal_with(internal:, value:, option:)
+          common_condition_with(attribute: internal, value:, option:)
+        end
+
+        def condition_for_output_with(output:, value:, option:)
+          common_condition_with(attribute: output, value:, option:)
+        end
+
+        def common_condition_with(attribute:, value:, option:)
+          return true if option.value == false
+          return [false, :wrong_type] if @default_hash_mode_class_names.intersection(attribute.types).empty?
+
+          schema = option.value.fetch(:is, option.value)
+
+          is_success, reason, meta = validate_for!(object: value, schema:)
+
+          prepare_object_with!(object: value, schema:) if is_success
+
+          [is_success, reason, meta]
+        end
+
+        def validate_for!(object:, schema:, root_schema_key: nil) # rubocop:disable Metrics/MethodLength
+          unless object.respond_to?(:fetch)
+            return [
+              false,
+              :wrong_element_value,
+              {
+                key_name: root_schema_key,
+                expected_type: Hash.name,
+                given_type: object.class.name
+              }
+            ]
+          end
+
+          errors = schema.map do |schema_key, schema_value|
+            attribute_type = schema_value.fetch(:type, String)
+
+            if attribute_type == Hash
+              validate_for!(
+                object: object.fetch(schema_key, {}),
+                schema: schema_value.except(*RESERVED_ATTRIBUTES),
+                root_schema_key: schema_key
+              )
+            else
+              is_success, given_type = validate_with(
+                object:,
+                schema_key:,
+                schema_value:,
+                attribute_type:,
+                attribute_required: schema_value.fetch(:required, true)
+              )
+
+              next if is_success
+
+              [false, :wrong_element_type, { key_name: schema_key, expected_type: attribute_type, given_type: }]
+            end
+          end
+
+          errors.compact.first || true
+        end
+
+        def validate_with(object:, schema_key:, schema_value:, attribute_type:, attribute_required:) # rubocop:disable Metrics/MethodLength
+          unless should_be_checked_for?(
+            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:, value:, required: attribute_required)
+
+          [
+            Array(attribute_type).uniq.any? { |type| prepared_value.is_a?(type) },
+            prepared_value.class.name
+          ]
+        end
+
+        def should_be_checked_for?(object:, schema_key:, schema_value:, required:)
+          required || (
+            !required && !fetch_default_from(schema_value).nil?
+          ) || (
+            !required && !object.fetch(schema_key, nil).nil?
+          )
+        end
+
+        def prepare_value_from(schema_value:, value:, required:)
+          if !required && !fetch_default_from(schema_value).nil? && value.blank?
+            fetch_default_from(schema_value)
+          else
+            value
+          end
+        end
+
+        def fetch_default_from(value)
+          value.fetch(:default, nil)
+        end
+
+        ########################################################################
+
+        def prepare_object_with!(object:, schema:) # rubocop:disable Metrics/MethodLength
+          schema.map do |schema_key, schema_value|
+            attribute_type = schema_value.fetch(:type, String)
+
+            if attribute_type == Hash
+              prepare_object_with!(
+                object: object.fetch(schema_key, {}),
+                schema: schema_value.except(*RESERVED_ATTRIBUTES)
+              )
+            else
+              next object unless object[schema_key].nil?
+
+              next object if (default = schema_value.fetch(:default, nil)).nil?
+
+              object[schema_key] = default
+            end
+          end
+        end
+
+        ########################################################################
+        ########################################################################
+        ########################################################################
+
+        def message_for_input_with(service:, input:, reason:, meta:, **)
+          i18n_key = "inputs.validations.must.dynamic_options.schema"
+          i18n_key += reason.present? ? ".#{reason}" : ".default"
+
+          service.translate(
+            i18n_key,
+            service_class_name: service.class_name,
+            input_name: input.name,
+            key_name: meta.fetch(:key_name),
+            expected_type: meta.fetch(:expected_type),
+            given_type: meta.fetch(:given_type)
+          )
+        end
+
+        def message_for_internal_with(service:, internal:, reason:, meta:, **)
+          i18n_key = "internals.validations.must.dynamic_options.schema"
+          i18n_key += reason.present? ? ".#{reason}" : ".default"
+
+          service.translate(
+            i18n_key,
+            service_class_name: service.class_name,
+            internal_name: internal.name,
+            key_name: meta.fetch(:key_name),
+            expected_type: meta.fetch(:expected_type),
+            given_type: meta.fetch(:given_type)
+          )
+        end
+
+        def message_for_output_with(service:, output:, reason:, meta:, **)
+          i18n_key = "outputs.validations.must.dynamic_options.schema"
+          i18n_key += reason.present? ? ".#{reason}" : ".default"
+
+          service.translate(
+            i18n_key,
+            service_class_name: service.class_name,
+            output_name: output.name,
+            key_name: meta.fetch(:key_name),
+            expected_type: meta.fetch(:expected_type),
+            given_type: meta.fetch(:given_type)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/servactory/version.rb

@@ -5,7 +5,7 @@ module Servactory
     MAJOR = 2
     MINOR = 12
     PATCH = 0
-    PRE = "rc1"
+    PRE = "rc3"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 2.12.0.rc1
+  version: 2.12.0.rc3
 platform: ruby
 authors:
 - Anton Sokolov
 bindir: bin
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -266,6 +266,7 @@ files:
 - lib/servactory/exceptions/internal.rb
 - lib/servactory/exceptions/output.rb
 - lib/servactory/exceptions/success.rb
+- lib/servactory/info/builder.rb
 - lib/servactory/info/dsl.rb
 - lib/servactory/info/result.rb
 - lib/servactory/inputs/collection.rb
@@ -291,15 +292,12 @@ files:
 - lib/servactory/maintenance/attributes/options_collection.rb
 - lib/servactory/maintenance/attributes/tools/check_errors.rb
 - lib/servactory/maintenance/attributes/tools/validation.rb
-- lib/servactory/maintenance/attributes/translator/inclusion.rb
 - lib/servactory/maintenance/attributes/translator/must.rb
 - lib/servactory/maintenance/attributes/translator/type.rb
 - lib/servactory/maintenance/attributes/validations/base.rb
 - lib/servactory/maintenance/attributes/validations/errors.rb
-- lib/servactory/maintenance/attributes/validations/inclusion.rb
 - lib/servactory/maintenance/attributes/validations/must.rb
 - lib/servactory/maintenance/attributes/validations/type.rb
-- lib/servactory/maintenance/validations/object_schema.rb
 - lib/servactory/maintenance/validations/types.rb
 - lib/servactory/outputs/collection.rb
 - lib/servactory/outputs/dsl.rb
@@ -311,7 +309,9 @@ files:
 - lib/servactory/test_kit/rspec/matchers.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/consists_of_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/inclusion_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/message_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/must_matcher.rb
+- lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/schema_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_attribute_matchers/types_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_input_matcher.rb
 - lib/servactory/test_kit/rspec/matchers/have_service_input_matchers/default_matcher.rb
@@ -322,10 +322,12 @@ files:
 - lib/servactory/test_kit/utils/faker.rb
 - lib/servactory/tool_kit/dynamic_options/consists_of.rb
 - lib/servactory/tool_kit/dynamic_options/format.rb
+- lib/servactory/tool_kit/dynamic_options/inclusion.rb
 - lib/servactory/tool_kit/dynamic_options/max.rb
 - lib/servactory/tool_kit/dynamic_options/min.rb
 - lib/servactory/tool_kit/dynamic_options/multiple_of.rb
 - lib/servactory/tool_kit/dynamic_options/must.rb
+- lib/servactory/tool_kit/dynamic_options/schema.rb
 - lib/servactory/utils.rb
 - lib/servactory/version.rb
 homepage: https://github.com/servactory/servactory

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

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