schemacop 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 553c564f36cf2b16bd1bc72f48f75abcaef6d66e
-  data.tar.gz: 9546f609f7e8e58db4012efd82ca4dee1ae21788
+  metadata.gz: 2a881f50a99b3649b5c14fa9abf22c9710bdde01
+  data.tar.gz: 4024af09852c2778bc001b48c535fadf37e9aea2
 SHA512:
-  metadata.gz: c033fe31d11708a6f499869d9736b4b42081c02860270e48776ac86e9181f0522668dd3fa18ab80f31f2621453a3ac32493fab6e2da1502d61d028a58a621f25
-  data.tar.gz: 219c873fbeac36c803011553d34a88d073da8c30b61119cf0647f8fc3347cc736f8ad4306411a23173a79043592c4a697b3f984134cc91a0ac5f7c02b37817f1
+  metadata.gz: 28d55b6ee46e777552d5a666d20e79d1ed6e2867c00b7540c8d2c07195ba3968617430d2b1ea50151e00e6ddf3007548ed2ecdf97b67e36db775ead8331c3ff1
+  data.tar.gz: e24a7f4e3edc58582c7289aa1f8497c2f96211e3b5f1e76c86fd896ef3dde56fcdb584c0f57f903904fec656c879a582d81fcaf651c02a077f38cf5e558da9d4

data/CHANGELOG.md

@@ -10,6 +10,24 @@
 ### Changes
 -->
 
+## 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

data/README.md

@@ -79,7 +79,7 @@ end
 At runtime:
 
 ```ruby
-my_shema.validate!(
+my_schema.validate!(
   # Your data goes here
 )
 ```
@@ -332,11 +332,16 @@ The following types are supported by Schemacop by default:
 
 * `: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.
 

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.3.0

data/doc/Schemacop.html

@@ -109,7 +109,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/ArrayValidator.html

@@ -319,7 +319,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/BooleanValidator.html

@@ -135,7 +135,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Collector.html

@@ -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,7 +701,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Exceptions.html

@@ -105,7 +105,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>

data/doc/Schemacop/Exceptions/InvalidSchemaError.html

@@ -114,7 +114,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed May 17 10:53:58 2017 by
+  Generated on Thu May 18 13:17:23 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.3.1).
 </div>