doc/Rubu/State.html in rubu-0.0.1 vs doc/Rubu/State.html in rubu-0.0.2
- old
+ new
@@ -97,11 +97,25 @@
<dd class="r2 last">lib/rubu.rb</dd>
</dl>
<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+
+<p>Persistent state of Rubu.</p>
+<p>State maintains YAML based state file (if in use). The file include MD5
+checksums of file content.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="md5-classvariable" class="">@@md5 =
@@ -146,11 +160,13 @@
- <span class="summary_desc"><div class='inline'></div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Load state.</p>
+</div></span>
</li>
<li class="public ">
@@ -168,11 +184,13 @@
- <span class="summary_desc"><div class='inline'></div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Check for existing checksum and update it if needed.</p>
+</div></span>
</li>
<li class="public ">
@@ -190,11 +208,13 @@
- <span class="summary_desc"><div class='inline'></div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Generate MD5 checksum for file.</p>
+</div></span>
</li>
<li class="public ">
@@ -212,11 +232,13 @@
- <span class="summary_desc"><div class='inline'></div></span>
+ <span class="summary_desc"><div class='inline'>
+<p>Save state.</p>
+</div></span>
</li>
</ul>
@@ -235,24 +257,35 @@
-</h3><table class="source_code">
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Load state.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-19
-20
-21
-22
-23</pre>
+25
+26
+27
+28
+29</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 19</span>
+ <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 25</span>
<span class='kw'>def</span> <span class='const'>State</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span>
<span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span> <span class='cvar'>@@state_file</span> <span class='rparen'>)</span>
<span class='cvar'>@@md5</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span> <span class='cvar'>@@state_file</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
@@ -272,15 +305,37 @@
</h3><div class="docstring">
<div class="discussion">
+<p>Check for existing checksum and update it if needed.</p>
+
</div>
</div>
<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+ <li>
+
+ <span class='name'>file</span>
+
+
+ <span class='type'></span>
+
+
+
+ —
+ <div class='inline'>
+<p>File.</p>
+</div>
+
+ </li>
+
+</ul>
+
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
@@ -297,26 +352,26 @@
<tr>
<td>
<pre class="lines">
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41</pre>
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 29</span>
+ <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 41</span>
<span class='kw'>def</span> <span class='const'>State</span><span class='period'>.</span><span class='id identifier rubyid_md5_check_and_update?'>md5_check_and_update?</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='cvar'>@@md5</span><span class='lbracket'>[</span> <span class='id identifier rubyid_file'>file</span> <span class='rbracket'>]</span>
<span class='id identifier rubyid_md5'>md5</span> <span class='op'>=</span> <span class='const'>State</span><span class='period'>.</span><span class='id identifier rubyid_md5_gen'>md5_gen</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_md5'>md5</span> <span class='op'>!=</span> <span class='cvar'>@@md5</span><span class='lbracket'>[</span> <span class='id identifier rubyid_file'>file</span> <span class='rbracket'>]</span>
@@ -341,22 +396,53 @@
-</h3><table class="source_code">
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Generate MD5 checksum for file.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>file</span>
+
+
+ <span class='type'></span>
+
+
+
+ —
+ <div class='inline'>
+<p>File.</p>
+</div>
+
+ </li>
+
+</ul>
+
+
+</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-25
-26
-27</pre>
+34
+35
+36</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 25</span>
+ <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 34</span>
<span class='kw'>def</span> <span class='const'>State</span><span class='period'>.</span><span class='id identifier rubyid_md5_gen'>md5_gen</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span>
<span class='const'>Digest</span><span class='op'>::</span><span class='const'>MD5</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span> <span class='id identifier rubyid_file'>file</span> <span class='rparen'>)</span> <span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -371,24 +457,35 @@
-</h3><table class="source_code">
+</h3><div class="docstring">
+ <div class="discussion">
+
+<p>Save state.</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-13
-14
-15
-16
-17</pre>
+18
+19
+20
+21
+22</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 13</span>
+ <pre class="code"><span class="info file"># File 'lib/rubu.rb', line 18</span>
<span class='kw'>def</span> <span class='const'>State</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
<span class='kw'>if</span> <span class='cvar'>@@md5</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
<span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span> <span class='cvar'>@@state_file</span><span class='comma'>,</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span> <span class='cvar'>@@md5</span> <span class='rparen'>)</span> <span class='rparen'>)</span>
<span class='kw'>end</span>
@@ -401,10 +498,10 @@
</div>
</div>
<div id="footer">
- Generated on Fri Jun 29 10:04:07 2018 by
+ Generated on Sun Jul 1 17:48:17 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.3).
</div>
</body>
\ No newline at end of file