smart_schema 0.11.0 → 0.12.1

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,25 +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
-  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
-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

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-class SmartCore::Schema::Checker::Rules::Options
-  # @api private
-  # @since 0.1.0
-  class Filled < Empty
-    # @note Constant is used only for other developers.
-    # @return [Symbol]
-    #
-    # @api private
-    # @since 0.1.0
-    ERROR_CODE = :non_filled
-
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [SmartCore::Schema::Checker::Rules::Result::Success]
-    # @return [SmartCore::Schema::Checker::Rules::Result::Failure]
-    #
-    # @api private
-    # @since 0.1.0
-    def validate(verifiable_hash)
-      schema_value = verifiable_hash[schema_key]
-
-      if non_filled?(schema_value)
-        SmartCore::Schema::Checker::Rules::Result::Failure.new(
-          key: schema_key,
-          value: schema_value,
-          error: ERROR_CODE,
-          message: 'Requires to be filled'
-        )
-      else
-        SmartCore::Schema::Checker::Rules::Result::Success.new(
-          key: schema_key,
-          value: schema_value
-        )
-      end
-    end
-
-    private
-
-    # @param value [Any]
-    # @return [Boolean]
-    #
-    # @api private
-    # @since 0.1.0
-    def non_filled?(value)
-      value == nil
-    end
-  end
-end

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

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-class SmartCore::Schema::Checker::Rules::Options
-  # @api private
-  # @since 0.1.0
-  class Type < Empty
-    # @note Constant is used only for clarity (for other developers)
-    # @return [Symbol]
-    #
-    # @api private
-    # @since 0.1.0
-    ERROR_CODE = :invalid_type
-
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @param required_type [String, Symbol, SmartCore::Types::Primitive]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def initialize(rule, required_type)
-      super(rule)
-      @type = resolve_required_type(required_type)
-    end
-
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [SmartCore::Schema::Checker::Rules::Result::Success]
-    # @return [SmartCore::Schema::Checker::Rules::Result::Failure]
-    #
-    # @api private
-    # @since 0.1.0
-    def validate(verifiable_hash)
-      schema_value = verifiable_hash[schema_key]
-
-      if type.valid?(schema_value)
-        SmartCore::Schema::Checker::Rules::Result::Success.new(
-          key: schema_key,
-          value: schema_value
-        )
-      else
-        SmartCore::Schema::Checker::Rules::Result::Failure.new(
-          key: schema_key,
-          value: schema_value,
-          error: ERROR_CODE,
-          message: "Requires #{type} type (got: #{schema_value.class})"
-        )
-      end
-    end
-
-    private
-
-    # @return [String, Symbol, SmartCore::Types::Primitive]
-    #
-    # @api private
-    # @since 0.1.0
-    attr_reader :type
-
-    # @param required_type [String, Symbol, SmartCore::Types::Primitive]
-    # @return [SmartCore::Types::Primitive]
-    #
-    # @api private
-    # @since 0.1.0
-    def resolve_required_type(required_type)
-      unless required_type.is_a?(String) ||
-             required_type.is_a?(Symbol) ||
-             required_type.is_a?(SmartCore::Types::Primitive)
-        raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE)
-          Schema key type should be a type of string, symbol or SmartCore:Types::Primitive (got: #{required_type})
-        ERROR_MESSAGE
-      end
-
-      if required_type.is_a?(SmartCore::Types::Primitive)
-        required_type
-      else
-        begin
-          SmartCore::Schema::Checker::Rules::TYPE_ALIASES.fetch(required_type.to_s)
-        rescue KeyError
-          raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE)
-            Chosen schema key type is not supported or not registered (got #{required_type})
-          ERROR_MESSAGE
-        end
-      end
-
-      # TODO: rework with smart_type-system
-    end
-  end
-end

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::Rules::Options
-  require_relative 'options/empty'
-  require_relative 'options/type'
-  require_relative 'options/filled'
-
-  # @param rule [SmartCore::Schema::Checker::Rules::Base]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(rule)
-    @type = Empty.new(rule)
-    @filled = Empty.new(rule)
-  end
-
-  # @return [SmartCore::Schema::Checker::Rules::Options::Type]
-  # @return [SmartCore::Schema::Checker::Rules::Options::Empty]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def type
-    @type
-  end
-
-  # @param option [SmartCore::Schema::Checker::Rules::Options::Type]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def type=(option)
-    @type = option
-  end
-
-  # @return [SmartCore::Schema::Checker::Rules::Options::Filled]
-  # @return [SmartCore::Schema::Checker::Rules::Options::Empty]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def filled
-    @filled
-  end
-
-  # @param option [SmartCore::Schema::Checker::Rules::Options::Filled]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def filled=(option)
-    @filled = option
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-class SmartCore::Schema::Checker::Rules::Required < SmartCore::Schema::Checker::Rules::Base
-  # @return [SmartCore::Schema::Checker::Rules::Requirement::Required]
-  #
-  # @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
-  def initialize(root_reconciler, schema_key, &nested_definitions)
-    super(root_reconciler, schema_key, &nested_definitions)
-    @requirement = SmartCore::Schema::Checker::Rules::Requirement::Required.new(self)
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Requirement::Optional
-  # @param rule [SmartCore::Schema::Checker::Rules::Optional]
-  # @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::Requirement::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  def validate(verifiable_hash)
-    SmartCore::Schema::Checker::Rules::Requirement::Result.new(
-      rule.schema_key,
-      verifiable_hash,
-      required: false,
-      key_exists: verifiable_hash.key?(rule.schema_key)
-    )
-  end
-
-  private
-
-  # @return [SmartCore::Schema::Checker::Rules::Required]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rule
-end

data/lib/smart_core/schema/checker/rules/requirement/required.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Requirement::Required
-  # @param rule [SmartCore::Schema::Checker::Rules::Required]
-  # @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::Requirement::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  def validate(verifiable_hash)
-    SmartCore::Schema::Checker::Rules::Requirement::Result.new(
-      rule.schema_key,
-      verifiable_hash,
-      required: true,
-      key_exists: verifiable_hash.key?(rule.schema_key)
-    )
-  end
-
-  private
-
-  # @return [SmartCore::Schema::Checker::Rules::Required]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rule
-end