smart_schema 0.12.0 → 0.12.1

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,88 +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::Schema.type_system.primitive_type_class)
-        raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE)
-          Schema key type should be a type of string, symbol or
-          #{SmartCore::Schema.type_system.primitive_type_class.name} (got: #{required_type})
-        ERROR_MESSAGE
-      end
-
-      if required_type.is_a?(SmartCore::Schema.type_system.primitive_type_class)
-        required_type
-      else
-        begin
-          SmartCore::Schema.type_system.type_from_alias(required_type)
-          # 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,27 +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
-  # 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::Required.new(self)
-  end
-  # rubocop:enable Style/SuperArguments
-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

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