RubyGems - browsercms - Versions diffs - 3.4.0.rc2 → 3.4.0 - Mend

browsercms 3.4.0.rc2 → 3.4.0

Files changed (776) hide show

data/doc/app/classes/Cms/Behaviors/Pagination/Collection.html DELETED Viewed

@@ -1,437 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!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: Cms::Behaviors::Pagination::Collection</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  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: none }</style>" )
-  // ]]>
-  </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">Cms::Behaviors::Pagination::Collection</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../../files/lib/cms/behaviors/pagination_rb.html">
-                lib/cms/behaviors/pagination.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Array
-            </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="#M000441">create</a>&nbsp;&nbsp;
-      <a href="#M000440">new</a>&nbsp;&nbsp;
-      <a href="#M000445">next_page</a>&nbsp;&nbsp;
-      <a href="#M000443">offset</a>&nbsp;&nbsp;
-      <a href="#M000442">out_of_bounds?</a>&nbsp;&nbsp;
-      <a href="#M000444">previous_page</a>&nbsp;&nbsp;
-      <a href="#M000447">replace</a>&nbsp;&nbsp;
-      <a href="#M000446">total_entries=</a>&nbsp;&nbsp;
-      </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">current_page</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">per_page</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">total_entries</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc"></td>
-        </tr>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">total_pages</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</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-M000441" class="method-detail">
-        <a name="M000441"></a>
-        <div class="method-heading">
-          <a href="#M000441" class="method-signature">
-          <span class="method-name">create</span><span class="method-args">(page, per_page, total = nil) {|pager| ...}</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Just like <tt><a href="Collection.html#M000440">new</a></tt>, but yields
-the object after instantiation and returns it afterwards. This is very
-useful for manual pagination:
-</p>
-<pre>
-  @entries = WillPaginate::Collection.create(1, 10) do |pager|
-    result = Post.find(:all, :limit =&gt; pager.per_page, :offset =&gt; pager.offset)
-    # inject the result array into the paginated collection:
-    pager.replace(result)
-    unless pager.total_entries
-      # the pager didn't manage to guess the total count, do it manually
-      pager.total_entries = Post.count
-    end
-  end
-</pre>
-<p>
-The possibilities with this are endless. For another example, here is how
-WillPaginate used to define pagination for Array instances:
-</p>
-<pre>
-  Array.class_eval do
-    def paginate(page = 1, per_page = 15)
-      WillPaginate::Collection.create(page, per_page, size) do |pager|
-        pager.replace self[pager.offset, pager.per_page].to_a
-      end
-    end
-  end
-</pre>
-<p>
-The Array#paginate API has since then changed, but this still serves as a
-fine example of WillPaginate::Collection usage.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000441-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000441-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 59</span>
-59:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">page</span>, <span class="ruby-identifier">per_page</span>, <span class="ruby-identifier">total</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-60:           <span class="ruby-identifier">pager</span> = <span class="ruby-identifier">new</span>(<span class="ruby-identifier">page</span>, <span class="ruby-identifier">per_page</span>, <span class="ruby-identifier">total</span>)
-61:           <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">pager</span>
-62:           <span class="ruby-identifier">pager</span>
-63:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000440" class="method-detail">
-        <a name="M000440"></a>
-        <div class="method-heading">
-          <a href="#M000440" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(page, per_page, total = nil)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Arguments to the constructor are the current page number, per-page limit
-and the total number of entries. The last argument is optional because it
-is best to do lazy counting; in other words, count <b>conditionally</b>
-after populating the collection using the <tt><a
-href="Collection.html#M000447">replace</a></tt> method.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000440-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000440-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 23</span>
-23:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">page</span>, <span class="ruby-identifier">per_page</span>, <span class="ruby-identifier">total</span> = <span class="ruby-keyword kw">nil</span>)
-24:           <span class="ruby-ivar">@current_page</span> = <span class="ruby-identifier">page</span>.<span class="ruby-identifier">to_i</span>
-25:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidPage</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">page</span>, <span class="ruby-ivar">@current_page</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@current_page</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span>
-26:           <span class="ruby-ivar">@per_page</span> = <span class="ruby-identifier">per_page</span>.<span class="ruby-identifier">to_i</span>
-27:           <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;`per_page` setting cannot be less than 1 (#{@per_page} given)&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@per_page</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span>
-28:
-29:           <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">total_entries</span> = <span class="ruby-identifier">total</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">total</span>
-30:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000445" class="method-detail">
-        <a name="M000445"></a>
-        <div class="method-heading">
-          <a href="#M000445" class="method-signature">
-          <span class="method-name">next_page</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-current_page + 1 or nil if there is no next page
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000445-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000445-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 86</span>
-86:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">next_page</span>
-87:           <span class="ruby-identifier">current_page</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">total_pages</span> <span class="ruby-value">? </span>(<span class="ruby-identifier">current_page</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
-88:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000443" class="method-detail">
-        <a name="M000443"></a>
-        <div class="method-heading">
-          <a href="#M000443" class="method-signature">
-          <span class="method-name">offset</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Current <a href="Collection.html#M000443">offset</a> of the paginated
-collection. If we&#8216;re on the first page, it is always 0. If
-we&#8216;re on the 2nd page and there are 30 entries per page, the <a
-href="Collection.html#M000443">offset</a> is 30. This property is useful if
-you want to render ordinals besides your records: simply start with <a
-href="Collection.html#M000443">offset</a> + 1.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000443-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000443-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 76</span>
-76:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">offset</span>
-77:           (<span class="ruby-identifier">current_page</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>) <span class="ruby-operator">*</span> <span class="ruby-identifier">per_page</span>
-78:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000442" class="method-detail">
-        <a name="M000442"></a>
-        <div class="method-heading">
-          <a href="#M000442" class="method-signature">
-          <span class="method-name">out_of_bounds?</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-Helper method that is true when someone tries to fetch a page with a larger
-number than the last page. Can be used in combination with flashes and
-redirecting.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000442-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000442-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 68</span>
-68:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">out_of_bounds?</span>
-69:           <span class="ruby-identifier">current_page</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">total_pages</span>
-70:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000444" class="method-detail">
-        <a name="M000444"></a>
-        <div class="method-heading">
-          <a href="#M000444" class="method-signature">
-          <span class="method-name">previous_page</span><span class="method-args">()</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-current_page - 1 or nil if there is no previous page
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000444-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000444-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 81</span>
-81:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">previous_page</span>
-82:           <span class="ruby-identifier">current_page</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">1</span> <span class="ruby-operator">?</span> (<span class="ruby-identifier">current_page</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword kw">nil</span>
-83:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000447" class="method-detail">
-        <a name="M000447"></a>
-        <div class="method-heading">
-          <a href="#M000447" class="method-signature">
-          <span class="method-name">replace</span><span class="method-args">(array)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p>
-This is a magic wrapper for the original Array#replace method. It serves
-for populating the paginated collection after initialization.
-</p>
-<p>
-Why magic? Because it tries to guess the total number of entries judging by
-the size of given array. If it is shorter than <tt>per_page</tt> limit,
-then we know we&#8216;re on the last page. This trick is very useful for
-avoiding unnecessary hits to the database to do the counting after we
-fetched the data for the current page.
-</p>
-<p>
-However, after using <tt><a href="Collection.html#M000447">replace</a></tt>
-you should always test the value of <tt>total_entries</tt> and set it to a
-proper value if it&#8216;s <tt>nil</tt>. See the example in <tt><a
-href="Collection.html#M000441">create</a></tt>.
-</p>
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000447-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000447-source">
-<pre>
-     <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 107</span>
-107:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">replace</span>(<span class="ruby-identifier">array</span>)
-108:           <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">super</span>
-109:
-110:           <span class="ruby-comment cmt"># The collection is shorter then page limit? Rejoice, because</span>
-111:           <span class="ruby-comment cmt"># then we know that we are on the last page!</span>
-112:           <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">total_entries</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">length</span> <span class="ruby-operator">&lt;</span> <span class="ruby-identifier">per_page</span> <span class="ruby-keyword kw">and</span> (<span class="ruby-identifier">current_page</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">length</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>)
-113:             <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">total_entries</span> = <span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">length</span>
-114:           <span class="ruby-keyword kw">end</span>
-115:
-116:           <span class="ruby-identifier">result</span>
-117:         <span class="ruby-keyword kw">end</span>
-</pre>
-          </div>
-        </div>
-      </div>
-      <div id="method-M000446" class="method-detail">
-        <a name="M000446"></a>
-        <div class="method-heading">
-          <a href="#M000446" class="method-signature">
-          <span class="method-name">total_entries=</span><span class="method-args">(number)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000446-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000446-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 90</span>
-90:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">total_entries=</span>(<span class="ruby-identifier">number</span>)
-91:           <span class="ruby-ivar">@total_entries</span> = <span class="ruby-identifier">number</span>.<span class="ruby-identifier">to_i</span>
-92:           <span class="ruby-ivar">@total_pages</span>   = (<span class="ruby-ivar">@total_entries</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">per_page</span>.<span class="ruby-identifier">to_f</span>).<span class="ruby-identifier">ceil</span>
-93:         <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></small></p>
-</div>
-</body>
-</html>

data/doc/app/classes/Cms/Behaviors/Pagination/InvalidPage.html DELETED Viewed

@@ -1,146 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!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: Cms::Behaviors::Pagination::InvalidPage</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-  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: none }</style>" )
-  // ]]>
-  </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">Cms::Behaviors::Pagination::InvalidPage</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../../../files/lib/cms/behaviors/pagination_rb.html">
-                lib/cms/behaviors/pagination.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                ArgumentError
-            </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="#M000439">new</a>&nbsp;&nbsp;
-      </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-M000439" class="method-detail">
-        <a name="M000439"></a>
-        <div class="method-heading">
-          <a href="#M000439" class="method-signature">
-          <span class="method-name">new</span><span class="method-args">(page, page_num)</span>
-          </a>
-        </div>
-        <div class="method-description">
-          <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000439-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000439-source">
-<pre>
-    <span class="ruby-comment cmt"># File lib/cms/behaviors/pagination.rb, line 12</span>
-12:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">page</span>, <span class="ruby-identifier">page_num</span>)
-13:           <span class="ruby-keyword kw">super</span> <span class="ruby-node">&quot;#{page.inspect} given as value, which translates to '#{page_num}' as page number&quot;</span>
-14:         <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></small></p>
-</div>
-</body>
-</html>