schemacop 2.0.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57fd66ee6db934d9c0c2026d2d9dab992d777b01
-  data.tar.gz: 27cda8b63a0962684c0f815145aa5e3fba9f3f6c
+SHA256:
+  metadata.gz: f276c94be15a6c27b4c690e71cafe375db73b53984a700205a9b4a78024a31da
+  data.tar.gz: 82dabde2bd0e6fc7fb06a5ebef3b4cf2065e718a0c27bb419960199b9898b145
 SHA512:
-  metadata.gz: 9fe380ead2ad62aa1d12171a49e1ca7d3ff3019d3c4839448818e724892e2d611702146cea0f12a5671a04db2ad98345a252da60d5aa8e9412e551112a2eb635
-  data.tar.gz: 3deefe749765e7e662f5878175ec9f1cb3aaebbd892c5d45ba0dd9b044bb6fd12baafd2ee22c13a5dc13e18d226ccd51d214b3830d96d2c15d0efe581c0a40ef
+  metadata.gz: 6bb7bcb290cffe2bdf0089e98dc977a2d6d90458875cd89d84756cd3749bfd925fa5ff1987fa4b19ad1c89cee52944385d7e84ea8e8dea417db8c7cb007a4507
+  data.tar.gz: 3d3122e09ff0aaed4605daec77228afbf38b02e604c0498bb8cd8c7a6bb5a8d17914378ba580f72d6e0155cef4dfa3b192689f7bf6a259d1efd8be82831ce746

data/.rubocop.yml

@@ -1,6 +1,4 @@
 AllCops:
-  TargetRubyVersion: 2.3
-
   Exclude:
     - 'local/**/*'
     - 'vendor/**/*'
@@ -10,21 +8,13 @@ AllCops:
     - 'db/schema.rb'
     - 'locale/translations.rb'
     - 'lib/scratch.rb'
+    - 'schemacop.gemspec'
 
   DisplayCopNames: true
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 Style/SignalException:
   EnforcedStyle: only_fail
 
-Style/ConditionalAssignment:
-  Enabled: false
-
-Style/IndentArray:
-  EnforcedStyle: consistent
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -53,9 +43,6 @@ Metrics/LineLength:
 Metrics/BlockNesting:
   Enabled: false
 
-Metrics/BlockLength:
-  Enabled: false
-
 Style/IfUnlessModifier:
   Enabled: false
 
@@ -93,8 +80,5 @@ Style/ClassAndModuleChildren:
   #
   # The compact style is only forced, for classes / modules with one child.
 
-Style/NumericPredicate:
-  Enabled: false
-
 Style/FormatString:
   Enabled: false

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
- - 2.0
- - 2.2
  - 2.3.0
 script:
  - bundle install

data/CHANGELOG.md

@@ -10,6 +10,55 @@
 ### Changes
 -->
 
+## 2.3.2 (2019-09-26)
+
+### New features
+
+* Add ability to return custom error messages from `:check` blocks
+
+## 2.3.1 (2019-08-19)
+
+### Changes
+
+* Make compatible with Rails 6
+
+## 2.3.0 (2017-05-18)
+
+### New features
+
+* Option `strict` for the Type `:object`
+
+  This option, which defaults to true, ensures that instance classes are checked
+  strictly. If set to false, instances of derived classes are also allowed.
+
+### Bug fixes
+
+* Removed '/root' from the paths in the error messages
+
+### Changes
+
+* Added tests for the Collector paths to ensure correct behavior
+* Added symbol Type to the short forms test
+
+## 2.2.0 (2017-05-17)
+
+### Changes
+
+* Handle `ActiveSupport::HashWithIndifferentAccess` objects gracefully when
+  performing the validation. This allows the user to specify the schema using
+  a mixture of symbols and strings, but during the validation of a
+  `HashWithIndifferentAccess` it transparently converts the keys, both in the
+  schema and in the hash, to symbols.
+
+  In the event that a key is defined both in the string and symbol version,
+  Schemacop expects a Ruby hash and will throw a ValidationError otherwise.
+
+## 2.1.0 (2017-05-16)
+
+### New features
+
+* Validator for type Symbol, accessible with the symbol `:symbol`
+
 ## 2.0.0 (2017-05-15)
 
 ### Changes

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Sitrox
+Copyright (c) 2019 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -79,7 +79,7 @@ end
 At runtime:
 
 ```ruby
-my_shema.validate!(
+my_schema.validate!(
   # Your data goes here
 )
 ```
@@ -108,7 +108,7 @@ this:
 s = Schema.new do
   type :integer
   type :hash do
-    req 'name' do
+    req 'present' do
       type :boolean
     end
   end
@@ -182,7 +182,7 @@ Consider a scenario in which you want to have the following rule set:
 The corresponding schema would look as follows:
 
 ```ruby
-Schma.new do
+Schema.new do
   type :integer, if: proc { |data| data.odd? }, max: 15
   type :integer
 end
@@ -203,8 +203,8 @@ the type checking, meaning that it only gets executed if the data has the right
 type and the proc in `if` (if any) has returned true.
 
 The proc passed to the `check` option is given the data being analyzed. It is to
-return true if the data passes the custom check. If it returns false, Schemacop
-considers the data to be invalid.
+return true if the data passes the custom check. If it returns false or an error
+message as a string, Schemacop considers the data to be invalid.
 
 The following example illustrates the use of the option `check`: Consider a
 scenario in which you want the following rule set:
@@ -224,10 +224,21 @@ end
 The above Type Line has type `:string` and two options (`min` and `check`). The
 option `min` is supported by the `:string` validator (covered later).
 
+You can also specify a custom error message by returning a string:
+
+
+```ruby
+Schema.new do
+  type :integer, check: proc { |i| i.even? ? true : 'Custom error' }
+end
+```
+
+This will include `Custom error` in the validation error message.
+
 ### Field Line
 
-Inside a Type Line of type `:hash` or `Hash`, you may specify an arbitrary
-number of field lines (one for each key-value pair you want to be in the hash).
+Inside a Type Line of type `:hash`, you may specify an arbitrary number of field
+lines (one for each key-value pair you want to be in the hash).
 
 Field Lines start with one of the following six identifiers: `req`, `req?`,
 `req!`, `opt`, `opt?` or `opt!`:
@@ -273,11 +284,42 @@ end
 You might find the notation cumbersome, and you'd be right to say so. Luckily
 there are plenty of short forms available which we will see below.
 
+#### Handling hashes with indifferent access
+
+Schemacop has special handling for objects of the class
+`ActiveSupport::HashWithIndifferentAccess`: You may specify the keys as symbols
+or strings, and Schemacop will handle the conversion necessary for proper
+validation internally. Note that if you define the same key as string and
+symbol, it will throw a `ValidationError` [exception](#exceptions) when asked to
+validate a hash with indifferent access.
+
+Thus, the following two schema definitions are equivalent when validating a hash
+with indifferent access:
+
+```ruby
+Schema.new do
+  type :hash do
+    req :name do
+      type :string
+    end
+  end
+end
+
+Schema.new do
+  type :hash do
+    req 'name' do
+      type :string
+    end
+  end
+end
+```
+
 ## Types
 
-The following types are supported by Schemacop:
-<!-- TODO: Test the following statement: (you can easily extend them by writing
-another `your_validator.rb` class under `validator/`): -->
+Types are defined via their validators, which is a class under `validator/`.
+Each validator is sourced by `schemacop.rb`.
+
+The following types are supported by Schemacop by default:
 
 * `:boolean` accepts a Ruby TrueClass or FalseClass instance.
 
@@ -297,13 +339,20 @@ another `your_validator.rb` class under `validator/`): -->
 
   - supported options: `min`, `max` (bounds for string length)
 
+* `:symbol` accepts a Ruby Symbol.
+
 * `:object` accepts an arbitrary Ruby object (any object if no option is given).
 
-  - supported option: `classes`: Ruby class (or an array of them) that will be
-    the only recognized filters. Unlike other options, this one affects not the
-    validation but the type recognition, meaning that you can have multiple Type
-    Lines with different `classes` option for the same field, each having its
-    own validation (e.g. through the option `check`).
+  Supported options:
+
+  - `classes`: Ruby class (or an array of them) that will be the only recognized
+    filters. Unlike other options, this one affects not the validation but the
+    type recognition, meaning that you can have multiple Type Lines with
+    different `classes` option for the same field, each having its own
+    validation (e.g. through the option `check`).
+
+  - `strict`: Boolean option, defaults to true. If set to false, the validator
+    also allows derived classes of those specified with `classes`.
 
 * `:array` accepts a Ruby Array.
 
@@ -314,7 +363,7 @@ another `your_validator.rb` class under `validator/`): -->
   - TODO no lookahead for different arrays, see
     validator_array_test#test_multiple_arrays
 
-* `:hash` accepts a Ruby Hash.
+* `:hash` accepts a Ruby Hash or an `ActiveSupport::HashWithIndifferentAccess`.
 
   - accepts a block with an arbitrary number of Field Lines.
 
@@ -531,4 +580,4 @@ to [SubGit](http://www.subgit.com/) for their great open source licensing.
 
 ## Copyright
 
-Copyright (c) 2017 Sitrox. See `LICENSE` for further details.
+Copyright (c) 2019 Sitrox. See `LICENSE` for further details.

data/Rakefile

@@ -18,11 +18,15 @@ task :gemspec do
     spec.add_development_dependency 'rake'
     spec.add_development_dependency 'ci_reporter', '~> 2.0'
     spec.add_development_dependency 'ci_reporter_minitest'
-    spec.add_development_dependency 'activesupport'
     spec.add_development_dependency 'haml'
     spec.add_development_dependency 'yard'
     spec.add_development_dependency 'rubocop', '0.35.1'
     spec.add_development_dependency 'redcarpet'
+
+    # This lower bound for ActiveSupport is not necessarily true. Schemacop
+    # needs access to ActiveSupport::HashWithIndifferentAccess and expects
+    # behavior of that as in version 5 of ActiveSupport.
+    spec.add_dependency 'activesupport', '>= 4.0'
   end
 
   File.open('schemacop.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.3.2

data/doc/Schemacop.html

@@ -6,7 +6,7 @@
 <title>
   Module: Schemacop
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -79,7 +79,7 @@
   <dl>
     <dt>Defined in:</dt>
     <dd>lib/schemacop.rb<span class="defines">,<br />
-  lib/schemacop/node.rb,<br /> lib/schemacop/schema.rb,<br /> lib/schemacop/collector.rb,<br /> lib/schemacop/root_node.rb,<br /> lib/schemacop/field_node.rb,<br /> lib/schemacop/node_resolver.rb,<br /> lib/schemacop/node_with_block.rb,<br /> lib/schemacop/node_supporting_type.rb,<br /> lib/schemacop/node_supporting_field.rb,<br /> lib/schemacop/validator/nil_validator.rb,<br /> lib/schemacop/validator/hash_validator.rb,<br /> lib/schemacop/validator/array_validator.rb,<br /> lib/schemacop/validator/float_validator.rb,<br /> lib/schemacop/validator/number_validator.rb,<br /> lib/schemacop/validator/object_validator.rb,<br /> lib/schemacop/validator/string_validator.rb,<br /> lib/schemacop/validator/boolean_validator.rb,<br /> lib/schemacop/validator/integer_validator.rb</span>
+  lib/schemacop/node.rb,<br /> lib/schemacop/schema.rb,<br /> lib/schemacop/collector.rb,<br /> lib/schemacop/root_node.rb,<br /> lib/schemacop/field_node.rb,<br /> lib/schemacop/node_resolver.rb,<br /> lib/schemacop/node_with_block.rb,<br /> lib/schemacop/node_supporting_type.rb,<br /> lib/schemacop/node_supporting_field.rb,<br /> lib/schemacop/validator/nil_validator.rb,<br /> lib/schemacop/validator/hash_validator.rb,<br /> lib/schemacop/validator/array_validator.rb,<br /> lib/schemacop/validator/float_validator.rb,<br /> lib/schemacop/validator/number_validator.rb,<br /> lib/schemacop/validator/object_validator.rb,<br /> lib/schemacop/validator/string_validator.rb,<br /> lib/schemacop/validator/symbol_validator.rb,<br /> lib/schemacop/validator/boolean_validator.rb,<br /> lib/schemacop/validator/integer_validator.rb</span>
 </dd>
   </dl>
   
@@ -93,7 +93,7 @@
     
   
     
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Schemacop/ArrayValidator.html" title="Schemacop::ArrayValidator (class)">ArrayValidator</a></span>, <span class='object_link'><a href="Schemacop/BooleanValidator.html" title="Schemacop::BooleanValidator (class)">BooleanValidator</a></span>, <span class='object_link'><a href="Schemacop/Collector.html" title="Schemacop::Collector (class)">Collector</a></span>, <span class='object_link'><a href="Schemacop/FieldNode.html" title="Schemacop::FieldNode (class)">FieldNode</a></span>, <span class='object_link'><a href="Schemacop/FloatValidator.html" title="Schemacop::FloatValidator (class)">FloatValidator</a></span>, <span class='object_link'><a href="Schemacop/HashValidator.html" title="Schemacop::HashValidator (class)">HashValidator</a></span>, <span class='object_link'><a href="Schemacop/IntegerValidator.html" title="Schemacop::IntegerValidator (class)">IntegerValidator</a></span>, <span class='object_link'><a href="Schemacop/NilValidator.html" title="Schemacop::NilValidator (class)">NilValidator</a></span>, <span class='object_link'><a href="Schemacop/Node.html" title="Schemacop::Node (class)">Node</a></span>, <span class='object_link'><a href="Schemacop/NodeResolver.html" title="Schemacop::NodeResolver (class)">NodeResolver</a></span>, <span class='object_link'><a href="Schemacop/NodeSupportingField.html" title="Schemacop::NodeSupportingField (class)">NodeSupportingField</a></span>, <span class='object_link'><a href="Schemacop/NodeSupportingType.html" title="Schemacop::NodeSupportingType (class)">NodeSupportingType</a></span>, <span class='object_link'><a href="Schemacop/NodeWithBlock.html" title="Schemacop::NodeWithBlock (class)">NodeWithBlock</a></span>, <span class='object_link'><a href="Schemacop/NumberValidator.html" title="Schemacop::NumberValidator (class)">NumberValidator</a></span>, <span class='object_link'><a href="Schemacop/ObjectValidator.html" title="Schemacop::ObjectValidator (class)">ObjectValidator</a></span>, <span class='object_link'><a href="Schemacop/RootNode.html" title="Schemacop::RootNode (class)">RootNode</a></span>, <span class='object_link'><a href="Schemacop/Schema.html" title="Schemacop::Schema (class)">Schema</a></span>, <span class='object_link'><a href="Schemacop/StringValidator.html" title="Schemacop::StringValidator (class)">StringValidator</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Schemacop/ArrayValidator.html" title="Schemacop::ArrayValidator (class)">ArrayValidator</a></span>, <span class='object_link'><a href="Schemacop/BooleanValidator.html" title="Schemacop::BooleanValidator (class)">BooleanValidator</a></span>, <span class='object_link'><a href="Schemacop/Collector.html" title="Schemacop::Collector (class)">Collector</a></span>, <span class='object_link'><a href="Schemacop/FieldNode.html" title="Schemacop::FieldNode (class)">FieldNode</a></span>, <span class='object_link'><a href="Schemacop/FloatValidator.html" title="Schemacop::FloatValidator (class)">FloatValidator</a></span>, <span class='object_link'><a href="Schemacop/HashValidator.html" title="Schemacop::HashValidator (class)">HashValidator</a></span>, <span class='object_link'><a href="Schemacop/IntegerValidator.html" title="Schemacop::IntegerValidator (class)">IntegerValidator</a></span>, <span class='object_link'><a href="Schemacop/NilValidator.html" title="Schemacop::NilValidator (class)">NilValidator</a></span>, <span class='object_link'><a href="Schemacop/Node.html" title="Schemacop::Node (class)">Node</a></span>, <span class='object_link'><a href="Schemacop/NodeResolver.html" title="Schemacop::NodeResolver (class)">NodeResolver</a></span>, <span class='object_link'><a href="Schemacop/NodeSupportingField.html" title="Schemacop::NodeSupportingField (class)">NodeSupportingField</a></span>, <span class='object_link'><a href="Schemacop/NodeSupportingType.html" title="Schemacop::NodeSupportingType (class)">NodeSupportingType</a></span>, <span class='object_link'><a href="Schemacop/NodeWithBlock.html" title="Schemacop::NodeWithBlock (class)">NodeWithBlock</a></span>, <span class='object_link'><a href="Schemacop/NumberValidator.html" title="Schemacop::NumberValidator (class)">NumberValidator</a></span>, <span class='object_link'><a href="Schemacop/ObjectValidator.html" title="Schemacop::ObjectValidator (class)">ObjectValidator</a></span>, <span class='object_link'><a href="Schemacop/RootNode.html" title="Schemacop::RootNode (class)">RootNode</a></span>, <span class='object_link'><a href="Schemacop/Schema.html" title="Schemacop::Schema (class)">Schema</a></span>, <span class='object_link'><a href="Schemacop/StringValidator.html" title="Schemacop::StringValidator (class)">StringValidator</a></span>, <span class='object_link'><a href="Schemacop/SymbolValidator.html" title="Schemacop::SymbolValidator (class)">SymbolValidator</a></span>
     
   
 </p>
@@ -109,9 +109,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon May 15 17:46:05 2017 by
+  Generated on Thu Sep 26 13:19:46 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Schemacop/ArrayValidator.html

@@ -6,7 +6,7 @@
 <title>
   Class: Schemacop::ArrayValidator
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -319,9 +319,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon May 15 17:46:05 2017 by
+  Generated on Thu Sep 26 13:19:47 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Schemacop/BooleanValidator.html

@@ -6,7 +6,7 @@
 <title>
   Class: Schemacop::BooleanValidator
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -123,7 +123,7 @@
   <h2>Method Summary</h2>
   
   <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Node.html" title="Schemacop::Node (class)">Node</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Node.html#build-class_method" title="Schemacop::Node.build (method)">build</a></span>, <span class='object_link'><a href="Node.html#class_matches%3F-class_method" title="Schemacop::Node.class_matches? (method)">class_matches?</a></span>, <span class='object_link'><a href="Node.html#clear_klasses-class_method" title="Schemacop::Node.clear_klasses (method)">clear_klasses</a></span>, <span class='object_link'><a href="Node.html#clear_symbols-class_method" title="Schemacop::Node.clear_symbols (method)">clear_symbols</a></span>, <span class='object_link'><a href="Node.html#exec_block-instance_method" title="Schemacop::Node#exec_block (method)">#exec_block</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Schemacop::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#klass-class_method" title="Schemacop::Node.klass (method)">klass</a></span>, <span class='object_link'><a href="Node.html#option-class_method" title="Schemacop::Node.option (method)">option</a></span>, <span class='object_link'><a href="Node.html#option-instance_method" title="Schemacop::Node#option (method)">#option</a></span>, <span class='object_link'><a href="Node.html#option%3F-instance_method" title="Schemacop::Node#option? (method)">#option?</a></span>, <span class='object_link'><a href="Node.html#register-class_method" title="Schemacop::Node.register (method)">register</a></span>, <span class='object_link'><a href="Node.html#resolve_type_klass-instance_method" title="Schemacop::Node#resolve_type_klass (method)">#resolve_type_klass</a></span>, <span class='object_link'><a href="Node.html#symbol-class_method" title="Schemacop::Node.symbol (method)">symbol</a></span>, <span class='object_link'><a href="Node.html#symbol_matches%3F-class_method" title="Schemacop::Node.symbol_matches? (method)">symbol_matches?</a></span>, <span class='object_link'><a href="Node.html#type_filter_matches%3F-instance_method" title="Schemacop::Node#type_filter_matches? (method)">#type_filter_matches?</a></span>, <span class='object_link'><a href="Node.html#type_label-instance_method" title="Schemacop::Node#type_label (method)">#type_label</a></span>, <span class='object_link'><a href="Node.html#type_matches%3F-class_method" title="Schemacop::Node.type_matches? (method)">type_matches?</a></span>, <span class='object_link'><a href="Node.html#type_matches%3F-instance_method" title="Schemacop::Node#type_matches? (method)">#type_matches?</a></span>, <span class='object_link'><a href="Node.html#validate-instance_method" title="Schemacop::Node#validate (method)">#validate</a></span></p>
+  <p class="inherited"><span class='object_link'><a href="Node.html#build-class_method" title="Schemacop::Node.build (method)">build</a></span>, <span class='object_link'><a href="Node.html#class_matches%3F-class_method" title="Schemacop::Node.class_matches? (method)">class_matches?</a></span>, <span class='object_link'><a href="Node.html#clear_klasses-class_method" title="Schemacop::Node.clear_klasses (method)">clear_klasses</a></span>, <span class='object_link'><a href="Node.html#clear_symbols-class_method" title="Schemacop::Node.clear_symbols (method)">clear_symbols</a></span>, <span class='object_link'><a href="Node.html#exec_block-instance_method" title="Schemacop::Node#exec_block (method)">#exec_block</a></span>, <span class='object_link'><a href="Node.html#initialize-instance_method" title="Schemacop::Node#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="Node.html#klass-class_method" title="Schemacop::Node.klass (method)">klass</a></span>, <span class='object_link'><a href="Node.html#option-class_method" title="Schemacop::Node.option (method)">option</a></span>, <span class='object_link'><a href="Node.html#option-instance_method" title="Schemacop::Node#option (method)">#option</a></span>, <span class='object_link'><a href="Node.html#option%3F-instance_method" title="Schemacop::Node#option? (method)">#option?</a></span>, <span class='object_link'><a href="Node.html#register-class_method" title="Schemacop::Node.register (method)">register</a></span>, <span class='object_link'><a href="Node.html#resolve_type_klass-instance_method" title="Schemacop::Node#resolve_type_klass (method)">#resolve_type_klass</a></span>, <span class='object_link'><a href="Node.html#symbol-class_method" title="Schemacop::Node.symbol (method)">symbol</a></span>, <span class='object_link'><a href="Node.html#symbol_matches%3F-class_method" title="Schemacop::Node.symbol_matches? (method)">symbol_matches?</a></span>, <span class='object_link'><a href="Node.html#type_filter_matches%3F-instance_method" title="Schemacop::Node#type_filter_matches? (method)">#type_filter_matches?</a></span>, <span class='object_link'><a href="Node.html#type_label-instance_method" title="Schemacop::Node#type_label (method)">#type_label</a></span>, <span class='object_link'><a href="Node.html#type_matches%3F-instance_method" title="Schemacop::Node#type_matches? (method)">#type_matches?</a></span>, <span class='object_link'><a href="Node.html#type_matches%3F-class_method" title="Schemacop::Node.type_matches? (method)">type_matches?</a></span>, <span class='object_link'><a href="Node.html#validate-instance_method" title="Schemacop::Node#validate (method)">#validate</a></span></p>
 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
@@ -135,9 +135,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon May 15 17:46:05 2017 by
+  Generated on Thu Sep 26 13:19:47 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>

data/doc/Schemacop/Collector.html

@@ -6,7 +6,7 @@
 <title>
   Class: Schemacop::Collector
   
-    &mdash; Documentation by YARD 0.9.9
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -131,6 +131,34 @@
     <span class="summary_desc"><div class='inline'><p>Returns the value of attribute current_path.</p>
 </div></span>
   
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#exceptions-instance_method" title="#exceptions (instance method)">#<strong>exceptions</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+      <span class="note title readonly">readonly</span>
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute exceptions.</p>
+</div></span>
+  
 </li>
 
     
@@ -188,6 +216,29 @@
   
     <span class="summary_desc"><div class='inline'></div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#ignore_next_segment-instance_method" title="#ignore_next_segment (instance method)">#<strong>ignore_next_segment</strong>  &#x21d2; Schemacop::Collector </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Does not include the path segment next time path is called.</p>
+</div></span>
+  
 </li>
 
       
@@ -233,7 +284,8 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'><p>Construct the current path.</p>
+</div></span>
   
 </li>
 
@@ -291,17 +343,19 @@
       <pre class="lines">
 
 
-5
 6
 7
-8</pre>
+8
+9
+10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 5</span>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 6</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@exceptions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
   <span class='ivar'>@current_path</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='ivar'>@ignore_next_segment</span> <span class='op'>=</span> <span class='kw'>false</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -355,6 +409,48 @@
 </table>
 </div>
     
+      
+      <span id=""></span>
+      <div class="method_details ">
+  <h3 class="signature " id="exceptions-instance_method">
+  
+    #<strong>exceptions</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Returns the value of attribute exceptions</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+4
+5
+6</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 4</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_exceptions'>exceptions</span>
+  <span class='ivar'>@exceptions</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
   </div>
 
 
@@ -377,15 +473,15 @@
       <pre class="lines">
 
 
-27
-28
-29
-30
-31
-32</pre>
+37
+38
+39
+40
+41
+42</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 27</span>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 37</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_error_msg'>error_msg</span><span class='rparen'>)</span>
   <span class='ivar'>@exceptions</span> <span class='op'>&lt;&lt;</span> <span class='lbrace'>{</span>
@@ -413,14 +509,14 @@
       <pre class="lines">
 
 
-21
-22
-23
-24
-25</pre>
+31
+32
+33
+34
+35</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 31</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_exception_message'>exception_message</span>
   <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Schemacop validation failed:\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>+</span> <span class='ivar'>@exceptions</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span>
@@ -430,6 +526,62 @@
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="ignore_next_segment-instance_method">
+  
+    #<strong>ignore_next_segment</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="Schemacop::Collector (class)">Schemacop::Collector</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Does not include the path segment next time path is
+called.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="" title="Schemacop::Collector (class)">Schemacop::Collector</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+48
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 48</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_ignore_next_segment'>ignore_next_segment</span>
+  <span class='ivar'>@ignore_next_segment</span> <span class='op'>=</span> <span class='kw'>true</span>
+  <span class='kw'>return</span> <span class='kw'>self</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
       <div class="method_details ">
@@ -441,27 +593,51 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Construct the current path</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-14
-15
-16
 17
 18
-19</pre>
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 14</span>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 17</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_path'>path</span><span class='lparen'>(</span><span class='id identifier rubyid_segment'>segment</span><span class='rparen'>)</span>
-  <span class='ivar'>@current_path</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_segment'>segment</span>
+  <span class='id identifier rubyid_ignore_this_segment'>ignore_this_segment</span> <span class='op'>=</span> <span class='kw'>false</span>
+  <span class='kw'>if</span> <span class='ivar'>@ignore_next_segment</span>
+    <span class='id identifier rubyid_ignore_this_segment'>ignore_this_segment</span> <span class='op'>=</span> <span class='kw'>true</span>
+    <span class='ivar'>@ignore_next_segment</span> <span class='op'>=</span> <span class='kw'>false</span>
+  <span class='kw'>end</span>
+
+  <span class='ivar'>@current_path</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_segment'>segment</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ignore_this_segment'>ignore_this_segment</span>
+
   <span class='kw'>yield</span>
 <span class='kw'>ensure</span>
-  <span class='ivar'>@current_path</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span>
+  <span class='ivar'>@current_path</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ignore_this_segment'>ignore_this_segment</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -505,12 +681,12 @@
       <pre class="lines">
 
 
-10
-11
-12</pre>
+12
+13
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 12</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_valid?'>valid?</span>
   <span class='ivar'>@exceptions</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
@@ -525,9 +701,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon May 15 17:46:05 2017 by
+  Generated on Thu Sep 26 13:19:46 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.9 (ruby-2.3.1).
+  0.9.20 (ruby-2.6.2).
 </div>
 
     </div>