RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/doc/Webmachine/Decision/Conneg/PriorityList.html DELETED Viewed

@@ -1,788 +0,0 @@
-<!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 http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Webmachine::Decision::Conneg::PriorityList
-    &mdash; Documentation by YARD 0.7.3
-</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">
-  relpath = '../../..';
-  if (relpath != '') relpath += '/';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../../../_index.html">Index (P)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Decision.html" title="Webmachine::Decision (module)">Decision</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Conneg.html" title="Webmachine::Decision::Conneg (module)">Conneg</a></span></span>
-     &raquo;
-    <span class="title">PriorityList</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Webmachine::Decision::Conneg::PriorityList
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Webmachine::Decision::Conneg::PriorityList</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Includes:</dt>
-      <dd class="r2">Enumerable</dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/webmachine/decision/conneg.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    Content-negotiation priority list that takes into account both
-assigned priority (&quot;q&quot; value) as well as order, since items
-that come earlier in an acceptance list have higher priority
-by fiat.
-  </div>
-</div>
-<div class="tags">
-</div><div id="subclasses">
-  <h2>Direct Known Subclasses</h2>
-  <p class="children"><span class='object_link'><a href="MediaTypeList.html" title="Webmachine::Decision::Conneg::MediaTypeList (class)">MediaTypeList</a></span></p>
-</div>
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#build-class_method" title="build (class method)">+ (Object) <strong>build</strong>(list) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Given an acceptance list, create a PriorityList from them.</div></span>
-</li>
-    </ul>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#%5B%5D-instance_method" title="#[] (instance method)">- (Array&lt;String&gt;) <strong>[]</strong>(q) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The list of acceptable items at
-the given priority.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#add-instance_method" title="#add (instance method)">- (Object) <strong>add</strong>(q, choice) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Adds an acceptable item with the given priority to the list.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#add_header_val-instance_method" title="#add_header_val (instance method)">- (Object) <strong>add_header_val</strong>(c) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Given a raw acceptable value from an acceptance header,
-parse and add it to the list.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#each-instance_method" title="#each (instance method)">- (Object) <strong>each</strong> {|q, v| ... }</a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Iterates over the list in priority order, that is, taking
-into account the order in which items were added as well as
-their priorities.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (PriorityList) <strong>initialize</strong> </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>Creates a <span class='object_link'><a href="" title="Webmachine::Decision::Conneg::PriorityList (class)">PriorityList</a></span>.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#priority_of-instance_method" title="#priority_of (instance method)">- (Float) <strong>priority_of</strong>(choice) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>The priority of that value.</div></span>
-</li>
-    </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><span class='object_link'><a href="" title="Webmachine::Decision::Conneg::PriorityList (class)">PriorityList</a></span></tt>) <strong>initialize</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    Creates a <span class='object_link'><a href="" title="Webmachine::Decision::Conneg::PriorityList (class)">Webmachine::Decision::Conneg::PriorityList</a></span>.
-  </div>
-</div>
-<div class="tags">
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li>PriorityList::build</li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-166
-167
-168
-169</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 166</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span>
-  <span class='ivar'>@hash</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id new'>new</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id h'>h</span><span class='comma'>,</span><span class='id k'>k</span><span class='op'>|</span> <span class='id h'>h</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
-  <span class='ivar'>@index</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="build-class_method">
-    + (<tt>Object</tt>) <strong>build</strong>(list)
-</p><div class="docstring">
-  <div class="discussion">
-    Given an acceptance list, create a PriorityList from them.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-156
-157
-158
-159
-160</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 156</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id build'>build</span><span class='lparen'>(</span><span class='id list'>list</span><span class='rparen'>)</span>
-  <span class='id new'>new</span><span class='period'>.</span><span class='id tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id plist'>plist</span><span class='op'>|</span>
-    <span class='id list'>list</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id item'>item</span><span class='op'>|</span> <span class='id plist'>plist</span><span class='period'>.</span><span class='id add_header_val'>add_header_val</span><span class='lparen'>(</span><span class='id item'>item</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="[]-instance_method">
-    - (<tt>Array&lt;String&gt;</tt>) <strong>[]</strong>(q)
-</p><div class="docstring">
-  <div class="discussion">
-    The list of acceptable items at
-the given priority
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>q</span>
-        <span class='type'>(<tt>Float</tt>)</span>
-        &mdash;
-        <div class='inline'>the priority to lookup</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
-        &mdash;
-        <div class='inline'>the list of acceptable items at
-the given priority</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-196
-197
-198</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 196</span>
-<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id q'>q</span><span class='rparen'>)</span>
-  <span class='ivar'>@hash</span><span class='lbracket'>[</span><span class='id q'>q</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="add-instance_method">
-    - (<tt>Object</tt>) <strong>add</strong>(q, choice)
-</p><div class="docstring">
-  <div class="discussion">
-    Adds an acceptable item with the given priority to the list.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>q</span>
-        <span class='type'>(<tt>Float</tt>)</span>
-        &mdash;
-        <div class='inline'>the priority</div>
-    </li>
-    <li>
-        <span class='name'>choice</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the acceptable item</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-174
-175
-176
-177</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 174</span>
-<span class='kw'>def</span> <span class='id add'>add</span><span class='lparen'>(</span><span class='id q'>q</span><span class='comma'>,</span> <span class='id choice'>choice</span><span class='rparen'>)</span>
-  <span class='ivar'>@index</span><span class='lbracket'>[</span><span class='id choice'>choice</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id q'>q</span>
-  <span class='ivar'>@hash</span><span class='lbracket'>[</span><span class='id q'>q</span><span class='rbracket'>]</span> <span class='op'>&lt;&lt;</span> <span class='id choice'>choice</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="add_header_val-instance_method">
-    - (<tt>Object</tt>) <strong>add_header_val</strong>(c)
-</p><div class="docstring">
-  <div class="discussion">
-    Given a raw acceptable value from an acceptance header,
-parse and add it to the list.
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>c</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the raw acceptable item</div>
-    </li>
-</ul>
-  <h3>See Also:</h3>
-  <ul class="see">
-      <li><span class='object_link'><a href="#add-instance_method" title="Webmachine::Decision::Conneg::PriorityList#add (method)">#add</a></span></li>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-183
-184
-185
-186
-187
-188
-189
-190
-191</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 183</span>
-<span class='kw'>def</span> <span class='id add_header_val'>add_header_val</span><span class='lparen'>(</span><span class='id c'>c</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id c'>c</span> <span class='op'>=~</span> <span class='const'>CONNEG_REGEX</span>
-    <span class='id choice'>choice</span><span class='comma'>,</span> <span class='id q'>q</span> <span class='op'>=</span> <span class='backref'>$1</span><span class='comma'>,</span> <span class='backref'>$2</span>
-    <span class='id q'>q</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>&lt;&lt;</span> <span class='id q'>q</span> <span class='kw'>if</span> <span class='id q'>q</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\.</span><span class='regexp_end'>/</span></span> <span class='comment'># handle strange FeedBurner Accept
-</span>    <span class='id add'>add</span><span class='lparen'>(</span><span class='id q'>q</span><span class='period'>.</span><span class='id to_f'>to_f</span><span class='comma'>,</span><span class='id choice'>choice</span><span class='rparen'>)</span>
-  <span class='kw'>else</span>
-    <span class='id add'>add</span><span class='lparen'>(</span><span class='float'>1.0</span><span class='comma'>,</span> <span class='id c'>c</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="each-instance_method">
-    - (<tt>Object</tt>) <strong>each</strong> {|q, v| ... }
-</p><div class="docstring">
-  <div class="discussion">
-    Iterates over the list in priority order, that is, taking
-into account the order in which items were added as well as
-their priorities.
-  </div>
-</div>
-<div class="tags">
-<h3>Yields:</h3>
-<ul class="yield">
-    <li>
-        <span class='type'>(<tt>q</tt>, <tt>v</tt>)</span>
-    </li>
-</ul>
-<h3>Yield Parameters:</h3>
-<ul class="yieldparam">
-    <li>
-        <span class='name'>q</span>
-        <span class='type'>(<tt>Float</tt>)</span>
-        &mdash;
-        <div class='inline'>the acceptable item's priority</div>
-    </li>
-    <li>
-        <span class='name'>v</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the acceptable item</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-212
-213
-214
-215
-216</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 212</span>
-<span class='kw'>def</span> <span class='id each'>each</span>
-  <span class='ivar'>@hash</span><span class='period'>.</span><span class='id to_a'>to_a</span><span class='period'>.</span><span class='id sort'>sort</span><span class='period'>.</span><span class='id reverse_each'>reverse_each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id q'>q</span><span class='comma'>,</span><span class='id l'>l</span><span class='op'>|</span>
-    <span class='id l'>l</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id v'>v</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id q'>q</span><span class='comma'>,</span> <span class='id v'>v</span> <span class='rbrace'>}</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="priority_of-instance_method">
-    - (<tt>Float</tt>) <strong>priority_of</strong>(choice)
-</p><div class="docstring">
-  <div class="discussion">
-    The priority of that value
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>choice</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>the acceptable item</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Float</tt>)</span>
-        &mdash;
-        <div class='inline'>the priority of that value</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-202
-203
-204</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/decision/conneg.rb', line 202</span>
-<span class='kw'>def</span> <span class='id priority_of'>priority_of</span><span class='lparen'>(</span><span class='id choice'>choice</span><span class='rparen'>)</span>
-  <span class='ivar'>@index</span><span class='lbracket'>[</span><span class='id choice'>choice</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:41 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
-</div>
-  </body>
-</html>