smart_diff 0.0.1 → 0.0.3

data/doc/Utils.html

@@ -106,7 +106,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#get_install_path-class_method" title="get_install_path (class method)">+ (Object) <strong>get_install_path</strong> </a>
+      <a href="#get_install_path-class_method" title="get_install_path (class method)">+ (Pathname) <strong>get_install_path</strong> </a>
     
 
     
@@ -120,7 +120,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Where in the file-system is smart_diff installed?.</p>
+</div></span>
   
 </li>
 
@@ -128,7 +130,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#inside_anchor%3F-class_method" title="inside_anchor? (class method)">+ (Boolean) <strong>inside_anchor?</strong>(tags, nd_start, nd_end) </a>
+      <a href="#inside_anchor%3F-class_method" title="inside_anchor? (class method)">+ (TrueClass, FalseClass) <strong>inside_anchor?</strong>(tags, nd_start, nd_end) </a>
     
 
     
@@ -142,7 +144,10 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Determines if the node beginning with nd_start and ending with nd_end falls
+inside an anchor.</p>
+</div></span>
   
 </li>
 
@@ -150,7 +155,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#node_end-class_method" title="node_end (class method)">+ (Object) <strong>node_end</strong>(node) </a>
+      <a href="#node_end-class_method" title="node_end (class method)">+ (Fixnum) <strong>node_end</strong>(node) </a>
     
 
     
@@ -164,7 +169,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get a node&#39;s end position.</p>
+</div></span>
   
 </li>
 
@@ -172,7 +179,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#node_start-class_method" title="node_start (class method)">+ (Object) <strong>node_start</strong>(node) </a>
+      <a href="#node_start-class_method" title="node_start (class method)">+ (Fixnum) <strong>node_start</strong>(node) </a>
     
 
     
@@ -186,7 +193,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Get a node&#39;s start position,.</p>
+</div></span>
   
 </li>
 
@@ -203,26 +212,55 @@
       <div class="method_details first">
   <h3 class="signature first" id="get_install_path-class_method">
   
-    + (<tt>Object</tt>) <strong>get_install_path</strong> 
+    + (<tt>Pathname</tt>) <strong>get_install_path</strong> 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Where in the file-system is smart_diff installed?</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Pathname</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the path to the installation of smart_diff</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-6
-7
-8
-9
-10</pre>
+11
+12
+13
+14
+15</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 6</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 11</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_get_install_path'>get_install_path</span>
   <span class='id identifier rubyid_utils_path'>utils_path</span> <span class='op'>=</span> <span class='const'>Pathname</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span>
@@ -237,7 +275,7 @@
       <div class="method_details ">
   <h3 class="signature " id="inside_anchor?-class_method">
   
-    + (<tt>Boolean</tt>) <strong>inside_anchor?</strong>(tags, nd_start, nd_end) 
+    + (<tt>TrueClass</tt>, <tt>FalseClass</tt>) <strong>inside_anchor?</strong>(tags, nd_start, nd_end) 
   
 
   
@@ -246,20 +284,91 @@
 </h3><div class="docstring">
   <div class="discussion">
     
+<p>Determines if the node beginning with nd_start and ending with nd_end falls
+inside an anchor. In other words, is the current node inside another node
+<em>which also changed</em> and has a match in the other file. (If it is an
+insertion or deletion it gets wrapped in a span so we aren&#39;t concerned
+with those.)</p>
+
+<p>In a pair of tags, the opening tag only has some of the position
+information, so they are marked with a meaningless -1. But the closing tags
+have the information needed- start and end offsets.</p>
+
+<p>Subnodes were added to the array after the outer nodes, so we check them
+here, once, against each tag, and decide how to process them as we generate
+the HTML.</p>
+
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>tags</span>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A list of all tags so far recorded.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>nd_start</span>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number representing the node&#39;s starting position.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>nd_end</span>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number representing the node&#39;s ending position.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 <p class="tag_title">Returns:</p>
 <ul class="return">
   
     <li>
       
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
+      
       
       
+        &mdash;
+        <div class='inline'>
+<p>Is it inside an anchor?</p>
+</div>
       
     </li>
   
@@ -271,17 +380,17 @@
       <pre class="lines">
 
 
-20
-21
-22
-23
-24
-25
-26
-27</pre>
+60
+61
+62
+63
+64
+65
+66
+67</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 60</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_inside_anchor?'>inside_anchor?</span><span class='lparen'>(</span><span class='id identifier rubyid_tags'>tags</span><span class='comma'>,</span> <span class='id identifier rubyid_nd_start'>nd_start</span><span class='comma'>,</span> <span class='id identifier rubyid_nd_end'>nd_end</span><span class='rparen'>)</span>
     <span class='id identifier rubyid_tags'>tags</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
@@ -299,24 +408,73 @@
       <div class="method_details ">
   <h3 class="signature " id="node_end-class_method">
   
-    + (<tt>Object</tt>) <strong>node_end</strong>(node) 
+    + (<tt>Fixnum</tt>) <strong>node_end</strong>(node) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Get a node&#39;s end position.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>node</span>
+      
+      
+        <span class='type'>(<tt>org.jrubyparser.Node</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a node in an abstract syntax tree</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number representing the node&#39;s end offset.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-16
-17
-18</pre>
+35
+36
+37</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 16</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 35</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_node_end'>node_end</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='period'>.</span><span class='id identifier rubyid_end_offset'>end_offset</span>
@@ -329,24 +487,73 @@
       <div class="method_details ">
   <h3 class="signature " id="node_start-class_method">
   
-    + (<tt>Object</tt>) <strong>node_start</strong>(node) 
+    + (<tt>Fixnum</tt>) <strong>node_start</strong>(node) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Get a node&#39;s start position,</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>node</span>
+      
+      
+        <span class='type'>(<tt>org.jrubyparser.Node</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>a node in an abstract syntax tree</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Number representing the node&#39;s start offset.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-12
-13
-14</pre>
+24
+25
+26</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/utils.rb', line 24</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_node_start'>node_start</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_node'>node</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='period'>.</span><span class='id identifier rubyid_start_offset'>start_offset</span>
@@ -361,7 +568,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:49 2013 by
+  Generated on Mon Sep 16 03:40:00 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-2.0.0).
 </div>

data/doc/_index.html

@@ -140,7 +140,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:37 2013 by
+  Generated on Mon Sep 16 03:39:58 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-2.0.0).
 </div>

data/doc/file.README.html

@@ -84,19 +84,24 @@ rather than comparing the text directly).</p>
 
 <p>This application should especially serve as an example of using the
 subdiff&#39;s produced by NodeDiff to improve the quality of the output.
-See <code>bin/smart_diff</code> .</p>
+See <code>bin/smart_diff</code>  or <a
+href="http://rubydoc.info/gems/smart_diff/0.0.1/frames">check out the
+docs</a>.</p>
+
+<h2 id="label-Install">Install</h2>
+
+<pre class="code ruby"><code class="ruby">$ jruby -S gem install smart_diff</code></pre>
 
 <h2 id="label-Usage">Usage</h2>
 
-<p>To run this, you&#39;ll need to have <code>JRuby</code> and the
-<code>jruby-parser</code> gem installed. Then run
-<code>bin/smart_diff</code> along with the paths to two versions of a ruby
+<p>Run <code>smart_diff</code> along with the paths to two versions of a ruby
 source file.</p>
 
-<pre class="code ruby"><code class="ruby">bin/smart_diff example/bar.rb example/foo.rb</code></pre>
+<pre class="code ruby"><code class="ruby">smart_diff example/bar.rb example/foo.rb</code></pre>
 
-<p>This will output an html file you can open in your browser. Check out
-<code>foo.rb-bar.rb.html</code> for a sample of the output.</p>
+<p>This will output an html file you can open in your browser. Check out <a
+href="http://edubkendo.github.io/smart_diff/file.Example.html">Example.html</a>
+for a sample of the output.</p>
 
 <p>LICENSE</p>
 
@@ -118,7 +123,7 @@ href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:44 2013 by
+  Generated on Mon Sep 16 03:40:00 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-2.0.0).
 </div>

data/doc/index.html

@@ -84,19 +84,24 @@ rather than comparing the text directly).</p>
 
 <p>This application should especially serve as an example of using the
 subdiff&#39;s produced by NodeDiff to improve the quality of the output.
-See <code>bin/smart_diff</code> .</p>
+See <code>bin/smart_diff</code>  or <a
+href="http://rubydoc.info/gems/smart_diff/0.0.1/frames">check out the
+docs</a>.</p>
+
+<h2 id="label-Install">Install</h2>
+
+<pre class="code ruby"><code class="ruby">$ jruby -S gem install smart_diff</code></pre>
 
 <h2 id="label-Usage">Usage</h2>
 
-<p>To run this, you&#39;ll need to have <code>JRuby</code> and the
-<code>jruby-parser</code> gem installed. Then run
-<code>bin/smart_diff</code> along with the paths to two versions of a ruby
+<p>Run <code>smart_diff</code> along with the paths to two versions of a ruby
 source file.</p>
 
-<pre class="code ruby"><code class="ruby">bin/smart_diff example/bar.rb example/foo.rb</code></pre>
+<pre class="code ruby"><code class="ruby">smart_diff example/bar.rb example/foo.rb</code></pre>
 
-<p>This will output an html file you can open in your browser. Check out
-<code>foo.rb-bar.rb.html</code> for a sample of the output.</p>
+<p>This will output an html file you can open in your browser. Check out <a
+href="http://edubkendo.github.io/smart_diff/file.Example.html">Example.html</a>
+for a sample of the output.</p>
 
 <p>LICENSE</p>
 
@@ -118,7 +123,7 @@ href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.</p>
 </div></div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:44 2013 by
+  Generated on Mon Sep 16 03:39:59 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-2.0.0).
 </div>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:49 2013 by
+  Generated on Mon Sep 16 03:40:00 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-2.0.0).
 </div>

data/{foo.rb-bar.rb.html → example/foo.rb-bar.rb.html}

@@ -6,7 +6,7 @@
 
     <style>
 
-    .d {                            /* deleted */
+.d {                            /* deleted */
     border: solid 1px #CC929A;
     border-radius: 3px;
     background-color: #FCBFBA;
@@ -103,7 +103,7 @@ p {
     -webkit-box-shadow: inset 0 0 6px rgba(0,0,0,0.5);
 }
 
-    
+
 </style>
 
     <script type="text/javascript">
@@ -384,7 +384,7 @@ window.onload =
 
     }
 
-    
+
 </script>
 
     </head>