updated rdoc - reportable - Fork of reportable required by WarVox, from hdm/reportable.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit d49526a87a4c6b2e298cb2324298e0a2cb8ec5bd
(DIR) parent ae05149c92108118879b867ae6c51f1b72113ed4
(HTM) Author: Marco Otte-Witte <marco.otte-witte@simplabs.com>
Date: Wed, 14 Jan 2009 01:49:39 +0800
updated rdoc
Signed-off-by: Marco Otte-Witte <marco.otte-witte@simplabs.com>
Diffstat:
M rdoc/classes/Kvlr/ReportsAsSparkli… | 2 +-
M rdoc/classes/Kvlr/ReportsAsSparkli… | 40 ++++++++++++++++++-------------
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 +-
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 +-
10 files changed, 37 insertions(+), 31 deletions(-)
---
(DIR) diff --git a/rdoc/classes/Kvlr/ReportsAsSparkline/AssetTagHelper.html b/rdoc/classes/Kvlr/ReportsAsSparkline/AssetTagHelper.html
@@ -146,7 +146,7 @@ href="AssetTagHelper.html#M000002">sparkline_tag</a>(User.registrations_report,
<span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/asset_tag_helper.rb, line 21</span>
21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sparkline_tag</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">options</span> = {})
22: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">reverse_merge!</span>({<span class="ruby-identifier">:width</span> =<span class="ruby-operator">></span> <span class="ruby-value">300</span>, <span class="ruby-identifier">:height</span> =<span class="ruby-operator">></span> <span class="ruby-value">34</span>, <span class="ruby-identifier">:color</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'0077cc'</span>})
-23: <span class="ruby-identifier">data</span>.<span class="ruby-identifier">collect!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">element</span><span class="ruby-operator">|</span> <span class="ruby-identifier">element</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">to_s</span> }
+23: <span class="ruby-identifier">data</span>.<span class="ruby-identifier">collect!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> <span class="ruby-identifier">d</span>[<span class="ruby-value">1</span>] }
24: <span class="ruby-identifier">image_tag</span>(
25: <span class="ruby-node">"http://chart.apis.google.com/chart?cht=ls&chs=#{options[:width]}x#{options[:height]}&chd=t:#{data.join(',')}&chco=#{options[:color]}&chm=B,E6F2FA,0,0,0&chls=1,0,0&chds=#{data.min},#{data.max}"</span>
26: )
(DIR) diff --git a/rdoc/classes/Kvlr/ReportsAsSparkline/Report.html b/rdoc/classes/Kvlr/ReportsAsSparkline/Report.html
@@ -125,17 +125,17 @@ and calculations
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
- <td class="context-item-name">grouping</td>
+ <td class="context-item-name">klass</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
- <td class="context-item-name">klass</td>
+ <td class="context-item-name">name</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
- <td class="context-item-name">name</td>
+ <td class="context-item-name">options</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
@@ -215,13 +215,14 @@ records that match there conditions are reported on
26: <span class="ruby-ivar">@date_column</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:date_column</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'created_at'</span>).<span class="ruby-identifier">to_s</span>
27: <span class="ruby-ivar">@value_column</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:value_column</span>] <span class="ruby-operator">||</span> (<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:aggregation</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">:sum</span> <span class="ruby-operator">?</span> <span class="ruby-value str">'id'</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>)).<span class="ruby-identifier">to_s</span>
28: <span class="ruby-ivar">@aggregation</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:aggregation</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:count</span>
-29: <span class="ruby-ivar">@grouping</span> = <span class="ruby-constant">Grouping</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:day</span>)
-30: <span class="ruby-ivar">@options</span> = {
-31: <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:limit</span>] <span class="ruby-operator">||</span> <span class="ruby-value">100</span>,
-32: <span class="ruby-identifier">:conditions</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:conditions</span>] <span class="ruby-operator">||</span> []
+29: <span class="ruby-ivar">@options</span> = {
+30: <span class="ruby-identifier">:limit</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:limit</span>] <span class="ruby-operator">||</span> <span class="ruby-value">100</span>,
+31: <span class="ruby-identifier">:conditions</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:conditions</span>] <span class="ruby-operator">||</span> [],
+32: <span class="ruby-identifier">:grouping</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Grouping</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">:day</span>)
33: }
34: <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">options</span>)
-35: <span class="ruby-keyword kw">end</span>
+35: <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">freeze</span>
+36: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
@@ -252,20 +253,25 @@ records that match there conditions are reported on (<b>Beware that when
you specify conditions here, caching will be disabled</b>)
</li>
+<li><tt>:grouping</tt> - The period records are grouped on (:hour, :day, :week,
+:month)
+
+</li>
</ul>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000010-source">
<pre>
- <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report.rb, line 42</span>
-42: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">options</span> = {})
-43: <span class="ruby-identifier">ensure_valid_options</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">:run</span>)
-44: <span class="ruby-identifier">custom_conditions</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:conditions</span>)
-45: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">reverse_merge!</span>(<span class="ruby-ivar">@options</span>)
-46: <span class="ruby-constant">ReportCache</span>.<span class="ruby-identifier">process</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:limit</span>], <span class="ruby-identifier">custom_conditions</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">begin_at</span><span class="ruby-operator">|</span>
-47: <span class="ruby-identifier">read_data</span>(<span class="ruby-identifier">begin_at</span>, <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:conditions</span>])
-48: <span class="ruby-keyword kw">end</span>
-49: <span class="ruby-keyword kw">end</span>
+ <span class="ruby-comment cmt"># File lib/kvlr/reports_as_sparkline/report.rb, line 44</span>
+44: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>(<span class="ruby-identifier">options</span> = {})
+45: <span class="ruby-identifier">ensure_valid_options</span>(<span class="ruby-identifier">options</span>, <span class="ruby-identifier">:run</span>)
+46: <span class="ruby-identifier">custom_conditions</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">:conditions</span>)
+47: <span class="ruby-identifier">options</span>.<span class="ruby-identifier">reverse_merge!</span>(<span class="ruby-ivar">@options</span>)
+48: <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>] = <span class="ruby-constant">Grouping</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>]) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>].<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Grouping</span>)
+49: <span class="ruby-constant">ReportCache</span>.<span class="ruby-identifier">process</span>(<span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:limit</span>], <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>], <span class="ruby-identifier">custom_conditions</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">begin_at</span><span class="ruby-operator">|</span>
+50: <span class="ruby-identifier">read_data</span>(<span class="ruby-identifier">begin_at</span>, <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:grouping</span>], <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:conditions</span>])
+51: <span class="ruby-keyword kw">end</span>
+52: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
(DIR) diff --git a/rdoc/created.rid b/rdoc/created.rid
@@ -1 +1 @@
-Tue, 13 Jan 2009 16:35:24 +0100
+Tue, 13 Jan 2009 18:49:33 +0100
(DIR) 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>Tue Jan 13 16:35:03 +0100 2009</td>
+ <td>Tue Jan 13 16:47:15 +0100 2009</td>
</tr>
</table>
</div>
@@ -81,13 +81,13 @@ This shows the basic usage. Consider the following user model, including
</p>
<pre>
class User < ActiveRecord::Base
- report_as_sparkline :registrations
- report_as_sparkline :activations, :date_column => :activated_at
- report_as_sparkline :total_users, :cumulate => true
+ reports_as_sparkline :registrations
+ reports_as_sparkline :activations, :date_column => :activated_at
+ reports_as_sparkline :total_users, :cumulate => true
end
</pre>
<p>
-Using <tt>report_as_sparkline</tt> like this will add the following class
+Using <tt>reports_as_sparkline</tt> like this will add the following class
methods to your User model:
</p>
<pre>
@@ -125,7 +125,7 @@ If you are on Rails &lt; 2.1, do this from your RAILS_ROOT
<b>generate migration</b>
</p>
<pre>
- ./script/generate report_as_sparkline_migration add_report_as_sparkline_tables
+ ./script/generate reports_as_sparkline_migration add_reports_as_sparkline_tables
</pre>
<p>
<b>migrate</b>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/asset_tag_helper_rb.html b/rdoc/files/lib/kvlr/reports_as_sparkline/asset_tag_helper_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Mon Dec 15 18:35:29 +0100 2008</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/cumulated_report_rb.html b/rdoc/files/lib/kvlr/reports_as_sparkline/cumulated_report_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Tue Jan 13 16:19:01 +0100 2009</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/grouping_rb.html b/rdoc/files/lib/kvlr/reports_as_sparkline/grouping_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Tue Jan 13 12:14:04 +0100 2009</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/report_cache_rb.html b/rdoc/files/lib/kvlr/reports_as_sparkline/report_cache_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Tue Jan 13 16:03:14 +0100 2009</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/report_rb.html b/rdoc/files/lib/kvlr/reports_as_sparkline/report_rb.html
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Tue Jan 13 14:22:10 +0100 2009</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>
(DIR) diff --git a/rdoc/files/lib/kvlr/reports_as_sparkline/reporting_period_rb.html b/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>Tue Jan 13 15:48:00 +0100 2009</td>
+ <td>Tue Jan 13 18:48:41 +0100 2009</td>
</tr>
</table>
</div>