schemacop 1.0.2 → 2.0.0

data/lib/schemacop/node_supporting_type.rb

@@ -0,0 +1,112 @@
+module Schemacop
+  class NodeSupportingType < NodeWithBlock
+    block_method :type
+
+    def self.build(options, &block)
+      new(nil, options, &block)
+    end
+
+    def initialize(options = {}, &block)
+      super(options)
+
+      @types = []
+      exec_block(&block)
+
+      if @types.none?
+        fail Exceptions::InvalidSchemaError, 'Block must contain a type definition or not be given at all.' if block_given?
+        type :object
+      end
+
+      # if @types.none?
+      #   super(options)
+      #   exec_block(&block)
+      #   if @types.none?
+      #     fail Exceptions::InvalidSchemaError, 'Block must contain a type definition or not be given at all.' if block_given?
+      #   end
+      # else
+      #   super({})
+      # end
+    end
+
+    def exec_block(&block)
+      super
+    rescue NoMethodError
+      @types = []
+      type :hash, {}, &block
+    end
+
+    # required signature:
+    # First argument must be a type or an array of types
+    # Following arguments may be subtypes
+    # Last argument may be an options hash.
+    # Options and given block are passed to the last specified type.
+    # Not permitted to give subtypes / options / a block if an array of types is given.
+    #
+    # TODO: Probably change this method so that the 'rescue NoMethodError'
+    # happens in here directly and not in the constructor. This way we can
+    # always call 'type', even if we don't have one and the type is auto-guessed
+    # as it formerly was the case in the constructor.
+    def type(*args, &block)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      types = [*args.shift]
+      subtypes = args
+
+      unless types.any?
+        fail Exceptions::InvalidSchemaError, 'At least one type must be given.'
+      end
+
+      if subtypes.any? && types.size > 1
+        fail Exceptions::InvalidSchemaError, "First given type can't be an array if subtypes are given."
+      end
+
+      if types.size > 1 && options.any?
+        fail Exceptions::InvalidSchemaError, 'No options can be specified if multiple types are given.'
+      end
+
+      types.each do |type|
+        klass = resolve_type_klass(type)
+
+        if subtypes.any?
+          unless klass <= NodeSupportingType
+            fail "Node #{klass} does not support subtypes."
+          end
+
+          child = klass.new do
+            self.type(*subtypes, options, &block)
+          end
+
+          # child = klass.build(options)
+          #
+          #
+          # child.type(*subtypes, &block)
+        else
+          if klass == ObjectValidator && type.is_a?(Class)
+            options[:classes] = type
+          end
+
+          child = klass.new(options, &block)
+        end
+
+        @types << child
+      end
+    end
+
+    def validate(data, collector)
+      super
+
+      validate_types(data, collector)
+    end
+
+    protected
+
+    def validate_types(data, collector)
+      unless (match = @types.find { |t| t.type_matches?(data) })
+        allowed_types = @types.map(&:type_label)
+
+        collector.error "Data type not matching: #{data.class}, allowed types: #{allowed_types.join('; ')}"
+        return
+      end
+      match.validate(data, collector)
+    end
+  end
+end

data/lib/schemacop/node_with_block.rb

@@ -0,0 +1,16 @@
+module Schemacop
+  class NodeWithBlock < Node
+    class_attribute :block_methods
+    self.block_methods = [].freeze
+
+    def self.block_method(name)
+      self.block_methods += [name]
+    end
+
+    def exec_block(&block)
+      return unless block_given?
+      se = ScopedEnv.new(self, self.class.block_methods)
+      se.instance_exec(&block)
+    end
+  end
+end

data/lib/schemacop/root_node.rb

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

data/lib/schemacop/schema.rb

@@ -0,0 +1,61 @@
+module Schemacop
+  class Schema
+    # Create a new Schema
+    #
+    # For detailed usage, please refer to README.md in the root of this project.
+    #
+    # @param args [Array] An array of arguments to apply to the root node of the
+    #   Schema.
+    # @param block A block with further Schema specification.
+    # @raise [Schemacop::Exceptions::InvalidSchemaError] If the Schema defined
+    #   is invalid.
+    def initialize(*args, &block)
+      @root = HashValidator.new do
+        req :root, *args, &block
+      end
+    end
+
+    # Query data validity
+    #
+    # @param data The data to validate.
+    # @return [Boolean] True if the data is valid, false otherwise.
+    def valid?(data)
+      validate(data).valid?
+    end
+
+    # Query data validity
+    #
+    # @param data The data to validate.
+    # @return [Boolean] True if data is invalid, false otherwise.
+    def invalid?(data)
+      !valid?(data)
+    end
+
+    # Validate data for the defined Schema
+    #
+    # @param data The data to validate.
+    # @return [Schemacop::Collector] The object that collected errors
+    #   throughout the validation.
+    def validate(data)
+      collector = Collector.new
+      @root.fields[:root].validate({ root: data }, collector)
+      return collector
+    end
+
+    # Validate data for the defined Schema
+    #
+    # @param data The data to validate.
+    # @raise [Schemacop::Exceptions::ValidationError] If the data is invalid,
+    #   this exception is thrown.
+    # @return nil
+    def validate!(data)
+      collector = validate(data)
+
+      unless collector.valid?
+        fail Exceptions::ValidationError, collector.exception_message
+      end
+
+      return nil
+    end
+  end
+end

data/lib/schemacop/scoped_env.rb

@@ -0,0 +1,18 @@
+class ScopedEnv
+  def initialize(delegation_object, methods)
+    @delegation_object = delegation_object
+    @methods = methods
+  end
+
+  def method_missing(symbol, *args, &block)
+    if @methods.include?(symbol)
+      @delegation_object.send(symbol, *args, &block)
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(symbol, include_private = false)
+    @methods.include?(symbol) || super
+  end
+end

data/lib/schemacop/validator/array_validator.rb

@@ -0,0 +1,30 @@
+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}]") do
+          validate_types(entry, collector)
+        end
+      end
+    end
+  end
+end

data/lib/schemacop/validator/boolean_validator.rb

@@ -0,0 +1,5 @@
+module Schemacop
+  class BooleanValidator < Node
+    register symbols: :boolean, klasses: [TrueClass, FalseClass]
+  end
+end

data/lib/schemacop/validator/float_validator.rb

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

data/lib/schemacop/validator/hash_validator.rb

@@ -0,0 +1,18 @@
+module Schemacop
+  class HashValidator < NodeSupportingField
+    register symbols: :hash, klasses: Hash
+
+    def validate(data, collector)
+      super
+
+      allowed_fields = @fields.keys
+      obsolete_keys = data.keys - allowed_fields
+
+      collector.error "Obsolete keys: #{obsolete_keys.inspect}." if obsolete_keys.any?
+
+      @fields.values.each do |field|
+        field.validate(data, collector)
+      end
+    end
+  end
+end

data/lib/schemacop/validator/integer_validator.rb

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

data/lib/schemacop/validator/nil_validator.rb

@@ -0,0 +1,5 @@
+module Schemacop
+  class NilValidator < Node
+    register symbols: :nil, klasses: NilClass
+  end
+end

data/lib/schemacop/validator/number_validator.rb

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,21 @@
+module Schemacop
+  class ObjectValidator < Node
+    register symbols: :object, klasses: Object
+
+    option :classes
+
+    def type_label
+      "#{super} (#{classes.join(', ')})"
+    end
+
+    def type_matches?(data)
+      super && (classes.empty? || classes.include?(data.class)) && !data.nil?
+    end
+
+    private
+
+    def classes
+      [*option(:classes)]
+    end
+  end
+end

data/lib/schemacop/validator/string_validator.rb

@@ -0,0 +1,37 @@
+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/schemacop.gemspec

@@ -1,18 +1,20 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 1.0.2 ruby lib
+# stub: schemacop 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "1.0.2"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2016-10-06"
-  s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "doc/Schemacop.html".freeze, "doc/Schemacop/Exceptions.html".freeze, "doc/Schemacop/Exceptions/Base.html".freeze, "doc/Schemacop/Exceptions/InvalidSchema.html".freeze, "doc/Schemacop/Exceptions/Validation.html".freeze, "doc/Schemacop/MethodValidation.html".freeze, "doc/Schemacop/MethodValidation/ClassMethods.html".freeze, "doc/Schemacop/Validator.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "lib/schemacop.rb".freeze, "lib/schemacop/exceptions.rb".freeze, "lib/schemacop/validator.rb".freeze, "schemacop.gemspec".freeze, "test/schemacop_validator_test.rb".freeze]
+  s.date = "2017-05-15"
+  s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "doc/Schemacop.html".freeze, "doc/Schemacop/ArrayValidator.html".freeze, "doc/Schemacop/BooleanValidator.html".freeze, "doc/Schemacop/Collector.html".freeze, "doc/Schemacop/Exceptions.html".freeze, "doc/Schemacop/Exceptions/InvalidSchemaError.html".freeze, "doc/Schemacop/Exceptions/ValidationError.html".freeze, "doc/Schemacop/FieldNode.html".freeze, "doc/Schemacop/FloatValidator.html".freeze, "doc/Schemacop/HashValidator.html".freeze, "doc/Schemacop/IntegerValidator.html".freeze, "doc/Schemacop/NilValidator.html".freeze, "doc/Schemacop/Node.html".freeze, "doc/Schemacop/NodeResolver.html".freeze, "doc/Schemacop/NodeSupportingField.html".freeze, "doc/Schemacop/NodeSupportingType.html".freeze, "doc/Schemacop/NodeWithBlock.html".freeze, "doc/Schemacop/NumberValidator.html".freeze, "doc/Schemacop/ObjectValidator.html".freeze, "doc/Schemacop/RootNode.html".freeze, "doc/Schemacop/Schema.html".freeze, "doc/Schemacop/StringValidator.html".freeze, "doc/ScopedEnv.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/inheritance.graphml".freeze, "doc/inheritance.pdf".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "lib/schemacop.rb".freeze, "lib/schemacop/collector.rb".freeze, "lib/schemacop/exceptions.rb".freeze, "lib/schemacop/field_node.rb".freeze, "lib/schemacop/node.rb".freeze, "lib/schemacop/node_resolver.rb".freeze, "lib/schemacop/node_supporting_field.rb".freeze, "lib/schemacop/node_supporting_type.rb".freeze, "lib/schemacop/node_with_block.rb".freeze, "lib/schemacop/root_node.rb".freeze, "lib/schemacop/schema.rb".freeze, "lib/schemacop/scoped_env.rb".freeze, "lib/schemacop/validator/array_validator.rb".freeze, "lib/schemacop/validator/boolean_validator.rb".freeze, "lib/schemacop/validator/float_validator.rb".freeze, "lib/schemacop/validator/hash_validator.rb".freeze, "lib/schemacop/validator/integer_validator.rb".freeze, "lib/schemacop/validator/nil_validator.rb".freeze, "lib/schemacop/validator/number_validator.rb".freeze, "lib/schemacop/validator/object_validator.rb".freeze, "lib/schemacop/validator/string_validator.rb".freeze, "schemacop.gemspec".freeze, "test/custom_check_test.rb".freeze, "test/custom_if_test.rb".freeze, "test/nil_dis_allow_test.rb".freeze, "test/short_forms_test.rb".freeze, "test/test_helper.rb".freeze, "test/types_test.rb".freeze, "test/validator_array_test.rb".freeze, "test/validator_boolean_test.rb".freeze, "test/validator_float_test.rb".freeze, "test/validator_hash_test.rb".freeze, "test/validator_integer_test.rb".freeze, "test/validator_nil_test.rb".freeze, "test/validator_number_test.rb".freeze, "test/validator_object_test.rb".freeze, "test/validator_string_test.rb".freeze]
+  s.homepage = "https://github.com/sitrox/schemacop".freeze
+  s.licenses = ["MIT".freeze]
   s.rubygems_version = "2.6.6".freeze
   s.summary = "Schemacop validates ruby structures consisting of nested hashes and arrays against simple schema definitions.".freeze
-  s.test_files = ["test/schemacop_validator_test.rb".freeze]
+  s.test_files = ["test/custom_check_test.rb".freeze, "test/custom_if_test.rb".freeze, "test/nil_dis_allow_test.rb".freeze, "test/short_forms_test.rb".freeze, "test/test_helper.rb".freeze, "test/types_test.rb".freeze, "test/validator_array_test.rb".freeze, "test/validator_boolean_test.rb".freeze, "test/validator_float_test.rb".freeze, "test/validator_hash_test.rb".freeze, "test/validator_integer_test.rb".freeze, "test/validator_nil_test.rb".freeze, "test/validator_number_test.rb".freeze, "test/validator_object_test.rb".freeze, "test/validator_string_test.rb".freeze]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/test/custom_check_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+module Schemacop
+  class CustomCheckTest < Minitest::Test
+    def test_integer_check_short_form
+      s = Schema.new :integer, check: proc { |i| i.even? }
+      assert_nil s.validate!(2)
+      assert_nil s.validate!(-8)
+      assert_nil s.validate!(0)
+      assert_verr { s.validate!(1) }
+      assert_verr { s.validate!(-7) }
+      assert_verr { s.validate!(2.1) }
+    end
+
+    def test_integer_check_with_lambda
+      s = Schema.new do
+        type :integer, check: ->(i) { i.even? }
+      end
+
+      assert_nil s.validate!(2)
+      assert_nil s.validate!(-8)
+      assert_nil s.validate!(0)
+      assert_verr { s.validate!(1) }
+      assert_verr { s.validate!(-7) }
+      assert_verr { s.validate!(2.1) }
+    end
+
+    def test_in_type_dsl
+      s = Schema.new do
+        type :number, check: proc { |x| x == 42 }
+      end
+      assert_nil s.validate!(42)
+      assert_verr { s.validate!(42.1) }
+      assert_verr { s.validate!(0) }
+    end
+
+    def test_with_array
+      s = Schema.new do
+        type :array, check: proc { |a| a.first == 1 } do
+          type :integer
+        end
+      end
+      assert_nil s.validate!([1, 2, 3])
+      assert_verr { s.validate!([2, 3, 4]) }
+    end
+
+    def test_with_array_nested
+      s = Schema.new do
+        type :array, check: proc { |a| a.first == 4 } do
+          type :integer, check: proc { |i| i >= 2 }
+        end
+      end
+
+      assert_nil s.validate!([4, 3, 2])
+      assert_verr { s.validate!([3, 2]) }
+      assert_verr { s.validate!([4, 1]) }
+    end
+
+    def test_with_hash
+      s = Schema.new :hash, check: proc { |h| h.all? { |k, v| k == v } } do
+        opt 1, :integer
+        opt 'two', :string
+      end
+      assert_nil s.validate!(1 => 1, 'two' => 'two')
+      assert_verr { s.validate!(1 => 2, 'two' => 'two') }
+      assert_verr { s.validate!(1 => 1, 'two' => 'one') }
+    end
+
+    def test_mixed_if_check
+      s = Schema.new do
+        req :first_name,
+            :string,
+            if: proc { |str| str.start_with?('Sand') },
+            check: proc { |str| str == 'Sandy' }
+        req :first_name, :string, min: 3
+      end
+
+      assert_nil s.validate!(first_name: 'Bob')
+      assert_nil s.validate!(first_name: 'Sandy')
+      assert_nil s.validate!(first_name: 'Sansibar')
+
+      assert_verr { s.validate!(first_name: 'Sandkasten') }
+      assert_verr { s.validate!(first_name: 'a') }
+    end
+  end
+end