mongrel 0.3 → 0.3.1

data/README

@@ -11,30 +11,31 @@ scream without too many portability issues.
 
 == Status
 
-The 0.3 release is the first official release to start supporting Ruby on Rails
-and to have a more complete DirHandler for serving directories of files.   This release
-is actually closer to a full functioning web server than the previous releases.
+The 0.3.1 release support Ruby On Rails much better than previously, and also
+sports the beginning of a command and plugin infrastructure.  This last part
+isn't documented yet.
 
-The Rails support is pretty rough right now, but check out the bin/mongrel_rails file,
-which should be installed into your PATH if you use a gem.  You should be able to
-do the following to run your Rails applications:
+After you've installed (either with gem install mongrel or via source) you should
+have the mongrel_rails command available in your PATH.  Then you just do the following:
 
-  > cd myrailsapp
-  > mongrel_rails 0.0.0.0 3000
+ > cd myrailsapp
+ > mongrel_rails start
 
-And then hit http://localhost:3000/ to see your app.  One thing is that if you have
-a public/index.html file then you'll get that served instead of your Rails application.
+This will start it in the foreground so you can play with it.  It runs your application
+in production mode.  To get help do:
 
-People with the daemons gem installed will see that mongrel_rails will go into the
-background.  You can kill it with:
+ > mongrel_rails start -h 
 
-  > kill -TERM `cat log/mongrel-3000.pid`
+Finally, you can then start in background mode (probably won't work in win32):
 
-Where "3000" is whatever port you told it to listen on when you ran it.
+ > mongrel_rails start -d
 
-The file serving is still a little rough and the redirects might not work well, but
-try it out and tell me about any weird errors.  File uploads will definitely have some
-problems.
+And you can stop it whenever you like with:
+
+ > mongrel_rails stop
+
+All of which should be done from your application's directory.  It writes the
+PID of the process you ran into log/mongrel.pid.
 
 
 == Install
@@ -82,16 +83,13 @@ type mapping is missing though.*
 
 == Speed
 
-The 0.2.1 release probably consists of the most effort I've ever put into 
-tuning a Ruby library for speed.  It consists of nearly everything I could think
-of to make Mongrel the fastest Ruby HTTP library possible.  I've tried about 
-seven different architectures and IO processing methods and none of them 
-make it any faster.  In short:  Mongrel is amazingly fast considering Ruby's speed
-limitations.
+Like previous releases 0.3.1 continues the trend of making things
+as fast as possible.  It currently might be a little slower than
+other releases but should hold up pretty good against at least 
+WEBrick (especially when running Rails).
 
-This release also brings in controllable threads that you can scale to meet your
-needs to do your processing.  Simple pass in the HttpServer.new third optional
-parameter:
+As before you can control the number of processor threads (and thus
+ActiveRecord database connections) with:
 
  h = Mongrel::HttpServer.new("0.0.0.0", "3000", 40)
 
@@ -101,8 +99,6 @@ limited processors also means that you can use ActiveRecord as-is and it will
 create a matching database connection for each processor thread.  More on 
 this in future releases.
 
-With this release I'm hoping that I've created a nice solid fast as hell core
-upon which I can build the remaining features I want in Mongrel.
 
 == The Future
 

data/Rakefile

@@ -8,7 +8,7 @@ require 'fileutils'
 include FileUtils
 
 setup_tests
-setup_clean ["ext/http11/Makefile", "pkg", "lib/*.bundle", "ext/http11/*.bundle"]
+setup_clean ["ext/http11/Makefile", "pkg", "lib/*.bundle", "ext/http11/*.bundle", "doc/site/output"]
 setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/*.rb', 'doc/**/*.rdoc', 'ext/http11/http11.c']
 
 desc "Does a full compile, test run"
@@ -19,11 +19,18 @@ task :compile => [:http11]
 task :package => [:clean]
 
 task :ragel do
-	sh %{/usr/local/bin/ragel ext/http11/http11_parser.rl | /usr/local/bin/rlcodegen -G2 -o ext/http11/http11_parser.c}
+  sh %{/usr/local/bin/ragel ext/http11/http11_parser.rl | /usr/local/bin/rlcodegen -G2 -o ext/http11/http11_parser.c}
+end
+
+task :site do
+  sh %{pushd doc/site; webgen; scp -r output/* #{ENV['SSH_USER']}@rubyforge.org:/var/www/gforge-projects/mongrel/; popd }
+  sh %{ scp -r doc/rdoc/* #{ENV['SSH_USER']}@rubyforge.org:/var/www/gforge-projects/mongrel/rdoc/ }
 end
 
 setup_extension("http11", "http11")
 
-summary = "An experimental fast simple web server for Ruby."
+summary = "A small fast HTTP library and server that runs Rails, Camping, and Nitro apps."
 test_file = "test/test_ws.rb"
-setup_gem("mongrel", "0.3",  "Zed A. Shaw", summary, ['mongrel_rails'], test_file)
+setup_gem("mongrel", "0.3.1",  "Zed A. Shaw", summary, ['mongrel_rails'], test_file) do |spec|
+  spec.add_dependency('daemons', '>= 0.4.2')
+end

data/bin/mongrel_rails

@@ -1,12 +1,8 @@
 require 'rubygems'
 require 'mongrel'
 require 'cgi'
-begin
-  require 'daemons/daemonize'
-  HAVE_DAEMONS=true
-rescue
-  HAVE_DAEMONS=false
-end
+require 'daemons/daemonize'
+require 'mongrel/command'
 
 
 class CGIFixed < ::CGI
@@ -87,28 +83,89 @@ class RailsHandler < Mongrel::HttpHandler
 end
 
 
-if ARGV.length != 2
-  STDERR.puts "usage:  mongrel_rails <host> <port>"
-  exit(1)
-end
 
-# store this for later since Daemonize insists on going to the / root
-cwd = Dir.pwd
+class StartCommand < Mongrel::Command::Command
+
+  def configure
+    options [
+      ["-e", "--environment ENV", "Rails environment to run as", :@environment, "production"],
+      ["-d", "--daemonize", "Whether to run in the background or not", :@daemon, false],
+      ['-p', '--port PORT', "Which port to bind to", :@port, 3000],
+      ['-a', '--address ADDR', "Address to bind to", :@address, "0.0.0.0"],
+      ['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
+      ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"]
+    ]
+  end
+  
+  def validate
+    valid? ["production","development"].include?(@environment), "Only valid environments are 'production' or 'development'"
+    valid_dir? File.dirname(@log_file), "Path to log file not valid: #@log_file"
+    valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
+    
+    return @valid
+  end
 
-if HAVE_DAEMONS
-  STDERR.puts "Running Mongrel in the background.  See log/mongrel.log for errors."
-  Daemonize.daemonize(log_file=File.join(cwd,"log","mongrel.log"))
-else
-  STDERR.puts "Unable to daemonize.  Running in foreground.  Use CTRL-C to stop."
+  
+  def run
+    cwd = Dir.pwd
+
+    if @daemon
+      puts "Running as Daemon at #@address:#@port"
+      Daemonize.daemonize(log_file=@log_file)
+      open(File.join(cwd,@pid_file),"w") {|f| f.write(Process.pid) }
+      # change back to the original starting directory
+      Dir.chdir(cwd)
+    else
+      puts "Running at #@address:#@port"
+    end
+
+    ENV['RAILS_ENV'] = @environment
+
+    require 'config/environment'
+    h = Mongrel::HttpServer.new(@address, @port)
+    h.register("/", RailsHandler.new(File.join(cwd,"public")))
+    h.run
+    
+    begin
+      h.acceptor.join
+    rescue Interrupt
+      puts "Interrupted."
+    end
+  end
 end
 
-# and go back
-Dir.chdir(cwd) do
-  require 'config/environment'
-  open(File.join(cwd,"log/mongrel-#{ARGV[1]}.pid"),"w") {|f| f.write(Process.pid) }
-  h = Mongrel::HttpServer.new(ARGV[0], ARGV[1])
-  h.register("/", RailsHandler.new(File.join(cwd,"public")))
-  h.run
+
+
+class StopCommand < Mongrel::Command::Command
+
+  def configure 
+    options [
+      ["-d", "--daemonize", "Whether to run in the background or not", :@daemon, false],
+      ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"]
+    ]
+  end
+  
+  def validate
+    valid_exists? @pid_file, "PID file #@pid_file does not exist. Not running?" 
+    return @valid
+  end
+
   
-  h.acceptor.join
+  def run
+    pid = open(@pid_file).read.to_i
+    print "Stopping Mongrel at PID #{pid}..."
+    begin
+      Process.kill("INT", pid)
+    rescue Errno::ESRCH
+      puts "Process does not exist.  Not running."
+    end
+
+    File.unlink(@pid_file)
+    puts "Done."
+  end
 end
+
+
+
+
+Mongrel::Command::Registry.instance.run ARGV

data/doc/rdoc/classes/FactoryError.html

@@ -0,0 +1,144 @@
+<?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: FactoryError</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">FactoryError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/pluginfactory_rb.html">
+                lib/pluginfactory.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                RuntimeError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+An exception class for <a href="PluginFactory.html">PluginFactory</a>
+specific errors.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">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-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="FactoryError.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('FactoryError.src/M000001.html');return false;">
+          <span class="method-name">new</span><span class="method-args">( *args )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </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/FactoryError.src/M000001.html

@@ -0,0 +1,23 @@
+<?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 (FactoryError)</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/pluginfactory.rb, line 87</span>
+87:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> )
+88:                 <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">empty?</span>
+89:                         <span class="ruby-identifier">msg</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">to_s</span>}.<span class="ruby-identifier">join</span>
+90:                         <span class="ruby-keyword kw">super</span>( <span class="ruby-identifier">msg</span> )
+91:                 <span class="ruby-keyword kw">else</span>
+92:                         <span class="ruby-keyword kw">super</span>( <span class="ruby-identifier">message</span> )
+93:                 <span class="ruby-keyword kw">end</span>                                   
+94:         <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/rdoc/classes/Mongrel.html

@@ -93,7 +93,7 @@ to service web application requests fast as possible.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000001">add_mime_type</a>&nbsp;&nbsp;
+      <a href="#M000015">add_mime_type</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -151,12 +151,12 @@ href="Mongrel/Const.html">Mongrel::Const</a>.
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000001" class="method-detail">
-        <a name="M000001"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="Mongrel.src/M000001.html" target="Code" class="method-signature"
-            onclick="popupCode('Mongrel.src/M000001.html');return false;">
+          <a href="Mongrel.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('Mongrel.src/M000015.html');return false;">
           <span class="method-name">add_mime_type</span><span class="method-args">(extension, type)</span>
           </a>
         </div>

data/doc/rdoc/classes/Mongrel.src/{M000001.html → M000015.html}

@@ -10,9 +10,9 @@
   <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.rb, line 577</span>
-577:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_mime_type</span>(<span class="ruby-identifier">extension</span>, <span class="ruby-identifier">type</span>)
-578:     <span class="ruby-constant">MIME_TYPES</span>[<span class="ruby-identifier">extension</span>] = <span class="ruby-identifier">type</span>
-579:   <span class="ruby-keyword kw">end</span></pre>
+  <pre>     <span class="ruby-comment cmt"># File lib/mongrel.rb, line 580</span>
+580:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_mime_type</span>(<span class="ruby-identifier">extension</span>, <span class="ruby-identifier">type</span>)
+581:     <span class="ruby-constant">MIME_TYPES</span>[<span class="ruby-identifier">extension</span>] = <span class="ruby-identifier">type</span>
+582:   <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

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

@@ -230,7 +230,7 @@ DNS resolves. It is only here for completeness for the CGI standard.
           <td width="3em">&nbsp;</td>
           <td class="context-item-desc">
 The name/host of our server as given by the <a
-href="HttpServer.html#M000014">HttpServer.new</a>(host,port) call.
+href="HttpServer.html#M000028">HttpServer.new</a>(host,port) call.
 
 </td>
         </tr>
@@ -241,7 +241,7 @@ href="HttpServer.html#M000014">HttpServer.new</a>(host,port) call.
           <td width="3em">&nbsp;</td>
           <td class="context-item-desc">
 The port of our server as given by the <a
-href="HttpServer.html#M000014">HttpServer.new</a>(host,port) call.
+href="HttpServer.html#M000028">HttpServer.new</a>(host,port) call.
 
 </td>
         </tr>