schemacop 2.1.0 → 2.4.0

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>
 
@@ -109,7 +109,7 @@
       <li class="public ">
   <span class="summary_signature">
     
-      <a href="#current_path-instance_method" title="#current_path (instance method)">#<strong>current_path</strong>  &#x21d2; Object </a>
+      <a href="#exceptions-instance_method" title="#exceptions (instance method)">#<strong>exceptions</strong>  &#x21d2; Object </a>
     
 
     
@@ -128,7 +128,7 @@
   
 
   
-    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute current_path.</p>
+    <span class="summary_desc"><div class='inline'><p>Returns the value of attribute exceptions.</p>
 </div></span>
   
 </li>
@@ -150,6 +150,28 @@
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong>(error_msg)  &#x21d2; Object </a>
     
 
@@ -194,7 +216,30 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>  &#x21d2; Collector </a>
+      <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>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(data)  &#x21d2; Collector </a>
     
 
     
@@ -219,7 +264,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong>(segment)  &#x21d2; Object </a>
+      <a href="#override_value-instance_method" title="#override_value (instance method)">#<strong>override_value</strong>(value)  &#x21d2; Object </a>
     
 
     
@@ -235,6 +280,29 @@
   
     <span class="summary_desc"><div class='inline'></div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#path-instance_method" title="#path (instance method)">#<strong>path</strong>(segment, index, type)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>Construct the current path.</p>
+</div></span>
+  
 </li>
 
       
@@ -269,7 +337,7 @@
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
   
-    #<strong>initialize</strong>  &#x21d2; <tt><span class='object_link'><a href="" title="Schemacop::Collector (class)">Collector</a></span></tt> 
+    #<strong>initialize</strong>(data)  &#x21d2; <tt><span class='object_link'><a href="" title="Schemacop::Collector (class)">Collector</a></span></tt> 
   
 
   
@@ -294,14 +362,20 @@
 5
 6
 7
-8</pre>
+8
+9
+10
+11</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 5</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</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='ivar'>@current_datappoint_path</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_data'>data</span><span class='rbracket'>]</span>
+  <span class='ivar'>@current_index</span> <span class='op'>=</span> <span class='kw'>nil</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -316,9 +390,9 @@
       
       <span id=""></span>
       <div class="method_details first">
-  <h3 class="signature first" id="current_path-instance_method">
+  <h3 class="signature first" id="exceptions-instance_method">
   
-    #<strong>current_path</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+    #<strong>exceptions</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
   
 
   
@@ -326,7 +400,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Returns the value of attribute current_path</p>
+    <p>Returns the value of attribute exceptions</p>
 
 
   </div>
@@ -347,8 +421,8 @@
     <td>
       <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 3</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_current_path'>current_path</span>
-  <span class='ivar'>@current_path</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>
@@ -363,7 +437,39 @@
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="error-instance_method">
+  <h3 class="signature first" id="data-instance_method">
+  
+    #<strong>data</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+13
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 13</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
+  <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>unless</span> <span class='id identifier rubyid_valid?'>valid?</span>
+  <span class='ivar'>@current_datappoint_path</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="error-instance_method">
   
     #<strong>error</strong>(error_msg)  &#x21d2; <tt>Object</tt> 
   
@@ -377,19 +483,19 @@
       <pre class="lines">
 
 
-27
-28
-29
-30
-31
-32</pre>
+65
+66
+67
+68
+69
+70</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 65</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>
-    <span class='label'>path:</span> <span class='id identifier rubyid_current_path'>current_path</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='comma'>,</span>
+    <span class='label'>path:</span> <span class='ivar'>@current_path</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span><span class='comma'>,</span>
     <span class='label'>message:</span> <span class='id identifier rubyid_error_msg'>error_msg</span>
   <span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
@@ -413,14 +519,14 @@
       <pre class="lines">
 
 
-21
-22
-23
-24
-25</pre>
+59
+60
+61
+62
+63</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 59</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>
@@ -433,9 +539,65 @@
 </div>
     
       <div class="method_details ">
-  <h3 class="signature " id="path-instance_method">
+  <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> 
   
-    #<strong>path</strong>(segment)  &#x21d2; <tt>Object</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">
+
+
+76
+77
+78
+79</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 76</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 ">
+  <h3 class="signature " id="override_value-instance_method">
+  
+    #<strong>override_value</strong>(value)  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -447,21 +609,111 @@
       <pre class="lines">
 
 
-14
-15
-16
-17
-18
-19</pre>
+51
+52
+53
+54
+55
+56
+57</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 51</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_override_value'>override_value</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='ivar'>@current_datappoint_path</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>&gt;</span> <span class='int'>1</span>
+    <span class='ivar'>@current_datappoint_path</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>2</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='ivar'>@current_index</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+  <span class='kw'>else</span>
+    <span class='ivar'>@current_datappoint_path</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="path-instance_method">
+  
+    #<strong>path</strong>(segment, index, type)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</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">
+
+
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/schemacop/collector.rb', line 23</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='comma'>,</span> <span class='id identifier rubyid_index'>index</span><span class='comma'>,</span> <span class='id identifier rubyid_type'>type</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_ignore_this_segment'>ignore_this_segment</span> <span class='op'>=</span> <span class='kw'>false</span>
+
+  <span class='id identifier rubyid_previous_index'>previous_index</span> <span class='op'>=</span> <span class='ivar'>@current_index</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'>else</span>
+    <span class='kw'>unless</span> <span class='ivar'>@current_datappoint_path</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
+      <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='symbol'>:hash</span>
+        <span class='ivar'>@current_datappoint_path</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
+      <span class='kw'>else</span>
+        <span class='ivar'>@current_datappoint_path</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+      <span class='kw'>end</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='ivar'>@current_datappoint_path</span> <span class='op'>&lt;&lt;</span> <span class='ivar'>@current_datappoint_path</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
+    <span class='ivar'>@current_index</span> <span class='op'>=</span> <span class='id identifier rubyid_index'>index</span>
+  <span class='kw'>end</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='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_index</span> <span class='op'>=</span> <span class='id identifier rubyid_previous_index'>previous_index</span>
+  <span class='ivar'>@current_datappoint_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='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 +757,12 @@
       <pre class="lines">
 
 
-10
-11
-12</pre>
+18
+19
+20</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 18</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 +777,9 @@
 </div>
 
       <div id="footer">
-  Generated on Tue May 16 11:56:24 2017 by
+  Generated on Mon Oct 28 16:21:59 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>