smart_schema 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 324e316565a37d67eac797e5deff2308973fbb339c16c739dfff3cbfa7a4c7f1
-  data.tar.gz: 4cf06afadcdca2b90fdf90492b95b79b448145ff453748069f2e5cd0ba0a6dcf
+  metadata.gz: 686b8bd1172752321dd2992f2cbe2aeb5230493142afb019c8c062347f215d97
+  data.tar.gz: f3395ec6d78bf5e8d6407018bb890e90043a8b730ec52ed1cabc090ab92953e2
 SHA512:
-  metadata.gz: 7ba48da56544751547a3a716cf49a23c32fe6c28ff0a8b8657398b8fd30df526229bfbdd51b942b5a4be72305f619bb88903e8fe24e576edc68aa5f6bcce921a
-  data.tar.gz: d9d08dc497ce96c42927f76fc30b65959aa355486f4648a453137aab29db1379606e054419fe67f07ef4007c6765c382a17417bf08968dd1a4311688be8a23b9
+  metadata.gz: f64e1350c2422b40e275638b0719b49f0300cb8c7e3e9e7e179029a94afba9d455fd8c8d5c82d83b8a5604eb4df1c2ed4cf3b4dd0af20ecef35628f89bf6fc9b
+  data.tar.gz: 1fb7354eeb85ae75471fc3075ddcbf6bc50a1b4c8f115a34c045a5a29a689fb7705a776fe006a3a8276c2f7b58796336e126192c3108bd93134cff3a0348e797

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 # Changelog
 All notable changes to this project will be documented in this file.
+
+# [0.1.0] - 2020-08-25
+
+- Release :)

data/Gemfile.lock

@@ -2,6 +2,8 @@ PATH
   remote: .
   specs:
     smart_schema (0.1.0)
+      smart_engine (~> 0.8)
+      smart_types (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,22 +14,27 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    armitage-rubocop (0.88.0)
-      rubocop (= 0.88.0)
+    armitage-rubocop (0.89.1)
+      rubocop (= 0.89.1)
       rubocop-performance (= 1.7.1)
-      rubocop-rails (= 2.6.0)
+      rubocop-rails (= 2.7.1)
       rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 1.42.0)
+      rubocop-rspec (= 1.43.2)
     ast (2.4.1)
-    concurrent-ruby (1.1.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
     docile (1.3.2)
     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)
       ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
@@ -46,32 +53,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.88.0)
+    rubocop (0.89.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.2.0)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     rubocop-performance (1.7.1)
       rubocop (>= 0.82.0)
-    rubocop-rails (2.6.0)
+    rubocop-rails (2.7.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.82.0)
+      rubocop (>= 0.87.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (1.42.0)
-      rubocop (>= 0.87.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
+    smart_engine (0.8.0)
+    smart_types (0.1.0)
+      smart_engine (~> 0.6)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
@@ -82,11 +92,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  armitage-rubocop (~> 0.88)
+  armitage-rubocop (~> 0.89)
   bundler (~> 2.1)
+  pry (~> 0.13)
   rake (~> 13.0)
   rspec (~> 3.9)
-  simplecov (~> 0.18)
+  simplecov (~> 0.19)
   smart_schema!
 
 BUNDLED WITH

data/README.md

@@ -1 +1,133 @@
-# SmartCore::Schema
+# 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.
+
+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).
+
+Works in predicate style and in OOP/Monadic result object style. Enjoy :)
+
+## 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;
+
+```ruby
+class MySchema < SmartCore::Schema
+  schema do
+    required(:key) do
+      optional(:data).type(:string).filled
+      optional(:value).type(:numeric)
+      required(:name).type(:string)
+
+      required(:nested) do
+        optional(:version).filled
+      end
+    end
+
+    required(:another_key).filled
+  end
+
+  # you can open already defined schema and continue schema definitioning:
+  #
+  # schema do
+  #   required(:third_key).filled.type(:string)
+  # 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]},
+#  @extra_keys=#<Set: {"third_key"}>,
+#  @source={:key=>{:data=>nil, :value=>"1", :name=>"D@iVeR"}, :another_key=>nil, :third_key=>"test"}>
+
+result.success? # => false
+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]
+}
+```
+
+---
+
+## Roadmap
+
+- **(0.2.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;
+
+---
+
+## 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.
+
+## Authors
+
+[Rustam Ibragimov](https://github.com/0exp)

data/lib/smart_core/schema.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'smart_core'
+require 'smart_core/types'
+require 'set'
+
 # @api pulic
 # @since 0.1.0
 module SmartCore
@@ -7,5 +11,41 @@ module SmartCore
   # @since 0.1.0
   class Schema
     require_relative 'schema/version'
+    require_relative 'schema/errors'
+    require_relative 'schema/key_control'
+    require_relative 'schema/result'
+    require_relative 'schema/checker'
+    require_relative 'schema/dsl'
+
+    # @since 0.1.0
+    include SmartCore::Schema::DSL
+
+    # @param verifiable_hash [Hash<String|Symbol,Any>]
+    # @return [Boolean]
+    #
+    # @api public
+    # @since 0.1.0
+    def valid?(verifiable_hash)
+      validate(verifiable_hash).success?
+    end
+
+    # @param verifiable_hash [Hash<String|Symbol,Any>]
+    # @return [SmartCore::Schema::Result]
+    #
+    # @api public
+    # @since 0.1.0
+    def validate(verifiable_hash)
+      schema_checker.check!(verifiable_hash)
+    end
+
+    private
+
+    # @return [SmartCore::Schema::Checker]
+    #
+    # @api private
+    # @since 0.1.0
+    def schema_checker
+      self.class.__schema_checker__
+    end
   end
 end

data/lib/smart_core/schema/checker.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.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
+  def initialize
+    @reconciler = Reconciler::Constructor.create
+    @lock = SmartCore::Engine::Lock.new
+  end
+
+  # @param verifiable_hash [Hash<String|Symbol,Any>]
+  # @return [SmartCore::Schema::Result]
+  #
+  # @api private
+  # @since 0.1.0
+  def check!(verifiable_hash)
+    thread_safe 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 definitions [Block]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def append_schema_definitions(&definitions)
+    thread_safe { add_schema_definitions(&definitions) }
+  end
+
+  # @param another_checker [SmartCore::Schema::Checker]
+  # @return [SmartCore::Schema::Checker]
+  #
+  # @api private
+  # @since 0.1.0
+  def combine_with(another_checker)
+    thread_safe { 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 block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class SmartCore::Schema::Checker::Reconciler
+  require_relative 'reconciler/constructor'
+  require_relative 'reconciler/matcher'
+
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @rules = SmartCore::Schema::Checker::Rules.new
+    @lock = SmartCore::Engine::Lock.new
+  end
+
+  # @param verifiable_hash [SmartCore::Schema::Checker::VerifiableHash]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def __match!(verifiable_hash)
+    thread_safe { SmartCore::Schema::Checker::Reconciler::Matcher.match(self, verifiable_hash) }
+  end
+
+  # @return [SmartCore::Schema::Checker::Rules::ExtraKeys]
+  #
+  # @api private
+  # @since 0.1.0
+  def __extra_keys_contract
+    SmartCore::Schema::Checker::Rules::ExtraKeys
+  end
+
+  # @return [SmartCore::Schema::Checker::Rules]
+  #
+  # @api private
+  # @since 0.1.0
+  def __contract_rules
+    thread_safe { rules }
+  end
+
+  # @param schema_key [String, Symbol]
+  # @param nested_definitions [Block]
+  # @return [SmartCore::Schema::Checker::Rules::Required]
+  #
+  # @api public
+  # @since 0.1.0
+  def required(schema_key, &nested_definitions)
+    thread_safe do
+      rule = SmartCore::Schema::Checker::Rules::Required.new(schema_key, &nested_definitions)
+      rule.tap { rules[rule.schema_key] = rule }
+    end
+  end
+
+  # @param schema_key [String, Symbol]
+  # @param nested_definitions [Block]
+  # @return [SmartCore::Schema::Checker::Rules::Optional]
+  #
+  # @api public
+  # @since 0.1.0
+  def optional(schema_key, &nested_definitions)
+    thread_safe do
+      rule = SmartCore::Schema::Checker::Rules::Optional.new(schema_key, &nested_definitions)
+      rule.tap { rules[rule.schema_key] = rule }
+    end
+  end
+
+  private
+
+  # @return [SmartCore::Schema::Checker::Rules]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :rules
+
+  # @param block [Block]
+  # @return [Any]
+  #
+  # @api private
+  # @since 0.1.0
+  def thread_safe(&block)
+    @lock.synchronize(&block)
+  end
+end