smart_schema 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a86fa55dff1a9608dd4bd87eccb26eb9f9cf7ea1fd5699e800754d1c006814d
-  data.tar.gz: 1bcdce646a6ea5db5494493c024bff6fbdab390bcc4445d7801047a644c272cd
+  metadata.gz: ad6ef4371489ef23da9a5b48a6acd744f3b471492407ab5e5b0201b35e5a4d76
+  data.tar.gz: 05f6c88bb367f406b4d401a5ac2349e17cda800ed46d5be6555b292c8b782d5b
 SHA512:
-  metadata.gz: 17f908f2ddcc72d096093af737b9b80214d3f0cbca2fd7064e95b81036731e9f94205cad5b5a8db25c4eac3b61bb22a1e670f7f3876540b9c73518da5fc279ad
-  data.tar.gz: 17361851cca2d1d4380ceb82c8fc3a138203fc075ac5286a1de87ab9e0fcf76dd095b6aa2d61347a89157aea806404ec5cd2347641f313dbb0ad8ac4faacdabc
+  metadata.gz: 0ec964a29f97595aa11087531ca29872f041c13182edfa6c8766e16472218db0cb9b1a91886a28cc7484761ab5dc5ec9a6dcbc9087d8ed3a35931d927f7582ad
+  data.tar.gz: 9d64b474fa69b251a0f88abd6c82f01cd6d629c6bee51c113d15481f53df77c296c4e510c5af904bacc5a4be570b080517f6721afd6180e211b9c90e39b5c68e

data/.rubocop.yml

@@ -6,6 +6,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.7.1
+  NewCops: enable
   Include:
     - lib/**/*.rb
     - spec/**/*.rb

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+# [0.3.0] - 2020-12-03
+### Added
+- Support for *strict* and *non-strict* schemas;
+  - `strict!` DSL directive marks your schema as a strict schema (your hash can not have extra keys);
+  - `non_strict!` DSL directive marks your schema as non-strict schema (your hash can have extra keys);
+  - use `strict!` in any schema's context place to mark your current schema context as a strict;
+  - use `non_strict` in any schema's context place to mark your current schema context as a strict;
+  - use `schema(:strict)` to globally define strict schema (default behavior);
+  - use `schema(:non_strict)` to globally define non-strict schema;
+  - nested schemas inherits strict behavior from outer schemas;
+  - root schema is `:strict` by default;
+  - schema reopening without mode attribute does not change original schema mode
+    (you should manually pass a mode attribute to redefine already defined schema mode);
+
 # [0.2.0] - 2020-11-09
 ### Added
 - `#errors` now includes `#extra_keys` too (`:extra_key` error code for each extra key);

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_schema (0.2.0)
+    smart_schema (0.3.0)
       smart_engine (~> 0.8)
       smart_types (~> 0.1)
 
@@ -82,8 +82,8 @@ GEM
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
     smart_engine (0.8.0)
-    smart_types (0.1.0)
-      smart_engine (~> 0.6)
+    smart_types (0.2.0)
+      smart_engine (~> 0.7)
     thread_safe (0.3.6)
     tzinfo (1.2.8)
       thread_safe (~> 0.1)
@@ -103,4 +103,4 @@ DEPENDENCIES
   smart_schema!
 
 BUNDLED WITH
-   2.1.4
+   2.2.0.rc.1

data/README.md

@@ -4,7 +4,7 @@
 
 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, schema value presence validation, schema inheritance (soon), schema extending (soon) and schema composition (soon).
+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 :)
 
@@ -33,18 +33,36 @@ require 'smart_core/schema'
 - `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
-  schema do
+  # 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
@@ -55,6 +73,30 @@ class MySchema < SmartCore::Schema
   # schema do
   #   required(:third_key).filled.type(:string)
   # end
+
+  # you can redefine strict behavior of already defined schema:
+  #
+  # schema(:non_strict) do
+  #   ...
+  # end
+  #
+  # -- or --
+  #
+  # schema do
+  #   non_strict!
+  # end
+  #
+  # -- or --
+  #
+  # non_strict!
+  
+  # you can redefine nested schema behavior:
+  #
+  # schema do
+  #   optional(:another_nested) do
+  #     strict! # change from :non_strict to :strict
+  #   end
+  # end
 end
 ```
 
@@ -90,9 +132,11 @@ result = MySchema.new.validate(
 #  #<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 # =>
 {
@@ -108,16 +152,18 @@ 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` (a key that does not exist in schema);
+  - `:extra_key` (concrete key does not exist in schema);
 
 ---
 
 ## Roadmap
 
-- **(0.3.0)** - schema inheritance;
-- **(0.3.0)** - schema composition (`required(:key).schema(SchemaClass)`) (`compose_with(AnotherSchema)`);
-- **(0.4.0)** - dependable schema checking (sample: if one key exist (or not) we should check another (or not), and vice verca);
-- **(0.5.0)** - error messages (that are consistent with error codes);
+- **(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.4.0)** - spread keys of non-strict schemas in validation result;
+- **(0.5.0)** - schema inheritance;
+- **(0.5.0)** - schema composition (`required(:key).schema(SchemaClass)`) (`compose_with(AnotherSchema)`);
+- **(0.5.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.6.0)** - `smart_type-system` integration;
 - **(0.7.0)** - support for another data structures (such as YAML strings, JSON strings, `Struct`, `OpenStruct`s, custom `Object`s  and etc);
 - **(0.8.0)** - think about pattern matching;

data/lib/smart_core/schema/checker.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Schema::Checker
   require_relative 'checker/verifiable_hash'
   require_relative 'checker/rules'
@@ -31,6 +32,24 @@ class SmartCore::Schema::Checker
     end
   end
 
+  # @param checker_invokations [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.3.0
+  def invoke_in_pipe(&checker_invokations)
+    thread_safe { instance_eval(&checker_invokations) }
+  end
+
+  # @param strict_mode [NilClass, String, Symbol]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.3.0
+  def set_strict_mode(strict_mode)
+    thread_safe { apply_strict_mode(strict_mode) }
+  end
+
   # @param definitions [Block]
   # @return [void]
   #
@@ -70,6 +89,15 @@ class SmartCore::Schema::Checker
     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
+
   # @param block [Block]
   # @return [Any]
   #

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Schema::Checker::Reconciler
   require_relative 'reconciler/constructor'
   require_relative 'reconciler/matcher'
@@ -10,8 +11,10 @@ class SmartCore::Schema::Checker::Reconciler
   #
   # @api private
   # @since 0.1.0
+  # @version 0.3.0
   def initialize
     @rules = SmartCore::Schema::Checker::Rules.new
+    @strict = Constructor::DEFAULT_STRICT_BEHAVIOR
     @lock = SmartCore::Engine::Lock.new
   end
 
@@ -40,15 +43,24 @@ class SmartCore::Schema::Checker::Reconciler
     thread_safe { rules }
   end
 
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 0.3.0
+  def __strict?
+    thread_safe { @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.3.0
   def required(schema_key, &nested_definitions)
     thread_safe do
-      rule = SmartCore::Schema::Checker::Rules::Required.new(schema_key, &nested_definitions)
+      rule = SmartCore::Schema::Checker::Rules::Required.new(self, schema_key, &nested_definitions)
       rule.tap { rules[rule.schema_key] = rule }
     end
   end
@@ -59,13 +71,31 @@ class SmartCore::Schema::Checker::Reconciler
   #
   # @api public
   # @since 0.1.0
+  # @version 0.3.0
   def optional(schema_key, &nested_definitions)
     thread_safe do
-      rule = SmartCore::Schema::Checker::Rules::Optional.new(schema_key, &nested_definitions)
+      rule = SmartCore::Schema::Checker::Rules::Optional.new(self, schema_key, &nested_definitions)
       rule.tap { rules[rule.schema_key] = rule }
     end
   end
 
+  # @param is_strict [Boolean]
+  # @return [void]
+  #
+  # @api public
+  # @since 0.3.0
+  def strict!(is_strict = Constructor::DEFAULT_STRICT_BEHAVIOR)
+    thread_safe { @strict = is_strict }
+  end
+
+  # @return [void]
+  #
+  # @api public
+  # @since 0.3.0
+  def non_strict!
+    thread_safe { strict!(Constructor::STRICT_MODES[:non_strict]) }
+  end
+
   private
 
   # @return [SmartCore::Schema::Checker::Rules]

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

@@ -2,7 +2,20 @@
 
 # @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]
@@ -14,6 +27,25 @@ module SmartCore::Schema::Checker::Reconciler::Constructor
       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]
     #

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

@@ -2,7 +2,9 @@
 
 # @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'
 
@@ -13,39 +15,46 @@ module SmartCore::Schema::Checker::Reconciler::Matcher
     #
     # @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, verifiable_hash, result)
-        match_for_extra_keys(reconciler, verifiable_hash, 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
-    def match_for_contract_keys(reconciler, verifiable_hash, result)
+    # @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)
+        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
-    def match_for_extra_keys(reconciler, verifiable_hash, result)
+    # @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
+        verifiable_hash, reconciler.__contract_rules, matcher_options
       )
       result.extra_keys_result(verification_result)
     end

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

@@ -0,0 +1,33 @@
+# 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_finalizer.rb

@@ -1,7 +1,10 @@
 # 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]
   #
@@ -15,6 +18,12 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
   # @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
@@ -27,26 +36,32 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
     #
     # @ai privates
     # @since 0.1.0
+    # @version 0.3.0
+    # rubocop:disable Layout/LineLength
     def finalize(result)
-      schema_errors, extra_keys = aggregate_errors(result)
-      schema_errors, extra_keys = compile_errors(schema_errors, extra_keys)
-      build_final_result(result, schema_errors, extra_keys)
+      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
-    def build_final_result(result, schema_errors, extra_keys)
+    # @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
+        extra_keys.freeze,
+        SPREAD_KEYS_CONTAINER_BUILDER.call.freeze # TODO: spread_keys.freeze
       )
     end
 
@@ -58,6 +73,7 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
     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
@@ -65,15 +81,16 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
           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]
+      [schema_errors, extra_keys, spread_keys]
     end
 
     # @param result [SmartCore::Schema::Checker::Rules::Verifier::Result]
     # @param errors [Hash<String,Array<String>|Hash<String,Hash>>]
-    # @param extra_keys [Set<String>]
     # @return [void]
     #
     # @api private
@@ -102,23 +119,41 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
       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.2.0
-    # rubocop:disable Metrics/AbcSize
-    def compile_errors(errors, extra_keys, initial_error_key = nil)
+    # @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
@@ -129,11 +164,13 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
             compiled_errors[compiled_key] << error
           when Array # nested errors
             sub_errors, sub_extra_keys = error
-            compiled_sub_errors, compiled_sub_extra_keys = compile_errors(
-              sub_errors, sub_extra_keys, compiled_key
+            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
@@ -142,8 +179,8 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
         compiled_errors[compiled_extra_key] << EXTRA_KEY_ERROR_CODE
       end
 
-      [compiled_errors, compiled_extra_keys]
+      [compiled_errors, compiled_extra_keys, compiled_spread_keys]
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
   end
 end

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

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Schema::Checker::Rules::Base
   # @return [String]
   #
@@ -21,14 +22,23 @@ class SmartCore::Schema::Checker::Rules::Base
   # @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
-  def initialize(schema_key, &nested_definitions)
+  # @version 0.3.0
+  def initialize(root_reconciler, schema_key, &nested_definitions)
     @lock = SmartCore::Engine::Lock.new
+    @root_reconciler = root_reconciler
     @schema_key = SmartCore::Schema::KeyControl.normalize(schema_key)
     @options = SmartCore::Schema::Checker::Rules::Options.new(self)
     @nested_reconciler = nil
@@ -40,12 +50,16 @@ class SmartCore::Schema::Checker::Rules::Base
   #   @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
-  def __verify!(verifiable_hash)
-    SmartCore::Schema::Checker::Rules::Verifier.verify!(self, verifiable_hash)
+  # @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]
@@ -84,11 +98,13 @@ class SmartCore::Schema::Checker::Rules::Base
   #
   # @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
 

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

@@ -2,21 +2,30 @@
 
 # @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
-    def __verify!(verifiable_hash, rules)
+    # @version 0.3.0
+    def __verify!(verifiable_hash, rules, matcher_options)
       extra_keys = verifiable_hash.keys - rules.keys
-      extra_keys.empty? ? Success.new : Failure.new(extra_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/extra_keys/failure.rb

@@ -1,36 +1,24 @@
 # frozen_string_literal: true
 
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::ExtraKeys::Failure
-  # @return extra_keys [Array<String>]
-  #
+module SmartCore::Schema::Checker::Rules::ExtraKeys
   # @api private
   # @since 0.1.0
-  attr_reader :extra_keys
+  # @version 0.3.0
+  class Failure < Result
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 0.1.0
+    def success?
+      false
+    end
 
-  # @param extra_keys [Array<String>]
-  # @return [void]
-  #
-  # @api private
-  # @since 0.1.0
-  def initialize(extra_keys)
-    @extra_keys = extra_keys
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def success?
-    false
-  end
-
-  # @return [Boolean]
-  #
-  # @api private
-  # @since 0.1.0
-  def failure?
-    true
+    # @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

@@ -0,0 +1,37 @@
+# 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,21 +1,30 @@
 # frozen_string_literal: true
 
-# @api private
-# @since 0.1.0
-class SmartCore::Schema::Checker::Rules::ExtraKeys::Success
-  # @return [Boolean]
-  #
+module SmartCore::Schema::Checker::Rules::ExtraKeys
   # @api private
   # @since 0.1.0
-  def success?
-    true
-  end
+  # @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 failure?
-    false
+    # @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/optional.rb

@@ -2,6 +2,7 @@
 
 # @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]
   #
@@ -9,14 +10,16 @@ class SmartCore::Schema::Checker::Rules::Optional < SmartCore::Schema::Checker::
   # @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
-  def initialize(schema_key, &nested_definitions)
-    super(schema_key, &nested_definitions)
+  # @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/filled.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# @api private
-# @since 0.1.0
 class SmartCore::Schema::Checker::Rules::Options
+  # @api private
+  # @since 0.1.0
   class Filled < Empty
-    # @note Constant is used only for clarity (for other developers).
+    # @note Constant is used only for other developers.
     # @return [Symbol]
     #
     # @api private

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# @api private
-# @since 0.1.0
 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]

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

@@ -2,6 +2,7 @@
 
 # @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]
   #
@@ -9,14 +10,16 @@ class SmartCore::Schema::Checker::Rules::Required < SmartCore::Schema::Checker::
   # @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
-  def initialize(schema_key, &nested_definitions)
-    super(schema_key, &nested_definitions)
+  # @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/verifier.rb

@@ -2,17 +2,20 @@
 
 # @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
-    def verify!(rule, verifiable_hash)
+    # @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?

data/lib/smart_core/schema/dsl.rb

@@ -36,6 +36,7 @@ module SmartCore::Schema::DSL
 
   # @api private
   # @since 0.1.0
+  # @version 0.3.0
   module ClassMethods
     # @return [SmartCore::Schema::Checker]
     #
@@ -45,13 +46,36 @@ module SmartCore::Schema::DSL
       @__schema_checker__
     end
 
+    # @param strict_mode [NilClass, String, Symbol]
     # @param definitions [Block]
     # @return [void]
     #
+    # @note nil strict mode means `do not change current mode`
+    #
     # @api public
     # @since 0.1.0
-    def schema(&definitions)
-      __schema_checker__.append_schema_definitions(&definitions)
+    # @version 0.3.0
+    def schema(strict_mode = nil, &definitions)
+      __schema_checker__.invoke_in_pipe do
+        set_strict_mode(strict_mode)
+        append_schema_definitions(&definitions)
+      end
+    end
+
+    # @return [void]
+    #
+    # @api public
+    # @since 0.3.0
+    def strict!
+      __schema_checker__.set_strict_mode(:strict)
+    end
+
+    # @return [void]
+    #
+    # @api public
+    # @since 0.3.0
+    def non_strict!
+      __schema_checker__.set_strict_mode(:non_strict)
     end
   end
 end

data/lib/smart_core/schema/result.rb

@@ -2,6 +2,7 @@
 
 # @api private
 # @since 0.1.0
+# @version 0.3.0
 class SmartCore::Schema::Result
   # @return [Hash<String,Any>]
   #
@@ -21,15 +22,26 @@ class SmartCore::Schema::Result
   # @since 0.1.0
   attr_reader :extra_keys
 
+  # @return [Set<String>]
+  #
+  # @api public
+  # @since 0.3.0
+  attr_reader :spread_keys
+
   # @param source [Hash<String|Symbol,Any>]
+  # @param errors [Hash<String,Array<Symbol>]
+  # @param extra_keys [Set<String>]
+  # @param spread_keys [Set<String>]
   # @return [void]
   #
   # @api private
   # @since 0.1.0
-  def initialize(source, errors, extra_keys)
+  # @version 0.3.0
+  def initialize(source, errors, extra_keys, spread_keys)
     @source = source
     @errors = errors
     @extra_keys = extra_keys
+    @spread_keys = spread_keys
   end
 
   # @return [Boolean]

data/lib/smart_core/schema/version.rb

@@ -5,7 +5,7 @@ module SmartCore
     # @return [String]
     #
     # @api public
-    # @since 0.2.0
-    VERSION = '0.2.0'
+    # @since 0.3.0
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -147,12 +147,14 @@ files:
 - lib/smart_core/schema/checker/reconciler.rb
 - lib/smart_core/schema/checker/reconciler/constructor.rb
 - lib/smart_core/schema/checker/reconciler/matcher.rb
+- lib/smart_core/schema/checker/reconciler/matcher/options.rb
 - lib/smart_core/schema/checker/reconciler/matcher/result.rb
 - lib/smart_core/schema/checker/reconciler/matcher/result_finalizer.rb
 - lib/smart_core/schema/checker/rules.rb
 - lib/smart_core/schema/checker/rules/base.rb
 - lib/smart_core/schema/checker/rules/extra_keys.rb
 - lib/smart_core/schema/checker/rules/extra_keys/failure.rb
+- lib/smart_core/schema/checker/rules/extra_keys/result.rb
 - lib/smart_core/schema/checker/rules/extra_keys/success.rb
 - lib/smart_core/schema/checker/rules/optional.rb
 - lib/smart_core/schema/checker/rules/options.rb
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.0.rc.1
 signing_key:
 specification_version: 4
 summary: SmartCore::Schema is a schema validator for Hash-like data structures