smart_schema 0.11.0 → 0.12.1

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

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Requirement::Result
-  # @return [Symbol]
-  #
-  # @api private
-  # @since 0.1.0
-  ERROR_CODE = :required_key_not_found
-
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :key
-
-  # @return [SmartCore::Schema::Checker::VerifiableHash]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :verifiable_hash
-
-  # @return [Symbol, NilClass]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :error
-
-  # @return [String, NilClass]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :message
-
-  # @param key [String]
-  # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-  # @param required [Boolean]
-  # @param key_exists [Boolean]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(key, verifiable_hash, required:, key_exists:)
-    @key = key
-    @verifiable_hash = verifiable_hash
-    @required = required
-    @optional = !required
-    @key_exists = key_exists
-    @success = required ? key_exists : true
-    @failure = required ? !key_exists : false
-    @error = (required && !key_exists) ? ERROR_CODE : nil
-    @message = (required && !key_exists) ? "Required key :#{key} not found" : nil
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def success?
-    @success
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def failure?
-    @failure
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def key_exists?
-    @key_exists
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def optional?
-    @optional
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def required?
-    @required
-  end
-end

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module SmartCore::Schema::Checker::Rules::Requirement
-  require_relative 'requirement/result'
-  require_relative 'requirement/required'
-  require_relative 'requirement/optional'
-end

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Result::Base
-  # @return [String]
-  #
-  # @api public
-  # @since 0.1.0
-  attr_reader :key
-
-  # @return [Any]
-  #
-  # @api public
-  # @since 0.1.0
-  attr_reader :value
-
-  # @option key [String]
-  # @option value [Any]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(key:, value:)
-    @key = key
-    @value = value
-  end
-
-  # @return [Boolean]
-  #
-  # @api public
-  # @since 0.1.0
-  def success?
-    false
-  end
-
-  # @return [Boolean]
-  #
-  # @api public
-  # @since 0.1.0
-  def failure?
-    false
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module SmartCore::Schema::Checker::Rules::Result
-  # @api private
-  # @since 0.1.0
-  class Failure < Base
-    # @return [Symbol]
-    #
-    # @api public
-    # @since 0.1.0
-    attr_reader :error
-
-    # @return [String]
-    #
-    # @api public
-    # @since 0.1.0
-    attr_reader :message
-
-    # @option key [String]
-    # @option value [Any]
-    # @option error [Symbol]
-    # @option message [String]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def initialize(key:, value:, error:, message:)
-      super(key: key, value: value)
-      @error = error
-      @message = message
-    end
-
-    # @return [Boolean]
-    #
-    # @api public
-    # @since 0.1.0
-    def failure?
-      true
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module SmartCore::Schema::Checker::Rules::Result
-  # @api private
-  # @since 0.1.0
-  class Success < Base
-    # @return [Boolean]
-    #
-    # @api public
-    # @since 0.1.0
-    def success?
-      true
-    end
-  end
-end

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

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-module SmartCore::Schema::Checker::Rules::Result
-  require_relative 'result/base'
-  require_relative 'result/success'
-  require_relative 'result/failure'
-end

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

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# rubocop:disable Style/StaticClass
-class SmartCore::Schema::Checker::Rules
-  # @todo rework with smart_type-system
-  # @note non-frized constant is used for temporary extendability
-  # @return [SmartCore::Types::Primitive]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.2.0
-  # rubocop:disable Style/MutableConstant
-  TYPE_ALIASES = {
-    'value.any'         => SmartCore::Types::Value::Any.nilable,
-    'value.nil'         => SmartCore::Types::Value::Nil.nilable,
-    'value.string'      => SmartCore::Types::Value::String.nilable,
-    'value.symbol'      => SmartCore::Types::Value::Symbol.nilable,
-    'value.text'        => SmartCore::Types::Value::Text.nilable,
-    'value.integer'     => SmartCore::Types::Value::Integer.nilable,
-    'value.float'       => SmartCore::Types::Value::Float.nilable,
-    'value.numeric'     => SmartCore::Types::Value::Numeric.nilable,
-    'value.big_decimal' => SmartCore::Types::Value::BigDecimal.nilable,
-    'value.boolean'     => SmartCore::Types::Value::Boolean.nilable,
-    'value.array'       => SmartCore::Types::Value::Array.nilable,
-    'value.hash'        => SmartCore::Types::Value::Hash.nilable,
-    'value.proc'        => SmartCore::Types::Value::Proc.nilable,
-    'value.class'       => SmartCore::Types::Value::Class.nilable,
-    'value.module'      => SmartCore::Types::Value::Module.nilable,
-    'value.time'        => SmartCore::Types::Value::Time.nilable,
-    'value.date_time'   => SmartCore::Types::Value::DateTime.nilable,
-    'value.date'        => SmartCore::Types::Value::Date.nilable,
-    'value.time_based'  => SmartCore::Types::Value::TimeBased.nilable,
-    'any'               => SmartCore::Types::Value::Any.nilable,
-    'nil'               => SmartCore::Types::Value::Nil.nilable,
-    'string'            => SmartCore::Types::Value::String.nilable,
-    'symbol'            => SmartCore::Types::Value::Symbol.nilable,
-    'text'              => SmartCore::Types::Value::Text.nilable,
-    'integer'           => SmartCore::Types::Value::Integer.nilable,
-    'float'             => SmartCore::Types::Value::Float.nilable,
-    'numeric'           => SmartCore::Types::Value::Numeric.nilable,
-    'big_decimal'       => SmartCore::Types::Value::BigDecimal.nilable,
-    'boolean'           => SmartCore::Types::Value::Boolean.nilable,
-    'array'             => SmartCore::Types::Value::Array.nilable,
-    'hash'              => SmartCore::Types::Value::Hash.nilable,
-    'proc'              => SmartCore::Types::Value::Proc.nilable,
-    'class'             => SmartCore::Types::Value::Class.nilable,
-    'module'            => SmartCore::Types::Value::Module.nilable,
-    'time'              => SmartCore::Types::Value::Time.nilable,
-    'date_time'         => SmartCore::Types::Value::DateTime.nilable,
-    'date'              => SmartCore::Types::Value::Date.nilable,
-    'time_based'        => SmartCore::Types::Value::TimeBased.nilable
-  }
-  # rubocop:enable Style/MutableConstant
-end
-# rubocop:enable Style/StaticClass

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::Verifier::Result
-  # @since 0.1.0
-  include Enumerable
-
-  # @return [Array<SmartCore::Schema::Checker::Rules::Result::Base>]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :results
-
-  # @return [SmartCore::Schema::Checker::Rules::Base]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rule
-
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(rule)
-    @rule = rule
-    @results = []
-  end
-
-  # @return [String]
-  #
-  # @api private
-  # @since 0.1.0
-  def key
-    rule.schema_key
-  end
-
-  # @param result [SmartCore::Schema::Checker::Rules::Result::Base]
-  # @return [result]
-  #
-  # @api private
-  # @since 0.1.0
-  def add(result)
-    result.tap { results << result }
-  end
-  alias_method :<<, :add
-
-  # @param block [Block]
-  # @yield [result]
-  # @yieldparam result [SmartCore::Schema::Checker::Rules::Result::Base]
-  # @return [Enumerable]
-  #
-  # @api private
-  # @since 0.1.0
-  def each(&block)
-    block_given? ? results.each(&block) : results.each
-  end
-  alias_method :each_result, :each
-
-  # @return [Boolean]
-  #
-  # @api public
-  # @since 0.1.0
-  def success?
-    results.all?(&:success?)
-  end
-
-  # @return [Boolean]
-  #
-  # @api public
-  # @since 0.1.0
-  def failure?
-    results.all?(&:failure?)
-  end
-end

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

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-module SmartCore::Schema::Checker::Rules::Verifier
-  require_relative 'verifier/result'
-
-  class << self
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @param matcher_options [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [SmartCore::Schema::Checker::Rules::Verifier::Result]
-    #
-    # @api private
-    # @since 0.1.0
-    # @version 0.3.0
-    def verify!(rule, matcher_options, verifiable_hash)
-      SmartCore::Schema::Checker::Rules::Verifier::Result.new(rule).tap do |result|
-        requirement = result << check_requirement(rule, verifiable_hash)
-        next result if requirement.required? && requirement.failure?
-        next result if requirement.optional? && requirement.success? && !requirement.key_exists?
-        result << check_type(rule, verifiable_hash)
-        filled = result << check_filled(rule, verifiable_hash)
-        result << check_nested(rule, verifiable_hash) if filled.success?
-      end
-    end
-
-    private
-
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [SmartCore::Schema::Checker::Rules::Requirement::Result]
-    #
-    # @api private
-    # @since 0.1.0
-    def check_requirement(rule, verifiable_hash)
-      rule.requirement.validate(verifiable_hash)
-    end
-
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @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 check_type(rule, verifiable_hash)
-      rule.options.type.validate(verifiable_hash)
-    end
-
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @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 check_filled(rule, verifiable_hash)
-      rule.options.filled.validate(verifiable_hash)
-    end
-
-    # @param rule [SmartCore::Schema::Checker::Rules::Base]
-    # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-    # @return [NilClass, SmartCore::Schema::Checker::Reconciler::Matcher::Result]
-    #
-    # @api private
-    # @since 0.1.0
-    def check_nested(rule, verifiable_hash)
-      return unless rule.nested_reconciler
-      rule.nested_reconciler.__match!(verifiable_hash.extract(rule.schema_key))
-    end
-  end
-end

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::Rules
-  require_relative 'rules/type_aliases'
-  require_relative 'rules/base'
-  require_relative 'rules/result'
-  require_relative 'rules/optional'
-  require_relative 'rules/required'
-  require_relative 'rules/extra_keys'
-  require_relative 'rules/options'
-  require_relative 'rules/requirement'
-  require_relative 'rules/verifier'
-
-  # @since 0.1.0
-  include Enumerable
-
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def initialize
-    @rules = {}
-    @cache = SmartCore::Engine::Cache.new
-  end
-
-  # @param schema_key [String]
-  # @param rule [SmartCore::Schema::Checker::Rules::Base]
-  # @return [SmartCore::Schema::Checker::Rules::Base]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8..0
-  def []=(schema_key, rule)
-    cache.clear
-    rules[schema_key] = rule
-  end
-
-  # @param block [Block]
-  # @yield [schema_key, rule]
-  # @yieldparam schema_key [String]
-  # @yieldparam rule [SmartCore::Schema::Checker::Rules::Base]
-  # @return [Enumerable]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def each(&block)
-    block_given? ? rules.each_pair(&block) : rules.each_pair
-  end
-
-  # @param block [Block]
-  # @yield [rule]
-  # @yieldparam rule [SmartCore::Schema::Checker::Rules::Base]
-  # @return [Enumerable]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def each_rule(&block)
-    block_given? ? rules.each_value(&block) : rules.each_value
-  end
-
-  # @return [Array<String>]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def keys
-    cache.read(:keys) { rules.keys }
-  end
-
-  private
-
-  # @return [Hash<String,SmartCore::Schema::Checker::Rules::Base>]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :rules
-
-  # @return [SmartCore::Engine::Cache]
-  #
-  # @api private
-  # @since 0.8.0
-  attr_reader :cache
-end

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::VerifiableHash
-  # @return [Hash<String|Symbol,Any>]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :source
-
-  # @param source [Hash<String|Symbol,Any>]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(source)
-    @source = source
-  end
-
-  # @param key [String]
-  # @return [SmartCore::Schema::Checker::VerifiableHash]
-  #
-  # @api private
-  # @since 0.8.0
-  def extract(key)
-    SmartCore::Schema::Checker::VerifiableHash.new(fetch(key))
-  end
-
-  # @return [Array<String>]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def keys
-    SmartCore::Schema::KeyControl.normalize_list(source.keys)
-  end
-
-  # @param key [String]
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def key?(key)
-    source.key?(key) || source.key?(key.to_sym)
-  end
-
-  # @param key [String]
-  # @return [Any]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def fetch(key)
-    # @note
-    #   Previously we used exceptional flow "hash.fetch(key) rescue hash.fetch(key.to_sym)".
-    #   This flow can generate a lot of useless objects during rescuable `KeyError` exception
-    #   (useless error messages, backtraces, etc, object that was silently suppressed).
-    #   So, the "if"-#key?-oriented flow is better (generates fewer number of objects statistically)
-    source.key?(key) ? source.fetch(key) : source.fetch(key.to_sym)
-  end
-  alias_method :[], :fetch
-end

data/lib/smart_core/schema/checker.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.9.0
-class SmartCore::Schema::Checker
-  require_relative 'checker/verifiable_hash'
-  require_relative 'checker/rules'
-  require_relative 'checker/reconciler'
-
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.9.0
-  def initialize
-    @reconciler = Reconciler::Constructor.create
-    @lock = SmartCore::Engine::ReadWriteLock.new
-  end
-
-  # @param verifiable_hash [Hash<String|Symbol,Any>]
-  # @return [SmartCore::Schema::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.9.0
-  def check!(verifiable_hash)
-    @lock.read_sync do
-      raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE) unless verifiable_hash.is_a?(Hash)
-        Verifiable hash should be a type of ::Hash
-      ERROR_MESSAGE
-
-      reconciler.__match!(VerifiableHash.new(verifiable_hash)).complete!
-    end
-  end
-
-  # @param checker_invokations [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.3.0
-  # @version 0.9.0
-  def invoke_in_pipe(&checker_invokations)
-    @lock.write_sync { instance_eval(&checker_invokations) }
-  end
-
-  # @param strict_mode [NilClass, String, Symbol]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.3.0
-  # @version 0.9.0
-  def set_strict_mode(strict_mode)
-    @lock.write_sync { apply_strict_mode(strict_mode) }
-  end
-
-  # @param definitions [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.9.0
-  def append_schema_definitions(&definitions)
-    @lock.write_sync { add_schema_definitions(&definitions) }
-  end
-
-  # @param another_checker [SmartCore::Schema::Checker]
-  # @return [SmartCore::Schema::Checker]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.9.0
-  def combine_with(another_checker)
-    @lock.write_sync { self } # TODO (0.x.0): merge the definitions and return self
-  end
-
-  private
-
-  # @return [SmartCore::Schema::Checker::Reconciler]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :reconciler
-
-  # @param definitions [Block]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def add_schema_definitions(&definitions)
-    raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE) unless block_given?
-      Schema definitions is not provided (you should provide Block argument)
-    ERROR_MESSAGE
-
-    Reconciler::Constructor.append_definitions(reconciler, &definitions)
-  end
-
-  # @param strict_mode [NilClass, String, Symbol]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.3.0
-  def apply_strict_mode(strict_mode)
-    Reconciler::Constructor.set_strict_mode(reconciler, strict_mode)
-  end
-end