RubyGems - schemacop - Versions diffs - 1.0.2 → 2.0.0 - Mend

schemacop 1.0.2 → 2.0.0

Files changed (90) hide show

checksums.yaml +4 -4
data/.gitignore +2 -1
data/.rubocop.yml +59 -1
data/CHANGELOG.md +10 -0
data/README.md +389 -199
data/Rakefile +2 -0
data/VERSION +1 -1
data/doc/Schemacop.html +41 -130
data/doc/Schemacop/ArrayValidator.html +329 -0
data/doc/Schemacop/BooleanValidator.html +145 -0
data/doc/Schemacop/Collector.html +535 -0
data/doc/Schemacop/Exceptions.html +39 -39
data/doc/Schemacop/Exceptions/InvalidSchemaError.html +124 -0
data/doc/Schemacop/Exceptions/ValidationError.html +124 -0
data/doc/Schemacop/FieldNode.html +409 -0
data/doc/Schemacop/FloatValidator.html +158 -0
data/doc/Schemacop/HashValidator.html +263 -0
data/doc/Schemacop/IntegerValidator.html +158 -0
data/doc/Schemacop/NilValidator.html +145 -0
data/doc/Schemacop/Node.html +1426 -0
data/doc/Schemacop/NodeResolver.html +242 -0
data/doc/Schemacop/NodeSupportingField.html +590 -0
data/doc/Schemacop/NodeSupportingType.html +614 -0
data/doc/Schemacop/NodeWithBlock.html +289 -0
data/doc/Schemacop/NumberValidator.html +232 -0
data/doc/Schemacop/ObjectValidator.html +288 -0
data/doc/Schemacop/RootNode.html +171 -0
data/doc/Schemacop/Schema.html +697 -0
data/doc/Schemacop/StringValidator.html +295 -0
data/doc/ScopedEnv.html +351 -0
data/doc/_index.html +190 -47
data/doc/class_list.html +24 -31
data/doc/css/full_list.css +32 -31
data/doc/css/style.css +244 -91
data/doc/file.README.html +428 -232
data/doc/file_list.html +26 -30
data/doc/frames.html +7 -16
data/doc/index.html +428 -232
data/doc/inheritance.graphml +524 -0
data/doc/inheritance.pdf +825 -0
data/doc/js/app.js +106 -77
data/doc/js/full_list.js +170 -135
data/doc/method_list.html +494 -38
data/doc/top-level-namespace.html +36 -36
data/lib/schemacop.rb +22 -7
data/lib/schemacop/collector.rb +34 -0
data/lib/schemacop/exceptions.rb +2 -8
data/lib/schemacop/field_node.rb +26 -0
data/lib/schemacop/node.rb +127 -0
data/lib/schemacop/node_resolver.rb +14 -0
data/lib/schemacop/node_supporting_field.rb +62 -0
data/lib/schemacop/node_supporting_type.rb +112 -0
data/lib/schemacop/node_with_block.rb +16 -0
data/lib/schemacop/root_node.rb +4 -0
data/lib/schemacop/schema.rb +61 -0
data/lib/schemacop/scoped_env.rb +18 -0
data/lib/schemacop/validator/array_validator.rb +30 -0
data/lib/schemacop/validator/boolean_validator.rb +5 -0
data/lib/schemacop/validator/float_validator.rb +5 -0
data/lib/schemacop/validator/hash_validator.rb +18 -0
data/lib/schemacop/validator/integer_validator.rb +5 -0
data/lib/schemacop/validator/nil_validator.rb +5 -0
data/lib/schemacop/validator/number_validator.rb +19 -0
data/lib/schemacop/validator/object_validator.rb +21 -0
data/lib/schemacop/validator/string_validator.rb +37 -0
data/schemacop.gemspec +7 -5
data/test/custom_check_test.rb +86 -0
data/test/custom_if_test.rb +95 -0
data/test/nil_dis_allow_test.rb +41 -0
data/test/short_forms_test.rb +316 -0
data/test/test_helper.rb +6 -0
data/test/types_test.rb +83 -0
data/test/validator_array_test.rb +97 -0
data/test/validator_boolean_test.rb +15 -0
data/test/validator_float_test.rb +57 -0
data/test/validator_hash_test.rb +71 -0
data/test/validator_integer_test.rb +46 -0
data/test/validator_nil_test.rb +13 -0
data/test/validator_number_test.rb +60 -0
data/test/validator_object_test.rb +87 -0
data/test/validator_string_test.rb +76 -0
metadata +78 -14
data/doc/Schemacop/Exceptions/Base.html +0 -127
data/doc/Schemacop/Exceptions/InvalidSchema.html +0 -141
data/doc/Schemacop/Exceptions/Validation.html +0 -142
data/doc/Schemacop/MethodValidation.html +0 -120
data/doc/Schemacop/MethodValidation/ClassMethods.html +0 -196
data/doc/Schemacop/Validator.html +0 -254
data/lib/schemacop/validator.rb +0 -145
data/test/schemacop_validator_test.rb +0 -257

data/doc/top-level-namespace.html CHANGED Viewed

@@ -1,12 +1,12 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html>
   <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
   Top Level Namespace
-    &mdash; Documentation by YARD 0.8.7.6
+    &mdash; Documentation by YARD 0.9.9
 </title>
@@ -15,9 +15,8 @@
   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
 <script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
+  pathId = "";
   relpath = '';
-  framesUrl = "frames.html#!top-level-namespace.html";
 </script>
@@ -28,58 +27,56 @@
   </head>
   <body>
-    <div id="header">
-      <div id="menu">
+    <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 class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>
-      <div id="search">
+        <div id="search">
     <a class="full_list_link" id="class_list_link"
         href="class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="file_list.html">
-      File List
+        <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>
-    <iframe id="search_frame"></iframe>
+        <div class="clear"></div>
+      </div>
-    <div id="content"><h1>Top Level Namespace
+      <div id="content"><h1>Top Level Namespace
 </h1>
+<div class="box_info">
-<dl class="box">
-</dl>
-<div class="clear"></div>
+</div>
 <h2>Defined Under Namespace</h2>
 <p class="children">
@@ -89,6 +86,8 @@
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="ScopedEnv.html" title="ScopedEnv (class)">ScopedEnv</a></span>
 </p>
@@ -102,11 +101,12 @@
 </div>
-    <div id="footer">
-  Generated on Thu Oct  6 19:45:02 2016 by
+      <div id="footer">
+  Generated on Mon May 15 17:46:05 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.7.6 (ruby-2.3.1).
+  0.9.9 (ruby-2.3.1).
 </div>
+    </div>
   </body>
 </html>

data/lib/schemacop.rb CHANGED Viewed

@@ -1,11 +1,26 @@
 module Schemacop
-  # {include:Schemacop::Validator.validate!}
-  # @see Schemacop::Validator.validate!
-  def self.validate!(schema, data)
-    Validator.validate!(schema, data)
-  end
 end
-require 'active_support/all'
+require 'set'
+require 'active_support/core_ext/class/attribute'
+require 'schemacop/scoped_env'
 require 'schemacop/exceptions'
-require 'schemacop/validator'
+require 'schemacop/schema'
+require 'schemacop/collector'
+require 'schemacop/node_resolver'
+require 'schemacop/node'
+require 'schemacop/node_with_block'
+require 'schemacop/node_supporting_type'
+require 'schemacop/field_node'
+require 'schemacop/root_node'
+require 'schemacop/node_supporting_field'
+require 'schemacop/validator/array_validator'
+require 'schemacop/validator/boolean_validator'
+require 'schemacop/validator/hash_validator'
+require 'schemacop/validator/number_validator'
+require 'schemacop/validator/integer_validator'
+require 'schemacop/validator/float_validator'
+require 'schemacop/validator/string_validator'
+require 'schemacop/validator/nil_validator'
+require 'schemacop/validator/object_validator' # Matches any object, must be last validator

data/lib/schemacop/collector.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module Schemacop
+  class Collector
+    attr_reader :current_path
+    def initialize
+      @exceptions = []
+      @current_path = []
+    end
+    def valid?
+      @exceptions.empty?
+    end
+    def path(segment)
+      @current_path << segment
+      yield
+    ensure
+      @current_path.pop
+    end
+    def exception_message
+      return "Schemacop validation failed:\n" + @exceptions.map do |e|
+        "- #{e[:path].join('')}: #{e[:message]}"
+      end.join("\n")
+    end
+    def error(error_msg)
+      @exceptions << {
+        path: current_path.dup,
+        message: error_msg
+      }
+    end
+  end
+end

data/lib/schemacop/exceptions.rb CHANGED Viewed

@@ -1,10 +1,4 @@
 module Schemacop::Exceptions
-  class Base < StandardError; end
-  # This exception is thrown when the given schema definition format is invalid.
-  class InvalidSchema < Base; end
-  # This exception is thrown when the given data does not comply with the given
-  # schema definition.
-  class Validation < Base; end
+  class ValidationError < RuntimeError; end
+  class InvalidSchemaError < RuntimeError; end
 end

data/lib/schemacop/field_node.rb ADDED Viewed

@@ -0,0 +1,26 @@
+module Schemacop
+  class FieldNode < NodeSupportingType
+    attr_reader :name
+    def initialize(name, required, options = {}, &block)
+      if options.any?
+        fail Exceptions::InvalidSchemaError, 'Node does not support options.'
+      end
+      super({}, &block)
+      @name = name
+      @required = required
+    end
+    def validate(data, collector)
+      unless data.key?(name)
+        collector.error "Missing key #{name.inspect}." if @required
+        return
+      end
+      collector.path "/#{name}" do
+        super(data[name], collector)
+      end
+    end
+  end
+end

data/lib/schemacop/node.rb ADDED Viewed

@@ -0,0 +1,127 @@
+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
+    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)
+      NodeResolver.register(self)
+      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
+    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) && !option(:check).call(data)
+        collector.error 'Custom :check failed.'
+      end
+    end
+  end
+end

data/lib/schemacop/node_resolver.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Schemacop
+  class NodeResolver
+    class_attribute :node_classes
+    self.node_classes = [].freeze
+    def self.register(node_class)
+      self.node_classes += [node_class]
+    end
+    def self.resolve(type)
+      node_classes.find { |c| c.type_matches?(type) }
+    end
+  end
+end

data/lib/schemacop/node_supporting_field.rb ADDED Viewed

@@ -0,0 +1,62 @@
+module Schemacop
+  class NodeSupportingField < NodeWithBlock
+    block_method :req?
+    block_method :req!
+    block_method :req
+    block_method :opt?
+    block_method :opt!
+    block_method :opt
+    attr_reader :fields
+    def initialize(options = {}, &block)
+      @fields = {}
+      super
+      exec_block(&block)
+    end
+    def req?(*args, &block)
+      field(*args, required: true, allow_nil: true, &block)
+    end
+    def req!(*args, &block)
+      field(*args, required: true, allow_nil: false, &block)
+    end
+    alias req req!
+    def opt?(*args, &block)
+      field(*args, required: false, allow_nil: true, &block)
+    end
+    def opt!(*args, &block)
+      field(*args, required: false, allow_nil: false, &block)
+    end
+    alias opt opt?
+    protected
+    def field(*args, required:, allow_nil:, &block)
+      # name = args.shift
+      # options = args.last.is_a?(Hash) ? args.pop : {}
+      name = args.shift
+      # rubocop: disable Style/IfInsideElse
+      if @fields[name]
+        @fields[name].type(*args, &block)
+      else
+        if args.any?
+          @fields[name] = FieldNode.new(name, required) do
+            type(*args, &block)
+          end
+        else
+          @fields[name] = FieldNode.new(name, required, &block)
+        end
+      end
+      # rubocop: enable Style/IfInsideElse
+      @fields[name].type(:nil) if allow_nil
+    end
+  end
+end