 |
remove the docs from the repo - reportable - Fork of reportable required by War… |
 |
Log |
|
Files |
|
Refs |
|
README |
|
--- |
|
commit 0bb2111b20c9f9e79c451630e287891f0fc0ed89 |
|
parent 54c8495f1ea3f1a5aab468b0683cf0106787e59b |
 |
Author: Marco Otte-Witte <[email protected]> |
|
Date: Wed, 24 Feb 2010 19:11:15 +0100 |
|
|
|
remove the docs from the repo |
|
|
|
Diffstat: |
|
D doc/classes/Simplabs/ReportsAsSpar… | 216 ---------------------------… |
|
D doc/classes/Simplabs/ReportsAsSpar… | 233 ---------------------------… |
|
D doc/classes/Simplabs/ReportsAsSpar… | 322 ---------------------------… |
|
D doc/classes/Simplabs/ReportsAsSpar… | 188 ---------------------------… |
|
D doc/classes/Simplabs/ReportsAsSpar… | 186 ---------------------------… |
|
D doc/created.rid | 1 - |
|
D doc/files/README_rdoc.html | 362 -----------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/files/lib/simplabs/reports_as_… | 102 ---------------------------… |
|
D doc/fr_class_index.html | 32 -----------------------------… |
|
D doc/fr_file_index.html | 35 -----------------------------… |
|
D doc/fr_method_index.html | 35 -----------------------------… |
|
D doc/index.html | 25 ------------------------- |
|
D doc/rdoc-style.css | 209 -----------------------------… |
|
|
|
19 files changed, 0 insertions(+), 2558 deletions(-) |
|
--- |
|
diff --git a/doc/classes/Simplabs/ReportsAsSparkline/ClassMethods.html b/doc/cl… |
|
@@ -1,215 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Module: Saulabs::ReportsAsSparkline::ClassMethods</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="classHeader"> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Module</strong></td> |
|
- <td class="class-name-in-header">Saulabs::ReportsAsSparkline::ClassM… |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>In:</strong></td> |
|
- <td> |
|
- <a href="../../../files/lib/saulabs/reports_as_sparkline_rb.ht… |
|
- lib/saulabs/reports_as_sparkline.rb |
|
- </a> |
|
- <br /> |
|
- </td> |
|
- </tr> |
|
- |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- <div id="method-list"> |
|
- <h3 class="section-bar">Methods</h3> |
|
- |
|
- <div class="name-list"> |
|
- <a href="#M000002">reports_as_sparkline</a> |
|
- </div> |
|
- </div> |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- <div id="methods"> |
|
- <h3 class="section-bar">Public Instance methods</h3> |
|
- |
|
- <div id="method-M000002" class="method-detail"> |
|
- <a name="M000002"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000002" class="method-signature"> |
|
- <span class="method-name">reports_as_sparkline</span><span class="me… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p> |
|
-Generates a report on a model. That report can then be executed via the new |
|
-method <tt><name>_report</tt> (see documentation of <a |
|
-href="Report.html#M000008">Saulabs::ReportsAsSparkline::Report#run</a>). |
|
-</p> |
|
-<h4>Parameters</h4> |
|
-<ul> |
|
-<li><tt>name</tt> - The name of the report, defines the name of the generated |
|
-report method (<tt><name>_report</tt>) |
|
- |
|
-</li> |
|
-</ul> |
|
-<h4>Options</h4> |
|
-<ul> |
|
-<li><tt>:date_column</tt> - The name of the date column over that the records |
|
-are aggregated (defaults to <tt>created_at</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:value_column</tt> - The name of the column that holds the values to |
|
-sum up when using aggregation <tt>:sum</tt> |
|
- |
|
-</li> |
|
-<li><tt>:aggregation</tt> - The aggregation to use (one of <tt>:count</tt>, |
|
-<tt>:sum</tt>, <tt>:minimum</tt>, <tt>:maximum</tt> or <tt>:average</tt>); |
|
-when using anything other than <tt>:count</tt>, <tt>:value_column</tt> must |
|
-also be specified (<b>If you really want to e.g. sum up the values in the |
|
-<tt>id</tt> column, you have to explicitely say so.</b>); (defaults to |
|
-<tt>:count</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:grouping</tt> - The period records are grouped on (<tt>:hour</tt>, |
|
-<tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt>); <b>Beware that <tt><a |
|
-href="ClassMethods.html#M000002">reports_as_sparkline</a></tt> treats weeks |
|
-as starting on monday!</b> |
|
- |
|
-</li> |
|
-<li><tt>:limit</tt> - The number of reporting periods to get (see |
|
-<tt>:grouping</tt>), (defaults to 100) |
|
- |
|
-</li> |
|
-<li><tt>:conditions</tt> - Conditions like in <tt>ActiveRecord::Base#find</tt>; |
|
-only records that match the conditions are reported; <b>Beware that when |
|
-conditions are specified, caching is disabled!</b> |
|
- |
|
-</li> |
|
-<li><tt>:live_data</tt> - Specifies whether data for the current reporting |
|
-period is to be read; <b>if <tt>:live_data</tt> is <tt>true</tt>, you will |
|
-experience a performance hit since the request cannot be satisfied from the |
|
-cache only (defaults to <tt>false</tt>)</b> |
|
- |
|
-</li> |
|
-<li><tt>:end_date</tt> - When specified, the report will only include data for |
|
-the <tt>:limit</tt> reporting periods until this date. |
|
- |
|
-</li> |
|
-</ul> |
|
-<h4>Examples</h4> |
|
-<pre> |
|
- class User < ActiveRecord::Base |
|
- reports_as_sparkline :registrations, :aggregation => :count |
|
- reports_as_sparkline :activations, :aggregation => :count, :date_colum… |
|
- reports_as_sparkline :total_users, :cumulate => true |
|
- reports_as_sparkline :rake, :aggregation => :sum, :value_colu… |
|
- end |
|
-</pre> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000002-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000002-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline.rb,… |
|
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-37: (<span class="ruby-keyword kw">class</span> <span class="ruby-oper… |
|
-38: <span class="ruby-identifier">define_method</span> <span class="… |
|
-39: <span class="ruby-keyword kw">if</span> <span class="ruby-iden… |
|
-40: <span class="ruby-identifier">report</span> = <span class="r… |
|
-41: <span class="ruby-keyword kw">else</span> |
|
-42: <span class="ruby-identifier">report</span> = <span class="r… |
|
-43: <span class="ruby-keyword kw">end</span> |
|
-44: <span class="ruby-identifier">raise</span> <span class="ruby-c… |
|
-45: <span class="ruby-identifier">report</span>.<span class="ruby-… |
|
-46: <span class="ruby-keyword kw">end</span> |
|
-47: <span class="ruby-keyword kw">end</span> |
|
-48: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/classes/Simplabs/ReportsAsSparkline/CumulatedReport.html b/doc… |
|
@@ -1,232 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Class: Saulabs::ReportsAsSparkline::CumulatedReport</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="classHeader"> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Class</strong></td> |
|
- <td class="class-name-in-header">Saulabs::ReportsAsSparkline::Cumula… |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>In:</strong></td> |
|
- <td> |
|
- <a href="../../../files/lib/saulabs/reports_as_sparkline/cumul… |
|
- lib/saulabs/reports_as_sparkline/cumulated_report.rb |
|
- </a> |
|
- <br /> |
|
- </td> |
|
- </tr> |
|
- |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Parent:</strong></td> |
|
- <td> |
|
- <a href="Report.html"> |
|
- Report |
|
- </a> |
|
- </td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- <div id="description"> |
|
- <p> |
|
-A special report class that cumulates all data (see <a |
|
-href="Report.html">Saulabs::ReportsAsSparkline::Report</a>) |
|
-</p> |
|
-<h4>Examples</h4> |
|
-<p> |
|
-When <a href="Report.html">Saulabs::ReportsAsSparkline::Report</a> returns |
|
-</p> |
|
-<pre> |
|
- [[<DateTime today>, 1], [<DateTime yesterday>, 2], etc.] |
|
-</pre> |
|
-<p> |
|
-<a |
|
-href="CumulatedReport.html">Saulabs::ReportsAsSparkline::CumulatedReport</a> |
|
-returns |
|
-</p> |
|
-<pre> |
|
- [[<DateTime today>, 3], [<DateTime yesterday>, 2], etc.] |
|
-</pre> |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- <div id="method-list"> |
|
- <h3 class="section-bar">Methods</h3> |
|
- |
|
- <div class="name-list"> |
|
- <a href="#M000004">cumulate</a> |
|
- <a href="#M000005">initial_cumulative_value</a> |
|
- <a href="#M000003">run</a> |
|
- </div> |
|
- </div> |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- <div id="methods"> |
|
- <h3 class="section-bar">Public Instance methods</h3> |
|
- |
|
- <div id="method-M000003" class="method-detail"> |
|
- <a name="M000003"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000003" class="method-signature"> |
|
- <span class="method-name">run</span><span class="method-args">(optio… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p> |
|
-Runs the report (see <a |
|
-href="Report.html#M000008">Saulabs::ReportsAsSparkline::Report#run</a>) |
|
-</p> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000003-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000003-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/cum… |
|
-19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-20: <span class="ruby-identifier">cumulate</span>(<span class="ruby-ke… |
|
-21: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- <h3 class="section-bar">Protected Instance methods</h3> |
|
- |
|
- <div id="method-M000004" class="method-detail"> |
|
- <a name="M000004"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000004" class="method-signature"> |
|
- <span class="method-name">cumulate</span><span class="method-args">(… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000004-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000004-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/cum… |
|
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identif… |
|
-26: <span class="ruby-identifier">first_reporting_period</span> = <s… |
|
-27: <span class="ruby-identifier">acc</span> = <span class="ruby-ide… |
|
-28: <span class="ruby-identifier">result</span> = [] |
|
-29: <span class="ruby-identifier">data</span>.<span class="ruby-iden… |
|
-30: <span class="ruby-identifier">acc</span> <span class="ruby-ope… |
|
-31: <span class="ruby-identifier">result</span> <span class="ruby-… |
|
-32: <span class="ruby-keyword kw">end</span> |
|
-33: <span class="ruby-identifier">result</span> |
|
-34: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- <div id="method-M000005" class="method-detail"> |
|
- <a name="M000005"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000005" class="method-signature"> |
|
- <span class="method-name">initial_cumulative_value</span><span class… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000005-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000005-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/cum… |
|
-36: <span class="ruby-keyword kw">def</span> <span class="ruby-identif… |
|
-37: <span class="ruby-identifier">conditions</span> = <span class="r… |
|
-38: <span class="ruby-ivar">@klass</span>.<span class="ruby-identifi… |
|
-39: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/classes/Simplabs/ReportsAsSparkline/Report.html b/doc/classes/… |
|
@@ -1,321 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Class: Saulabs::ReportsAsSparkline::Report</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="classHeader"> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Class</strong></td> |
|
- <td class="class-name-in-header">Saulabs::ReportsAsSparkline::Report… |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>In:</strong></td> |
|
- <td> |
|
- <a href="../../../files/lib/saulabs/reports_as_sparkline/repor… |
|
- lib/saulabs/reports_as_sparkline/report.rb |
|
- </a> |
|
- <br /> |
|
- </td> |
|
- </tr> |
|
- |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Parent:</strong></td> |
|
- <td> |
|
- Object |
|
- </td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- <div id="description"> |
|
- <p> |
|
-The <a href="Report.html">Report</a> class that does all the data retrieval |
|
-and calculations |
|
-</p> |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- <div id="method-list"> |
|
- <h3 class="section-bar">Methods</h3> |
|
- |
|
- <div class="name-list"> |
|
- <a href="#M000007">new</a> |
|
- <a href="#M000008">run</a> |
|
- </div> |
|
- </div> |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <div id="attribute-list"> |
|
- <h3 class="section-bar">Attributes</h3> |
|
- |
|
- <div class="name-list"> |
|
- <table> |
|
- <tr class="top-aligned-row context-row"> |
|
- <td class="context-item-name">aggregation</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">date_column</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-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-value"> [R] </td> |
|
- <td class="context-item-desc"></td> |
|
- </tr> |
|
- <tr class="top-aligned-row context-row"> |
|
- <td class="context-item-name">options</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">value_column</td> |
|
- <td class="context-item-value"> [R] </td> |
|
- <td class="context-item-desc"></td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- <div id="methods"> |
|
- <h3 class="section-bar">Public Class methods</h3> |
|
- |
|
- <div id="method-M000007" class="method-detail"> |
|
- <a name="M000007"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000007" class="method-signature"> |
|
- <span class="method-name">new</span><span class="method-args">(klass… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <h4>Parameters</h4> |
|
-<ul> |
|
-<li><tt>klass</tt> - The model the report works on (This is the class you |
|
-invoke <a |
|
-href="ClassMethods.html#M000002">Saulabs::ReportsAsSparkline::ClassMethods#rep… |
|
-on) |
|
- |
|
-</li> |
|
-<li><tt>name</tt> - The name of the report (as in <a |
|
-href="ClassMethods.html#M000002">Saulabs::ReportsAsSparkline::ClassMethods#rep… |
|
- |
|
-</li> |
|
-</ul> |
|
-<h4>Options</h4> |
|
-<ul> |
|
-<li><tt>:date_column</tt> - The name of the date column over that the records |
|
-are aggregated (defaults to <tt>created_at</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:value_column</tt> - The name of the column that holds the values to |
|
-sum up when using aggregation <tt>:sum</tt> |
|
- |
|
-</li> |
|
-<li><tt>:aggregation</tt> - The aggregation to use (one of <tt>:count</tt>, |
|
-<tt>:sum</tt>, <tt>:minimum</tt>, <tt>:maximum</tt> or <tt>:average</tt>); |
|
-when using anything other than <tt>:count</tt>, <tt>:value_column</tt> must |
|
-also be specified (<b>If you really want to e.g. sum up the values in the |
|
-<tt>id</tt> column, you have to explicitely say so.</b>); (defaults to |
|
-<tt>:count</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:grouping</tt> - The period records are grouped on (<tt>:hour</tt>, |
|
-<tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt>); <b>Beware that |
|
-<tt>reports_as_sparkline</tt> treats weeks as starting on monday!</b> |
|
- |
|
-</li> |
|
-<li><tt>:limit</tt> - The number of reporting periods to get (see |
|
-<tt>:grouping</tt>), (defaults to 100) |
|
- |
|
-</li> |
|
-<li><tt>:conditions</tt> - Conditions like in <tt>ActiveRecord::Base#find</tt>; |
|
-only records that match the conditions are reported; <b>Beware that when |
|
-conditions are specified, caching is disabled!</b> |
|
- |
|
-</li> |
|
-<li><tt>:live_data</tt> - Specifies whether data for the current reporting |
|
-period is to be read; <b>if <tt>:live_data</tt> is <tt>true</tt>, you will |
|
-experience a performance hit since the request cannot be satisfied from the |
|
-cache only (defaults to <tt>false</tt>)</b> |
|
- |
|
-</li> |
|
-<li><tt>:end_date</tt> - When specified, the report will only include data for |
|
-the <tt>:limit</tt> reporting periods until this date. |
|
- |
|
-</li> |
|
-</ul> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000007-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000007-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/rep… |
|
-24: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-25: <span class="ruby-identifier">ensure_valid_options</span>(<span cl… |
|
-26: <span class="ruby-ivar">@klass</span> = <span class="ruby-i… |
|
-27: <span class="ruby-ivar">@name</span> = <span class="ruby-i… |
|
-28: <span class="ruby-ivar">@date_column</span> = (<span class="ruby-… |
|
-29: <span class="ruby-ivar">@aggregation</span> = <span class="ruby-i… |
|
-30: <span class="ruby-ivar">@value_column</span> = (<span class="ruby-… |
|
-31: <span class="ruby-ivar">@options</span> = { |
|
-32: <span class="ruby-identifier">:limit</span> =<span class="r… |
|
-33: <span class="ruby-identifier">:conditions</span> =<span class="r… |
|
-34: <span class="ruby-identifier">:grouping</span> =<span class="r… |
|
-35: <span class="ruby-identifier">:live_data</span> =<span class="r… |
|
-36: <span class="ruby-identifier">:end_date</span> =<span class="r… |
|
-37: } |
|
-38: <span class="ruby-ivar">@options</span>.<span class="ruby-identifi… |
|
-39: <span class="ruby-ivar">@options</span>.<span class="ruby-identifi… |
|
-40: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- <h3 class="section-bar">Public Instance methods</h3> |
|
- |
|
- <div id="method-M000008" class="method-detail"> |
|
- <a name="M000008"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000008" class="method-signature"> |
|
- <span class="method-name">run</span><span class="method-args">(optio… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p> |
|
-Runs the report and returns an array of array of DateTimes and Floats |
|
-</p> |
|
-<h4>Options</h4> |
|
-<ul> |
|
-<li><tt>:grouping</tt> - The period records are grouped on (<tt>:hour</tt>, |
|
-<tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt>); <b>Beware that |
|
-<tt>reports_as_sparkline</tt> treats weeks as starting on monday!</b> |
|
- |
|
-</li> |
|
-<li><tt>:limit</tt> - The number of reporting periods to get (see |
|
-<tt>:grouping</tt>), (defaults to 100) |
|
- |
|
-</li> |
|
-<li><tt>:conditions</tt> - Conditions like in <tt>ActiveRecord::Base#find</tt>; |
|
-only records that match the conditions are reported; <b>Beware that when |
|
-conditions are specified, caching is disabled!</b> |
|
- |
|
-</li> |
|
-<li><tt>:live_data</tt> - Specifies whether data for the current reporting |
|
-period is to be read; <b>if <tt>:live_data</tt> is <tt>true</tt>, you will |
|
-experience a performance hit since the request cannot be satisfied from the |
|
-cache only (defaults to <tt>false</tt>)</b> |
|
- |
|
-</li> |
|
-<li><tt>:end_date</tt> - When specified, the report will only include data for |
|
-the <tt>:limit</tt> reporting periods until this date. |
|
- |
|
-</li> |
|
-</ul> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000008-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000008-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/rep… |
|
-50: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-51: <span class="ruby-identifier">custom_conditions</span> = <span cla… |
|
-52: <span class="ruby-identifier">options</span> = <span class="ruby-i… |
|
-53: <span class="ruby-constant">ReportCache</span>.<span class="ruby-i… |
|
-54: <span class="ruby-identifier">read_data</span>(<span class="ruby… |
|
-55: <span class="ruby-keyword kw">end</span> |
|
-56: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/classes/Simplabs/ReportsAsSparkline/ReportCache.html b/doc/cla… |
|
@@ -1,187 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Class: Saulabs::ReportsAsSparkline::ReportCache</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="classHeader"> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Class</strong></td> |
|
- <td class="class-name-in-header">Saulabs::ReportsAsSparkline::Report… |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>In:</strong></td> |
|
- <td> |
|
- <a href="../../../files/lib/saulabs/reports_as_sparkline/repor… |
|
- lib/saulabs/reports_as_sparkline/report_cache.rb |
|
- </a> |
|
- <br /> |
|
- </td> |
|
- </tr> |
|
- |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Parent:</strong></td> |
|
- <td> |
|
- ActiveRecord::Base |
|
- </td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- <div id="description"> |
|
- <p> |
|
-The <a href="ReportCache.html">ReportCache</a> class is a regular |
|
-<tt>ActiveRecord</tt> model and represents cached results for single |
|
-reporting periods (table name is <tt>reports_as_sparkline_cache</tt>) <a |
|
-href="ReportCache.html">ReportCache</a> instances are identified by the |
|
-combination of <tt>model_name</tt>, <tt>report_name</tt>, |
|
-<tt>grouping</tt>, <tt>aggregation</tt> and <tt>reporting_period</tt> |
|
-</p> |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- <div id="method-list"> |
|
- <h3 class="section-bar">Methods</h3> |
|
- |
|
- <div class="name-list"> |
|
- <a href="#M000006">clear_for</a> |
|
- </div> |
|
- </div> |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- <div id="methods"> |
|
- <h3 class="section-bar">Public Class methods</h3> |
|
- |
|
- <div id="method-M000006" class="method-detail"> |
|
- <a name="M000006"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000006" class="method-signature"> |
|
- <span class="method-name">clear_for</span><span class="method-args">… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p> |
|
-Clears the cache for the specified <tt>klass</tt> and <tt>report</tt> |
|
-</p> |
|
-<h3>Parameters</h3> |
|
-<ul> |
|
-<li><tt>klass</tt> - The model the report to clear the cache for works on |
|
- |
|
-</li> |
|
-<li><tt>report</tt> - The name of the report to clear the cache for |
|
- |
|
-</li> |
|
-</ul> |
|
-<h3>Example</h3> |
|
-<p> |
|
-To clear the cache for a report defined as |
|
-</p> |
|
-<pre> |
|
- class User < ActiveRecord::Base |
|
- reports_as_sparkline :registrations |
|
- end |
|
-</pre> |
|
-<p> |
|
-just do |
|
-</p> |
|
-<pre> |
|
- Saulabs::ReportsAsSparkline::ReportCache.clear_for(User, :registrations) |
|
-</pre> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000006-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000006-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/rep… |
|
-26: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword k… |
|
-27: <span class="ruby-keyword kw">self</span>.<span class="ruby-identi… |
|
-28: <span class="ruby-identifier">:model_name</span> =<span class="… |
|
-29: <span class="ruby-identifier">:report_name</span> =<span class="… |
|
-30: }) |
|
-31: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/classes/Simplabs/ReportsAsSparkline/SparklineTagHelper.html b/… |
|
@@ -1,185 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Module: Saulabs::ReportsAsSparkline::SparklineTagHelper</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="classHeader"> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Module</strong></td> |
|
- <td class="class-name-in-header">Saulabs::ReportsAsSparkline::Sparkl… |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>In:</strong></td> |
|
- <td> |
|
- <a href="../../../files/lib/saulabs/reports_as_sparkline/spark… |
|
- lib/saulabs/reports_as_sparkline/sparkline_tag_helper.rb |
|
- </a> |
|
- <br /> |
|
- </td> |
|
- </tr> |
|
- |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- <div id="method-list"> |
|
- <h3 class="section-bar">Methods</h3> |
|
- |
|
- <div class="name-list"> |
|
- <a href="#M000001">sparkline_tag</a> |
|
- </div> |
|
- </div> |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- <div id="methods"> |
|
- <h3 class="section-bar">Public Instance methods</h3> |
|
- |
|
- <div id="method-M000001" class="method-detail"> |
|
- <a name="M000001"></a> |
|
- |
|
- <div class="method-heading"> |
|
- <a href="#M000001" class="method-signature"> |
|
- <span class="method-name">sparkline_tag</span><span class="method-ar… |
|
- </a> |
|
- </div> |
|
- |
|
- <div class="method-description"> |
|
- <p> |
|
-Renders a sparkline with the given data. |
|
-</p> |
|
-<h4>Parameters</h4> |
|
-<ul> |
|
-<li><tt>data</tt> - The data to render the sparkline for, is retrieved from a |
|
-report like <tt>User.registration_report</tt> |
|
- |
|
-</li> |
|
-</ul> |
|
-<h4>Options</h4> |
|
-<ul> |
|
-<li><tt>width</tt> - The width of the generated image |
|
- |
|
-</li> |
|
-<li><tt>height</tt> - The height of the generated image |
|
- |
|
-</li> |
|
-<li><tt>line_color</tt> - The line color of the sparkline (hex code) |
|
- |
|
-</li> |
|
-<li><tt>fill_color</tt> - The color to fill the area below the sparkline with |
|
-(hex code) |
|
- |
|
-</li> |
|
-<li><tt>labels</tt> - The axes to render lables for (Array of <tt>:x</tt>, |
|
-<tt>:y+</tt>, <tt>:r</tt>, <tt>:t</tt>; this is x axis, y axis, right, top) |
|
- |
|
-</li> |
|
-</ul> |
|
-<h4>Example</h4> |
|
-<p> |
|
-<tt><%= <a |
|
-href="SparklineTagHelper.html#M000001">sparkline_tag</a>(User.registrations_re… |
|
-:width => 200, :height => 100, :color => ‘000’) |
|
-%></tt> |
|
-</p> |
|
- <p><a class="source-toggle" href="#" |
|
- onclick="toggleCode('M000001-source');return false;">[Source]</a><… |
|
- <div class="method-source-code" id="M000001-source"> |
|
-<pre> |
|
- <span class="ruby-comment cmt"># File lib/saulabs/reports_as_sparkline/spa… |
|
-23: <span class="ruby-keyword kw">def</span> <span class="ruby-identifie… |
|
-24: <span class="ruby-identifier">options</span>.<span class="ruby-ide… |
|
-25: <span class="ruby-identifier">data</span> = <span class="ruby-iden… |
|
-26: <span class="ruby-identifier">labels</span> = <span class="ruby-va… |
|
-27: <span class="ruby-keyword kw">unless</span> <span class="ruby-iden… |
|
-28: <span class="ruby-identifier">labels</span> = <span class="ruby-… |
|
-29: <span class="ruby-keyword kw">end</span> |
|
-30: <span class="ruby-identifier">image_tag</span>( |
|
-31: <span class="ruby-node">"http://chart.apis.google.com/chart… |
|
-32: ) |
|
-33: <span class="ruby-keyword kw">end</span> |
|
-</pre> |
|
- </div> |
|
- </div> |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/created.rid b/doc/created.rid |
|
@@ -1 +0,0 @@ |
|
-Tue, 05 May 2009 19:07:12 +0200 |
|
diff --git a/doc/files/README_rdoc.html b/doc/files/README_rdoc.html |
|
@@ -1,361 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: README.rdoc</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="scr… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>README.rdoc</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>README.rdoc |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 19:07:10 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- <div id="description"> |
|
- <h1>ReportsAsSparkline</h1> |
|
-<p> |
|
-ReportsAsSparkline enables you to generate sparkline reports from your |
|
-model‘s data with very little effort. |
|
-</p> |
|
-<h2>Usage</h2> |
|
-<p> |
|
-If you hace a <tt>User</tt> model with <tt>created_at</tt> and |
|
-<tt>activated_at</tt> columns, you can just add |
|
-<tt>reports_as_sparkline</tt> to it with the following options: |
|
-</p> |
|
-<ul> |
|
-<li><tt>:date_column</tt> - The name of the date column over that the records |
|
-are aggregated (defaults to <tt>created_at</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:value_column</tt> - The name of the column that holds the values to |
|
-sum up when using aggregation <tt>:sum</tt> |
|
- |
|
-</li> |
|
-<li><tt>:aggregation</tt> - The aggregation to use (one of <tt>:count</tt>, |
|
-<tt>:sum</tt>, <tt>:minimum</tt>, <tt>:maximum</tt> or <tt>:average</tt>); |
|
-when using anything other than <tt>:count</tt>, <tt>:value_column</tt> must |
|
-also be specified (<b>If you really want to e.g. sum up the values in the |
|
-<tt>id</tt> column, you have to explicitely say so.</b>); (defaults to |
|
-<tt>:count</tt>) |
|
- |
|
-</li> |
|
-<li><tt>:grouping</tt> - The period records are grouped on (<tt>:hour</tt>, |
|
-<tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt>); <b>Beware that |
|
-<tt>reports_as_sparkline</tt> treats weeks as starting on monday!</b> |
|
- |
|
-</li> |
|
-<li><tt>:limit</tt> - The number of reporting periods to get (see |
|
-<tt>:grouping</tt>), (defaults to 100) |
|
- |
|
-</li> |
|
-<li><tt>:conditions</tt> - Conditions like in <tt>ActiveRecord::Base#find</tt>; |
|
-only records that match the conditions are reported; <b>Beware that when |
|
-conditions are specified, caching is disabled!</b> |
|
- |
|
-</li> |
|
-<li><tt>:live_data</tt> - Specifies whether data for the current reporting |
|
-period is to be read; <b>if <tt>:live_data</tt> is <tt>true</tt>, you will |
|
-experience a performance hit since the request cannot be satisfied from the |
|
-cache only (defaults to <tt>false</tt>)</b> |
|
- |
|
-</li> |
|
-<li><tt>:end_date</tt> - When specified, the report will only include data for |
|
-the <tt>:limit</tt> reporting periods until this date. |
|
- |
|
-</li> |
|
-</ul> |
|
-<p> |
|
-<b>Example:</b> |
|
-</p> |
|
-<pre> |
|
- class User < ActiveRecord::Base |
|
- reports_as_sparkline :registrations |
|
- reports_as_sparkline :activations, :date_column => :activated_at |
|
- reports_as_sparkline :total_users, :cumulate => true |
|
- end |
|
-</pre> |
|
-<p> |
|
-This will add the following class methods to your User model: |
|
-</p> |
|
-<pre> |
|
- User.registrations_report |
|
- User.activations_report |
|
- User.total_users_report |
|
-</pre> |
|
-<p> |
|
-When invoking the report, you can override some of the options you |
|
-specified for <tt>reports_as_sparkline</tt>: |
|
-</p> |
|
-<ul> |
|
-<li><tt>:grouping</tt> - The period records are grouped on (<tt>:hour</tt>, |
|
-<tt>:day</tt>, <tt>:week</tt>, <tt>:month</tt>); <b>Beware that |
|
-<tt>reports_as_sparkline</tt> treats weeks as starting on monday!</b> |
|
- |
|
-</li> |
|
-<li><tt>:limit</tt> - The number of reporting periods to get (see |
|
-<tt>:grouping</tt>), (defaults to 100) |
|
- |
|
-</li> |
|
-<li><tt>:conditions</tt> - Conditions like in <tt>ActiveRecord::Base#find</tt>; |
|
-only records that match the conditions are reported; <b>Beware that when |
|
-conditions are specified, caching is disabled!</b> |
|
- |
|
-</li> |
|
-<li><tt>:live_data</tt> - Specifies whether data for the current reporting |
|
-period is to be read; <b>if <tt>:live_data</tt> is <tt>true</tt>, you will |
|
-experience a performance hit since the request cannot be satisfied from the |
|
-cache only (defaults to <tt>false</tt>)</b> |
|
- |
|
-</li> |
|
-<li><tt>:end_date</tt> - When specified, the report will only include data for |
|
-the <tt>:limit</tt> reporting periods until this date. |
|
- |
|
-</li> |
|
-</ul> |
|
-<p> |
|
-<b>Example:</b> |
|
-</p> |
|
-<pre> |
|
- User.registrations_report(:conditions => ['last_name LIKE 'A%']) |
|
- User.activations_report(:grouping => :week, :limit => 5) |
|
-</pre> |
|
-<h3>The Report cache</h3> |
|
-<p> |
|
-Unless you specify parameters that make it impossible to cache report |
|
-results, all results will be cached. You can access the cache via the |
|
-<tt><a |
|
-href="../classes/Saulabs/ReportsAsSparkline/ReportCache.html">Saulabs::Reports… |
|
-class. <b>Beware that when you modify data in the cache, report results may |
|
-be incorrect or execurting reports may even fail completely!</b> To clear |
|
-the cache for a specific report, use the |
|
-<tt>Saulabs::ReportsAsSparkline::ReportCache.clear_for</tt> method. |
|
-</p> |
|
-<p> |
|
-<b>Example</b> |
|
-</p> |
|
-<p> |
|
-For a report defined as |
|
-</p> |
|
-<pre> |
|
- class User < ActiveRecord::Base |
|
- reports_as_sparkline :registrations |
|
- end |
|
-</pre> |
|
-<p> |
|
-you can clear the cache with |
|
-</p> |
|
-<pre> |
|
- Saulabs::ReportsAsSparkline::ReportCache.clear_for(User, :registrations) |
|
-</pre> |
|
-<h3>In your views</h3> |
|
-<p> |
|
-You can than render sparklines for these reports with sparkline_tag in your |
|
-view: |
|
-</p> |
|
-<pre> |
|
- <%= sparkline_tag(User.registrations_report) %> |
|
-</pre> |
|
-<p> |
|
-The <tt>sparkline_tag</tt> helper takes the following parameters: |
|
-</p> |
|
-<ul> |
|
-<li><tt>width</tt> - The width of the generated image |
|
- |
|
-</li> |
|
-<li><tt>height</tt> - The height of the generated image |
|
- |
|
-</li> |
|
-<li><tt>line_color</tt> - The line color of the sparkline (hex code) |
|
- |
|
-</li> |
|
-<li><tt>fill_color</tt> - The color to fill the area below the sparkline with |
|
-(hex code) |
|
- |
|
-</li> |
|
-<li><tt>labels</tt> - The axes to render lables for (Array of <tt>:x</tt>, |
|
-<tt>:y+</tt>, <tt>:r</tt>, <tt>:t</tt>; this is x axis, y axis, right, top) |
|
- |
|
-</li> |
|
-</ul> |
|
-<h2>Installation</h2> |
|
-<p> |
|
-Installation requires 3 simple steps: |
|
-</p> |
|
-<p> |
|
-<b>get the plugin</b> |
|
-</p> |
|
-<p> |
|
-From your RAILS_ROOT in Rails >= 2.1, do |
|
-</p> |
|
-<pre> |
|
- ./script/plugin install git://github.com/marcoow/reports_as_sparkline.git |
|
-</pre> |
|
-<p> |
|
-If you are on Rails < 2.1, do this from your RAILS_ROOT |
|
-</p> |
|
-<pre> |
|
- git clone git://github.com/marcoow/reports_as_sparkline.git vendor/plugins/r… |
|
-</pre> |
|
-<p> |
|
-<b>generate migration</b> |
|
-</p> |
|
-<pre> |
|
- ./script/generate reports_as_sparkline_migration add_reports_as_sparkline_ta… |
|
-</pre> |
|
-<p> |
|
-<b>migrate</b> |
|
-</p> |
|
-<pre> |
|
- rake db:migrate |
|
-</pre> |
|
-<h2>Performance</h2> |
|
-<p> |
|
-To achieve best performance, you should add indices to your tables on the |
|
-date columns that are used for grouping the records (see |
|
-Saulabs::ReportsAsSparkline::ClassMethods.reports_as_sparkline): |
|
-</p> |
|
-<pre> |
|
- add_index :[table], :[date_column] |
|
-</pre> |
|
-<p> |
|
-If you are on PostgreSQL, you should add functional indices: |
|
-</p> |
|
-<pre> |
|
- add_index :[table], :[date_column], :functional => "date_trunc('hour… |
|
- add_index :[table], :[date_column], :functional => "date_trunc('day'… |
|
- add_index :[table], :[date_column], :functional => "date_trunc('week… |
|
- add_index :[table], :[date_column], :functional => "date_trunc('year… |
|
-</pre> |
|
-<p> |
|
-You might also want to use fragment caching in your views since processing |
|
-the data read from the db (either from the model‘s table or from the |
|
-cache) aso takes some time. |
|
-</p> |
|
-<p> |
|
-<b>Example</b> |
|
-</p> |
|
-<pre> |
|
- <%- cache(:key => 'UserRegistrationsReport') do -%> |
|
- <%= sparkline_tag(User.registrations_report) %> |
|
- <%- end -%> |
|
-</pre> |
|
-<h2>TODOs/ future plans</h2> |
|
-<ul> |
|
-<li>support for Oracle and DB2 (and others?) missing |
|
- |
|
-</li> |
|
-<li>Limit number of data points to maximum that the google chart api allows |
|
- |
|
-</li> |
|
-<li>Make graph styling configurable |
|
- |
|
-</li> |
|
-</ul> |
|
-<p> |
|
-If you want to suggest any new features or report bugs, do so at <a |
|
-href="http://github.com/marcoow/reports_as_sparkline/issues">github.com/marcoo… |
|
-</p> |
|
-<h2>Contributors</h2> |
|
-<ul> |
|
-<li>myronmarston (<a |
|
-href="http://github.com/myronmarston">github.com/myronmarston</a>) |
|
- |
|
-</li> |
|
-</ul> |
|
-<h2>Author</h2> |
|
-<p> |
|
-© 2008-2009 Marco Otte-Witte (<a |
|
-href="http://saulabs.com">saulabs.com</a>), Martin Kavalar, released |
|
-under the MIT license |
|
-</p> |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/cumulated_report_rb.ht… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: cumulated_report.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>cumulated_report.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/cumulated_report.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Wed Apr 29 19:28:16 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/grouping_rb.html b/doc… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: grouping.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>grouping.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/grouping.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 18:20:50 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/report_cache_rb.html b… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: report_cache.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>report_cache.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/report_cache.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 19:02:15 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/report_rb.html b/doc/f… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: report.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>report.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/report.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 15:51:11 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/reporting_period_rb.ht… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: reporting_period.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>reporting_period.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/reporting_period.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 18:41:47 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline/sparkline_tag_helper_r… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: sparkline_tag_helper.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" m… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>sparkline_tag_helper.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline/sparkline_tag_helper.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Wed Apr 29 19:28:41 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/files/lib/simplabs/reports_as_sparkline_rb.html b/doc/files/li… |
|
@@ -1,101 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>File: reports_as_sparkline.rb</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <meta http-equiv="Content-Script-Type" content="text/javascript" /> |
|
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" medi… |
|
- <script type="text/javascript"> |
|
- // <![CDATA[ |
|
- |
|
- function popupCode( url ) { |
|
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=n… |
|
- } |
|
- |
|
- function toggleCode( id ) { |
|
- if ( document.getElementById ) |
|
- elem = document.getElementById( id ); |
|
- else if ( document.all ) |
|
- elem = eval( "document.all." + id ); |
|
- else |
|
- return false; |
|
- |
|
- elemStyle = elem.style; |
|
- |
|
- if ( elemStyle.display != "block" ) { |
|
- elemStyle.display = "block" |
|
- } else { |
|
- elemStyle.display = "none" |
|
- } |
|
- |
|
- return true; |
|
- } |
|
- |
|
- // Make codeblocks hidden by default |
|
- document.writeln( "<style type=\"text/css\">div.method-source-code { display… |
|
- |
|
- // ]]> |
|
- </script> |
|
- |
|
-</head> |
|
-<body> |
|
- |
|
- |
|
- |
|
- <div id="fileHeader"> |
|
- <h1>reports_as_sparkline.rb</h1> |
|
- <table class="header-table"> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Path:</strong></td> |
|
- <td>lib/saulabs/reports_as_sparkline.rb |
|
- </td> |
|
- </tr> |
|
- <tr class="top-aligned-row"> |
|
- <td><strong>Last Update:</strong></td> |
|
- <td>Tue May 05 19:02:42 +0200 2009</td> |
|
- </tr> |
|
- </table> |
|
- </div> |
|
- <!-- banner header --> |
|
- |
|
- <div id="bodyContent"> |
|
- |
|
- |
|
- |
|
- <div id="contextContent"> |
|
- |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
- <!-- if includes --> |
|
- |
|
- <div id="section"> |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- |
|
- <!-- if method_list --> |
|
- |
|
- |
|
- </div> |
|
- |
|
- |
|
-<div id="validator-badges"> |
|
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></sm… |
|
-</div> |
|
- |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/fr_class_index.html b/doc/fr_class_index.html |
|
@@ -1,31 +0,0 @@ |
|
- |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<!-- |
|
- |
|
- Classes |
|
- |
|
- --> |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Classes</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" /> |
|
- <base target="docwin" /> |
|
-</head> |
|
-<body> |
|
-<div id="index"> |
|
- <h1 class="section-bar">Classes</h1> |
|
- <div id="index-entries"> |
|
- <a href="classes/Saulabs/ReportsAsSparkline/ClassMethods.html">Saulabs::Re… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/CumulatedReport.html">Saulabs:… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/Report.html">Saulabs::ReportsA… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/ReportCache.html">Saulabs::Rep… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/SparklineTagHelper.html">Saula… |
|
- </div> |
|
-</div> |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/fr_file_index.html b/doc/fr_file_index.html |
|
@@ -1,34 +0,0 @@ |
|
- |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<!-- |
|
- |
|
- Files |
|
- |
|
- --> |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Files</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" /> |
|
- <base target="docwin" /> |
|
-</head> |
|
-<body> |
|
-<div id="index"> |
|
- <h1 class="section-bar">Files</h1> |
|
- <div id="index-entries"> |
|
- <a href="files/README_rdoc.html">README.rdoc</a><br /> |
|
- <a href="files/lib/saulabs/reports_as_sparkline_rb.html">lib/saulabs/repor… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/cumulated_report_rb.html">… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/grouping_rb.html">lib/saul… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/report_rb.html">lib/saulab… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/report_cache_rb.html">lib/… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/reporting_period_rb.html">… |
|
- <a href="files/lib/saulabs/reports_as_sparkline/sparkline_tag_helper_rb.ht… |
|
- </div> |
|
-</div> |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/fr_method_index.html b/doc/fr_method_index.html |
|
@@ -1,34 +0,0 @@ |
|
- |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
- |
|
-<!-- |
|
- |
|
- Methods |
|
- |
|
- --> |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>Methods</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
- <link rel="stylesheet" href="rdoc-style.css" type="text/css" /> |
|
- <base target="docwin" /> |
|
-</head> |
|
-<body> |
|
-<div id="index"> |
|
- <h1 class="section-bar">Methods</h1> |
|
- <div id="index-entries"> |
|
- <a href="classes/Saulabs/ReportsAsSparkline/ReportCache.html#M000006">clea… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/CumulatedReport.html#M000004">… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/CumulatedReport.html#M000005">… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/Report.html#M000007">new (Saul… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/ClassMethods.html#M000002">rep… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/CumulatedReport.html#M000003">… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/Report.html#M000008">run (Saul… |
|
- <a href="classes/Saulabs/ReportsAsSparkline/SparklineTagHelper.html#M00000… |
|
- </div> |
|
-</div> |
|
-</body> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/index.html b/doc/index.html |
|
@@ -1,24 +0,0 @@ |
|
-<?xml version="1.0" encoding="iso-8859-1"?> |
|
-<!DOCTYPE html |
|
- PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" |
|
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> |
|
- |
|
-<!-- |
|
- |
|
- ReportsAsSparkline |
|
- |
|
- --> |
|
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|
-<head> |
|
- <title>ReportsAsSparkline</title> |
|
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
|
-</head> |
|
-<frameset rows="20%, 80%"> |
|
- <frameset cols="25%,35%,45%"> |
|
- <frame src="fr_file_index.html" title="Files" name="Files" /> |
|
- <frame src="fr_class_index.html" name="Classes" /> |
|
- <frame src="fr_method_index.html" name="Methods" /> |
|
- </frameset> |
|
- <frame src="files/README_rdoc.html" name="docwin" /> |
|
-</frameset> |
|
-</html> |
|
-\ No newline at end of file |
|
diff --git a/doc/rdoc-style.css b/doc/rdoc-style.css |
|
@@ -1,208 +0,0 @@ |
|
- |
|
-body { |
|
- font-family: Verdana,Arial,Helvetica,sans-serif; |
|
- font-size: 90%; |
|
- margin: 0; |
|
- margin-left: 40px; |
|
- padding: 0; |
|
- background: white; |
|
-} |
|
- |
|
-h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } |
|
-h1 { font-size: 150%; } |
|
-h2,h3,h4 { margin-top: 1em; } |
|
- |
|
-a { background: #eef; color: #039; text-decoration: none; } |
|
-a:hover { background: #039; color: #eef; } |
|
- |
|
-/* Override the base stylesheet's Anchor inside a table cell */ |
|
-td > a { |
|
- background: transparent; |
|
- color: #039; |
|
- text-decoration: none; |
|
-} |
|
- |
|
-/* and inside a section title */ |
|
-.section-title > a { |
|
- background: transparent; |
|
- color: #eee; |
|
- text-decoration: none; |
|
-} |
|
- |
|
-/* === Structural elements =================================== */ |
|
- |
|
-div#index { |
|
- margin: 0; |
|
- margin-left: -40px; |
|
- padding: 0; |
|
- font-size: 90%; |
|
-} |
|
- |
|
- |
|
-div#index a { |
|
- margin-left: 0.7em; |
|
-} |
|
- |
|
-div#index .section-bar { |
|
- margin-left: 0px; |
|
- padding-left: 0.7em; |
|
- background: #ccc; |
|
- font-size: small; |
|
-} |
|
- |
|
- |
|
-div#classHeader, div#fileHeader { |
|
- width: auto; |
|
- color: white; |
|
- padding: 0.5em 1.5em 0.5em 1.5em; |
|
- margin: 0; |
|
- margin-left: -40px; |
|
- border-bottom: 3px solid #006; |
|
-} |
|
- |
|
-div#classHeader a, div#fileHeader a { |
|
- background: inherit; |
|
- color: white; |
|
-} |
|
- |
|
-div#classHeader td, div#fileHeader td { |
|
- background: inherit; |
|
- color: white; |
|
-} |
|
- |
|
- |
|
-div#fileHeader { |
|
- background: #057; |
|
-} |
|
- |
|
-div#classHeader { |
|
- background: #048; |
|
-} |
|
- |
|
- |
|
-.class-name-in-header { |
|
- font-size: 180%; |
|
- font-weight: bold; |
|
-} |
|
- |
|
- |
|
-div#bodyContent { |
|
- padding: 0 1.5em 0 1.5em; |
|
-} |
|
- |
|
-div#description { |
|
- padding: 0.5em 1.5em; |
|
- background: #efefef; |
|
- border: 1px dotted #999; |
|
-} |
|
- |
|
-div#description h1,h2,h3,h4,h5,h6 { |
|
- color: #125;; |
|
- background: transparent; |
|
-} |
|
- |
|
-div#validator-badges { |
|
- text-align: center; |
|
-} |
|
-div#validator-badges img { border: 0; } |
|
- |
|
-div#copyright { |
|
- color: #333; |
|
- background: #efefef; |
|
- font: 0.75em sans-serif; |
|
- margin-top: 5em; |
|
- margin-bottom: 0; |
|
- padding: 0.5em 2em; |
|
-} |
|
- |
|
- |
|
-/* === Classes =================================== */ |
|
- |
|
-table.header-table { |
|
- color: white; |
|
- font-size: small; |
|
-} |
|
- |
|
-.type-note { |
|
- font-size: small; |
|
- color: #DEDEDE; |
|
-} |
|
- |
|
-.xxsection-bar { |
|
- background: #eee; |
|
- color: #333; |
|
- padding: 3px; |
|
-} |
|
- |
|
-.section-bar { |
|
- color: #333; |
|
- border-bottom: 1px solid #999; |
|
- margin-left: -20px; |
|
-} |
|
- |
|
- |
|
-.section-title { |
|
- background: #79a; |
|
- color: #eee; |
|
- padding: 3px; |
|
- margin-top: 2em; |
|
- margin-left: -30px; |
|
- border: 1px solid #999; |
|
-} |
|
- |
|
-.top-aligned-row { vertical-align: top } |
|
-.bottom-aligned-row { vertical-align: bottom } |
|
- |
|
-/* --- Context section classes ----------------------- */ |
|
- |
|
-.context-row { } |
|
-.context-item-name { font-family: monospace; font-weight: bold; color: black; } |
|
-.context-item-value { font-size: small; color: #448; } |
|
-.context-item-desc { color: #333; padding-left: 2em; } |
|
- |
|
-/* --- Method classes -------------------------- */ |
|
-.method-detail { |
|
- background: #efefef; |
|
- padding: 0; |
|
- margin-top: 0.5em; |
|
- margin-bottom: 1em; |
|
- border: 1px dotted #ccc; |
|
-} |
|
-.method-heading { |
|
- color: black; |
|
- background: #ccc; |
|
- border-bottom: 1px solid #666; |
|
- padding: 0.2em 0.5em 0 0.5em; |
|
-} |
|
-.method-signature { color: black; background: inherit; } |
|
-.method-name { font-weight: bold; } |
|
-.method-args { font-style: italic; } |
|
-.method-description { padding: 0 0.5em 0 0.5em; } |
|
- |
|
-/* --- Source code sections -------------------- */ |
|
- |
|
-a.source-toggle { font-size: 90%; } |
|
-div.method-source-code { |
|
- background: #262626; |
|
- color: #ffdead; |
|
- margin: 1em; |
|
- padding: 0.5em; |
|
- border: 1px dashed #999; |
|
- overflow: hidden; |
|
-} |
|
- |
|
-div.method-source-code pre { color: #ffdead; overflow: hidden; } |
|
- |
|
-/* --- Ruby keyword styles --------------------- */ |
|
- |
|
-.standalone-code { background: #221111; color: #ffdead; overflow: hidden; } |
|
- |
|
-.ruby-constant { color: #7fffd4; background: transparent; } |
|
-.ruby-keyword { color: #00ffff; background: transparent; } |
|
-.ruby-ivar { color: #eedd82; background: transparent; } |
|
-.ruby-operator { color: #00ffee; background: transparent; } |
|
-.ruby-identifier { color: #ffdead; background: transparent; } |
|
-.ruby-node { color: #ffa07a; background: transparent; } |
|
-.ruby-comment { color: #b22222; font-weight: bold; background: transparent; } |
|
-.ruby-regexp { color: #ffa07a; background: transparent; } |
|
-.ruby-value { color: #7fffd4; background: transparent; } |
|
-\ No newline at end of file |
