doc/TableSetter/Table.html in table_setter-0.1.10 vs doc/TableSetter/Table.html in table_setter-0.1.11
- old
+ new
@@ -1,10 +1,10 @@
<!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>
- <meta name="Content-Type" content="text/html; charset=UTF-8" />
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Class: TableSetter::Table</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
@@ -22,11 +22,11 @@
<div id="header">
<div id="menu">
<a href="../_index.html">Index (T)</a> »
- <span class='title'><a href="../TableSetter.html" title="TableSetter (module)">TableSetter</a></span>
+ <span class='title'><span class='object_link'><a href="../TableSetter.html" title="TableSetter (module)">TableSetter</a></span></span>
»
<span class="title">Table</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
@@ -41,13 +41,14 @@
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
- <div id="content"><h1>Class: TableSetter::Table
+ <div id="content"><h1>Class: TableSetter::Table
+
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
@@ -69,19 +70,20 @@
+
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/table_setter/table.rb</dd>
</dl>
<div class="clear"></div>
- <h2>Instance Attribute Summary</h2>
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
@@ -96,17 +98,18 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
<li class="public ">
@@ -123,17 +126,18 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
<li class="public ">
@@ -150,17 +154,18 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
<li class="public ">
@@ -177,17 +182,18 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
<li class="public ">
@@ -204,17 +210,18 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
<li class="public ">
@@ -231,29 +238,34 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The <tt>Table</tt> class handles processing the yaml processing and csv
loading, through table fu.
-
-</span>
+</p>
+</div></span>
</li>
</ul>
- <h2>Class Method Summary</h2>
+
+ <h2>
+ Class Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
- <ul class="summary">
-
- <li class="public ">
+ <ul class="summary">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#all-class_method" title="all (class method)">+ (Object) <strong>all</strong> </a>
@@ -262,21 +274,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
Returns all the tables in the table directory.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#exists%3F-class_method" title="exists? (class method)">+ (Boolean) <strong>exists?</strong>(slug) </a>
@@ -285,21 +298,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
Does a table with this slug exist?.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#fresh_yaml_time-class_method" title="fresh_yaml_time (class method)">+ (Object) <strong>fresh_yaml_time</strong> </a>
@@ -308,23 +322,24 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
<tt>fresh_yaml_time</tt> checks each file in the tables directory and
returns the newest file’s modification time — there’s
probably a more unix-y way to do this but for now this is plenty speedy.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#table_path-class_method" title="table_path (class method)">+ (Object) <strong>table_path</strong>(slug) </a>
@@ -333,27 +348,31 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
Convenience method for looking up by slug.
-
-</span>
+</p>
+</div></span>
</li>
-
- </ul>
+
+ </ul>
+
+ <h2>
+ Instance Method Summary
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+ </h2>
- <h2>Instance Method Summary</h2>
-
- <ul class="summary">
-
- <li class="public ">
+ <ul class="summary">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#csv_data-instance_method" title="#csv_data (instance method)">- (Object) <strong>csv_data</strong> </a>
@@ -362,23 +381,24 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The csv_data for the table fu instance is loaded either from the remote
source or from a local file, depending on the keys present in the yaml
file.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#faceted%3F-instance_method" title="#faceted? (instance method)">- (Boolean) <strong>faceted?</strong> </a>
@@ -387,18 +407,19 @@
+
- <span class="summary_desc"></span>
+ <span class="summary_desc"><div class='inline'></div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#hard_paginate%3F-instance_method" title="#hard_paginate? (instance method)">- (Boolean) <strong>hard_paginate?</strong> </a>
@@ -407,21 +428,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
hard_paginate instructs the app to render batches of a table.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Table) <strong>initialize</strong>(slug, opts = {:defer => false}) </a>
@@ -432,23 +454,24 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
A new Table should accept a slug, mapped to a yaml in the tables directory,
optionally you can defer loading of the table until you’re ready to
render it.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#load-instance_method" title="#load (instance method)">- (Object) <strong>load</strong> </a>
@@ -457,22 +480,23 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The load method handles the actual request either to the file system or
remote url.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(method) </a>
@@ -481,22 +505,23 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
We magically need access to the top level keys like google_key, or uri for
the other methods.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#paginate%21-instance_method" title="#paginate! (instance method)">- (Object) <strong>paginate!</strong>(curr_page) </a>
@@ -505,21 +530,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
paginate uses TableFu’s only! method to batch the table.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#per_page-instance_method" title="#per_page (instance method)">- (Object) <strong>per_page</strong> </a>
@@ -528,21 +554,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The number of rows per page.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#sort_array-instance_method" title="#sort_array (instance method)">- (Object) <strong>sort_array</strong> </a>
@@ -551,21 +578,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
A convienence method to return the sort array for table setter.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#sortable%3F-instance_method" title="#sortable? (instance method)">- (Boolean) <strong>sortable?</strong> </a>
@@ -574,22 +602,23 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
A table isn’t sortable by tablesorter if it’s either faceted or
multi-page paginated.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#total_pages-instance_method" title="#total_pages (instance method)">- (Object) <strong>total_pages</strong> </a>
@@ -598,21 +627,22 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The total pages we’ll have.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#updated_at-instance_method" title="#updated_at (instance method)">- (Object) <strong>updated_at</strong> </a>
@@ -621,22 +651,23 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
The real <tt>updated_at</tt> of a Table instance is the newer modification
time of the csv file or the yaml file.
-
-</span>
+</p>
+</div></span>
</li>
-
- <li class="public ">
+
+ <li class="public ">
<span class="summary_signature">
<a href="#uri-instance_method" title="#uri (instance method)">- (Object) <strong>uri</strong> </a>
@@ -645,28 +676,31 @@
+
- <span class="summary_desc">
+ <span class="summary_desc"><div class='inline'><p>
Returns a usable uri based on what sort of input we have.
-
-</span>
+</p>
+</div></span>
</li>
-
- </ul>
+
+ </ul>
+
+
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<p class="signature first" id="initialize-instance_method">
- - (<tt><a href="" title="TableSetter::Table (class)">Table</a></tt>) <strong>initialize</strong>(slug, opts = {:defer => false})
+ - (<tt><span class='object_link'><a href="" title="TableSetter::Table (class)">Table</a></span></tt>) <strong>initialize</strong>(slug, opts = {:defer => false})
</p><div class="docstring">
<div class="discussion">
@@ -1601,11 +1635,11 @@
<td>
<pre class="code"><span class="info file"># File 'lib/table_setter/table.rb', line 101</span>
<span class='def def kw'>def</span> <span class='sort_array identifier id'>sort_array</span>
<span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='sorted_by identifier id'>sorted_by</span><span class='dot token'>.</span><span class='inject identifier id'>inject</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='memo identifier id'>memo</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='key identifier id'>key</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='rparen token'>)</span><span class='bitor op'>|</span>
- <span class='memo identifier id'>memo</span> <span class='lshft op'><<</span> <span class='lbrack token'>[</span><span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='columns identifier id'>columns</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='key identifier id'>key</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='value identifier id'>value</span> <span class='eq op'>==</span> <span class='string val'>'descending'</span> <span class='question op'>?</span> <span class='integer val'>0</span> <span class='colon op'>:</span> <span class='integer val'>1</span><span class='rbrack token'>]</span>
+ <span class='memo identifier id'>memo</span> <span class='lshft op'><<</span> <span class='lbrack token'>[</span><span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='columns identifier id'>columns</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='key identifier id'>key</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='value identifier id'>value</span> <span class='eq op'>==</span> <span class='string val'>'descending'</span> <span class='question op'>?</span> <span class='integer val'>1</span> <span class='colon op'>:</span> <span class='integer val'>0</span><span class='rbrack token'>]</span>
<span class='end end kw'>end</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
@@ -1802,12 +1836,12 @@
</div>
</div>
<div id="footer">
- Generated on Tue Mar 9 17:18:07 2010 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
- 0.5.3 (ruby-1.8.7).
+ Generated on Thu Nov 4 18:34:17 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.7).
</div>
</body>
</html>
\ No newline at end of file