puma 2.16.0 → 3.0.0.rc1

data/lib/puma/control_cli.rb

@@ -9,12 +9,17 @@ module Puma
 
     COMMANDS = %w{halt restart phased-restart start stats status stop reload-worker-directory}
 
-    def is_windows?
-      RUBY_PLATFORM =~ /(win|w)32$/ ? true : false
-    end
-
     def initialize(argv, stdout=STDOUT, stderr=STDERR)
-      @argv = argv
+      @state = nil
+      @quiet = false
+      @pidfile = nil
+      @pid = nil
+      @control_url = nil
+      @control_auth_token = nil
+      @config_file = nil
+      @command = nil
+
+      @argv = argv.dup
       @stdout = stdout
       @stderr = stderr
       @cli_options = {}
@@ -23,31 +28,31 @@ module Puma
         o.banner = "Usage: pumactl (-p PID | -P pidfile | -S status_file | -C url -T token | -F config.rb) (#{COMMANDS.join("|")})"
 
         o.on "-S", "--state PATH", "Where the state file to use is" do |arg|
-          @cli_options[:state] = arg
+          @state = arg
         end
 
         o.on "-Q", "--quiet", "Not display messages" do |arg|
-          @cli_options[:quiet_flag] = true
+          @quiet = true
         end
 
         o.on "-P", "--pidfile PATH", "Pid file" do |arg|
-          @cli_options[:pidfile] = arg
+          @pidfile = arg
         end
 
         o.on "-p", "--pid PID", "Pid" do |arg|
-          @cli_options[:pid] = arg.to_i
+          @pid = arg.to_i
         end
 
         o.on "-C", "--control-url URL", "The bind url to use for the control server" do |arg|
-          @cli_options[:control_url] = arg
+          @control_url = arg
         end
 
         o.on "-T", "--control-token TOKEN", "The token to use as authentication for the control server" do |arg|
-          @cli_options[:control_auth_token] = arg
+          @control_auth_token = arg
         end
 
         o.on "-F", "--config-file PATH", "Puma config script" do |arg|
-          @cli_options[:config_file] = arg
+          @config_file = arg
         end
 
         o.on_tail("-H", "--help", "Show this message") do
@@ -63,32 +68,29 @@ module Puma
 
       opts.order!(argv) { |a| opts.terminate a }
 
-      command = argv.shift
-      @cli_options[:command] = command if command
-
-      @options = nil
+      @command = argv.shift
 
-      unless @cli_options[:config_file] == '-'
-        if @cli_options[:config_file].nil? and File.exist?('config/puma.rb')
-          @cli_options[:config_file] = 'config/puma.rb'
+      unless @config_file == '-'
+        if @config_file.nil? and File.exist?('config/puma.rb')
+          @config_file = 'config/puma.rb'
         end
 
-        if @cli_options[:config_file]
-          config = Puma::Configuration.new(@cli_options)
-          config.load
-          @options = config.options
+        if @config_file
+          config = Puma::Configuration.from_file @config_file
+          @state ||= config.options[:state]
+          @control_url ||= config.options[:control_url]
+          @control_auth_token ||= config.options[:control_auth_token]
+          @pidfile ||= config.options[:pidfile]
         end
       end
 
-      @options ||= @cli_options
-
       # check present of command
-      unless @options[:command]
+      unless @command
         raise "Available commands: #{COMMANDS.join(", ")}"
       end
 
-      unless COMMANDS.include? @options[:command]
-        raise "Invalid command: #{@options[:command]}"
+      unless COMMANDS.include? @command
+        raise "Invalid command: #{@command}"
       end
 
     rescue => e
@@ -97,45 +99,29 @@ module Puma
     end
 
     def message(msg)
-      @stdout.puts msg unless @options[:quiet_flag]
+      @stdout.puts msg unless @quiet
     end
 
     def prepare_configuration
-      if @options.has_key? :state
-        unless File.exist? @options[:state]
-          raise "Status file not found: #{@options[:state]}"
+      if @state
+        unless File.exist? @state
+          raise "State file not found: #{@state}"
         end
 
-        status = YAML.load File.read(@options[:state])
-
-        if status.kind_of?(Hash) && status.has_key?("config")
-
-          conf = status["config"]
-
-          # get control_url
-          if url = conf.options[:control_url]
-            @options[:control_url] = url
-          end
-
-          # get control_auth_token
-          if token = conf.options[:control_auth_token]
-            @options[:control_auth_token] = token
-          end
-
-          # get pid
-          @options[:pid] = status["pid"].to_i
-        else
-          raise "Invalid status file: #{@options[:state]}"
-        end
+        sf = StateFile.new
+        sf.load @state
 
-      elsif @options.has_key? :pidfile
+        @control_url = sf.control_url
+        @control_auth_token = sf.control_auth_token
+        @pid = sf.pid
+      elsif @pidfile
         # get pid from pid_file
-        @options[:pid] = File.open(@options[:pidfile]).gets.to_i
+        @pid = File.open(@pidfile).gets.to_i
       end
     end
 
     def send_request
-      uri = URI.parse @options[:control_url]
+      uri = URI.parse @control_url
 
       # create server object by scheme
       @server = case uri.scheme
@@ -147,13 +133,13 @@ module Puma
                   raise "Invalid scheme: #{uri.scheme}"
                 end
 
-      if @options[:command] == "status"
+      if @command == "status"
         message "Puma is started"
       else
-        url = "/#{@options[:command]}"
+        url = "/#{@command}"
 
-        if @options.has_key?(:control_auth_token)
-          url = url + "?token=#{@options[:control_auth_token]}"
+        if @control_auth_token
+          url = url + "?token=#{@control_auth_token}"
         end
 
         @server << "GET #{url} HTTP/1.0\r\n\r\n"
@@ -178,30 +164,29 @@ module Puma
           raise "Bad response from server: #{@code}"
         end
 
-        message "Command #{@options[:command]} sent success"
-        message response.last if @options[:command] == "stats"
+        message "Command #{@command} sent success"
+        message response.last if @command == "stats"
       end
 
       @server.close
     end
 
     def send_signal
-      unless pid = @options[:pid]
+      unless @pid
         raise "Neither pid nor control url available"
       end
 
       begin
         Process.getpgid pid
       rescue SystemCallError
-        if @options[:command] == "restart"
-          @options.delete(:command)
+        if @command == "restart"
           start
         else
           raise "No pid '#{pid}' found"
         end
       end
 
-      case @options[:command]
+      case @command
       when "restart"
         Process.kill "SIGUSR2", pid
 
@@ -227,18 +212,18 @@ module Puma
         return
       end
 
-      message "Command #{@options[:command]} sent success"
+      message "Command #{@command} sent success"
     end
 
     def run
-      start if @options[:command] == "start"
+      start if @command == "start"
 
       prepare_configuration
 
-      if is_windows?
+      if Puma.windows?
         send_request
       else
-        @options.has_key?(:control_url) ? send_request : send_signal
+        @control_url ? send_request : send_signal
       end
 
     rescue => e
@@ -252,11 +237,11 @@ module Puma
 
       run_args = @argv
 
-      if path = @options[:state]
+      if path = @state
         run_args = ["-S", path] + run_args
       end
 
-      if path = @options[:config_file]
+      if path = @config_file
         run_args = ["-C", path] + run_args
       end
 

data/lib/puma/convenient.rb

@@ -0,0 +1,23 @@
+require 'puma/launcher'
+require 'puma/configuration'
+
+module Puma
+  def self.run(opts={})
+    cfg = Puma::Configuration.new do |c|
+      if port = opts[:port]
+        c.port port
+      end
+
+      c.quiet
+
+      yield c
+    end
+
+    cfg.clamp
+
+    events = Puma::Events.null
+
+    launcher = Puma::Launcher.new cfg, :events => events
+    launcher.run
+  end
+end

data/lib/puma/daemon_ext.rb

@@ -3,6 +3,12 @@ module Process
   # This overrides the default version because it is broken if it
   # exists.
 
+  if respond_to? :daemon
+    class << self
+      remove_method :daemon
+    end
+  end
+
   def self.daemon(nochdir=false, noclose=false)
     exit if fork                     # Parent exits, child continues.
 

data/lib/puma/detect.rb

@@ -1,4 +1,11 @@
 module Puma
   IS_JRUBY = defined?(JRUBY_VERSION)
-end
 
+  def self.jruby?
+    IS_JRUBY
+  end
+
+  def self.windows?
+    RUBY_PLATFORM =~ /mswin32|ming32/
+  end
+end

data/lib/puma/dsl.rb

@@ -4,20 +4,57 @@ module Puma
   class DSL
     include ConfigDefault
 
-    def self.load(options, path)
-      new(options).tap do |obj|
-        obj._load_from(path)
-      end
+    def self.load(options, cfg, path)
+      d = new(options, cfg)
+      d._load_from(path)
 
       options
+    ensure
+      d._offer_plugins
     end
 
-    def initialize(options)
+    def initialize(options, config)
+      @config = config
       @options = options
+
+      @plugins = []
     end
 
     def _load_from(path)
       instance_eval(File.read(path), path, 1) if path
+    ensure
+      _offer_plugins
+    end
+
+    def _offer_plugins
+      @plugins.each do |o|
+        if o.respond_to? :config
+          @options.shift
+          o.config self
+        end
+      end
+
+      @plugins.clear
+    end
+
+    def _run(&blk)
+      blk.call self
+    ensure
+      _offer_plugins
+    end
+
+    def inject(&blk)
+      instance_eval(&blk)
+    end
+
+    def get(key,default=nil)
+      @options[key.to_sym] || default
+    end
+
+    # Load the named plugin for use by this configuration
+    #
+    def plugin(name)
+      @plugins << @config.load_plugin(name)
     end
 
     # Use +obj+ or +block+ as the Rack app. This allows a config file to
@@ -34,29 +71,43 @@ module Puma
     # Start the Puma control rack app on +url+. This app can be communicated
     # with to control the main server.
     #
-    def activate_control_app(url="auto", opts=nil)
-      @options[:control_url] = url
+    def activate_control_app(url="auto", opts={})
+      if url == "auto"
+        path = Configuration.temp_path
+        @options[:control_url] = "unix://#{path}"
+        @options[:control_url_temp] = path
+      else
+        @options[:control_url] = url
+      end
 
-      if opts
+      if opts[:no_token]
+        auth_token = :none
+      else
         auth_token = opts[:auth_token]
-        @options[:control_auth_token] = auth_token if auth_token
-
-        @options[:control_auth_token] = :none if opts[:no_token]
-        @options[:control_url_umask] = opts[:umask] if opts[:umask]
+        auth_token ||= Configuration.random_token
       end
+
+      @options[:control_auth_token] = auth_token
+      @options[:control_url_umask] = opts[:umask] if opts[:umask]
+    end
+
+    # Load additional configuration from a file
+    def load(file)
+      _ary(:config_files) << file
     end
 
     # Bind the server to +url+. tcp:// and unix:// are the only accepted
     # protocols.
     #
     def bind(url)
-      @options[:binds] << url
+      _ary(:binds) << url
     end
 
     # Define the TCP port to bind to. Use +bind+ for more advanced options.
     #
-    def port(port)
-      @options[:binds] << "tcp://#{Configuration::DefaultTCPHost}:#{port}"
+    def port(port, host=nil)
+      host ||= Configuration::DefaultTCPHost
+      bind "tcp://#{host}:#{port}"
     end
 
     # Work around leaky apps that leave garbage in Thread locals
@@ -91,7 +142,7 @@ module Puma
     # This can be called multiple times to add code each time.
     #
     def on_restart(&block)
-      @options[:on_restart] << block
+      _ary(:on_restart) << block
     end
 
     # Command to use to restart puma. This should be just how to
@@ -99,12 +150,12 @@ module Puma
     # to puma, as those are the same as the original process.
     #
     def restart_command(cmd)
-      @options[:restart_cmd] = cmd
+      @options[:restart_cmd] = cmd.to_s
     end
 
     # Store the pid of the server in the file at +path+.
     def pidfile(path)
-      @options[:pidfile] = path
+      @options[:pidfile] = path.to_s
     end
 
     # Disable request logging.
@@ -113,12 +164,24 @@ module Puma
       @options[:quiet] = true
     end
 
+    # Show debugging info
+    #
+    def debug
+      @options[:debug] = true
+    end
+
     # Load +path+ as a rackup file.
     #
     def rackup(path)
       @options[:rackup] = path.to_s
     end
 
+    # Run Puma in TCP mode
+    #
+    def tcp_mode!
+      @options[:mode] = :tcp
+    end
+
     # Redirect STDOUT and STDERR to files specified.
     def stdout_redirect(stdout=nil, stderr=nil, append=false)
       @options[:redirect_stdout] = stdout
@@ -136,6 +199,10 @@ module Puma
         raise "The minimum (#{min}) number of threads must be less than or equal to the max (#{max})"
       end
 
+      if max < 1
+        raise "The maximum number of threads (#{max}) must be greater than 0"
+      end
+
       @options[:min_threads] = min
       @options[:max_threads] = max
     end
@@ -143,9 +210,9 @@ module Puma
     def ssl_bind(host, port, opts)
       if defined?(JRUBY_VERSION)
         keystore_additions = "keystore=#{opts[:keystore]}&keystore-pass=#{opts[:keystore_pass]}"
-        @options[:binds] << "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}"
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}"
       else
-        @options[:binds] << "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}"
+        bind "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}"
       end
     end
 
@@ -172,7 +239,7 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def before_fork(&block)
-      @options[:before_fork] << block
+      _ary(:before_fork) << block
     end
 
     # *Cluster mode only* Code to run immediately before a worker shuts
@@ -183,7 +250,7 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_shutdown(&block)
-      @options[:before_worker_shutdown] << block
+      _ary(:before_worker_shutdown) << block
     end
 
     # *Cluster mode only* Code to run when a worker boots to setup
@@ -192,7 +259,7 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_boot(&block)
-      @options[:before_worker_boot] << block
+      _ary(:before_worker_boot) << block
     end
 
     # *Cluster mode only* Code to run when a master process is
@@ -201,7 +268,7 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def on_worker_fork(&block)
-      @options[:before_worker_fork] << block
+      _ary(:before_worker_fork) << block
     end
 
     # *Cluster mode only* Code to run when a worker boots to setup
@@ -210,12 +277,18 @@ module Puma
     # This can be called multiple times to add hooks.
     #
     def after_worker_boot(&block)
-      @options[:after_worker_boot] << block
+      _ary(:after_worker_fork) << block
     end
 
     # The directory to operate out of.
     def directory(dir)
       @options[:directory] = dir.to_s
+
+      worker_directory dir
+    end
+
+    # Set the directory for workers to start in
+    def worker_directory(dir)
       @options[:worker_directory] = dir.to_s
     end
 
@@ -259,7 +332,7 @@ module Puma
 
     # Additional text to display in process listing
     def tag(string)
-      @options[:tag] = string
+      @options[:tag] = string.to_s
     end
 
     # *Cluster mode only* Set the timeout for workers in seconds
@@ -344,5 +417,11 @@ module Puma
         raise "Invalid value for set_remote_address - #{val}"
       end
     end
+
+    private
+
+    def _ary(key)
+      (@options.cur[key] ||= [])
+    end
   end
 end