RubyGems - mongrel - Versions diffs - 0.3 → 0.3.1 - Mend

mongrel 0.3 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

data/doc/rdoc/files/lib/mongrel_rb.html CHANGED

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Feb 10 00:03:40 EST 2006</td>
+      <td>Sun Feb 12 00:50:22 EST 2006</td>
     </tr>
     </table>
   </div>

data/doc/rdoc/files/lib/pluginfactory_rb.html ADDED

@@ -0,0 +1,132 @@
+<?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>File: pluginfactory.rb</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="fileHeader">
+    <h1>pluginfactory.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/pluginfactory.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Sat Feb 11 22:57:24 EST 2006</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+This module contains the <a
+href="../../classes/PluginFactory.html">PluginFactory</a> mixin. Including
+<a href="../../classes/PluginFactory.html">PluginFactory</a> in your class
+turns it into a factory for its derivatives, capable of searching for and
+loading them by name. This is useful when you have an abstract base class
+which defines an interface and basic functionality for a part of a larger
+system, and a collection of subclasses which implement the interface for
+different underlying functionality.
+</p>
+<p>
+An example of where this might be useful is in a program which talks to a
+database. To avoid coupling it to a specific database, you use a Driver
+class which encapsulates your program&#8217;s interaction with the database
+behind a useful interface. Now you can create a concrete implementation of
+the Driver class for each kind of database you wish to talk to. If you make
+the base Driver class a <a
+href="../../classes/PluginFactory.html">PluginFactory</a>, too, you can add
+new drivers simply by dropping them in a directory and using the
+Driver&#8217;s <tt>create</tt> method to instantiate them:
+</p>
+<h2>Creation Argument Variants</h2>
+<p>
+The <tt>create</tt> class method added to your class by <a
+href="../../classes/PluginFactory.html">PluginFactory</a> searches for your
+module using
+</p>
+<h2>Synopsis</h2>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </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/fr_class_index.html CHANGED

@@ -20,6 +20,7 @@
 <div id="index">
   <h1 class="section-bar">Classes</h1>
   <div id="index-entries">
+    <a href="classes/FactoryError.html">FactoryError</a><br />
     <a href="classes/Mongrel.html">Mongrel</a><br />
     <a href="classes/Mongrel/Const.html">Mongrel::Const</a><br />
     <a href="classes/Mongrel/DirHandler.html">Mongrel::DirHandler</a><br />
@@ -31,6 +32,7 @@
     <a href="classes/Mongrel/HttpResponse.html">Mongrel::HttpResponse</a><br />
     <a href="classes/Mongrel/HttpServer.html">Mongrel::HttpServer</a><br />
     <a href="classes/Mongrel/URIClassifier.html">Mongrel::URIClassifier</a><br />
+    <a href="classes/PluginFactory.html">PluginFactory</a><br />
   </div>
 </div>
 </body>

data/doc/rdoc/fr_file_index.html CHANGED

@@ -25,6 +25,7 @@
     <a href="files/README.html">README</a><br />
     <a href="files/ext/http11/http11_c.html">ext/http11/http11.c</a><br />
     <a href="files/lib/mongrel_rb.html">lib/mongrel.rb</a><br />
+    <a href="files/lib/pluginfactory_rb.html">lib/pluginfactory.rb</a><br />
   </div>
 </div>
 </body>

data/doc/rdoc/fr_method_index.html CHANGED

@@ -20,41 +20,55 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/Mongrel/HeaderOut.html#M000020">[]= (Mongrel::HeaderOut)</a><br />
-    <a href="classes/Mongrel.html#M000001">add_mime_type (Mongrel)</a><br />
-    <a href="classes/Mongrel/DirHandler.html#M000010">can_serve (Mongrel::DirHandler)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000006">error? (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000005">execute (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000004">finish (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000032">finished (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000007">finished? (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/URIClassifier.html#M000021">new (Mongrel::URIClassifier)</a><br />
-    <a href="classes/Mongrel/Error404Handler.html#M000033">new (Mongrel::Error404Handler)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000026">new (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/DirHandler.html#M000009">new (Mongrel::DirHandler)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000002">new (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpServer.html#M000014">new (Mongrel::HttpServer)</a><br />
-    <a href="classes/Mongrel/HeaderOut.html#M000019">new (Mongrel::HeaderOut)</a><br />
-    <a href="classes/Mongrel/HttpRequest.html#M000035">new (Mongrel::HttpRequest)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000008">nread (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpHandler.html#M000025">process (Mongrel::HttpHandler)</a><br />
-    <a href="classes/Mongrel/Error404Handler.html#M000034">process (Mongrel::Error404Handler)</a><br />
-    <a href="classes/Mongrel/DirHandler.html#M000013">process (Mongrel::DirHandler)</a><br />
-    <a href="classes/Mongrel/HttpServer.html#M000015">process_client (Mongrel::HttpServer)</a><br />
-    <a href="classes/Mongrel/URIClassifier.html#M000022">register (Mongrel::URIClassifier)</a><br />
-    <a href="classes/Mongrel/HttpServer.html#M000017">register (Mongrel::HttpServer)</a><br />
-    <a href="classes/Mongrel/HttpParser.html#M000003">reset (Mongrel::HttpParser)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000028">reset (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/URIClassifier.html#M000024">resolve (Mongrel::URIClassifier)</a><br />
-    <a href="classes/Mongrel/HttpServer.html#M000016">run (Mongrel::HttpServer)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000031">send_body (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/DirHandler.html#M000011">send_dir_listing (Mongrel::DirHandler)</a><br />
-    <a href="classes/Mongrel/DirHandler.html#M000012">send_file (Mongrel::DirHandler)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000030">send_header (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000029">send_status (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/HttpResponse.html#M000027">start (Mongrel::HttpResponse)</a><br />
-    <a href="classes/Mongrel/URIClassifier.html#M000023">unregister (Mongrel::URIClassifier)</a><br />
-    <a href="classes/Mongrel/HttpServer.html#M000018">unregister (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/HeaderOut.html#M000034">[]= (Mongrel::HeaderOut)</a><br />
+    <a href="classes/Mongrel.html#M000015">add_mime_type (Mongrel)</a><br />
+    <a href="classes/Mongrel/DirHandler.html#M000024">can_serve (Mongrel::DirHandler)</a><br />
+    <a href="classes/PluginFactory.html#M000009">create (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000008">derivativeClasses (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000005">derivatives (PluginFactory)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000020">error? (Mongrel::HttpParser)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000019">execute (Mongrel::HttpParser)</a><br />
+    <a href="classes/PluginFactory.html#M000004">extend_object (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000006">factoryType (PluginFactory)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000018">finish (Mongrel::HttpParser)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000046">finished (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000021">finished? (Mongrel::HttpParser)</a><br />
+    <a href="classes/PluginFactory.html#M000012">getModuleName (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000010">getSubclass (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000003">included (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000007">inherited (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000011">loadDerivative (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000002">log (PluginFactory)</a><br />
+    <a href="classes/PluginFactory.html#M000014">makeRequirePath (PluginFactory)</a><br />
+    <a href="classes/FactoryError.html#M000001">new (FactoryError)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000040">new (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/DirHandler.html#M000023">new (Mongrel::DirHandler)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000016">new (Mongrel::HttpParser)</a><br />
+    <a href="classes/Mongrel/HeaderOut.html#M000033">new (Mongrel::HeaderOut)</a><br />
+    <a href="classes/Mongrel/URIClassifier.html#M000035">new (Mongrel::URIClassifier)</a><br />
+    <a href="classes/Mongrel/Error404Handler.html#M000047">new (Mongrel::Error404Handler)</a><br />
+    <a href="classes/Mongrel/HttpServer.html#M000028">new (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/HttpRequest.html#M000049">new (Mongrel::HttpRequest)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000022">nread (Mongrel::HttpParser)</a><br />
+    <a href="classes/Mongrel/Error404Handler.html#M000048">process (Mongrel::Error404Handler)</a><br />
+    <a href="classes/Mongrel/HttpHandler.html#M000039">process (Mongrel::HttpHandler)</a><br />
+    <a href="classes/Mongrel/DirHandler.html#M000027">process (Mongrel::DirHandler)</a><br />
+    <a href="classes/Mongrel/HttpServer.html#M000029">process_client (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/HttpServer.html#M000031">register (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/URIClassifier.html#M000036">register (Mongrel::URIClassifier)</a><br />
+    <a href="classes/PluginFactory.html#M000013">requireDerivative (PluginFactory)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000042">reset (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/HttpParser.html#M000017">reset (Mongrel::HttpParser)</a><br />
+    <a href="classes/Mongrel/URIClassifier.html#M000038">resolve (Mongrel::URIClassifier)</a><br />
+    <a href="classes/Mongrel/HttpServer.html#M000030">run (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000045">send_body (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/DirHandler.html#M000025">send_dir_listing (Mongrel::DirHandler)</a><br />
+    <a href="classes/Mongrel/DirHandler.html#M000026">send_file (Mongrel::DirHandler)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000044">send_header (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000043">send_status (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/HttpResponse.html#M000041">start (Mongrel::HttpResponse)</a><br />
+    <a href="classes/Mongrel/HttpServer.html#M000032">unregister (Mongrel::HttpServer)</a><br />
+    <a href="classes/Mongrel/URIClassifier.html#M000037">unregister (Mongrel::URIClassifier)</a><br />
   </div>
 </div>
 </body>

data/examples/simpletest.rb CHANGED

@@ -1,13 +1,20 @@
 require 'mongrel'
 require 'yaml'
+require 'zlib'
 class SimpleHandler < Mongrel::HttpHandler
     def process(request, response)
       response.start do |head,out|
         head["Content-Type"] = "text/html"
-        out << "<html><body>Your request:<br />"
-        out << "<pre>#{request.params.to_yaml}</pre>"
-        out << "<a href=\"/files\">View the files.</a></body></html>"
+        results = "<html><body>Your request:<br /><pre>#{request.params.to_yaml}</pre><a href=\"/files\">View the files.</a></body></html>"
+        if not request.params["HTTP_ACCEPT_ENCODING"] == "gzip,deflate"
+          head["Content-Encoding"] = "deflate"
+          # send it back deflated
+          out << Zlib::Deflate.deflate(results)
+        else
+          # no gzip supported, send it back normal
+          out << results
+        end
       end
     end
 end

data/lib/mongrel.rb CHANGED

@@ -229,7 +229,7 @@ module Mongrel
     # the socket in the proper order.  This lets you intermix header and
     # body content as needed.
     def start(status=200)
-      @status = status
+      @status = status.to_i
       yield @header, @body
       finished
     end
@@ -242,7 +242,7 @@ module Mongrel
     end
     def send_status
-      @socket.write("HTTP/1.1 #{@status} #{HTTP_STATUS_CODES[@status]}\r\nContent-Length: #{@body.length}\r\nConnection: close\r\n")
+      @socket.write("HTTP/1.1 #{@status.to_i} #{HTTP_STATUS_CODES[@status.to_i]}\r\nContent-Length:#{body.length}\r\nConnection: close\r\n")
     end
     def send_header
@@ -256,7 +256,7 @@ module Mongrel
       # connection: close is also added to ensure that the client does not pipeline.
       @socket.write(@body.read)
-    end
+    end
     # This takes whatever has been done to header and body and then writes it in the
     # proper format to make an HTTP/1.1 response.
@@ -489,6 +489,9 @@ module Mongrel
           # it's a file and it's there
           return req
         end
+      else
+        # does not exist or isn't in the right spot
+        return nil
       end
     end

data/lib/mongrel/command.rb ADDED

@@ -0,0 +1,192 @@
+require 'singleton'
+require 'optparse'
+require 'pluginfactory'
+module Mongrel
+  # Contains all of the various commands that are used with
+  # Mongrel servers.
+  module Command
+    # A Command pattern implementation used to create the set of command available to the user
+    # from Mongrel.  The script uses objects which implement this interface to do the
+    # user's bidding.
+    #
+    # Creating a new command is very easy, and you can do it without modifying the source
+    # of Mongrel thanks to PluginFactory.  What you do is the following:
+    #
+    # 1.
+    class Command
+      include PluginFactory
+      attr_reader :valid, :done_validating
+      # Called by the implemented command to set the options for that command.
+      # Every option has a short and long version, a description, a variable to
+      # set, and a default value.  No exceptions.
+      def options(opts)
+        # process the given options array
+        opts.each do |short, long, help, variable, default|
+          self.instance_variable_set(variable, default)
+          @opt.on(short, long, help) do |arg|
+            self.instance_variable_set(variable, arg)
+          end
+        end
+      end
+      # Called by the subclass to setup the command and parse the argv arguments.
+      # The call is destructive on argv since it uses the OptionParser#parse! function.
+      def initialize(argv)
+        @opt = OptionParser.new
+        @valid = true
+        # this is retarded, but it has to be done this way because -h and -v exit
+        @done_validating = false
+        configure
+        # I need to add my own -h definition to prevent the -h by default from exiting.
+        @opt.on_tail("-h", "--help", "Show this message") do
+          @done_validating = true
+          puts @opt
+        end
+        # I need to add my own -v definition to prevent the -h from exiting by default as well.
+        @opt.on_tail("--version", "Show version") do
+          @done_validating = true
+          if VERSION
+            puts "Version #{VERSION}"
+          end
+        end
+        @opt.parse! argv
+      end
+      # Tells the PluginFactory where to look for additional commands.  By default
+      # it's just a "plugins" directory wherever we are located.
+      def self.derivativeDirs
+        return ["plugins"]
+      end
+      # Returns true/false depending on whether the command is configured properly.
+      def validate
+        return @valid
+      end
+      # Returns a help message.  Defaults to OptionParser#help which should be good.
+      def help
+        @opt.help
+      end
+      # Runs the command doing it's job.  You should implement this otherwise it will
+      # throw a NotImplementedError as a reminder.
+      def run
+        raise NotImplementedError
+      end
+      # Validates the given expression is true and prints the message if not, exiting.
+      def valid?(exp, message)
+        if not @done_validating and (not exp)
+          failure message
+          @valid = false
+          @done_validating = true
+        end
+      end
+      # Validates that a file exists and if not displays the message
+      def valid_exists?(file, message)
+        valid?(file != nil && File.exist?(file), message)
+      end
+      # Validates that the file is a file and not a directory or something else.
+      def valid_file?(file, message)
+        valid?(file != nil && File.file?(file), message)
+      end
+      # Validates that the given directory exists
+      def valid_dir?(file, message)
+        valid?(file != nil && File.directory?(file), message)
+      end
+      # Just a simple method to display failure until something better is developed.
+      def failure(message)
+        STDERR.puts "!!! #{message}"
+      end
+    end
+    # A Singleton class that manages all of the available commands
+    # and handles running them.
+    class Registry
+      include Singleton
+      # Builds a list of possible commands from the Command derivates list
+      def commands
+        list = Command.derivatives()
+        match = Regexp.new("(.*::.*)|(.*command.*)", Regexp::IGNORECASE)
+        results = []
+        list.keys.each do |key|
+          results << key.to_s unless match.match(key.to_s)
+        end
+        return results.sort
+      end
+      # Prints a list of available commands.
+      def print_command_list
+        puts "Available commands are:\n\n"
+        self.commands.each do |name|
+          puts " - #{name}\n"
+        end
+        puts "\nEach command takes -h as an option to get help."
+      end
+      # Runs the args against the first argument as the command name.
+      # If it has any errors it returns a false, otherwise it return true.
+      def run(args)
+        # find the command and change the program's name to reflect it
+        cmd_name = args.shift
+        $0 = "#{cmd_name}"
+        if cmd_name == "?" or cmd_name == "help"
+          print_command_list
+          return true
+        end
+        # command exists, set it up and validate it
+        begin
+          command = Command.create(cmd_name, args)
+        rescue FactoryError
+          STDERR.puts "INVALID COMMAND: #$!"
+          print_command_list
+          return
+        end
+        # Normally the command is NOT valid right after being created
+        # but sometimes (like with -h or -v) there's no further processing
+        # needed so the command is already valid so we can skip it.
+        if not command.done_validating
+          if not command.validate
+            STDERR.puts "#{cmd_name} reported an error. Use -h to get help."
+            return false
+          else
+            command.run
+          end
+        end
+        return true
+      end
+    end
+  end
+end