smart_schema 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 686b8bd1172752321dd2992f2cbe2aeb5230493142afb019c8c062347f215d97
-  data.tar.gz: f3395ec6d78bf5e8d6407018bb890e90043a8b730ec52ed1cabc090ab92953e2
+  metadata.gz: 0a86fa55dff1a9608dd4bd87eccb26eb9f9cf7ea1fd5699e800754d1c006814d
+  data.tar.gz: 1bcdce646a6ea5db5494493c024bff6fbdab390bcc4445d7801047a644c272cd
 SHA512:
-  metadata.gz: f64e1350c2422b40e275638b0719b49f0300cb8c7e3e9e7e179029a94afba9d455fd8c8d5c82d83b8a5604eb4df1c2ed4cf3b4dd0af20ecef35628f89bf6fc9b
-  data.tar.gz: 1fb7354eeb85ae75471fc3075ddcbf6bc50a1b4c8f115a34c045a5a29a689fb7705a776fe006a3a8276c2f7b58796336e126192c3108bd93134cff3a0348e797
+  metadata.gz: 17f908f2ddcc72d096093af737b9b80214d3f0cbca2fd7064e95b81036731e9f94205cad5b5a8db25c4eac3b61bb22a1e670f7f3876540b9c73518da5fc279ad
+  data.tar.gz: 17361851cca2d1d4380ceb82c8fc3a138203fc075ac5286a1de87ab9e0fcf76dd095b6aa2d61347a89157aea806404ec5cd2347641f313dbb0ad8ac4faacdabc

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+# [0.2.0] - 2020-11-09
+### Added
+- `#errors` now includes `#extra_keys` too (`:extra_key` error code for each extra key);
+- Unfreezed `SmartCore::Schema::Checker::Rules::TYPE_ALIASES` for extendability (until `smart_type-syste` has been integrated);
+
 # [0.1.0] - 2020-08-25
 
 - Release :)

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    smart_schema (0.1.0)
+    smart_schema (0.2.0)
       smart_engine (~> 0.8)
       smart_types (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    armitage-rubocop (0.89.1)
-      rubocop (= 0.89.1)
-      rubocop-performance (= 1.7.1)
-      rubocop-rails (= 2.7.1)
+    armitage-rubocop (1.2.0)
+      rubocop (= 1.2.0)
+      rubocop-performance (= 1.8.1)
+      rubocop-rails (= 2.8.1)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 1.43.2)
+      rubocop-rspec (= 2.0.0)
     ast (2.4.1)
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
@@ -28,9 +28,9 @@ GEM
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    minitest (5.14.2)
+    parallel (1.20.0)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -38,65 +38,67 @@ GEM
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.89.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rails (2.7.1)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.8.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 0.87.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.43.2)
-      rubocop (~> 0.87)
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.10.1)
-    simplecov (0.19.0)
+    simplecov (0.19.1)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    simplecov-html (0.12.3)
     smart_engine (0.8.0)
     smart_types (0.1.0)
       smart_engine (~> 0.6)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.89)
+  armitage-rubocop (~> 1.2)
   bundler (~> 2.1)
   pry (~> 0.13)
   rake (~> 13.0)
-  rspec (~> 3.9)
+  rspec (~> 3.10)
   simplecov (~> 0.19)
   smart_schema!
 

data/README.md

@@ -1,6 +1,6 @@
 # SmartCore::Schema [![Gem Version](https://badge.fury.io/rb/smart_schema.svg)](https://badge.fury.io/rb/smart_schema) [![Build Status](https://travis-ci.org/smart-rb/smart_schema.svg?branch=master)](https://travis-ci.org/smart-rb/smart_schema)
 
-`SmartCore::Schema` is a schema validator for `Hash`-like data structures.
+`SmartCore::Schema` is a schema validator for `Hash`-like data structures 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.
 
@@ -88,7 +88,7 @@ result = MySchema.new.validate(
 
 # => outputs:
 #  #<SmartCore::Schema::Result:0x00007ffcd8926990
-#  @errors={"key.data"=>[:non_filled], "key.value"=>[:invalid_type], "key.nested"=>[:required_key_not_found], "another_key"=>[:non_filled]},
+#  @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"}>,
 #  @source={:key=>{:data=>nil, :value=>"1", :name=>"D@iVeR"}, :another_key=>nil, :third_key=>"test"}>
 
@@ -99,20 +99,28 @@ result.errors # =>
   "key.data"=>[:non_filled],
   "key.value"=>[:invalid_type],
   "key.nested"=>[:required_key_not_found],
-  "another_key"=>[:non_filled]
+  "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` (a key that does not exist in schema);
+
 ---
 
 ## Roadmap
 
-- **(0.2.0)** - schema inheritance;
+- **(0.3.0)** - schema inheritance;
 - **(0.3.0)** - schema composition (`required(:key).schema(SchemaClass)`) (`compose_with(AnotherSchema)`);
-- **(0.4.0)** - error messages (that are consistent with error codes);
-- **(0.5.0)** - `smart_type-system` integration;
-- **(0.6.0)** - support for another data structures (such as YAML strings, JSON strings, `Struct`, `OpenStruct`s, custom `Object`s  and etc);
-- **(0.7.0)** - think about pattern matching;
+- **(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.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/reconciler/matcher/result_finalizer.rb

@@ -7,7 +7,7 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
   #
   # @api private
   # @since 0.1.0
-  ERRORS_CONTAINER_BUILDER = -> { Hash.new { |hash, key| hash[key] = [] } }
+  ERRORS_CONTAINER_BUILDER = -> { Hash.new { |hash, key| hash[key] = Set.new } }
 
   # @return [Proc]
   #
@@ -15,6 +15,12 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
   # @since 0.1.0
   EXTRA_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]
@@ -98,10 +104,12 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
 
     # @param errors [Hash]
     # @param extra_keys [Set]
-    # @return [Array<Hash<String,Array<Symbol>>,Set<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)
       compiled_errors = ERRORS_CONTAINER_BUILDER.call
       compiled_extra_keys = EXTRA_KEYS_CONTAINER_BUILDER.call
@@ -130,7 +138,12 @@ module SmartCore::Schema::Checker::Reconciler::Matcher::ResultFinalizer
         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]
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

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

@@ -4,10 +4,13 @@
 # @since 0.1.0
 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,
@@ -47,5 +50,6 @@ class SmartCore::Schema::Checker::Rules
     'date_time'         => SmartCore::Types::Value::DateTime.nilable,
     'date'              => SmartCore::Types::Value::Date.nilable,
     'time_based'        => SmartCore::Types::Value::TimeBased.nilable
-  }.freeze
+  }
+  # rubocop:enable Style/MutableConstant
 end

data/lib/smart_core/schema/version.rb

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

data/smart_schema.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry',              '~> 0.13'
   spec.add_development_dependency 'bundler',          '~> 2.1'
   spec.add_development_dependency 'rake',             '~> 13.0'
-  spec.add_development_dependency 'rspec',            '~> 3.9'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.89'
+  spec.add_development_dependency 'rspec',            '~> 3.10'
+  spec.add_development_dependency 'armitage-rubocop', '~> 1.2'
   spec.add_development_dependency 'simplecov',        '~> 0.19'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rustam Ibragimov
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smart_engine
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: armitage-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.89'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.89'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +185,7 @@ metadata:
   homepage_uri: https://github.com/smart-rb/smart_schema
   source_code_uri: https://github.com/smart-rb/smart_schema
   changelog_uri: https://github.com/smart-rb/smart_schema/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,8 +200,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: SmartCore::Schema is a schema validator for Hash-like data structures
 test_files: []