mongrel 0.3.8 → 0.3.9

data/doc/rdoc/classes/Mongrel/URIClassifier.html

@@ -90,12 +90,12 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000024">inspect</a>&nbsp;&nbsp;
-      <a href="#M000025">new</a>&nbsp;&nbsp;
-      <a href="#M000026">register</a>&nbsp;&nbsp;
-      <a href="#M000028">resolve</a>&nbsp;&nbsp;
-      <a href="#M000027">unregister</a>&nbsp;&nbsp;
-      <a href="#M000023">uris</a>&nbsp;&nbsp;
+      <a href="#M000046">inspect</a>&nbsp;&nbsp;
+      <a href="#M000047">new</a>&nbsp;&nbsp;
+      <a href="#M000048">register</a>&nbsp;&nbsp;
+      <a href="#M000050">resolve</a>&nbsp;&nbsp;
+      <a href="#M000049">unregister</a>&nbsp;&nbsp;
+      <a href="#M000045">uris</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -117,12 +117,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000025" class="method-detail">
-        <a name="M000025"></a>
+      <div id="method-M000047" class="method-detail">
+        <a name="M000047"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000025.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000025.html');return false;">
+          <a href="URIClassifier.src/M000047.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000047.html');return false;">
           <span class="method-name">URIClassifier.new &rarr; URIClassifier<br />
 </span>
           </a>
@@ -149,12 +149,12 @@ portion.
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000024" class="method-detail">
-        <a name="M000024"></a>
+      <div id="method-M000046" class="method-detail">
+        <a name="M000046"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000024.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000024.html');return false;">
+          <a href="URIClassifier.src/M000046.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000046.html');return false;">
           <span class="method-name">inspect</span><span class="method-args">()</span>
           </a>
         </div>
@@ -166,12 +166,12 @@ Simply does an inspect that looks like a Hash inspect.
         </div>
       </div>
 
-      <div id="method-M000026" class="method-detail">
-        <a name="M000026"></a>
+      <div id="method-M000048" class="method-detail">
+        <a name="M000048"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000026.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000026.html');return false;">
+          <a href="URIClassifier.src/M000048.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000048.html');return false;">
           <span class="method-name">uc.register("/someuri", SampleHandler.new) &rarr; nil<br />
 </span>
           </a>
@@ -196,12 +196,12 @@ to get right with a Hash.
         </div>
       </div>
 
-      <div id="method-M000028" class="method-detail">
-        <a name="M000028"></a>
+      <div id="method-M000050" class="method-detail">
+        <a name="M000050"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000028.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000028.html');return false;">
+          <a href="URIClassifier.src/M000050.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000050.html');return false;">
           <span class="method-name">uc.resolve("/someuri") &rarr; "/someuri", "", handler<br />
 uc.resolve("/someuri/pathinfo") &rarr; "/someuri", "/pathinfo", handler<br />
 uc.resolve("/notfound/orhere") &rarr; nil, nil, nil<br />
@@ -215,8 +215,9 @@ uc.resolve("/path/from/root") &rarr; "/", "/path/from/root", handler  # if uc.re
           <p>
 Attempts to resolve either the whole URI or at the longest prefix,
 returning the prefix (as script_info), path (as path_info), and registered
-handler (usually an HttpHandler). If it doesn&#8217;t find a handler
-registered at the longest match then it returns nil,nil,nil.
+handler (usually an <a href="HttpHandler.html">HttpHandler</a>). If it
+doesn&#8217;t find a handler registered at the longest match then it
+returns nil,nil,nil.
 </p>
 <p>
 Because the resolver uses a trie you are able to register a handler at
@@ -247,12 +248,12 @@ Don&#8216;t try other string-like stuff yet.
         </div>
       </div>
 
-      <div id="method-M000027" class="method-detail">
-        <a name="M000027"></a>
+      <div id="method-M000049" class="method-detail">
+        <a name="M000049"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000027.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000027.html');return false;">
+          <a href="URIClassifier.src/M000049.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000049.html');return false;">
           <span class="method-name">uc.unregister("/someuri")<br />
 </span>
           </a>
@@ -265,12 +266,12 @@ Yep, just removes this uri and it&#8217;s handler from the trie.
         </div>
       </div>
 
-      <div id="method-M000023" class="method-detail">
-        <a name="M000023"></a>
+      <div id="method-M000045" class="method-detail">
+        <a name="M000045"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000023.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000023.html');return false;">
+          <a href="URIClassifier.src/M000045.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000045.html');return false;">
           <span class="method-name">uris</span><span class="method-args">()</span>
           </a>
         </div>

data/doc/rdoc/classes/RailsHandler.html

@@ -0,0 +1,225 @@
+<?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: RailsHandler</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="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">RailsHandler</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/mongrel/rails_rb.html">
+                lib/mongrel/rails.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Mongrel/HttpHandler.html">
+                Mongrel::HttpHandler
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Implements a handler that can run Rails and serve files out of the Rails
+application&#8217;s public directory. This lets you run your Rails
+application with <a href="Mongrel.html">Mongrel</a> during development and
+testing, then use it also in production behind a server that&#8217;s better
+at serving the static files.
+</p>
+<p>
+The <a href="RailsHandler.html">RailsHandler</a> takes a mime_map parameter
+which is a simple suffix=mimetype mapping that it should add to the list of
+valid mime types.
+</p>
+<p>
+It also supports page caching directly and will try to resolve a request in
+the following order:
+</p>
+<ul>
+<li>If the requested exact PATH_INFO exists as a file then serve it.
+
+</li>
+<li>If it exists at PATH_INFO+&quot;.html&quot; exists then serve that.
+
+</li>
+<li>Finally, construct a <a
+href="Mongrel/CGIWrapper.html">Mongrel::CGIWrapper</a> and run
+Dispatcher.dispath to have Rails go.
+
+</li>
+</ul>
+<p>
+This means that if you are using page caching it will actually work with <a
+href="Mongrel.html">Mongrel</a> and you should see a decent speed boost
+(but not as fast as if you use lighttpd).
+</p>
+<p>
+An additional feature you can use is
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">new</a>&nbsp;&nbsp;
+      <a href="#M000002">process</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">files</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-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="RailsHandler.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('RailsHandler.src/M000001.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(dir, mime_map = {})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <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="RailsHandler.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('RailsHandler.src/M000002.html');return false;">
+          <span class="method-name">process</span><span class="method-args">(request, response)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Attempts to resolve the request as follows:
+</p>
+<ul>
+<li>If the requested exact PATH_INFO exists as a file then serve it.
+
+</li>
+<li>If it exists at PATH_INFO+&quot;.html&quot; exists then serve that.
+
+</li>
+<li>Finally, construct a <a
+href="Mongrel/CGIWrapper.html">Mongrel::CGIWrapper</a> and run
+Dispatcher.dispath to have Rails go.
+
+</li>
+</ul>
+        </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/rdoc/classes/RailsHandler.src/M000001.html

@@ -0,0 +1,22 @@
+<?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>
+<head>
+  <title>new (RailsHandler)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/mongrel/rails.rb, line 27</span>
+27:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">dir</span>, <span class="ruby-identifier">mime_map</span> = {})
+28:     <span class="ruby-ivar">@files</span> = <span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">DirHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dir</span>,<span class="ruby-keyword kw">false</span>)
+29:     <span class="ruby-ivar">@guard</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
+30:     
+31:     <span class="ruby-comment cmt"># register the requested mime types</span>
+32:     <span class="ruby-identifier">mime_map</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">DirHandler</span><span class="ruby-operator">::</span><span class="ruby-identifier">add_mime_type</span>(<span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span>) }
+33:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/RailsHandler.src/M000002.html

@@ -0,0 +1,48 @@
+<?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>
+<head>
+  <title>process (RailsHandler)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre>    <span class="ruby-comment cmt"># File lib/mongrel/rails.rb, line 41</span>
+41:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">process</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">response</span>)
+42:     <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">socket</span>.<span class="ruby-identifier">closed?</span>
+43: 
+44:     <span class="ruby-identifier">path_info</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">params</span>[<span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">Const</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_INFO</span>]
+45:     <span class="ruby-identifier">page_cached</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">params</span>[<span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">Const</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_INFO</span>] <span class="ruby-operator">+</span> <span class="ruby-value str">&quot;.html&quot;</span>
+46: 
+47:     <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">can_serve</span>(<span class="ruby-identifier">path_info</span>)
+48:       <span class="ruby-comment cmt"># File exists as-is so serve it up</span>
+49:       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">process</span>(<span class="ruby-identifier">request</span>,<span class="ruby-identifier">response</span>)
+50:     <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">can_serve</span>(<span class="ruby-identifier">page_cached</span>)
+51:       <span class="ruby-comment cmt"># possible cached page, serve it up      </span>
+52:       <span class="ruby-identifier">request</span>.<span class="ruby-identifier">params</span>[<span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">Const</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_INFO</span>] = <span class="ruby-identifier">page_cached</span>
+53:       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">process</span>(<span class="ruby-identifier">request</span>,<span class="ruby-identifier">response</span>)
+54:     <span class="ruby-keyword kw">else</span>
+55:       <span class="ruby-identifier">cgi</span> = <span class="ruby-constant">Mongrel</span><span class="ruby-operator">::</span><span class="ruby-constant">CGIWrapper</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">request</span>, <span class="ruby-identifier">response</span>)
+56:       <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">handler</span> = <span class="ruby-keyword kw">self</span>
+57: 
+58:       <span class="ruby-keyword kw">begin</span>
+59:         <span class="ruby-ivar">@guard</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
+60:           <span class="ruby-comment cmt"># Rails is not thread safe so must be run entirely within synchronize </span>
+61:           <span class="ruby-constant">Dispatcher</span>.<span class="ruby-identifier">dispatch</span>(<span class="ruby-identifier">cgi</span>, <span class="ruby-constant">ActionController</span><span class="ruby-operator">::</span><span class="ruby-constant">CgiRequest</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_SESSION_OPTIONS</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>)
+62:         <span class="ruby-keyword kw">end</span>
+63: 
+64:         <span class="ruby-comment cmt"># This finalizes the output using the proper HttpResponse way</span>
+65:         <span class="ruby-identifier">cgi</span>.<span class="ruby-identifier">out</span> {<span class="ruby-value str">&quot;&quot;</span>}
+66:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
+67:         <span class="ruby-comment cmt"># ignored</span>
+68:       <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Object</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">rails_error</span>
+69:         <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Error calling Dispatcher.dispatch #{rails_error.inspect}&quot;</span>
+70:         <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">rails_error</span>.<span class="ruby-identifier">backtrace</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
+71:       <span class="ruby-keyword kw">end</span>
+72:     <span class="ruby-keyword kw">end</span>
+73:   <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>