puma 2.11.1 → 2.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b495e74e45d4bc182f179febf4fa01f881fbf44
-  data.tar.gz: 664e64737272b0befe90f6bbc4b4502116a8a31d
+  metadata.gz: 48c8ae38ddb47bb86ee31ba25019f04fb213a9b8
+  data.tar.gz: 8f79fa19e0b4ad06c87030fa6b8a0af7ca978834
 SHA512:
-  metadata.gz: 6bad4f3bd1ab507047f9021b038ef81ecd6062f4eacf287e15f8a3d12bc7656de793eae2f96dbd0ee4e69ca052bd043a5ad1a67a4085f8290286557b977885f6
-  data.tar.gz: 8eb7a622f1286d3f076f146ca0a2a1da38c0647836c8e23b27d4a8aafb221d2d365dceaf9cfe9bbab413e1d45ce38cdd8f98b7c7f36947a4ec8a406fb19b312b
+  metadata.gz: 2b4497fdf7dd5233d501666882b8896c75b3b2b095f76ea2ca7b809e123ba39536a2ddf6c2ecf4b9c4fbee2c1faf3acbfd9488b49bbfe524f68cd8185523211e
+  data.tar.gz: f8d976a6b89d03cd6ae561564e56f9d5a6fb5d13c233375186fe0423c875af398cb72aee4cb3b1437e18a0f006457cfda98964e841d74355da07b86bf5b1bbbb

data/History.txt

@@ -1,3 +1,26 @@
+=== 2.11.2 / 2015-04-11
+
+* 2 minor features:
+  * Add `on_worker_fork` hook, which allows to mimic Unicorn's behavior
+  * Add shutdown_debug config option
+
+* 4 bug fixes:
+  * Fix the Config constants not being available in the DSL. Fixes #683
+  * Ignore multiple port declarations
+  * Proper 'Connection' header handling compatible with HTTP 1.[01] protocols
+  * Use "Puma" instead of "puma" to reporting to New Relic
+
+* 1 doc fixes:
+  * Add Gitter badge.
+
+* 6 PRs merged:
+  * Merge pull request #657 from schneems/schneems/puma-once-port
+  * Merge pull request #658 from Tomohiro/newrelic-dispatcher-default-update
+  * Merge pull request #662 from basecrm/connection-compatibility
+  * Merge pull request #664 from fxposter/on-worker-fork
+  * Merge pull request #667 from JuanitoFatas/doc/gemspec
+  * Merge pull request #672 from chulkilee/refactor
+
 === 2.11.1 / 2015-02-11
 
 * 2 bug fixes:

data/Manifest.txt

@@ -41,6 +41,7 @@ lib/puma/control_cli.rb
 lib/puma/daemon_ext.rb
 lib/puma/delegation.rb
 lib/puma/detect.rb
+lib/puma/dsl.rb
 lib/puma/events.rb
 lib/puma/io_buffer.rb
 lib/puma/java_io_buffer.rb

data/lib/puma/cli.rb

@@ -15,6 +15,14 @@ require 'rack/commonlogger'
 require 'rack/utils'
 
 module Puma
+  class << self
+    # The CLI exports its Puma::Configuration object here to allow
+    # apps to pick it up. An app needs to use it conditionally though
+    # since it is not set if the app is launched via another
+    # mechanism than the CLI class.
+    attr_accessor :cli_config
+  end
+
   # Handles invoke a Puma::Server in a command line style.
   #
   class CLI
@@ -35,7 +43,7 @@ module Puma
 
       @config = nil
 
-      ENV['NEWRELIC_DISPATCHER'] ||= "puma"
+      ENV['NEWRELIC_DISPATCHER'] ||= "Puma"
 
       setup_options
       generate_restart_data
@@ -69,9 +77,15 @@ module Puma
     end
 
     def debug(str)
-      if @options[:debug]
-        @events.log "- #{str}"
-      end
+      @events.log "- #{str}" if @options[:debug]
+    end
+
+    def clustered?
+      @options[:workers] > 0
+    end
+
+    def prune_bundler?
+      @options[:prune_bundler] && clustered? && !@options[:preload_app]
     end
 
     def jruby?
@@ -82,12 +96,207 @@ module Puma
       RUBY_PLATFORM =~ /mswin32|ming32/
     end
 
-    def unsupported(str, cond=true)
-      return unless cond
-      @events.error str
+    def env
+      @options[:environment] || ENV['RACK_ENV'] || 'development'
+    end
+
+    def write_state
+      write_pid
+
+      path = @options[:state]
+      return unless path
+
+      state = { 'pid' => Process.pid }
+      cfg = @config.dup
+
+      [
+        :logger,
+        :before_worker_shutdown, :before_worker_boot, :before_worker_fork,
+        :after_worker_boot,
+        :on_restart, :lowlevel_error_handler
+      ].each { |k| cfg.options.delete(k) }
+      state['config'] = cfg
+
+      require 'yaml'
+      File.open(path, 'w') { |f| f.write state.to_yaml }
+    end
+
+    # If configured, write the pid of the current process out
+    # to a file.
+    #
+    def write_pid
+      path = @options[:pidfile]
+      return unless path
+
+      File.open(path, 'w') { |f| f.puts Process.pid }
+      cur = Process.pid
+      at_exit do
+        delete_pidfile if cur == Process.pid
+      end
+    end
+
+    def delete_pidfile
+      path = @options[:pidfile]
+      File.unlink(path) if path && File.exist?(path)
+    end
+
+    def graceful_stop
+      @runner.stop_blocked
+      log "=== puma shutdown: #{Time.now} ==="
+      log "- Goodbye!"
+    end
+
+    def jruby_daemon_start
+      require 'puma/jruby_restart'
+      JRubyRestart.daemon_start(@restart_dir, restart_args)
+    end
+
+    def restart!
+      @options[:on_restart].each do |block|
+        block.call self
+      end
+
+      if jruby?
+        close_binder_listeners
+
+        require 'puma/jruby_restart'
+        JRubyRestart.chdir_exec(@restart_dir, restart_args)
+      elsif windows?
+        close_binder_listeners
+
+        argv = restart_args
+        Dir.chdir(@restart_dir)
+        argv += [redirects] if RUBY_VERSION >= '1.9'
+        Kernel.exec(*argv)
+      else
+        redirects = {:close_others => true}
+        @binder.listeners.each_with_index do |(l, io), i|
+          ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
+          redirects[io.to_i] = io.to_i
+        end
+
+        argv = restart_args
+        Dir.chdir(@restart_dir)
+        argv += [redirects] if RUBY_VERSION >= '1.9'
+        Kernel.exec(*argv)
+      end
+    end
+
+    # Parse the options, load the rackup, start the server and wait
+    # for it to finish.
+    #
+    def run
+      begin
+        parse_options
+      rescue UnsupportedOption
+        exit 1
+      end
+
+      dir = @options[:directory]
+      Dir.chdir(dir) if dir
+
+      prune_bundler if prune_bundler?
+
+      set_rack_environment
+
+      if clustered?
+        @events.formatter = Events::PidFormatter.new
+        @options[:logger] = @events
+
+        @runner = Cluster.new(self)
+      else
+        @runner = Single.new(self)
+      end
+
+      setup_signals
+      set_process_title
+
+      @status = :run
+
+      @runner.run
+
+      case @status
+      when :halt
+        log "* Stopping immediately!"
+      when :run, :stop
+        graceful_stop
+      when :restart
+        log "* Restarting..."
+        @runner.before_restart
+        restart!
+      when :exit
+        # nothing
+      end
+    end
+
+    def stop
+      @status = :stop
+      @runner.stop
+    end
+
+    def restart
+      @status = :restart
+      @runner.restart
+    end
+
+    def reload_worker_directory
+      @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory)
+    end
+
+    def phased_restart
+      unless @runner.respond_to?(:phased_restart) and @runner.phased_restart
+        log "* phased-restart called but not available, restarting normally."
+        return restart
+      end
+      true
+    end
+
+    def redirect_io
+      @runner.redirect_io
+    end
+
+    def stats
+      @runner.stats
+    end
+
+    def halt
+      @status = :halt
+      @runner.halt
+    end
+
+  private
+    def title
+      buffer = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
+      buffer << " [#{@options[:tag]}]" if @options[:tag]
+      buffer
+    end
+
+    def unsupported(str)
+      @events.error(str)
       raise UnsupportedOption
     end
 
+    def restart_args
+      cmd = @options[:restart_cmd]
+      if cmd
+        cmd.split(' ') + @original_argv
+      else
+        @restart_argv
+      end
+    end
+
+    def set_process_title
+      Process.respond_to?(:setproctitle) ? Process.setproctitle(title) : $0 = title
+    end
+
+    def find_config
+      if @options[:config_file] == '-'
+        @options[:config_file] = nil
+      else
+        @options[:config_file] ||= %W(config/puma/#{env}.rb config/puma.rb).find { |f| File.exist?(f) }
+      end
+    end
+
     # Build the OptionParser object to handle the available options.
     #
     def setup_options
@@ -101,6 +310,7 @@ module Puma
         :daemon => false,
         :before_worker_shutdown => [],
         :before_worker_boot => [],
+        :before_worker_fork => [],
         :after_worker_boot => []
       }
 
@@ -209,124 +419,16 @@ module Puma
         o.on "--tag NAME", "Additional text to display in process listing" do |arg|
           @options[:tag] = arg
         end
-      end
-
-      @parser.banner = "puma <options> <rackup file>"
-
-      @parser.on_tail "-h", "--help", "Show help" do
-        log @parser
-        exit 1
-      end
-    end
-
-    def write_state
-      write_pid
-
-      require 'yaml'
-
-      if path = @options[:state]
-        state = { "pid" => Process.pid }
-
-        cfg = @config.dup
-
-        [ :logger, :before_worker_shutdown, :before_worker_boot, :after_worker_boot, :on_restart, :lowlevel_error_handler ].each { |o| cfg.options.delete o }
-
-        state["config"] = cfg
-
-        File.open(path, "w") do |f|
-          f.write state.to_yaml
-        end
-      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|
-          f.puts Process.pid
-        end
 
-        cur = Process.pid
+        o.banner = "puma <options> <rackup file>"
 
-        at_exit do
-          if cur == Process.pid
-            delete_pidfile
-          end
-        end
-      end
-    end
-
-    def env
-      # Try the user option first, then the environment variable,
-      # finally default to development
-      @options[:environment] || ENV['RACK_ENV'] || 'development'
-    end
-
-    def set_rack_environment
-      @options[:environment] = env
-      ENV['RACK_ENV'] = env
-    end
-
-    def delete_pidfile
-      if path = @options[:pidfile]
-        File.unlink path if File.exist? path
-      end
-    end
-
-    def find_config
-      if cfg = @options[:config_file]
-        # Allow - to disable config finding
-        if cfg == "-"
-          @options[:config_file] = nil
-          return
+        o.on_tail "-h", "--help", "Show help" do
+          log o
+          exit 1
         end
-
-        return
-      end
-
-      pos = ["config/puma/#{env}.rb", "config/puma.rb"]
-      @options[:config_file] = pos.find { |f| File.exist? f }
-    end
-
-    # :nodoc:
-    def parse_options
-      @parser.parse! @argv
-
-      if @argv.last
-        @options[:rackup] = @argv.shift
-      end
-
-      find_config
-
-      @config = Puma::Configuration.new @options
-
-      # Advertise the Configuration
-      Puma.cli_config = @config
-
-      @config.load
-
-      if clustered?
-        unsupported "worker mode not supported on JRuby or Windows",
-                    jruby? || windows?
-      end
-
-      if @options[:daemon] and windows?
-        unsupported "daemon mode not supported on Windows"
       end
     end
 
-    def clustered?
-      @options[:workers] > 0
-    end
-
-    def graceful_stop
-      @runner.stop_blocked
-      log "=== puma shutdown: #{Time.now} ==="
-      log "- Goodbye!"
-    end
-
     def generate_restart_data
       # Use the same trick as unicorn, namely favor PWD because
       # it will contain an unresolved symlink, useful for when
@@ -372,157 +474,9 @@ module Puma
       end
     end
 
-    def restart_args
-      if cmd = @options[:restart_cmd]
-        cmd.split(' ') + @original_argv
-      else
-        @restart_argv
-      end
-    end
-
-    def jruby_daemon_start
-      require 'puma/jruby_restart'
-      JRubyRestart.daemon_start(@restart_dir, restart_args)
-    end
-
-    def restart!
-      @options[:on_restart].each do |block|
-        block.call self
-      end
-
-      if jruby?
-        @binder.listeners.each_with_index do |(str,io),i|
-          io.close
-
-          # We have to unlink a unix socket path that's not being used
-          uri = URI.parse str
-          if uri.scheme == "unix"
-            path = "#{uri.host}#{uri.path}"
-            File.unlink path
-          end
-        end
-
-        require 'puma/jruby_restart'
-        JRubyRestart.chdir_exec(@restart_dir, restart_args)
-
-      elsif windows?
-        @binder.listeners.each_with_index do |(str,io),i|
-          io.close
-
-          # We have to unlink a unix socket path that's not being used
-          uri = URI.parse str
-          if uri.scheme == "unix"
-            path = "#{uri.host}#{uri.path}"
-            File.unlink path
-          end
-        end
-
-        argv = restart_args
-
-        Dir.chdir @restart_dir
-
-        argv += [redirects] unless RUBY_VERSION < '1.9'
-        Kernel.exec(*argv)
-
-      else
-        redirects = {:close_others => true}
-        @binder.listeners.each_with_index do |(l,io),i|
-          ENV["PUMA_INHERIT_#{i}"] = "#{io.to_i}:#{l}"
-          redirects[io.to_i] = io.to_i
-        end
-
-        argv = restart_args
-
-        Dir.chdir @restart_dir
-
-        argv += [redirects] unless RUBY_VERSION < '1.9'
-
-        Kernel.exec(*argv)
-      end
-    end
-
-    def prune_bundler?
-      @options[:prune_bundler] && clustered? && !@options[:preload_app]
-    end
-
-    # Parse the options, load the rackup, start the server and wait
-    # for it to finish.
-    #
-    def run
-      begin
-        parse_options
-      rescue UnsupportedOption
-        exit 1
-      end
-
-      if dir = @options[:directory]
-        Dir.chdir dir
-      end
-
-      if prune_bundler? && defined?(Bundler)
-        puma = Bundler.rubygems.loaded_specs("puma")
-
-        dirs = puma.require_paths.map { |x| File.join(puma.full_gem_path, x) }
-
-        puma_lib_dir = dirs.detect { |x| File.exist? File.join(x, "../bin/puma-wild") }
-
-        deps = puma.runtime_dependencies.map { |d|
-          spec = Bundler.rubygems.loaded_specs(d.name)
-          "#{d.name}:#{spec.version.to_s}"
-        }.join(",")
-
-        if puma_lib_dir
-          log "* Pruning Bundler environment"
-
-          home = ENV['GEM_HOME']
-
-          Bundler.with_clean_env do
-
-            ENV['GEM_HOME'] = home
-
-            wild = File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))
-
-            wild_loadpath = dirs.join(":")
-
-            args = [Gem.ruby] + [wild, "-I", wild_loadpath, deps] + @original_argv
-
-            Kernel.exec(*args)
-          end
-        end
-
-        log "! Unable to prune Bundler environment, continuing"
-      end
-
-      set_rack_environment
-
-      if clustered?
-        @events.formatter = Events::PidFormatter.new
-        @options[:logger] = @events
-
-        @runner = Cluster.new(self)
-      else
-        @runner = Single.new(self)
-      end
-
-      setup_signals
-      set_process_title
-
-      @status = :run
-
-      @runner.run
-
-      case @status
-      when :halt
-        log "* Stopping immediately!"
-      when :run, :stop
-        graceful_stop
-      when :restart
-        log "* Restarting..."
-        @runner.before_restart
-        restart!
-      when :exit
-        # nothing
-      end
+    def set_rack_environment
+      @options[:environment] = env
+      ENV['RACK_ENV'] = env
     end
 
     def setup_signals
@@ -567,50 +521,62 @@ module Puma
       end
     end
 
-    def stop
-      @status = :stop
-      @runner.stop
+    def close_binder_listeners
+      @binder.listeners.each do |l, io|
+        io.close
+        uri = URI.parse(l)
+        next unless uri.scheme == 'unix'
+        File.unlink("#{uri.host}#{uri.path}")
+      end
     end
 
-    def restart
-      @status = :restart
-      @runner.restart
-    end
+    def parse_options
+      @parser.parse! @argv
 
-    def reload_worker_directory
-      @runner.reload_worker_directory if @runner.respond_to?(:reload_worker_directory)
-    end
+      @options[:rackup] = @argv.shift if @argv.last
 
-    def phased_restart
-      unless @runner.respond_to?(:phased_restart) and @runner.phased_restart
-        log "* phased-restart called but not available, restarting normally."
-        return restart
+      find_config
+
+      @config = Puma::Configuration.new @options
+
+      # Advertise the Configuration
+      Puma.cli_config = @config
+
+      @config.load
+
+      if clustered? && (jruby? || windows?)
+        unsupported 'worker mode not supported on JRuby or Windows'
       end
-      true
-    end
 
-    def redirect_io
-      @runner.redirect_io
+      if @options[:daemon] && windows?
+        unsupported 'daemon mode not supported on Windows'
+      end
     end
 
-    def stats
-      @runner.stats
-    end
+    def prune_bundler
+      return unless defined?(Bundler)
+      puma = Bundler.rubygems.loaded_specs("puma")
+      dirs = puma.require_paths.map { |x| File.join(puma.full_gem_path, x) }
+      puma_lib_dir = dirs.detect { |x| File.exist? File.join(x, '../bin/puma-wild') }
 
-    def halt
-      @status = :halt
-      @runner.halt
-    end
+      unless puma_lib_dir
+        log "! Unable to prune Bundler environment, continuing"
+        return
+      end
 
-  private
-    def title
-      buffer = "puma #{Puma::Const::VERSION} (#{@options[:binds].join(',')})"
-      buffer << " [#{@options[:tag]}]" if @options[:tag]
-      buffer
-    end
+      deps = puma.runtime_dependencies.map do |d|
+        spec = Bundler.rubygems.loaded_specs(d.name)
+        "#{d.name}:#{spec.version.to_s}"
+      end
 
-    def set_process_title
-      Process.respond_to?(:setproctitle) ? Process.setproctitle(title) : $0 = title
+      log '* Pruning Bundler environment'
+      home = ENV['GEM_HOME']
+      Bundler.with_clean_env do
+        ENV['GEM_HOME'] = home
+        wild = File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))
+        args = [Gem.ruby, wild, '-I', dirs.join(':'), deps.join(',')] + @original_argv
+        Kernel.exec(*args)
+      end
     end
   end
 end