RubyGems - schemacop - Versions diffs - 2.4.7 → 3.0.0.rc0 - Mend

schemacop 2.4.7 → 3.0.0.rc0

Files changed (172) hide show

checksums.yaml +4 -4
data/.gitignore +3 -0
data/.rubocop.yml +25 -1
data/.travis.yml +2 -1
data/CHANGELOG.md +8 -0
data/README.md +41 -708
data/README_V2.md +775 -0
data/README_V3.md +683 -0
data/Rakefile +8 -12
data/VERSION +1 -1
data/lib/schemacop.rb +35 -37
data/lib/schemacop/base_schema.rb +37 -0
data/lib/schemacop/railtie.rb +10 -0
data/lib/schemacop/schema.rb +1 -60
data/lib/schemacop/schema2.rb +22 -0
data/lib/schemacop/schema3.rb +21 -0
data/lib/schemacop/scoped_env.rb +25 -13
data/lib/schemacop/v2.rb +26 -0
data/lib/schemacop/{caster.rb → v2/caster.rb} +16 -2
data/lib/schemacop/{collector.rb → v2/collector.rb} +5 -2
data/lib/schemacop/{dupper.rb → v2/dupper.rb} +1 -1
data/lib/schemacop/{field_node.rb → v2/field_node.rb} +4 -3
data/lib/schemacop/v2/node.rb +142 -0
data/lib/schemacop/{node_resolver.rb → v2/node_resolver.rb} +1 -1
data/lib/schemacop/{node_supporting_field.rb → v2/node_supporting_field.rb} +8 -10
data/lib/schemacop/{node_supporting_type.rb → v2/node_supporting_type.rb} +6 -3
data/lib/schemacop/{node_with_block.rb → v2/node_with_block.rb} +3 -2
data/lib/schemacop/v2/root_node.rb +6 -0
data/lib/schemacop/v2/validator/array_validator.rb +32 -0
data/lib/schemacop/{validator → v2/validator}/boolean_validator.rb +1 -1
data/lib/schemacop/v2/validator/float_validator.rb +7 -0
data/lib/schemacop/v2/validator/hash_validator.rb +37 -0
data/lib/schemacop/v2/validator/integer_validator.rb +7 -0
data/lib/schemacop/{validator → v2/validator}/nil_validator.rb +1 -1
data/lib/schemacop/v2/validator/number_validator.rb +21 -0
data/lib/schemacop/v2/validator/object_validator.rb +29 -0
data/lib/schemacop/v2/validator/string_validator.rb +39 -0
data/lib/schemacop/{validator → v2/validator}/symbol_validator.rb +1 -1
data/lib/schemacop/v3.rb +45 -0
data/lib/schemacop/v3/all_of_node.rb +27 -0
data/lib/schemacop/v3/any_of_node.rb +28 -0
data/lib/schemacop/v3/array_node.rb +219 -0
data/lib/schemacop/v3/boolean_node.rb +16 -0
data/lib/schemacop/v3/combination_node.rb +45 -0
data/lib/schemacop/v3/context.rb +17 -0
data/lib/schemacop/v3/dsl_scope.rb +46 -0
data/lib/schemacop/v3/global_context.rb +114 -0
data/lib/schemacop/v3/hash_node.rb +217 -0
data/lib/schemacop/v3/integer_node.rb +13 -0
data/lib/schemacop/v3/is_not_node.rb +32 -0
data/lib/schemacop/v3/node.rb +214 -0
data/lib/schemacop/v3/node_registry.rb +49 -0
data/lib/schemacop/v3/number_node.rb +18 -0
data/lib/schemacop/v3/numeric_node.rb +76 -0
data/lib/schemacop/v3/object_node.rb +40 -0
data/lib/schemacop/v3/one_of_node.rb +28 -0
data/lib/schemacop/v3/reference_node.rb +49 -0
data/lib/schemacop/v3/result.rb +58 -0
data/lib/schemacop/v3/string_node.rb +124 -0
data/lib/schemacop/v3/symbol_node.rb +13 -0
data/schemacop.gemspec +24 -27
data/test/lib/test_helper.rb +152 -0
data/test/schemas/nested/group.rb +6 -0
data/test/schemas/user.rb +7 -0
data/test/unit/schemacop/v2/casting_test.rb +120 -0
data/test/unit/schemacop/v2/collector_test.rb +47 -0
data/test/unit/schemacop/v2/custom_check_test.rb +95 -0
data/test/unit/schemacop/v2/custom_if_test.rb +97 -0
data/test/unit/schemacop/v2/defaults_test.rb +95 -0
data/test/unit/schemacop/v2/empty_test.rb +16 -0
data/test/unit/schemacop/v2/nil_dis_allow_test.rb +43 -0
data/test/unit/schemacop/v2/node_resolver_test.rb +28 -0
data/test/unit/schemacop/v2/short_forms_test.rb +351 -0
data/test/unit/schemacop/v2/types_test.rb +88 -0
data/test/unit/schemacop/v2/validator_array_test.rb +99 -0
data/test/unit/schemacop/v2/validator_boolean_test.rb +17 -0
data/test/unit/schemacop/v2/validator_float_test.rb +59 -0
data/test/unit/schemacop/v2/validator_hash_test.rb +95 -0
data/test/unit/schemacop/v2/validator_integer_test.rb +48 -0
data/test/unit/schemacop/v2/validator_nil_test.rb +15 -0
data/test/unit/schemacop/v2/validator_number_test.rb +62 -0
data/test/unit/schemacop/v2/validator_object_test.rb +141 -0
data/test/unit/schemacop/v2/validator_string_test.rb +78 -0
data/test/unit/schemacop/v2/validator_symbol_test.rb +18 -0
data/test/unit/schemacop/v3/all_of_node_test.rb +199 -0
data/test/unit/schemacop/v3/any_of_node_test.rb +218 -0
data/test/unit/schemacop/v3/array_node_test.rb +805 -0
data/test/unit/schemacop/v3/boolean_node_test.rb +126 -0
data/test/unit/schemacop/v3/global_context_test.rb +164 -0
data/test/unit/schemacop/v3/hash_node_test.rb +775 -0
data/test/unit/schemacop/v3/integer_node_test.rb +323 -0
data/test/unit/schemacop/v3/is_not_node_test.rb +173 -0
data/test/unit/schemacop/v3/node_test.rb +148 -0
data/test/unit/schemacop/v3/number_node_test.rb +292 -0
data/test/unit/schemacop/v3/object_node_test.rb +170 -0
data/test/unit/schemacop/v3/one_of_node_test.rb +187 -0
data/test/unit/schemacop/v3/reference_node_test.rb +351 -0
data/test/unit/schemacop/v3/string_node_test.rb +334 -0
data/test/unit/schemacop/v3/symbol_node_test.rb +75 -0
metadata +152 -145
data/doc/Schemacop.html +0 -146
data/doc/Schemacop/ArrayValidator.html +0 -329
data/doc/Schemacop/BooleanValidator.html +0 -145
data/doc/Schemacop/Caster.html +0 -379
data/doc/Schemacop/Collector.html +0 -787
data/doc/Schemacop/Dupper.html +0 -214
data/doc/Schemacop/Exceptions.html +0 -115
data/doc/Schemacop/Exceptions/InvalidSchemaError.html +0 -124
data/doc/Schemacop/Exceptions/ValidationError.html +0 -124
data/doc/Schemacop/FieldNode.html +0 -421
data/doc/Schemacop/FloatValidator.html +0 -158
data/doc/Schemacop/HashValidator.html +0 -293
data/doc/Schemacop/IntegerValidator.html +0 -158
data/doc/Schemacop/NilValidator.html +0 -145
data/doc/Schemacop/Node.html +0 -1438
data/doc/Schemacop/NodeResolver.html +0 -258
data/doc/Schemacop/NodeSupportingField.html +0 -590
data/doc/Schemacop/NodeSupportingType.html +0 -612
data/doc/Schemacop/NodeWithBlock.html +0 -289
data/doc/Schemacop/NumberValidator.html +0 -232
data/doc/Schemacop/ObjectValidator.html +0 -298
data/doc/Schemacop/RootNode.html +0 -171
data/doc/Schemacop/Schema.html +0 -699
data/doc/Schemacop/StringValidator.html +0 -295
data/doc/Schemacop/SymbolValidator.html +0 -145
data/doc/ScopedEnv.html +0 -351
data/doc/_index.html +0 -379
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -496
data/doc/file.README.html +0 -833
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -17
data/doc/index.html +0 -833
data/doc/inheritance.graphml +0 -524
data/doc/inheritance.pdf +0 -825
data/doc/js/app.js +0 -303
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -587
data/doc/top-level-namespace.html +0 -112
data/lib/schemacop/node.rb +0 -139
data/lib/schemacop/root_node.rb +0 -4
data/lib/schemacop/validator/array_validator.rb +0 -30
data/lib/schemacop/validator/float_validator.rb +0 -5
data/lib/schemacop/validator/hash_validator.rb +0 -35
data/lib/schemacop/validator/integer_validator.rb +0 -5
data/lib/schemacop/validator/number_validator.rb +0 -19
data/lib/schemacop/validator/object_validator.rb +0 -27
data/lib/schemacop/validator/string_validator.rb +0 -37
data/test/casting_test.rb +0 -118
data/test/collector_test.rb +0 -45
data/test/custom_check_test.rb +0 -93
data/test/custom_if_test.rb +0 -95
data/test/defaults_test.rb +0 -93
data/test/empty_test.rb +0 -14
data/test/nil_dis_allow_test.rb +0 -41
data/test/node_resolver_test.rb +0 -26
data/test/short_forms_test.rb +0 -349
data/test/test_helper.rb +0 -13
data/test/types_test.rb +0 -84
data/test/validator_array_test.rb +0 -97
data/test/validator_boolean_test.rb +0 -15
data/test/validator_float_test.rb +0 -57
data/test/validator_hash_test.rb +0 -93
data/test/validator_integer_test.rb +0 -46
data/test/validator_nil_test.rb +0 -13
data/test/validator_number_test.rb +0 -60
data/test/validator_object_test.rb +0 -139
data/test/validator_string_test.rb +0 -76
data/test/validator_symbol_test.rb +0 -16

data/doc/top-level-namespace.html DELETED

@@ -1,112 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Top Level Namespace
-    &mdash; Documentation by YARD 0.9.20
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index</a> &raquo;
-    <span class="title">Top Level Namespace</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Top Level Namespace
-</h1>
-<div class="box_info">
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Schemacop.html" title="Schemacop (module)">Schemacop</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ScopedEnv.html" title="ScopedEnv (class)">ScopedEnv</a></span>
-</p>
-</div>
-      <div id="footer">
-  Generated on Thu Jul  2 11:30:34 2020 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.20 (ruby-2.6.2).
-</div>
-    </div>
-  </body>
-</html>

data/lib/schemacop/node.rb DELETED

@@ -1,139 +0,0 @@
-module Schemacop
-  class Node
-    attr_reader :options
-    class_attribute :allowed_options
-    self.allowed_options = {}.freeze
-    class_attribute :symbols
-    self.symbols = [].freeze
-    class_attribute :klasses
-    self.klasses = [].freeze
-    def self.option(key, default: nil)
-      self.allowed_options = allowed_options.merge(key => default)
-    end
-    option :if
-    option :check
-    option :cast
-    option :default
-    def type_label
-      str = (symbols.first || 'unknown').to_s
-      str += '*' if option?(:if)
-      return str
-    end
-    def self.symbol(symbol)
-      self.symbols += [symbol]
-    end
-    def self.clear_symbols
-      self.symbols = [].freeze
-    end
-    def self.klass(klass)
-      self.klasses += [klass]
-    end
-    def self.clear_klasses
-      self.klasses = [].freeze
-    end
-    def self.register(symbols: [], klasses: [], clear: true, before: nil)
-      NodeResolver.register(self, before: before)
-      symbols = [*symbols]
-      klasses = [*klasses]
-      if clear
-        clear_symbols
-        clear_klasses
-      end
-      symbols.each { |s| symbol s }
-      klasses.each { |k| klass k }
-    end
-    def self.type_matches?(type)
-      symbol_matches?(type) || class_matches?(type)
-    end
-    def self.symbol_matches?(type)
-      return false unless type.is_a?(Symbol)
-      symbols.include?(type)
-    end
-    def self.class_matches?(type)
-      return false unless type.is_a?(Class)
-      klasses.each do |klass|
-        return true if type <= klass
-      end
-      return false
-    end
-    def self.build(options, &block)
-      new(options, &block)
-    end
-    def initialize(options = {})
-      # Check and save given options
-      @options = self.class.allowed_options.merge(options)
-      if (obsolete_opts = @options.keys - self.class.allowed_options.keys).any?
-        fail Exceptions::InvalidSchemaError,
-             "Unrecognized option(s) #{obsolete_opts.inspect} for #{self.class.inspect}, allowed options: #{self.class.allowed_options.keys.inspect}."
-      end
-      if option?(:cast) && self.class.klasses.size > 1
-        fail Exceptions::InvalidSchemaError,
-             "Casting is only allowed for single-value datatypes, but type #{self.class.inspect} has classes "\
-             "#{self.class.klasses.map(&:inspect)}."
-      end
-    end
-    def option(key)
-      options[key]
-    end
-    def option?(key)
-      # rubocop:disable Style/DoubleNegation
-      !!options[key]
-      # rubocop:enable Style/DoubleNegation
-    end
-    def exec_block
-      fail Exceptions::InvalidSchemaError, 'Node does not support block.' if block_given?
-    end
-    def resolve_type_klass(type)
-      klass = NodeResolver.resolve(type)
-      unless klass
-        fail Exceptions::InvalidSchemaError, "No validation class found for type #{type.inspect}."
-      end
-      return klass
-    end
-    def validate(data, collector)
-      validate_custom_check(data, collector)
-    end
-    def type_matches?(data)
-      self.class.type_matches?(data.class) && type_filter_matches?(data)
-    end
-    def type_filter_matches?(data)
-      !option?(:if) || option(:if).call(data)
-    end
-    protected
-    def validate_custom_check(data, collector)
-      if option?(:check) && (check_result = option(:check).call(data)) != true
-        if check_result.is_a?(String)
-          collector.error "Custom :check failed: #{check_result}."
-        else
-          collector.error 'Custom :check failed.'
-        end
-      end
-    end
-  end
-end

data/lib/schemacop/root_node.rb DELETED

@@ -1,4 +0,0 @@
-module Schemacop
-  class RootNode < NodeSupportingType
-  end
-end

data/lib/schemacop/validator/array_validator.rb DELETED

@@ -1,30 +0,0 @@
-module Schemacop
-  class ArrayValidator < NodeSupportingType
-    register symbols: :array, klasses: Array
-    option :min # Minimal number of elements
-    option :max # Maximal number of elements
-    option :nil # Whether to allow nil values
-    def initialize(*args)
-      super
-      type(:nil) if option(:nil)
-    end
-    def validate(data, collector)
-      validate_custom_check(data, collector)
-      if option?(:min) && data.size < option(:min)
-        collector.error "Array must have more (>=) than #{option(:min)} elements."
-      end
-      if option?(:max) && data.size > option(:max)
-        collector.error "Array must have less (<=) than #{option(:max)} elements."
-      end
-      data.each_with_index do |entry, index|
-        collector.path("[#{index}]", index, :array) do
-          validate_types(entry, collector)
-        end
-      end
-    end
-  end
-end

data/lib/schemacop/validator/float_validator.rb DELETED

@@ -1,5 +0,0 @@
-module Schemacop
-  class FloatValidator < NumberValidator
-    register symbols: :float, klasses: Float, before: NumberValidator
-  end
-end

data/lib/schemacop/validator/hash_validator.rb DELETED

@@ -1,35 +0,0 @@
-module Schemacop
-  class HashValidator < NodeSupportingField
-    register symbols: :hash, klasses: Hash
-    option :allow_obsolete_keys
-    def validate(data, collector)
-      super
-      if data.is_a? ActiveSupport::HashWithIndifferentAccess
-        allowed_fields = @fields.keys.map { |k| k.is_a?(String) ? k.to_sym : k }
-        data_keys = data.keys.map { |k| k.is_a?(String) ? k.to_sym : k }
-        # If the same key is specified in the schema as string and symbol, we
-        # definitely expect a Ruby hash and not one with indifferent access
-        if @fields.keys.length != Set.new(allowed_fields).length
-          fail Exceptions::ValidationError, 'Hash expected, but got ActiveSupport::HashWithIndifferentAccess.'
-        end
-      else
-        allowed_fields = @fields.keys
-        data_keys = data.keys
-      end
-      obsolete_keys = data_keys - allowed_fields
-      unless option?(:allow_obsolete_keys)
-        collector.error "Obsolete keys: #{obsolete_keys.inspect}." if obsolete_keys.any?
-      end
-      @fields.values.each do |field|
-        field.validate(data, collector)
-      end
-    end
-  end
-end

data/lib/schemacop/validator/integer_validator.rb DELETED

@@ -1,5 +0,0 @@
-module Schemacop
-  class IntegerValidator < NumberValidator
-    register symbols: :integer, klasses: Integer, before: NumberValidator
-  end
-end

data/lib/schemacop/validator/number_validator.rb DELETED

@@ -1,19 +0,0 @@
-module Schemacop
-  class NumberValidator < Node
-    register symbols: :number, klasses: [Integer, Float]
-    option :min
-    option :max
-    def validate(data, collector)
-      super
-      if option?(:min) && data < option(:min)
-        collector.error "Value must be >= #{option(:min)}."
-      end
-      if option?(:max) && data > option(:max)
-        collector.error "Value must be <= #{option(:max)}."
-      end
-    end
-  end
-end

data/lib/schemacop/validator/object_validator.rb DELETED

@@ -1,27 +0,0 @@
-module Schemacop
-  class ObjectValidator < Node
-    register symbols: :object, klasses: BasicObject
-    option :classes
-    option :strict
-    def type_label
-      "#{super} (#{classes.join(', ')})"
-    end
-    def type_matches?(data)
-      if option(:strict).is_a?(FalseClass)
-        sub_or_class = classes.map { |klass| data.class <= klass }.include?(true)
-        super && (classes.empty? || sub_or_class) && !data.nil?
-      else
-        super && (classes.empty? || classes.include?(data.class)) && !data.nil?
-      end
-    end
-    private
-    def classes
-      [*option(:classes)]
-    end
-  end
-end

data/lib/schemacop/validator/string_validator.rb DELETED

@@ -1,37 +0,0 @@
-module Schemacop
-  class StringValidator < Node
-    register symbols: :string, klasses: String
-    option :min
-    option :max
-    def initialize(options = {})
-      super(options)
-      validate_options!
-    end
-    def validate(data, collector)
-      super
-      if option?(:min) && data.size < option(:min)
-        collector.error "String must be longer (>=) than #{option(:min)} characters."
-      end
-      if option?(:max) && data.size > option(:max)
-        collector.error "String must be shorter (<=) than #{option(:max)} characters."
-      end
-    end
-    protected
-    def validate_options!
-      option_schema = Schema.new :integer, min: 0
-      if option?(:min) && option_schema.invalid?(option(:min))
-        fail Exceptions::InvalidSchemaError, 'String option :min must be an integer >= 0.'
-      elsif option?(:max) && option_schema.invalid?(option(:max))
-        fail Exceptions::InvalidSchemaError, 'String option :max must be an integer >= 0.'
-      end
-    end
-  end
-end

data/test/casting_test.rb DELETED

@@ -1,118 +0,0 @@
-require 'test_helper'
-module Schemacop
-  class CastingTest < Minitest::Test
-    def test_basic
-      s = Schema.new :integer, cast: [String]
-      input = '42'
-      output = s.validate!(input)
-      assert_equal(42, output)
-    end
-    def test_field
-      s = Schema.new do
-        req :foo, :integer, cast: [String]
-      end
-      input = { foo: '42' }
-      output = s.validate!(input)
-      assert_equal({ foo: '42' }, input)
-      assert_equal({ foo: 42 }, output)
-    end
-    def test_first_type_matches
-      s = Schema.new do
-        type TrueClass
-        type :integer, cast: [String]
-      end
-      assert_equal(42, s.validate!('42'))
-      assert_equal(42, s.validate!(42))
-      assert_equal(true, s.validate!(true))
-    end
-    def test_with_if
-      s = Schema.new do
-        type Float, if: proc { |data| !data.is_a?(String) || data.match(/\d+\.\d+/) }, cast: [String]
-        type Integer, cast: [String]
-      end
-      assert_equal 42.2, s.validate!('42.2')
-      assert_equal 42, s.validate!('42')
-    end
-    def test_arrays
-      s = Schema.new do
-        req :foo, :array, :integer, cast: [String]
-      end
-      assert_equal(
-        { foo: [1, 2, 3] },
-        s.validate!(foo: %w(1 2 3))
-      )
-    end
-    def test_check_after_cast
-      s = Schema.new do
-        type Integer, cast: [String], check: proc { |v| v > 41 }
-      end
-      assert_equal 42, s.validate!('42')
-      assert_equal 43, s.validate!('43')
-      assert_equal 42, s.validate!(42)
-      assert_verr { s.validate!('41') }
-      assert_verr { s.validate!(42.2) }
-    end
-    def test_multilple_types
-      e = assert_raises Exceptions::InvalidSchemaError do
-        Schema.new do
-          type :number, cast: [String]
-        end
-      end
-      assert_equal 'Casting is only allowed for single-value datatypes, '\
-                   'but type Schemacop::NumberValidator has classes ["Integer", "Float"].',
-                   e.message
-    end
-    def test_custom_castings
-      s = Schema.new do
-        type :integer, cast: { String => proc { |v| Integer(v) } }
-      end
-      assert_equal 42, s.validate!('42')
-    end
-    def test_decimal_basis_castings
-      s = Schema.new do
-        type :integer, cast: [String]
-      end
-      assert_equal 1, s.validate!('01')
-      assert_equal 8, s.validate!('08')
-      assert_equal 11, s.validate!('011')
-    end
-    def test_string_to_nil_castings
-      s = Schema.new do
-        opt :int_field, :integer, cast: [String]
-        opt :float_field, :float, cast: [String]
-      end
-      expected_int = { int_field: nil }
-      expected_float = { float_field: nil }
-      assert_equal expected_int, s.validate!(int_field: nil)
-      assert_equal expected_int, s.validate!(int_field: "")
-      assert_equal expected_int, s.validate!(int_field: "     ")
-      assert_equal expected_float, s.validate!(float_field: nil)
-      assert_equal expected_float, s.validate!(float_field: "")
-      assert_equal expected_float, s.validate!(float_field: "     ")
-    end
-  end
-end