mongrel 0.3.13.1 → 0.3.13.2

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

@@ -90,12 +90,12 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000091">inspect</a>&nbsp;&nbsp;
-      <a href="#M000092">new</a>&nbsp;&nbsp;
-      <a href="#M000093">register</a>&nbsp;&nbsp;
-      <a href="#M000095">resolve</a>&nbsp;&nbsp;
-      <a href="#M000094">unregister</a>&nbsp;&nbsp;
-      <a href="#M000090">uris</a>&nbsp;&nbsp;
+      <a href="#M000094">inspect</a>&nbsp;&nbsp;
+      <a href="#M000095">new</a>&nbsp;&nbsp;
+      <a href="#M000096">register</a>&nbsp;&nbsp;
+      <a href="#M000098">resolve</a>&nbsp;&nbsp;
+      <a href="#M000097">unregister</a>&nbsp;&nbsp;
+      <a href="#M000093">uris</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -130,12 +130,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000092" class="method-detail">
-        <a name="M000092"></a>
+      <div id="method-M000095" class="method-detail">
+        <a name="M000095"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000092.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000092.html');return false;">
+          <a href="URIClassifier.src/M000095.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000095.html');return false;">
           <span class="method-name">URIClassifier.new &rarr; URIClassifier<br />
 </span>
           </a>
@@ -162,12 +162,12 @@ portion.
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000091" class="method-detail">
-        <a name="M000091"></a>
+      <div id="method-M000094" class="method-detail">
+        <a name="M000094"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000091.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000091.html');return false;">
+          <a href="URIClassifier.src/M000094.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000094.html');return false;">
           <span class="method-name">inspect</span><span class="method-args">()</span>
           </a>
         </div>
@@ -179,12 +179,12 @@ Simply does an inspect that looks like a Hash inspect.
         </div>
       </div>
 
-      <div id="method-M000093" class="method-detail">
-        <a name="M000093"></a>
+      <div id="method-M000096" class="method-detail">
+        <a name="M000096"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000093.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000093.html');return false;">
+          <a href="URIClassifier.src/M000096.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000096.html');return false;">
           <span class="method-name">uc.register("/someuri", SampleHandler.new) &rarr; nil<br />
 </span>
           </a>
@@ -209,12 +209,12 @@ to get right with a Hash.
         </div>
       </div>
 
-      <div id="method-M000095" class="method-detail">
-        <a name="M000095"></a>
+      <div id="method-M000098" class="method-detail">
+        <a name="M000098"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000095.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000095.html');return false;">
+          <a href="URIClassifier.src/M000098.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000098.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 />
@@ -261,12 +261,12 @@ Don&#8216;t try other string-like stuff yet.
         </div>
       </div>
 
-      <div id="method-M000094" class="method-detail">
-        <a name="M000094"></a>
+      <div id="method-M000097" class="method-detail">
+        <a name="M000097"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000094.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000094.html');return false;">
+          <a href="URIClassifier.src/M000097.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000097.html');return false;">
           <span class="method-name">uc.unregister("/someuri")<br />
 </span>
           </a>
@@ -279,12 +279,12 @@ Yep, just removes this uri and it&#8217;s handler from the trie.
         </div>
       </div>
 
-      <div id="method-M000090" class="method-detail">
-        <a name="M000090"></a>
+      <div id="method-M000093" class="method-detail">
+        <a name="M000093"></a>
 
         <div class="method-heading">
-          <a href="URIClassifier.src/M000090.html" target="Code" class="method-signature"
-            onclick="popupCode('URIClassifier.src/M000090.html');return false;">
+          <a href="URIClassifier.src/M000093.html" target="Code" class="method-signature"
+            onclick="popupCode('URIClassifier.src/M000093.html');return false;">
           <span class="method-name">uris</span><span class="method-args">()</span>
           </a>
         </div>

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

@@ -5,47 +5,14 @@
 
 <html>
 <head>
-  <title>register (Mongrel::URIClassifier)</title>
+  <title>uris (Mongrel::URIClassifier)</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>/**
- * call-seq:
- *    uc.register(&quot;/someuri&quot;, SampleHandler.new) -&gt; nil
- *
- * Registers the SampleHandler (one for all requests) with the &quot;/someuri&quot;.
- * When URIClassifier::resolve is called with &quot;/someuri&quot; it'll return
- * SampleHandler immediately.  When called with &quot;/someuri/iwant&quot; it'll also
- * return SomeHandler immediatly, with no additional searches, but it will
- * return path info with &quot;/iwant&quot;.
- *
- * You actually can reuse this class to register nearly anything and 
- * quickly resolve it.  This could be used for caching, fast mapping, etc.
- * The downside is it uses much more memory than a Hash, but it can be
- * a lot faster.  It's main advantage is that it works on prefixes, which
- * is damn hard to get right with a Hash.
- */
-VALUE URIClassifier_register(VALUE self, VALUE uri, VALUE handler)
-{
-  int rc = 0;
-  void *ptr = NULL;
-  struct tst *tst = NULL;
-  DATA_GET(self, struct tst, tst);
-
-  rc = tst_insert((unsigned char *)StringValueCStr(uri), (void *)handler , tst, 0, &amp;ptr);
-
-  if(rc == TST_DUPLICATE_KEY) {
-    rb_raise(rb_eStandardError, &quot;Handler already registered with that name&quot;);
-  } else if(rc == TST_ERROR) {
-    rb_raise(rb_eStandardError, &quot;Memory error registering handler&quot;);
-  } else if(rc == TST_NULL_KEY) {
-    rb_raise(rb_eStandardError, &quot;URI was empty&quot;);
-  }
-  
-  rb_hash_aset(rb_ivar_get(self, id_handler_map), uri, handler);
-
-  return Qnil;
-}</pre>
+  <pre>    <span class="ruby-comment cmt"># File lib/mongrel.rb, line 52</span>
+52:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">uris</span>
+53:       <span class="ruby-ivar">@handler_map</span>.<span class="ruby-identifier">keys</span>
+54:     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

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

@@ -5,32 +5,14 @@
 
 <html>
 <head>
-  <title>unregister (Mongrel::URIClassifier)</title>
+  <title>inspect (Mongrel::URIClassifier)</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>/**
- * call-seq:
- *    uc.unregister(&quot;/someuri&quot;)
- *
- * Yep, just removes this uri and it's handler from the trie.
- */
-VALUE URIClassifier_unregister(VALUE self, VALUE uri)
-{
-  void *handler = NULL;
-  struct tst *tst = NULL;
-  DATA_GET(self, struct tst, tst);
-
-  handler = tst_delete((unsigned char *)StringValueCStr(uri), tst);
-
-  if(handler) {
-    rb_hash_delete(rb_ivar_get(self, id_handler_map), uri);
-
-    return (VALUE)handler;
-  } else {
-    return Qnil;
-  }
-}</pre>
+  <pre>    <span class="ruby-comment cmt"># File lib/mongrel.rb, line 57</span>
+57:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
+58:       <span class="ruby-ivar">@handler_map</span>.<span class="ruby-identifier">inspect</span>
+59:     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

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

@@ -5,79 +5,35 @@
 
 <html>
 <head>
-  <title>resolve (Mongrel::URIClassifier)</title>
+  <title>new (Mongrel::URIClassifier)</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>/**
  * call-seq:
- *    uc.resolve(&quot;/someuri&quot;) -&gt; &quot;/someuri&quot;, &quot;&quot;, handler
- *    uc.resolve(&quot;/someuri/pathinfo&quot;) -&gt; &quot;/someuri&quot;, &quot;/pathinfo&quot;, handler
- *    uc.resolve(&quot;/notfound/orhere&quot;) -&gt; nil, nil, nil
- *    uc.resolve(&quot;/&quot;) -&gt; &quot;/&quot;, &quot;/&quot;, handler  # if uc.register(&quot;/&quot;, handler)
- *    uc.resolve(&quot;/path/from/root&quot;) -&gt; &quot;/&quot;, &quot;/path/from/root&quot;, handler  # if uc.register(&quot;/&quot;, handler) 
- * 
- * 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't find a handler registered at the longest
- * match then it returns nil,nil,nil.
+ *    URIClassifier.new -&gt; URIClassifier
  *
- * Because the resolver uses a trie you are able to register a handler at *any* character
- * in the URI and it will be handled as long as it's the longest prefix.  So, if you 
- * registered handler #1 at &quot;/something/lik&quot;, and #2 at &quot;/something/like/that&quot;, then a
- * a search for &quot;/something/like&quot; would give you #1.  A search for &quot;/something/like/that/too&quot;
- * would give you #2.
- * 
- * This is very powerful since it means you can also attach handlers to parts of the ; 
- * (semi-colon) separated path params, any part of the path, use off chars, anything really.
- * It also means that it's very efficient to do this only taking as long as the URI has
- * characters.
+ * Initializes a new URIClassifier object that you can use to associate URI sequences
+ * with objects.  You can actually use it with any string sequence and any objects,
+ * but it's mostly used with URIs.
  *
- * A slight modification to the CGI 1.2 standard is given for handlers registered to &quot;/&quot;.
- * CGI expects all CGI scripts to be at some script path, so it doesn't really say anything
- * about a script that handles the root.  To make this work, the resolver will detect that
- * the requested handler is at &quot;/&quot;, and return that for script_name, and then simply return
- * the full URI back as path_info.
+ * It uses TST from http://www.octavian.org/cs/software.html to build an ternary search
+ * trie to hold all of the URIs.  It uses this to do an initial search for the a URI
+ * prefix, and then to break the URI into SCRIPT_NAME and PATH_INFO portions.  It actually
+ * will do two searches most of the time in order to find the right handler for the
+ * registered prefix portion.
  *
- * It expects strings with no embedded '\0' characters.  Don't try other string-like stuff yet.
  */
-VALUE URIClassifier_resolve(VALUE self, VALUE uri)
+VALUE URIClassifier_init(VALUE self)
 {
-  void *handler = NULL;
-  int pref_len = 0;
-  struct tst *tst = NULL;
-  VALUE result;
-  unsigned char *uri_str = NULL;
+  VALUE hash;
 
-  DATA_GET(self, struct tst, tst);
-  uri_str = (unsigned char *)StringValueCStr(uri);
+  // we create an internal hash to protect stuff from the GC
+  hash = rb_hash_new();
+  rb_ivar_set(self, id_handler_map, hash);
 
-  handler = tst_search(uri_str, tst, &amp;pref_len);
-
-  // setup for multiple return values
-  result = rb_ary_new();
-
-  if(handler) {
-    rb_ary_push(result, rb_str_substr (uri, 0, pref_len));
-    // compensate for a script_name=&quot;/&quot; where we need to add the &quot;/&quot; to path_info to keep it consistent
-    if(pref_len == 1 &amp;&amp; uri_str[0] == '/') {
-      // matches the root URI so we have to use the whole URI as the path_info
-      rb_ary_push(result, uri);
-    } else {
-      // matches a script so process like normal
-      rb_ary_push(result, rb_str_substr(uri, pref_len, RSTRING(uri)-&gt;len));
-    }
-      
-    rb_ary_push(result, (VALUE)handler);
-  } else {
-    // not found so push back nothing
-    rb_ary_push(result, Qnil);
-    rb_ary_push(result, Qnil);
-    rb_ary_push(result, Qnil);
-  }
-
-  return result;
+  return self;
 }</pre>
 </body>
 </html>

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

@@ -0,0 +1,51 @@
+<?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>register (Mongrel::URIClassifier)</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>/**
+ * call-seq:
+ *    uc.register(&quot;/someuri&quot;, SampleHandler.new) -&gt; nil
+ *
+ * Registers the SampleHandler (one for all requests) with the &quot;/someuri&quot;.
+ * When URIClassifier::resolve is called with &quot;/someuri&quot; it'll return
+ * SampleHandler immediately.  When called with &quot;/someuri/iwant&quot; it'll also
+ * return SomeHandler immediatly, with no additional searches, but it will
+ * return path info with &quot;/iwant&quot;.
+ *
+ * You actually can reuse this class to register nearly anything and 
+ * quickly resolve it.  This could be used for caching, fast mapping, etc.
+ * The downside is it uses much more memory than a Hash, but it can be
+ * a lot faster.  It's main advantage is that it works on prefixes, which
+ * is damn hard to get right with a Hash.
+ */
+VALUE URIClassifier_register(VALUE self, VALUE uri, VALUE handler)
+{
+  int rc = 0;
+  void *ptr = NULL;
+  struct tst *tst = NULL;
+  DATA_GET(self, struct tst, tst);
+
+  rc = tst_insert((unsigned char *)StringValueCStr(uri), (void *)handler , tst, 0, &amp;ptr);
+
+  if(rc == TST_DUPLICATE_KEY) {
+    rb_raise(rb_eStandardError, &quot;Handler already registered with that name&quot;);
+  } else if(rc == TST_ERROR) {
+    rb_raise(rb_eStandardError, &quot;Memory error registering handler&quot;);
+  } else if(rc == TST_NULL_KEY) {
+    rb_raise(rb_eStandardError, &quot;URI was empty&quot;);
+  }
+  
+  rb_hash_aset(rb_ivar_get(self, id_handler_map), uri, handler);
+
+  return Qnil;
+}</pre>
+</body>
+</html>

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

@@ -0,0 +1,36 @@
+<?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>unregister (Mongrel::URIClassifier)</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>/**
+ * call-seq:
+ *    uc.unregister(&quot;/someuri&quot;)
+ *
+ * Yep, just removes this uri and it's handler from the trie.
+ */
+VALUE URIClassifier_unregister(VALUE self, VALUE uri)
+{
+  void *handler = NULL;
+  struct tst *tst = NULL;
+  DATA_GET(self, struct tst, tst);
+
+  handler = tst_delete((unsigned char *)StringValueCStr(uri), tst);
+
+  if(handler) {
+    rb_hash_delete(rb_ivar_get(self, id_handler_map), uri);
+
+    return (VALUE)handler;
+  } else {
+    return Qnil;
+  }
+}</pre>
+</body>
+</html>

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

@@ -0,0 +1,83 @@
+<?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>resolve (Mongrel::URIClassifier)</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>/**
+ * call-seq:
+ *    uc.resolve(&quot;/someuri&quot;) -&gt; &quot;/someuri&quot;, &quot;&quot;, handler
+ *    uc.resolve(&quot;/someuri/pathinfo&quot;) -&gt; &quot;/someuri&quot;, &quot;/pathinfo&quot;, handler
+ *    uc.resolve(&quot;/notfound/orhere&quot;) -&gt; nil, nil, nil
+ *    uc.resolve(&quot;/&quot;) -&gt; &quot;/&quot;, &quot;/&quot;, handler  # if uc.register(&quot;/&quot;, handler)
+ *    uc.resolve(&quot;/path/from/root&quot;) -&gt; &quot;/&quot;, &quot;/path/from/root&quot;, handler  # if uc.register(&quot;/&quot;, handler) 
+ * 
+ * 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't find a handler registered at the longest
+ * match then it returns nil,nil,nil.
+ *
+ * Because the resolver uses a trie you are able to register a handler at *any* character
+ * in the URI and it will be handled as long as it's the longest prefix.  So, if you 
+ * registered handler #1 at &quot;/something/lik&quot;, and #2 at &quot;/something/like/that&quot;, then a
+ * a search for &quot;/something/like&quot; would give you #1.  A search for &quot;/something/like/that/too&quot;
+ * would give you #2.
+ * 
+ * This is very powerful since it means you can also attach handlers to parts of the ; 
+ * (semi-colon) separated path params, any part of the path, use off chars, anything really.
+ * It also means that it's very efficient to do this only taking as long as the URI has
+ * characters.
+ *
+ * A slight modification to the CGI 1.2 standard is given for handlers registered to &quot;/&quot;.
+ * CGI expects all CGI scripts to be at some script path, so it doesn't really say anything
+ * about a script that handles the root.  To make this work, the resolver will detect that
+ * the requested handler is at &quot;/&quot;, and return that for script_name, and then simply return
+ * the full URI back as path_info.
+ *
+ * It expects strings with no embedded '\0' characters.  Don't try other string-like stuff yet.
+ */
+VALUE URIClassifier_resolve(VALUE self, VALUE uri)
+{
+  void *handler = NULL;
+  int pref_len = 0;
+  struct tst *tst = NULL;
+  VALUE result;
+  unsigned char *uri_str = NULL;
+
+  DATA_GET(self, struct tst, tst);
+  uri_str = (unsigned char *)StringValueCStr(uri);
+
+  handler = tst_search(uri_str, tst, &amp;pref_len);
+
+  // setup for multiple return values
+  result = rb_ary_new();
+
+  if(handler) {
+    rb_ary_push(result, rb_str_substr (uri, 0, pref_len));
+    // compensate for a script_name=&quot;/&quot; where we need to add the &quot;/&quot; to path_info to keep it consistent
+    if(pref_len == 1 &amp;&amp; uri_str[0] == '/') {
+      // matches the root URI so we have to use the whole URI as the path_info
+      rb_ary_push(result, uri);
+    } else {
+      // matches a script so process like normal
+      rb_ary_push(result, rb_str_substr(uri, pref_len, RSTRING(uri)-&gt;len));
+    }
+      
+    rb_ary_push(result, (VALUE)handler);
+  } else {
+    // not found so push back nothing
+    rb_ary_push(result, Qnil);
+    rb_ary_push(result, Qnil);
+    rb_ary_push(result, Qnil);
+  }
+
+  return result;
+}</pre>
+</body>
+</html>