smart_diff 0.0.1 → 0.0.3

data/doc/SmartDiff.html

@@ -257,7 +257,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#diff-instance_method" title="#diff (instance method)">- (Object) <strong>diff</strong> </a>
+      <a href="#diff-instance_method" title="#diff (instance method)">- (java.util.ArrayList) <strong>diff</strong> </a>
     
 
     
@@ -271,7 +271,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Create a diff of the two AST objects.</p>
+</div></span>
   
 </li>
 
@@ -306,7 +308,7 @@ on AST generated by JRubyParser.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#parse-instance_method" title="#parse (instance method)">- (Object) <strong>parse</strong>(code_to_parse, file_name) </a>
+      <a href="#parse-instance_method" title="#parse (instance method)">- (org.jrubyparser.Node) <strong>parse</strong>(code_to_parse, file_name) </a>
     
 
     
@@ -320,7 +322,9 @@ on AST generated by JRubyParser.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Parse the source into an abstract syntax tree.</p>
+</div></span>
   
 </li>
 
@@ -328,7 +332,7 @@ on AST generated by JRubyParser.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#read-instance_method" title="#read (instance method)">- (Object) <strong>read</strong>(file_name) </a>
+      <a href="#read-instance_method" title="#read (instance method)">- (String) <strong>read</strong>(file_name) </a>
     
 
     
@@ -342,7 +346,9 @@ on AST generated by JRubyParser.</p>
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Read the source code into a string.</p>
+</div></span>
   
 </li>
 
@@ -665,31 +671,62 @@ on AST generated by JRubyParser.</p>
       <div class="method_details first">
   <h3 class="signature first" id="diff-instance_method">
   
-    - (<tt>Object</tt>) <strong>diff</strong> 
+    - (<tt>java.util.ArrayList</tt>) <strong>diff</strong> 
+  
+
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Create a diff of the two AST objects.</p>
+
+<p>org.jrubyparser.DeepDiff objects.</p>
 
+
+  </div>
+</div>
+<div class="tags">
   
-</h3><table class="source_code">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>java.util.ArrayList</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>An ArrayList containing</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47</pre>
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 38</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 59</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_diff'>diff</span><span class='lparen'>(</span><span class='rparen'>)</span>
   <span class='ivar'>@code_one</span> <span class='op'>=</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='ivar'>@file_one</span><span class='rparen'>)</span>
@@ -709,24 +746,89 @@ on AST generated by JRubyParser.</p>
       <div class="method_details ">
   <h3 class="signature " id="parse-instance_method">
   
-    - (<tt>Object</tt>) <strong>parse</strong>(code_to_parse, file_name) 
+    - (<tt>org.jrubyparser.Node</tt>) <strong>parse</strong>(code_to_parse, file_name) 
+  
+
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Parse the source into an abstract syntax tree. AST.</p>
 
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
-</h3><table class="source_code">
+    <li>
+      
+        <span class='name'>code_to_parse</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Ruby source code.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>file_name</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The path to the file containing code_to_parse</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>org.jrubyparser.Node</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A Node object representing the code as an</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-34
-35
-36</pre>
+49
+50
+51</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 34</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 49</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_code_to_parse'>code_to_parse</span><span class='comma'>,</span> <span class='id identifier rubyid_file_name'>file_name</span><span class='rparen'>)</span>
   <span class='const'>JRubyParser</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_code_to_parse'>code_to_parse</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:filename</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_file_name'>file_name</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
@@ -739,29 +841,78 @@ on AST generated by JRubyParser.</p>
       <div class="method_details ">
   <h3 class="signature " id="read-instance_method">
   
-    - (<tt>Object</tt>) <strong>read</strong>(file_name) 
+    - (<tt>String</tt>) <strong>read</strong>(file_name) 
   
 
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Read the source code into a string.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>file_name</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the path to a file containing ruby source</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The code read in from the file path passed in.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-25
-26
-27
-28
-29
-30
-31
-32</pre>
+32
+33
+34
+35
+36
+37
+38
+39</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff.rb', line 32</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_file_name'>file_name</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_path'>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='id identifier rubyid_file_name'>file_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span>
@@ -781,7 +932,7 @@ on AST generated by JRubyParser.</p>
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:49 2013 by
+  Generated on Mon Sep 16 03:40:01 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/Tag.html

@@ -99,7 +99,23 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>A Tag wrapping an element in an HTML file. It contains information about
+the node wrapped inside it such as the start and end offset. The
+<code>tag</code> attr contains the actual HTML, and includes information
+used to style the nodes based on whether its an insertion, deletion or
+modification. Matching modifications are wrapped in anchor tags so they can
+be linked to their matches.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
 
 
@@ -220,7 +236,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>A new instance of Tag.</p>
+<p>Construct a new tag.</p>
 </div></span>
   
 </li>
@@ -229,7 +245,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
     
 
     
@@ -243,7 +259,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>String representation of the Tag object.</p>
+</div></span>
   
 </li>
 
@@ -266,13 +284,69 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>A new instance of Tag</p>
+<p>Construct a new tag.</p>
+
+<p>The end offset of the node if it is a closing tag. for a closing tag.</p>
 
 
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
   
+    <li>
+      
+        <span class='name'>tag</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>An HTML tag.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>idx</span>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>The start of the node&#39;s offset for an opening tag,</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>start</span>
+      
+      
+        <span class='type'>(<tt>Fixnum</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>-1)</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Left -1 for an open tag, the node&#39;s start offset</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 
 </div><table class="source_code">
   <tr>
@@ -280,14 +354,14 @@
       <pre class="lines">
 
 
-7
-8
-9
-10
-11</pre>
+29
+30
+31
+32
+33</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 7</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_tag'>tag</span><span class='comma'>,</span> <span class='id identifier rubyid_idx'>idx</span><span class='comma'>,</span> <span class='id identifier rubyid_start'>start</span><span class='op'>=</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span>
   <span class='ivar'>@tag</span> <span class='op'>=</span> <span class='id identifier rubyid_tag'>tag</span>
@@ -332,12 +406,12 @@
       <pre class="lines">
 
 
-5
-6
-7</pre>
+16
+17
+18</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 5</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 16</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_idx'>idx</span>
   <span class='ivar'>@idx</span>
@@ -375,12 +449,12 @@
       <pre class="lines">
 
 
-5
-6
-7</pre>
+16
+17
+18</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 5</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 16</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_start'>start</span>
   <span class='ivar'>@start</span>
@@ -418,12 +492,12 @@
       <pre class="lines">
 
 
-5
-6
-7</pre>
+16
+17
+18</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 5</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 16</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_tag'>tag</span>
   <span class='ivar'>@tag</span>
@@ -443,24 +517,53 @@
       <div class="method_details first">
   <h3 class="signature first" id="to_s-instance_method">
   
-    - (<tt>Object</tt>) <strong>to_s</strong> 
+    - (<tt>String</tt>) <strong>to_s</strong> 
+  
+
   
 
   
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>String representation of the Tag object.</p>
 
+
+  </div>
+</div>
+<div class="tags">
   
-</h3><table class="source_code">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Tag as string.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-13
-14
-15</pre>
+40
+41
+42</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/smart_diff/htmlize.rb', line 40</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
   <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tag: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@tag</span><span class='embexpr_end'>}</span><span class='tstring_content'>, idx: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@idx</span><span class='embexpr_end'>}</span><span class='tstring_content'> start: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@start</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
@@ -475,7 +578,7 @@
 </div>
 
     <div id="footer">
-  Generated on Fri Sep 13 17:10:49 2013 by
+  Generated on Mon Sep 16 03:40:01 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>