 |
updated documentation - reportable - Fork of reportable required by WarVox, fro… |
 |
Log |
|
Files |
|
Refs |
|
README |
|
--- |
|
commit baf5e26d2090c2390f178f3405728f9f2caf38cf |
|
parent 4bdd41ffb940013461b09f647bef8828387a199d |
 |
Author: Marco Otte-Witte <[email protected]> |
|
Date: Tue, 20 Jan 2009 17:45:53 +0100 |
|
|
|
updated documentation |
|
|
|
Diffstat: |
|
M README.rdoc | 2 ++ |
|
M rdoc/classes/Kvlr/ReportsAsSparkli… | 83 +++++++++++++++------------… |
|
M rdoc/created.rid | 2 +- |
|
M rdoc/files/README_rdoc.html | 12 +++++++++++- |
|
M rdoc/files/lib/kvlr/reports_as_spa… | 2 +- |
|
M rdoc/files/lib/kvlr/reports_as_spa… | 2 +- |
|
M rdoc/files/lib/kvlr/reports_as_spa… | 2 +- |
|
|
|
7 files changed, 58 insertions(+), 47 deletions(-) |
|
--- |
|
diff --git a/README.rdoc b/README.rdoc |
|
@@ -14,6 +14,7 @@ to it with the following options: |
|
* :limit - The number of periods to get (see :grouping) |
|
* :conditions - Conditions like in ActiveRecord::Base#find; only records that … |
|
* :cumulate - Sets whether to cumulate the numbers (instead of [1, 2, 3] retur… |
|
+* :live_data - Specified whether data for the current reporting period is read… |
|
|
|
<b>Example:</b> |
|
|
|
@@ -34,6 +35,7 @@ When invoking the report, you can override some of the option… |
|
* :grouping - The period records are grouped on (:hour, :day, :week, :month) |
|
* :limit - The number of periods to get (see :grouping) |
|
* :conditions - Conditions like in ActiveRecord::Base#find; only records that … |
|
+* :live_data - Specified whether data for the current reporting period is read… |
|
|
|
<b>Example:</b> |
|
|
|
diff --git a/rdoc/classes/Kvlr/ReportsAsSparkline/ReportingPeriod.html b/rdoc/c… |
|
@@ -153,8 +153,7 @@ Returns the <a href="ReportingPeriod.html#M000007">first</a… |
|
period for a grouping and a limit; e.g. the <a |
|
href="ReportingPeriod.html#M000007">first</a> reporting period for <a |
|
href="Grouping.html">Grouping</a> :day and limit 2 would be Time.now - |
|
-1.days (since limit is 2, 2 reporting periods are included in the range, |
|
-that is yesterday and today) |
|
+2.days |
|
</p> |
|
<h4>Parameters</h4> |
|
<ul> |
|
@@ -172,20 +171,20 @@ href="ReportingPeriod.html#M000007">first</a> one |
|
onclick="toggleCode('M000007-source');return false;">[Source]</a><… |
|
<div class="method-source-code" id="M000007-source"> |
|
<pre> |
|
- <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
-24: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword k… |
|
-25: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
-26: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-27: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-28: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-29: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-30: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-31: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-32: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-33: <span class="ruby-identifier">date</span> = <span class="ruby-… |
|
-34: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-35: <span class="ruby-keyword kw">end</span> |
|
-36: <span class="ruby-keyword kw">end</span> |
|
+ <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
+23: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword k… |
|
+24: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
+25: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+26: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+27: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+28: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+29: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+30: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+31: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+32: <span class="ruby-identifier">date</span> = <span class="ruby-… |
|
+33: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+34: <span class="ruby-keyword kw">end</span> |
|
+35: <span class="ruby-keyword kw">end</span> |
|
</pre> |
|
</div> |
|
</div> |
|
@@ -247,19 +246,19 @@ hour/day/month/year) |
|
onclick="toggleCode('M000008-source');return false;">[Source]</a><… |
|
<div class="method-source-code" id="M000008-source"> |
|
<pre> |
|
- <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
-54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword k… |
|
-55: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
-56: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-57: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-58: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-59: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-60: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-61: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-62: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-63: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-64: <span class="ruby-keyword kw">end</span> |
|
-65: <span class="ruby-keyword kw">end</span> |
|
+ <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
+53: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword k… |
|
+54: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
+55: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+56: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+57: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+58: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+59: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+60: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+61: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+62: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+63: <span class="ruby-keyword kw">end</span> |
|
+64: <span class="ruby-keyword kw">end</span> |
|
</pre> |
|
</div> |
|
</div> |
|
@@ -284,19 +283,19 @@ hour/day/month/year) |
|
onclick="toggleCode('M000009-source');return false;">[Source]</a><… |
|
<div class="method-source-code" id="M000009-source"> |
|
<pre> |
|
- <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
-68: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-69: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
-70: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-71: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-72: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-73: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-74: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-75: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-76: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
-77: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
-78: <span class="ruby-keyword kw">end</span> |
|
-79: <span class="ruby-keyword kw">end</span> |
|
+ <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report… |
|
+67: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
+68: <span class="ruby-keyword kw">return</span> <span class="ruby-keyw… |
|
+69: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+70: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+71: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+72: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+73: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+74: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+75: <span class="ruby-keyword kw">when</span> <span class="ruby-iden… |
|
+76: <span class="ruby-keyword kw">self</span>.<span class="ruby-id… |
|
+77: <span class="ruby-keyword kw">end</span> |
|
+78: <span class="ruby-keyword kw">end</span> |
|
</pre> |
|
</div> |
|
</div> |
|
diff --git a/rdoc/created.rid b/rdoc/created.rid |
|
@@ -1 +1 @@ |
|
-Mon, 19 Jan 2009 13:15:23 +0100 |
|
+Tue, 20 Jan 2009 17:45:36 +0100 |
|
diff --git a/rdoc/files/README_rdoc.html b/rdoc/files/README_rdoc.html |
|
@@ -56,7 +56,7 @@ |
|
</tr> |
|
<tr class="top-aligned-row"> |
|
<td><strong>Last Update:</strong></td> |
|
- <td>Thu Jan 15 16:53:21 +0100 2009</td> |
|
+ <td>Tue Jan 20 17:45:12 +0100 2009</td> |
|
</tr> |
|
</table> |
|
</div> |
|
@@ -107,6 +107,11 @@ match there conditions are reported on |
|
returns [1, 3, 6]) |
|
|
|
</li> |
|
+<li>:live_data - Specified whether data for the current reporting period is |
|
+read; if :live_data is true, you will experience a performance hit since |
|
+the request cannot be satisfied from the cache only (defaults to false) |
|
+ |
|
+</li> |
|
</ul> |
|
<p> |
|
<b>Example:</b> |
|
@@ -141,6 +146,11 @@ specified for <tt>reports_as_sparkline</tt>: |
|
match there conditions are reported on |
|
|
|
</li> |
|
+<li>:live_data - Specified whether data for the current reporting period is |
|
+read; if :live_data is true, you will experience a performance hit since |
|
+the request cannot be satisfied from the cache only (defaults to false) |
|
+ |
|
+</li> |
|
</ul> |
|
<p> |
|
<b>Example:</b> |
|
diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/report_cache_rb.html b/rd… |
|
@@ -56,7 +56,7 @@ |
|
</tr> |
|
<tr class="top-aligned-row"> |
|
<td><strong>Last Update:</strong></td> |
|
- <td>Thu Jan 15 18:29:30 +0100 2009</td> |
|
+ <td>Tue Jan 20 17:31:13 +0100 2009</td> |
|
</tr> |
|
</table> |
|
</div> |
|
diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/report_rb.html b/rdoc/fil… |
|
@@ -56,7 +56,7 @@ |
|
</tr> |
|
<tr class="top-aligned-row"> |
|
<td><strong>Last Update:</strong></td> |
|
- <td>Mon Jan 19 13:09:10 +0100 2009</td> |
|
+ <td>Tue Jan 20 12:21:17 +0100 2009</td> |
|
</tr> |
|
</table> |
|
</div> |
|
diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/reporting_period_rb.html … |
|
@@ -56,7 +56,7 @@ |
|
</tr> |
|
<tr class="top-aligned-row"> |
|
<td><strong>Last Update:</strong></td> |
|
- <td>Mon Jan 19 13:11:39 +0100 2009</td> |
|
+ <td>Tue Jan 20 17:19:46 +0100 2009</td> |
|
</tr> |
|
</table> |
|
</div> |
