smart_schema 0.11.0 → 0.12.1

data/README.md

@@ -1,236 +0,0 @@
-# SmartCore::Schema &middot; <a target="_blank" href="https://github.com/Cado-Labs"><img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_badge.svg" alt="Supported by Cado Labs" style="max-width: 100%; height: 20px"></a> &middot; [![Gem Version](https://badge.fury.io/rb/smart_schema.svg)](https://badge.fury.io/rb/smart_schema)
-
-`SmartCore::Schema` is a schema validator for `Hash`-like data structures (`Array`-like - coming soon) in declarative DSL-powered style.
-
-Provides convenient and concise DSL to define complex schemas in easiest way and public validation interface to achieve a comfortable work with detailed validation result.
-
-Supports nested structures, type validation (via `smart_types`), required- and optional- schema keys, *strict* and *non-strict* schemas, schema value presence validation, schema inheritance (soon), schema extending (soon) and schema composition (soon).
-
-Works in predicate style and in OOP/Monadic result object style. Enjoy :)
-
----
-
-<p>
-  <a href="https://github.com/Cado-Labs">
-    <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_supporting.svg" alt="Supported by Cado Labs" />
-  </a>
-</p>
-
----
-
-## Installation
-
-```ruby
-gem 'smart_schema'
-```
-
-```shell
-bundle install
-# --- or ---
-gem install smart_schema
-```
-
-```ruby
-require 'smart_core/schema'
-```
-
----
-
-## Synopsis
-
-- key requirement: `required` and `optional`;
-- type validation: `type`;
-- `nil` control: `filled`;
-- nested definitions: `do ... end`;
-- supported types: see `smart_types` gem;
-- strict modes and strict behavior: `strict!`, `non_strict!`, `schema(:strict)`, `schema(:non_strict)`;
-- `:strict` is used by default (in first `schema` invokation);
-- you can make non-strict inner schemas inside strict schemas (and vise-versa);
-- inner schemas inherits their's mode from their's nearest outer schema (and can have own mode too);
-
-```ruby
-class MySchema < SmartCore::Schema
-  # you can mark strict mode in root schema here:
-  #
-  # non_strict!
-  #
-  # -- or --
-  #
-  # strict!
-
-  schema do # or here with `schema(:strict)` (default in first time) or `schema(:non_strict)`
-    required(:key) do
-      # inherits `:strict`
-      optional(:data).type(:string).filled
-      optional(:value).type(:numeric)
-      required(:name).type(:string)
-
-      required(:nested) do
-        # inherits `:strict`
-        optional(:version).filled
-      end
-
-      optional(:another_nested) do
-        non_strict! # marks current nested schema as `:non_strict`
-      end
-    end
-
-    required(:another_key).filled
-  end
-end
-```
-
-```ruby
-# you can open already defined schema and continue schema definitioning:
-
-schema do
-  required(:third_key).filled.type(:string)
-end
-```
-
-```ruby
-# you can redefine strict behavior of already defined schema:
-
-schema(:non_strict) do
-  # ...
-end
-
-# -- or --
-schema do
-  non_strict!
-end
-
-# -- or --
-non_strict!
-```
-
-```ruby
-# you can redefine nested schema behavior:
-
-schema do
-  optional(:another_nested) do
-    strict! # change from :non_strict to :strict
-  end
-end
-```
-
-```ruby
-MySchema.new.valid?({
-  key: {
-    data: '5',
-    value: 1,
-    name: 'D@iVeR'
-    nested: {}
-  }
-  another_key: true
-}) # => true
-
-MySchema.new.valid?({
-  key: {
-    data: nil,
-    value: 1,
-    name: 'D@iVeR'
-    nested: {}
-  }
-}) # => false (missing :another_key, key->data is not filled)
-```
-
-```ruby
-result = MySchema.new.validate(
-  key: { data: nil, value: '1', name: 'D@iVeR' },
-  another_key: nil,
-  third_key: 'test'
-)
-
-# => outputs:
-#  #<SmartCore::Schema::Result:0x00007ffcd8926990
-#  @errors={"key.data"=>[:non_filled], "key.value"=>[:invalid_type], "key.nested"=>[:required_key_not_found], "another_key"=>[:non_filled], "third_key"=>[:extra_key]},
-#  @extra_keys=#<Set: {"third_key"}>,
-#  @spread_keys=#<Set: {}>, (coming soon (spread keys of non-strict schemas))
-#  @source={:key=>{:data=>nil, :value=>"1", :name=>"D@iVeR"}, :another_key=>nil, :third_key=>"test"}>
-
-result.success? # => false
-result.spread_keys # => <Set: {}> (coming soon (spread keys of non-strict schemas))
-result.extra_keys # => <Set: {"third_key"}>
-result.errors # =>
-{
-  "key.data"=>[:non_filled],
-  "key.value"=>[:invalid_type],
-  "key.nested"=>[:required_key_not_found],
-  "another_key"=>[:non_filled],
-  "third_key"=>[:extra_key]
-}
-```
-
-Possible errors:
-  - `:non_filled` (existing key has nil value);
-  - `:invalid_type` (existing key has invalid type);
-  - `:required_key_not_found` (required key does not exist);
-  - `:extra_key` (concrete key does not exist in schema);
-
----
-
-## Roadmap
-
-- **(x.x.x)** - mutable schemas (value convertion during schema checking with returning the new coerced data structure);
-- **(x.x.x)** - public interface for type aliasing (custom type alias registration API);
-- **(x.x.x)** - support for `Array`-like data structures;
-- **(0.x.0)** - an abiltiy to represent the required schema as a string (conviniet way to check what schema is defained internally when we work wtih a dynamic schema definition or in a console);
-- **(0.x.0)** - migrate to `GitHub Actions` (CI);
-- **(0.x.0)** - value-validation layer;
-- **(0.x.0)** - error messages (that are consistent with error codes), with a support for error-code-auto-mappings for error messages via explicit hashes or via file (yaml, json and other formats);
-- **(0.6.0)** - support for `Array`-type in schema definition;
-- **(0.6.0)** - spread keys of non-strict schemas in validation result;
-- **(0.7.0)** - schema inheritance;
-- **(0.7.0)** - schema composition (`required(:key).schema(SchemaClass)`) (`compose_with(AnotherSchema)`);
-- **(0.7.0)** - dependable schema checking (sample: if one key exist (or not) we should check another (or not), and vice verca) (mb `if(:_key_)` rule);
-- **(0.8.0)** - `smart_type-system` integration;
-- **(0.9.0)** - support for another data structures (such as YAML strings, JSON strings, `Struct`, `OpenStruct`s, custom `Object`s  and etc);
-- **(0.10.0)** - mixin-based implementation;
-- **(0.x.0)** - think about pattern matching;
-
----
-
-## Build
-
-- run tests:
-
-```shell
-bundle exec rake rspec
-```
-
-- run code style checks:
-
-```shell
-bundle exec rake rubocop
-```
-
-- run code style checks with auto-correction:
-
-```shell
-bundle exec rake rubocop -A
-```
-
----
-
-## Contributing
-
-- Fork it ( https://github.com/smart-rb/smart_schema )
-- Create your feature branch (`git checkout -b feature/my-new-feature`)
-- Commit your changes (`git commit -am '[feature_context] Add some feature'`)
-- Push to the branch (`git push origin feature/my-new-feature`)
-- Create new Pull Request
-
-## License
-
-Released under MIT License.
-
-## Supporting
-
-<a href="https://github.com/Cado-Labs">
-  <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_logo.png" alt="Supported by Cado Labs" />
-</a>
-
-## Authors
-
-[Rustam Ibragimov](https://github.com/0exp)

data/Rakefile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop'
-require 'rubocop/rake_task'
-require 'rubocop-performance'
-require 'rubocop-rspec'
-require 'rubocop-rake'
-
-RuboCop::RakeTask.new(:rubocop) do |t|
-  config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
-  t.options = ['--config', config_path]
-  t.requires << 'rubocop-rspec'
-  t.requires << 'rubocop-performance'
-  t.requires << 'rubocop-rake'
-end
-
-RSpec::Core::RakeTask.new(:rspec)
-
-task default: :rspec

data/bin/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'smart_core'
-
-require 'pry'
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.3.0
-module SmartCore::Schema::Checker::Reconciler::Constructor
-  # @return [Hash<String,Boolean>]
-  #
-  # @api private
-  # @since 0.3.0
-  STRICT_MODES = { strict: true, 'strict' => true, non_strict: false, 'non_strict' => true }.freeze
-
-  # @return [Boolean]
-  #
-  # @pai private
-  # @since 0.3.0
-  DEFAULT_STRICT_BEHAVIOR = STRICT_MODES[:strict] # NOTE: means `strict by default`
-
-  class << self
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @param definitions [Proc]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.1.0
-    def append_definitions(reconciler, &definitions)
-      reconciler.instance_eval(&definitions)
-    end
-
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @param strict_mode [NilClass, String, Symbol]
-    # @return [void]
-    #
-    # @api private
-    # @since 0.3.0
-    def set_strict_mode(reconciler, strict_mode)
-      return if strict_mode == nil
-
-      is_strict = STRICT_MODES.fetch(strict_mode) do
-        raise(SmartCore::Schema::ArgumentError, <<~ERROR_MESSAGE)
-          Unsupported strict mode "#{strict_mode}".
-          SmartCore::Schema supports "strict" and "non_strict" modes only.
-        ERROR_MESSAGE
-      end
-
-      reconciler.strict!(is_strict)
-    end
-
-    # @param definitions [Proc, NilClass]
-    # @return [SmarCore::Schema::Checker::Reconciler]
-    #
-    # @api private
-    # @since 0.1.0
-    def create(&definitions)
-      SmartCore::Schema::Checker::Reconciler.new.tap do |reconciler|
-        append_definitions(reconciler, &definitions) if block_given?
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.3.0
-class SmartCore::Schema::Checker::Reconciler::Matcher::Options
-  class << self
-    # @param reconciler [SmartCore::Schema::Checker::Reconciler]
-    # @return [SmartCore::Schema::Checker::Reconciler::Matcher::Options]
-    #
-    # @api private
-    # @since 0.3.0
-    def build_from(reconciler)
-      new(reconciler.__strict?)
-    end
-  end
-
-  # @param is_strict_schema [Boolean]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.3.0
-  def initialize(is_strict_schema)
-    @is_strict_schema = is_strict_schema
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.3.0
-  def strict_schema?
-    @is_strict_schema
-  end
-end

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

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-# @api private
-# @since 0.1.0
-# @version 0.8.0
-class SmartCore::Schema::Checker::Reconciler::Matcher::Result
-  # @return [Hash<String|Symbol,Any>]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :verifiable_hash
-
-  # @return [SmartCore::Schema::Checker::Rules::Verifier::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  attr_reader :contract_keys_results
-
-  # @return [
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Success,
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Failure
-  # ]
-  # @api private
-  # @since 0.1.0
-  attr_reader :extra_keys_results
-
-  # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def initialize(verifiable_hash)
-    @verifiable_hash = verifiable_hash
-    @contract_keys_results = []
-    @extra_keys_results = []
-  end
-
-  # @param block
-  # @yield [result]
-  # @yieldparam result [
-  #   SmartCore::Schema::Checker::Rules::Verifier::Result,
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Success,
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Failure
-  # ]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def each_result(&block)
-    contract_keys_results.each(&block)
-    extra_keys_results.each(&block)
-  end
-
-  # @param result [SmartCore::Schema::Checker::Rules::Verifier::Result]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def contract_key_result(result)
-    contract_keys_results << result
-  end
-
-  # @param result [
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Success,
-  #   SmartCore::Schema::Checker::Rules::ExtraKeys::Failure
-  # ]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def extra_keys_result(result)
-    extra_keys_results << result
-  end
-
-  # @return [SmartCore::Schema::Result]
-  #
-  # @api private
-  # @since 0.1.0
-  # @version 0.8.0
-  def complete!
-    SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer.finalize(self)
-  end
-end

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