puma 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 898a1954d5ebcc2e339fa1b455a0f772922550d9
-  data.tar.gz: ed25f3dcea9438077229cfbfc9e4feca966a1190
+  metadata.gz: 74aab6aaab377487d53393978bbb59ffae181f66
+  data.tar.gz: 383b6735116a87480a5c73403107de1941da3e99
 SHA512:
-  metadata.gz: 81e27d75599ba7fe68b342c375ba5bf1f80f8e6859072950ea20beb3de14a5c9c18272231c3d66734bab76622a258489a8e9bad6c8bedaaf7aae67e22dcfd980
-  data.tar.gz: 17251b4e6c9af4e7af501e3974e7c42e836ac95798793e8b05df01cdb19cd8d9178ed960b84adb2030fb475d584fb0dee6fc01ff07e0ae5be40dd98199dba079
+  metadata.gz: 2d9663eec2cf39f8e7471937887633cb56a6b8a8989ab3055a8c64497637decc45b56b9d87d2873004ee56665ba9d8386da28c1dd9d216ff9c15942a5961a1e5
+  data.tar.gz: e65857e59cda95b3980761ec5bf8b00f55c55fa1798d6dc43c56c775e84872f7d36d28a5260c232c360f354d4fe865fcc9a76e731b1430e7f26d6291066c60fd

data/DEPLOYMENT.md

@@ -0,0 +1,92 @@
+# Deployment engineering for puma
+
+Puma is software that is expected to be run in a deployed environment eventually.
+You can centainly use it as your dev server only, but most people look to use
+it in their production deployments as well.
+
+To that end, this is meant to serve as a foundation of wisdom how to do that
+in a way that increases happiness and decreases downtime.
+
+## Specifying puma
+
+Most people want to do this by putting `gem "puma"` into their Gemfile, so we'll
+go ahead and assume that. Go add it now... we'll wait.
+
+
+Welcome back!
+
+## Single vs Cluster mode
+
+Puma was originally concieved as a thread-only webserver, but grew the ability to
+also use processes in version 2.
+
+Here are some rules of thumb:
+
+### MRI
+
+* Use cluster mode and set the number of workers to 1.5x the number of cpu cores
+  in the machine, minimum 2.
+* Set the number of threads to desired concurrent requests / number of workers.
+  Puma defaults to 8 and thats a decent number.
+
+#### Migrating from Unicorn
+
+* If you're migrating from unicorn though, here are some settings to start with:
+  * Set workers to half the number of unicorn workers you're using
+  * Set threads to 2
+  * Enjoy 50% memory savings
+* As you grow more confident in the thread safety of your app, you can tune the
+  workers down and the threads up.
+
+#### Worker utilization
+
+**How do you know if you're got enough (or too many workers)?**
+
+A good question. Due to MRI's GIL, only one thread can be executing at a time.
+But since so many apps are waiting on IO from DBs, etc., they can utilize threads
+to make better use of the process.
+
+The rule of thumb is you never want processes that are pegged all the time. This
+means that there is more work to do that the process can get through. On the other
+hand, if you have processes that sit around doing nothing, then they're just eating
+up resources.
+
+Watching your CPU utilization over time and aim for about 70% on average. This means
+you've got capacity still but aren't starving threads.
+
+## Daemonizing
+
+I prefer to not daemonize my servers and use something like `runit` or `upstrart` to
+monitor them as child processes. This gives them fast response to crashes and
+makes it easy to figure out what is going on. Additionally, unlike `unicorn`,
+puma does not require daemonization to do zero-downtime restarts.
+
+I see people using daemonization because they start puma directly via capistrano
+task and thus want it to live on past the `cap deploy`. To this people I said:
+You need to be using a process monitor. Nothing is making sure puma stays up in
+this scenario! You're just waiting for something weird to happen, puma to die,
+and to get paged at 3am. Do yourself a favor, at least the process monitoring
+your OS comes with, be it `sysvinit`, `upstart`, or `systemd`. Or branch out
+and use `runit` or hell, even `monit`.
+
+## Restarting
+
+You probably will want to deploy some new code at some point, and you'd like
+puma to start running that new code. Minimizing the amount of time the server
+is unavailable would be nice as well. Here's how to do it:
+
+1. Don't use `preload!`. This dirties the master process and means it will have
+to shutdown all the workers and re-exec itself to get your new code, which means
+much higher waiting around for things to load.
+
+1. Use `prune_bundler`. This makes it so that the cluster master will detach itself
+from a Bundler context on start. This allows the cluster workers to load your app
+and start a brand new Bundler context within the worker only. This means your
+master remains pristine and can live on between new releases of your code.
+
+1. Use phased-restart (`SIGUSR1` or `pumactl phased-restart`). This tells the master
+to kill off one worker at a time and restart them in your new code. This minimizes
+downtime and staggers the restart nicely. **WARNING** This means that both your
+old code and your new code will be running concurrently. Most deployment solutions
+already cause that, but it's worth warning you about it again. Be careful with your
+migrations, etc!

data/History.txt

@@ -1,3 +1,19 @@
+=== 2.8.1 / 2014-03-06
+
+* 1 bug fixes:
+  * Run puma-wild with proper deps for prune_bundler
+
+* 2 doc changes:
+  * Described the configuration file finding behavior added in 2.8.0 and how to disable it.
+  * Start the deployment doc
+
+* 6 PRs merged:
+  * Merge pull request #471 from arthurnn/fix_test
+  * Merge pull request #485 from joneslee85/patch-9
+  * Merge pull request #486 from joshwlewis/patch-1
+  * Merge pull request #490 from tobinibot/patch-1
+  * Merge pull request #491 from brianknight10/clarify-no-config
+
 === 2.8.0 / 2014-02-28
 
 * 8 minor features:

data/Manifest.txt

@@ -1,4 +1,5 @@
 COPYING
+DEPLOYMENT.md
 Gemfile
 History.txt
 LICENSE
@@ -6,6 +7,7 @@ Manifest.txt
 README.md
 Rakefile
 bin/puma
+bin/puma-wild
 bin/pumactl
 docs/config.md
 docs/nginx.md

data/README.md

@@ -149,6 +149,12 @@ You can also provide a configuration file which Puma will use with the `-C` (or
 
     $ puma -C /path/to/config
 
+By default, if no configuration file is specifed, Puma will look for a configuration file at config/puma.rb. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` environment variable, the default file location will be config/puma/environment_name.rb.
+
+If you want to prevent Puma from looking for a configuration file in those locations, provide a dash as the argument to the `-C` (or `--config`) flag:
+
+    $ puma -C "-"
+
 Take the following [sample configuration](https://github.com/puma/puma/blob/master/examples/config.rb) as inspiration or check out [configuration.rb](https://github.com/puma/puma/blob/master/lib/puma/configuration.rb) to see all available options.
 
 ## Restart

data/bin/puma-wild

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2014 Evan Phoenix
+#
+
+require 'rubygems'
+
+deps = ARGV.shift.split(",").each do |s|
+  name, ver = s.split(":",2)
+  gem name, ver
+end
+
+require 'puma/cli'
+
+cli = Puma::CLI.new ARGV
+
+cli.run

data/lib/puma/cli.rb

@@ -456,14 +456,27 @@ module Puma
       end
 
       if prune_bundler? && defined?(Bundler)
-        puma_lib_dir = $:.detect { |d| File.exist? File.join(d, "puma", "const.rb") }
+        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"
           Bundler.with_clean_env do
-            Kernel.exec(Gem.ruby, "-I", puma_lib_dir,
-                        File.expand_path(puma_lib_dir + "/../bin/puma"),
-                        *@original_argv)
+
+            wild = File.expand_path(File.join(puma_lib_dir, "../bin/puma-wild"))
+
+            args = [Gem.ruby] + dirs.map { |x| ["-I", x] }.flatten +
+                   [wild, deps] + @original_argv
+
+            Kernel.exec(*args)
           end
         end
 

data/lib/puma/const.rb

@@ -28,8 +28,8 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "2.8.0".freeze
-    CODE_NAME = "Sir Edmund Percival Hillary"
+    PUMA_VERSION = VERSION = "2.8.1".freeze
+    CODE_NAME = "Sir Edmund Percival Hillary".freeze
 
     FAST_TRACK_KA_TIMEOUT = 0.2
 
@@ -58,7 +58,7 @@ module Puma
     PUMA_TMP_BASE = "puma".freeze
 
     # Indicate that we couldn't parse the request
-    ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n"
+    ERROR_400_RESPONSE = "HTTP/1.1 400 Bad Request\r\n\r\n".freeze
 
     # The standard empty 404 response for bad requests.  Use Error4040Handler for custom stuff.
     ERROR_404_RESPONSE = "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze
@@ -69,7 +69,7 @@ module Puma
     CONTENT_LENGTH = "CONTENT_LENGTH".freeze
 
     # Indicate that there was an internal error, obviously.
-    ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n"
+    ERROR_500_RESPONSE = "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze
 
     # A common header for indicating the server is too busy.  Not used yet.
     ERROR_503_RESPONSE = "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze

data/test/test_http11.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2011 Evan Phoenix
-# Copyright (c) 2005 Zed A. Shaw 
+# Copyright (c) 2005 Zed A. Shaw
 
-require 'test/testhelp'
+require 'testhelp'
 
 include Puma
 
@@ -24,11 +24,11 @@ class Http11ParserTest < Test::Unit::TestCase
     assert_equal 'GET', req['REQUEST_METHOD']
     assert_nil req['FRAGMENT']
     assert_nil req['QUERY_STRING']
-    
+
     parser.reset
     assert parser.nread == 0, "Number read after reset should be 0"
   end
- 
+
   def test_parse_dumbfuck_headers
     parser = HttpParser.new
     req = {}
@@ -38,7 +38,7 @@ class Http11ParserTest < Test::Unit::TestCase
     assert parser.finished?
     assert !parser.error?
   end
-  
+
   def test_parse_error
     parser = HttpParser.new
     req = {}
@@ -72,7 +72,7 @@ class Http11ParserTest < Test::Unit::TestCase
   def rand_data(min, max, readable=true)
     count = min + ((rand(max)+1) *10).to_i
     res = count.to_s + "/"
-    
+
     if readable
       res << Digest::SHA1.hexdigest(rand(count * 100).to_s) * (count / 40)
     else
@@ -142,4 +142,3 @@ class Http11ParserTest < Test::Unit::TestCase
 
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.8.1
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -84,6 +84,7 @@ executables:
 extensions:
 - ext/puma_http11/extconf.rb
 extra_rdoc_files:
+- DEPLOYMENT.md
 - History.txt
 - Manifest.txt
 - README.md
@@ -95,6 +96,7 @@ extra_rdoc_files:
 - tools/jungle/upstart/README.md
 files:
 - COPYING
+- DEPLOYMENT.md
 - Gemfile
 - History.txt
 - LICENSE
@@ -102,6 +104,7 @@ files:
 - README.md
 - Rakefile
 - bin/puma
+- bin/puma-wild
 - bin/pumactl
 - docs/config.md
 - docs/nginx.md
@@ -152,14 +155,6 @@ files:
 - lib/puma/util.rb
 - lib/rack/handler/puma.rb
 - puma.gemspec
-- tools/jungle/README.md
-- tools/jungle/init.d/README.md
-- tools/jungle/init.d/puma
-- tools/jungle/init.d/run-puma
-- tools/jungle/upstart/README.md
-- tools/jungle/upstart/puma-manager.conf
-- tools/jungle/upstart/puma.conf
-- tools/trickletest.rb
 - test/test_app_status.rb
 - test/test_cli.rb
 - test/test_config.rb
@@ -177,6 +172,14 @@ files:
 - test/test_thread_pool.rb
 - test/test_unix_socket.rb
 - test/test_ws.rb
+- tools/jungle/README.md
+- tools/jungle/init.d/README.md
+- tools/jungle/init.d/puma
+- tools/jungle/init.d/run-puma
+- tools/jungle/upstart/README.md
+- tools/jungle/upstart/puma-manager.conf
+- tools/jungle/upstart/puma.conf
+- tools/trickletest.rb
 homepage: http://puma.io
 licenses:
 - BSD
@@ -199,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: puma
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for