puma 0.8.2 → 0.9.0

data/Manifest.txt

@@ -7,17 +7,7 @@ README.md
 Rakefile
 TODO
 bin/puma
-examples/builder.rb
-examples/camping/README
-examples/camping/blog.rb
-examples/camping/tepee.rb
-examples/httpd.conf
-examples/mime.yaml
-examples/mongrel.conf
-examples/monitrc
-examples/random_thrash.rb
-examples/simpletest.rb
-examples/webrick_compare.rb
+bin/pumactl
 ext/puma_http11/PumaHttp11Service.java
 ext/puma_http11/ext_help.h
 ext/puma_http11/extconf.rb
@@ -30,23 +20,21 @@ ext/puma_http11/org/jruby/puma/Http11.java
 ext/puma_http11/org/jruby/puma/Http11Parser.java
 ext/puma_http11/puma_http11.c
 lib/puma.rb
+lib/puma/app/status.rb
 lib/puma/cli.rb
 lib/puma/const.rb
+lib/puma/control_cli.rb
 lib/puma/events.rb
-lib/puma/gems.rb
-lib/puma/mime_types.yml
+lib/puma/null_io.rb
 lib/puma/rack_patch.rb
 lib/puma/server.rb
 lib/puma/thread_pool.rb
-lib/puma/utils.rb
 lib/rack/handler/puma.rb
 puma.gemspec
-tasks/gem.rake
-tasks/java.rake
-tasks/native.rake
-tasks/ragel.rake
+test/ab_rs.rb
 test/lobster.ru
 test/mime.yaml
+test/test_app_status.rb
 test/test_cli.rb
 test/test_http10.rb
 test/test_http11.rb

data/Rakefile

@@ -1,12 +1,90 @@
-#
-# NOTE: Keep this file clean.
-# Add your customizations inside tasks directory.
-# Thank You.
-#
-
 require 'rubygems'
 
+require 'hoe'
+
 IS_JRUBY = defined?(RUBY_ENGINE) ? RUBY_ENGINE == "jruby" : false
 
-# load rakefile extensions (tasks)
-Dir['tasks/*.rake'].sort.each { |f| load f }
+HOE = Hoe.spec 'puma' do
+  self.rubyforge_name = 'puma'
+  self.readme_file = "README.md"
+  developer 'Evan Phoenix', 'evan@phx.io'
+
+  spec_extras[:extensions] = ["ext/puma_http11/extconf.rb"]
+  spec_extras[:executables] = ['puma', 'pumactl']
+
+  dependency 'rack', '~> 1.2'
+
+  extra_dev_deps << ['rake-compiler', "~> 0.7.0"]
+
+  clean_globs.push('test_*.log', 'log')
+end
+
+task :test => [:compile]
+
+# hoe/test and rake-compiler don't seem to play well together, so disable
+# hoe/test's .gemtest touch file thingy for now
+HOE.spec.files -= [".gemtest"]
+
+file "#{HOE.spec.name}.gemspec" => ['Rakefile'] do |t|
+  puts "Generating #{t.name}"
+  File.open(t.name, 'w') { |f| f.puts HOE.spec.to_ruby }
+end
+
+desc "Generate or update the standalone gemspec file for the project"
+task :gemspec => ["#{HOE.spec.name}.gemspec"]
+
+# the following tasks ease the build of C file from Ragel one
+
+file 'ext/puma_http11/http11_parser.c' => ['ext/puma_http11/http11_parser.rl'] do |t|
+  begin
+    sh "ragel #{t.prerequisites.last} -C -G2 -o #{t.name}"
+  rescue
+    fail "Could not build wrapper using Ragel (it failed or not installed?)"
+  end
+end
+
+file 'ext/puma_http11/org/jruby/puma/Http11Parser.java' => ['ext/puma_http11/http11_parser.java.rl'] do |t|
+  begin
+    sh "ragel #{t.prerequisites.last} -J -G2 -o #{t.name}"
+  rescue
+    fail "Could not build wrapper using Ragel (it failed or not installed?)"
+  end
+end
+
+if IS_JRUBY
+  require 'rake/javaextensiontask'
+
+  # build http11 java extension
+  Rake::JavaExtensionTask.new('puma_http11', HOE.spec)
+
+  task :ragel => 'ext/puma_http11/org/jruby/puma/Http11Parser.java'
+else
+  # use rake-compiler for building the extension
+  require 'rake/extensiontask'
+  
+  # build http11 C extension
+  Rake::ExtensionTask.new('puma_http11', HOE.spec) do |ext|
+    # define target for extension (supporting fat binaries)
+    if RUBY_PLATFORM =~ /mingw|mswin/ then
+      RUBY_VERSION =~ /(\d+\.\d+)/
+      ext.lib_dir = "lib/#{$1}"
+    elsif ENV['CROSS']
+      # define cross-compilation tasks when not on Windows.
+      ext.cross_compile = true
+      ext.cross_platform = ['i386-mswin32', 'i386-mingw32']
+    end
+  
+    # cleanup versioned library directory
+    CLEAN.include 'lib/{1.8,1.9}'
+  end
+
+  task :ragel => 'ext/puma_http11/http11_parser.c'
+end
+
+task :ext_clean do
+  sh "rm -rf lib/puma_http11.bundle"
+  sh "rm -rf lib/puma_http11.jar"
+  sh "rm -rf lib/puma_http11.so"
+end
+
+task :clean => :ext_clean

data/bin/puma

@@ -10,6 +10,7 @@ cli = Puma::CLI.new ARGV
 begin
   cli.run
 rescue => e
+  raise e if $DEBUG
   STDERR.puts e.message
   exit 1
 end

data/bin/pumactl

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'puma/control_cli'
+
+cli = Puma::ControlCLI.new ARGV
+
+begin
+  cli.run
+rescue => e
+  STDERR.puts e.message
+  exit 1
+end

data/lib/puma.rb

@@ -8,11 +8,8 @@ require 'etc'
 require 'uri'
 require 'stringio'
 
-# Gem conditional loader
-require 'puma/gems'
 require 'thread'
 
 # Ruby Puma
 require 'puma/const'
 require 'puma/server'
-require 'puma/utils'

data/lib/puma/app/status.rb

@@ -0,0 +1,37 @@
+module Puma
+  module App
+    class Status
+      def initialize(server, cli)
+        @server = server
+        @cli = cli
+      end
+
+      def call(env)
+        case env['PATH_INFO']
+        when "/stop"
+          @server.stop
+          return [200, {}, ['{ "status": "ok" }']]
+
+        when "/halt"
+          @server.halt
+          return [200, {}, ['{ "status": "ok" }']]
+
+        when "/restart"
+          if @cli and @cli.restart_on_stop!
+            @server.stop
+            return [200, {}, ['{ "status": "ok" }']]
+          else
+            return [200, {}, ['{ "status": "not configured" }']]
+          end
+
+        when "/stats"
+          b = @server.backlog
+          r = @server.running
+          return [200, {}, ["{ \"backlog\": #{b}, \"running\": #{r} }"]]
+        end
+
+        [404, {}, ["Unsupported action"]]
+      end
+    end
+  end
+end

data/lib/puma/cli.rb

@@ -7,10 +7,20 @@ require 'puma/const'
 require 'rack/commonlogger'
 
 module Puma
+  # Handles invoke a Puma::Server in a command line style.
+  #
   class CLI
     DefaultTCPHost = "0.0.0.0"
     DefaultTCPPort = 9292
 
+    IS_JRUBY = defined?(JRUBY_VERSION)
+
+    # Create a new CLI object using +argv+ as the command line
+    # arguments.
+    #
+    # +stdout+ and +stderr+ can be set to IO-like objects which
+    # this object will report status on.
+    #
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
       @argv = argv
       @stdout = stdout
@@ -18,18 +28,78 @@ module Puma
 
       @events = Events.new @stdout, @stderr
 
+      @server = nil
+      @status = nil
+
+      @restart = false
+      @temp_status_path = nil
+
       setup_options
+
+      generate_restart_data
+    end
+
+    def restart_on_stop!
+      if @restart_argv
+        @restart = true
+        return true
+      else
+        return false
+      end
+    end
+
+    def generate_restart_data
+      # Use the same trick as unicorn, namely favor PWD because
+      # it will contain an unresolved symlink, useful for when
+      # the pwd is /data/releases/current.
+      if dir = ENV['PWD']
+        s_env = File.stat(dir)
+        s_pwd = File.stat(Dir.pwd)
+
+        if s_env.ino == s_pwd.ino and s_env.dev == s_pwd.dev
+          @restart_dir = dir
+        end
+      end
+
+      @restart_dir ||= Dir.pwd
+
+      if defined? Rubinius::OS_ARGV
+        @restart_argv = Rubinius::OS_ARGV
+      else
+        require 'rubygems'
+
+        # if $0 is a file in the current directory, then restart
+        # it the same, otherwise add -S on there because it was
+        # picked up in PATH.
+        #
+        if File.exists?($0)
+          @restart_argv = [Gem.ruby, $0] + ARGV
+        else
+          @restart_argv = [Gem.ruby, "-S", $0] + ARGV
+        end
+      end
     end
 
+    def restart!
+      Dir.chdir @restart_dir
+      Kernel.exec(*@restart_argv)
+    end
+
+    # Write +str+ to +@stdout+
+    #
     def log(str)
       @stdout.puts str
     end
 
+    # Write +str+ to +@stderr+
+    #
     def error(str)
       @stderr.puts "ERROR: #{str}"
       exit 1
     end
 
+    # Build the OptionParser object to handle the available options.
+    #
     def setup_options
       @options = {
         :min_threads => 0,
@@ -63,6 +133,27 @@ module Puma
           end
         end
 
+        o.on "-S", "--state PATH", "Where to store the state details" do |arg|
+          @options[:state] = arg
+        end
+
+        o.on "--status [URL]", "The bind url to use for the status server" do |arg|
+          if arg and arg != "@"
+            @options[:status_address] = arg
+          elsif IS_JRUBY
+            raise NotImplementedError, "No default url available on JRuby"
+          else
+            require 'tmpdir'
+
+            t = (Time.now.to_f * 1000).to_i
+            path = "#{Dir.tmpdir}/puma-status-#{t}-#{$$}"
+
+            @temp_status_path = path
+
+            @options[:status_address] = "unix://#{path}"
+          end
+        end
+
       end
 
       @parser.banner = "puma <options> <rackup file>"
@@ -73,6 +164,9 @@ module Puma
       end
     end
 
+    # Load the specified rackup file, pull an options from
+    # the rackup file, and set @app.
+    #
     def load_rackup
       @app, options = Rack::Builder.parse_file @rackup
       @options.merge! options
@@ -84,6 +178,9 @@ module Puma
       end
     end
 
+    # If configured, write the pid of the current process out
+    # to a file.
+    #
     def write_pid
       if path = @options[:pidfile]
         File.open(path, "w") do |f|
@@ -92,14 +189,34 @@ module Puma
       end
     end
 
+    def write_state
+      require 'yaml'
+
+      if path = @options[:state]
+        state = { "pid" => Process.pid }
+
+        if url = @options[:status_address]
+          state["status_address"] = url
+        end
+
+        File.open(path, "w") do |f|
+          f.write state.to_yaml
+        end
+      end
+    end
+
+    # :nodoc:
     def parse_options
       @parser.parse! @argv
     end
 
+    # Parse the options, load the rackup, start the server and wait
+    # for it to finish.
+    #
     def run
       parse_options
 
-      @rackup = ARGV.shift || "config.ru"
+      @rackup = @argv.shift || "config.ru"
 
       unless File.exists?(@rackup)
         raise "Missing rackup file '#{@rackup}'"
@@ -107,8 +224,9 @@ module Puma
 
       load_rackup
       write_pid
+      write_state
 
-      unless @quiet
+      unless @options[:quiet]
         @app = Rack::CommonLogger.new(@app, STDOUT)
       end
 
@@ -148,8 +266,33 @@ module Puma
         end
       end
 
-      if server.attempt_bonjour(@rackup)
-        log "* Announced services via bonjour"
+      @server = server
+
+      if str = @options[:status_address]
+        require 'puma/app/status'
+
+        uri = URI.parse str
+
+        app = Puma::App::Status.new server, self
+        status = Puma::Server.new app, @events
+        status.min_threads = 0
+        status.max_threads = 1
+
+        case uri.scheme
+        when "tcp"
+          log "* Starting status server on #{str}"
+          status.add_tcp_listener uri.host, uri.port
+        when "unix"
+          log "* Starting status server on #{str}"
+          path = "#{uri.host}#{uri.path}"
+
+          status.add_unix_listener path
+        else
+          error "Invalid status URI: #{str}"
+        end
+
+        status.run
+        @status = status
       end
 
       log "Use Ctrl-C to stop"
@@ -157,8 +300,21 @@ module Puma
       begin
         server.run.join
       rescue Interrupt
-        log " - Shutting down..."
+        log " - Gracefully stopping, waiting for requests to finish"
+        server.stop(true)
+        log " - Goodbye!"
       end
+
+      File.unlink @temp_status_path if @temp_status_path
+
+      if @restart
+        log "* Restarting..."
+        restart!
+      end
+    end
+
+    def stop
+      @server.stop(true) if @server
     end
   end
 end