smart_schema 0.12.0 → 0.12.1

data/lib/smart_core/schema/checker/reconciler/matcher/result_finalizer.rb

@@ -1,186 +0,0 @@
-# frozen_string_literal: true
-
-# TODO: refactor error data propagating (with Value Object)
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
-  # @return [Proc]
-  #
-  # @api private
-  # @since 0.1.0
-  ERRORS_CONTAINER_BUILDER = -> { Hash.new { |hash, key| hash[key] = Set.new } }
-
-  # @return [Proc]
-  #
-  # @api private
-  # @since 0.1.0
-  EXTRA_KEYS_CONTAINER_BUILDER = -> { Set.new }
-
-  # @return [Proc]
-  #
-  # @api private
-  # @since 0.3.0
-  SPREAD_KEYS_CONTAINER_BUILDER = -> { Set.new }
-
-  # @return [Symbol]
-  #
-  # @api private
-  # @since 0.2.0
-  EXTRA_KEY_ERROR_CODE = :extra_key
-
-  class << self
-    # @param result [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    # @return [SmartCore::Schema::Result]
-    #
-    # @ai privates
-    # @since 0.1.0
-    # @version 0.3.0
-    # rubocop:disable Layout/LineLength
-    def finalize(result)
-      schema_errors, extra_keys, spread_keys = aggregate_errors(result)
-      schema_errors, extra_keys, spread_keys = compile_errors(schema_errors, extra_keys, spread_keys)
-      build_final_result(result, schema_errors, extra_keys, spread_keys)
-    end
-    # rubocop:enable Layout/LineLength
-
-    private
-
-    # @param result [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    # @param schema_errors [Hash<String,Array<Symbol>>]
-    # @param extra_keys [Set<String>]
-    # @param spread_keys [Set<String>]
-    # @return [SmartCore::Schema::Result]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def build_final_result(result, schema_errors, extra_keys, spread_keys)
-      SmartCore::Schema::Result.new(
-        result.verifiable_hash.source,
-        schema_errors.freeze,
-        extra_keys.freeze,
-        SPREAD_KEYS_CONTAINER_BUILDER.call.freeze # TODO: spread_keys.freeze
-      )
-    end
-
-    # @param result [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    # @return [Array<Hash<String,Any>,Set<String>>]
-    #
-    # @api private
-    # @since 0.1.0
-    def aggregate_errors(result)
-      schema_errors = ERRORS_CONTAINER_BUILDER.call
-      extra_keys = EXTRA_KEYS_CONTAINER_BUILDER.call
-      spread_keys = SPREAD_KEYS_CONTAINER_BUILDER.call
-
-      result.each_result do |concrete_result|
-        case concrete_result
-        when SmartCore::Schema::Checker::Rules::Verifier::Result
-          aggregate_verifier_errors(concrete_result, schema_errors)
-        when SmartCore::Schema::Checker::Rules::ExtraKeys::Failure
-          aggregate_extra_keys_errors(concrete_result, extra_keys)
-        when SmartCore::Schema::Checker::Rules::ExtraKeys::Success
-          aggregate_spread_keys_notice(concrete_result, spread_keys)
-        end
-      end
-
-      [schema_errors, extra_keys, spread_keys]
-    end
-
-    # @param result [SmartCore::Schema::Checker::Rules::Verifier::Result]
-    # @param errors [Hash<String,Array<String>|Hash<String,Hash>>]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def aggregate_verifier_errors(result, errors)
-      result.each_result do |concrete_result|
-        case concrete_result
-        when SmartCore::Schema::Checker::Reconciler::Matcher::Result
-          sub_schema_errors, sub_extra_keys = aggregate_errors(concrete_result)
-          errors[result.key] << [sub_schema_errors, sub_extra_keys]
-        when SmartCore::Schema::Checker::Rules::Requirement::Result
-          errors[concrete_result.key] << concrete_result.error if concrete_result.failure?
-        when SmartCore::Schema::Checker::Rules::Result::Failure
-          errors[concrete_result.key] << concrete_result.error
-        end
-      end
-    end
-
-    # @param result [SmartCore::Schema::Checker::Rules::ExtraKeys::Failure]
-    # @param extra_keys [Set<String>]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def aggregate_extra_keys_errors(result, extra_keys)
-      extra_keys.merge(result.extra_keys)
-    end
-
-    # @param result [SmartCore::Schema::Checker::Rules::ExtraKeys::Success]
-    # @param spread_keys [Set<String>]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.3.0
-    def aggregate_spread_keys_notice(result, spread_keys)
-      spread_keys.merge(result.spread_keys)
-    end
-
-    # @param errors [Hash]
-    # @param extra_keys [Set]
-    # @param spread_keys [Set]
-    # @param initial_error_key [NilClass, String]
-    # @return [Array<Hash<String,Set<Symbol>>,Set<String>]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-    def compile_errors(errors, extra_keys, spread_keys, initial_error_key = nil)
-      compiled_errors = ERRORS_CONTAINER_BUILDER.call
-      compiled_extra_keys = EXTRA_KEYS_CONTAINER_BUILDER.call
-      compiled_spread_keys = SPREAD_KEYS_CONTAINER_BUILDER.call
-
-      compiled_extra_keys.merge(extra_keys).map! do |key|
-        # dot-notated nested keys
-        initial_error_key ? "#{initial_error_key}.#{key}" : key
-      end
-
-      compiled_spread_keys.merge(spread_keys).map! do |key|
-        # dot-notated nested keys
-        initial_error_key ? "#{initial_error_key}.#{key}" : key
-      end
-
-      errors.each_pair do |key, error_set|
-        # dot-notated nested key
-        compiled_key = initial_error_key ? "#{initial_error_key}.#{key}" : key
-
-        error_set.each do |error|
-          case error
-          when Symbol # error code
-            compiled_errors[compiled_key] << error
-          when Array # nested errors
-            sub_errors, sub_extra_keys = error
-            sub_spread_keys = SPREAD_KEYS_CONTAINER_BUILDER.call
-            compiled_sub_errors, compiled_sub_extra_keys, compiled_sub_spread_keys = compile_errors(
-              sub_errors, sub_extra_keys, sub_spread_keys, compiled_key
-            )
-            compiled_errors.merge!(compiled_sub_errors)
-            compiled_extra_keys.merge(compiled_sub_extra_keys)
-            compiled_spread_keys.merge(compiled_sub_spread_keys)
-          end
-        end
-      end
-
-      compiled_extra_keys.each do |compiled_extra_key|
-        compiled_errors[compiled_extra_key] << EXTRA_KEY_ERROR_CODE
-      end
-
-      [compiled_errors, compiled_extra_keys, compiled_spread_keys]
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
-  end
-end

data/lib/smart_core/schema/checker/reconciler/matcher.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-module SmartCore::Schema::Checker::Reconciler::Matcher
-  require_relative 'matcher/options'
-  require_relative 'matcher/result'
-  require_relative 'matcher/result_finalizer'
-
-  class << self
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def match(reconciler, verifiable_hash)
-      matcher_options = Options.build_from(reconciler)
-
-      Result.new(verifiable_hash).tap do |result|
-        match_for_contract_keys(reconciler, matcher_options, verifiable_hash, result)
-        match_for_extra_keys(reconciler, matcher_options, verifiable_hash, result)
-      end
-    end
-
-    private
-
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @param result [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def match_for_contract_keys(reconciler, matcher_options, verifiable_hash, result)
-      reconciler.__contract_rules.each_rule do |rule|
-        verification_result = rule.__verify!(verifiable_hash, matcher_options)
-        result.contract_key_result(verification_result)
-      end
-    end
-
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @param result [SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def match_for_extra_keys(reconciler, matcher_options, verifiable_hash, result)
-      verification_result = reconciler.__extra_keys_contract.__verify!(
-        verifiable_hash, reconciler.__contract_rules, matcher_options
-      )
-      result.extra_keys_result(verification_result)
-    end
-  end
-end

data/lib/smart_core/schema/checker/reconciler.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::Reconciler
-  require_relative 'reconciler/constructor'
-  require_relative 'reconciler/matcher'
-
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  def initialize
-    @rules = SmartCore::Schema::Checker::Rules.new
-    @strict = Constructor::DEFAULT_STRICT_BEHAVIOR
-  end
-
-  # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def __match!(verifiable_hash)
-    SmartCore::Schema::Checker::Reconciler::Matcher.match(self, verifiable_hash)
-  end
-
-  # @return [SmartCore::Schema::Checker::Rules::ExtraKeys]
-  #
-  # @api private
-  # @since 0.1.0
-  def __extra_keys_contract
-    SmartCore::Schema::Checker::Rules::ExtraKeys
-  end
-
-  # @return [SmartCore::Schema::Checker::Rules]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def __contract_rules
-    rules
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.3.0
-  # @version 0.8.0
-  def __strict?
-    @strict
-  end
-
-  # @param schema_key [String, Symbol]
-  # @param nested_definitions [Block]
-  # @return [SmartCore::Schema::Checker::Rules::Required]
-  #
-  # @api public
-  # @since 0.1.0
-  # @version 0.8.0
-  def required(schema_key, &nested_definitions)
-    rule = SmartCore::Schema::Checker::Rules::Required.new(self, schema_key, &nested_definitions)
-    rule.tap { rules[rule.schema_key] = rule }
-  end
-
-  # @param schema_key [String, Symbol]
-  # @param nested_definitions [Block]
-  # @return [SmartCore::Schema::Checker::Rules::Optional]
-  #
-  # @api public
-  # @since 0.1.0
-  # @version 0.8.0
-  def optional(schema_key, &nested_definitions)
-    rule = SmartCore::Schema::Checker::Rules::Optional.new(self, schema_key, &nested_definitions)
-    rule.tap { rules[rule.schema_key] = rule }
-  end
-
-  # @param is_strict [Boolean]
-  # @return [void]
-  #
-  # @api public
-  # @since 0.3.0
-  # @version 0.8.0
-  def strict!(is_strict = Constructor::DEFAULT_STRICT_BEHAVIOR)
-    @strict = is_strict
-  end
-
-  # @return [void]
-  #
-  # @api public
-  # @since 0.3.0
-  # @version 0.8.0
-  def non_strict!
-    strict!(Constructor::STRICT_MODES[:non_strict])
-  end
-
-  private
-
-  # @return [SmartCore::Schema::Checker::Rules]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rules
-end

data/lib/smart_core/schema/checker/rules/base.rb

@@ -1,110 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::Rules::Base
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :schema_key
-
-  # @return [SmartCore::Schema::Checker::Rules::Options]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :options
-
-  # @return [NilClass, SmartCore::Schema::Checker::Reconciler]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :nested_reconciler
-
-  # @return [SmartCore::Schema::Checker::Reconciler]
-  #
-  # @api private
-  # @since 0.3.0
-  attr_reader :root_reconciler
-
-  # @param root_reconciler [SmartCore::Schema::Checker::Reconciler]
-  # @param schema_key [String, Symbol]
-  # @param nested_definitions [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def initialize(root_reconciler, schema_key, &nested_definitions)
-    @root_reconciler = root_reconciler
-    @schema_key = SmartCore::Schema::KeyControl.normalize(schema_key)
-    @options = SmartCore::Schema::Checker::Rules::Options.new(self)
-    @nested_reconciler = nil
-    define_nested_reconciler(&nested_definitions)
-  end
-
-  # @!method requirement
-  #   @return [SmartCore::Schema::Checker::Rules::Requirement::Optional]
-  #   @return [SmartCore::Schema::Checker::Rules::Requirement::Required]
-
-  # @param verifiable_hash [Hash<String|Symbol,Any>]
-  # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-  # @return [SmartCore::Schema::Checker::Rules::Verifier::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  def __verify!(verifiable_hash, matcher_options)
-    SmartCore::Schema::Checker::Rules::Verifier.verify!(
-      self, matcher_options, verifiable_hash
-    )
-  end
-
-  # @param required_type [String, Symbol, SmartCore::Types::Primitive]
-  # @param nested_definitions [Block]
-  # @return [self]
-  #
-  # @api public
-  # @since 0.1.0
-  # @version 0.8.0
-  def type(required_type, &nested_definitions)
-    tap do
-      options.type = SmartCore::Schema::Checker::Rules::Options::Type.new(self, required_type)
-      define_nested_reconciler(&nested_definitions)
-    end
-  end
-
-  # @param nested_definitions [Block]
-  # @return [self]
-  #
-  # @api public
-  # @since 0.1.0
-  # @version 0.8.0
-  def filled(&nested_definitions)
-    tap do
-      options.filled = SmartCore::Schema::Checker::Rules::Options::Filled.new(self)
-      define_nested_reconciler(&nested_definitions)
-    end
-  end
-
-  private
-
-  # @param nested_definitions [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  def define_nested_reconciler(&nested_definitions)
-    return unless block_given?
-
-    SmartCore::Schema::Checker::Reconciler::Constructor.tap do |constructor|
-      @nested_reconciler = constructor.create if @nested_reconciler == nil
-      @nested_reconciler.strict!(root_reconciler.__strict?)
-      constructor.append_definitions(@nested_reconciler, &nested_definitions)
-    end
-
-    type(:hash).filled
-  end
-end

data/lib/smart_core/schema/checker/rules/extra_keys/failure.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module SmartCore::Schema::Checker::Rules::ExtraKeys
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  class Failure < Result
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def success?
-      false
-    end
-
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def failure?
-      true
-    end
-  end
-end

data/lib/smart_core/schema/checker/rules/extra_keys/result.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-# @apbstract
-#
-# @api private
-# @since 0.3.0
-class SmartCore::Schema::Checker::Rules::ExtraKeys::Result
-  # @return [Array<String>]
-  #
-  # @api private
-  # @since 0.3.0
-  attr_reader :extra_keys
-
-  # @return [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-  #
-  # @api private
-  # @since 0.3.0
-  attr_reader :matcher_options
-
-  # @param extra_keys [Array<String>]
-  # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  def initialize(extra_keys, matcher_options)
-    @extra_keys = extra_keys
-    @matcher_options = matcher_options
-  end
-
-  # @!method success?
-  #   @return [Boolean]
-
-  # @!method failure?
-  #   @return [Boolean]
-end

data/lib/smart_core/schema/checker/rules/extra_keys/success.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module SmartCore::Schema::Checker::Rules::ExtraKeys
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  class Success < Result
-    # @return [Array<String>]
-    #
-    # @api private
-    # @since 0.3.0
-    alias_method :spread_keys, :extra_keys
-
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def success?
-      true
-    end
-
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def failure?
-      false
-    end
-  end
-end

data/lib/smart_core/schema/checker/rules/extra_keys.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-module SmartCore::Schema::Checker::Rules::ExtraKeys
-  require_relative 'extra_keys/result'
-  require_relative 'extra_keys/success'
-  require_relative 'extra_keys/failure'
-
-  class << self
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @param rules [SmartCore::Schema::Checker::Rules]
-    # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-    # @return [SmartCore::Schema::Checker::Rules::ExtraKeys::Success]
-    # @return [SmartCore::Schema::Checker::Rules::ExtraKeys::Failure]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def __verify!(verifiable_hash, rules, matcher_options)
-      extra_keys = verifiable_hash.keys - rules.keys
-
-      if extra_keys.empty? || (extra_keys.any? && !matcher_options.strict_schema?)
-        Success.new(extra_keys, matcher_options)
-      else
-        Failure.new(extra_keys, matcher_options)
-      end
-    end
-  end
-end

data/lib/smart_core/schema/checker/rules/optional.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-class SmartCore::Schema::Checker::Rules::Optional < SmartCore::Schema::Checker::Rules::Base
-  # @return [SmartCore::Schema::Checker::Rules::Requirement::Optional]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :requirement
-
-  # @param root_reconciler [SmartCore::Schema::Checker::Reconciler]
-  # @param schema_key [String, Symbol]
-  # @param nested_definitions [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.3.0
-  # rubocop:disable Style/SuperArguments
-  def initialize(root_reconciler, schema_key, &nested_definitions)
-    super(root_reconciler, schema_key, &nested_definitions)
-    @requirement = SmartCore::Schema::Checker::Rules::Requirement::Optional.new(self)
-  end
-  # rubocop:enable Style/SuperArguments
-end

data/lib/smart_core/schema/checker/rules/options/empty.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Options::Empty
-  # @since 0.1.0
-  extend Forwardable
-
-  # @param rule [SmartCore::Schema::Checker::Rules::Base]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(rule)
-    @rule = rule
-  end
-
-  # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-  # @return [SmartCore::Schema::Checker::Rules::Result::Success]
-  #
-  # @api private
-  # @since 0.1.0
-  def validate(verifiable_hash)
-    SmartCore::Schema::Checker::Rules::Result::Success.new(
-      key: schema_key,
-      value: verifiable_hash[schema_key]
-    )
-  end
-
-  private
-
-  # @return [SmartCore::Schema::Checker::Rules::Base]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rule
-
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  def_delegator :rule, :schema_key
-end