unicorn 0.91.0 → 0.92.0

data/GNUmakefile

@@ -1,8 +1,15 @@
 # use GNU Make to run tests in parallel, and without depending on Rubygems
 all:: test
 ruby = ruby
+rake = rake
 ragel = ragel
+GIT_URL = $(shell git config --get remote.origin.url 2>/dev/null || \
+           echo git://git.bogomips.org/unicorn.git)
 RLFLAGS = -G2
+
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
 -include local.mk
 ruby_bin := $(shell which $(ruby))
 ifeq ($(DLEXT),) # "so" for Linux
@@ -29,8 +36,9 @@ test_prefix = $(CURDIR)/test/install-$(RUBY_VERSION)
 
 ext := ext/unicorn_http
 c_files := $(ext)/unicorn_http.c $(wildcard $(ext)/*.h)
-rl_files := $(addprefix $(ext)/,unicorn_http.rl unicorn_http_common.rl)
-rb_files := $(shell grep '^\(bin\|lib\)' Manifest)
+rl_files := $(wildcard $(ext)/*.rl)
+bins := $(wildcard bin/*)
+rb_files := $(bins) $(shell find lib -type f -name '*.rb')
 inst_deps := $(c_files) $(rb_files)
 
 ragel: $(ext)/unicorn_http.c
@@ -48,13 +56,11 @@ http: lib/unicorn_http.$(DLEXT)
 
 $(test_prefix)/.stamp: $(inst_deps)
 	mkdir -p $(test_prefix)/.ccache
-	tar c `cat Manifest` | (cd $(test_prefix) && tar x)
+	tar c `cat .manifest` | (cd $(test_prefix) && tar x)
 	$(MAKE) -C $(test_prefix) clean
 	$(MAKE) -C $(test_prefix) http shebang
 	> $@
 
-bins := $(wildcard bin/*)
-
 # this is only intended to be run within $(test_prefix)
 shebang: $(bins)
 	$(ruby) -i -p -e '$$_.gsub!(%r{^#!.*$$},"#!$(ruby_bin)")' $^
@@ -119,20 +125,54 @@ prep_setup_rb := @-$(RM) $(setup_rb_files);$(MAKE) -C $(ext) clean
 
 clean:
 	-$(MAKE) -C $(ext) clean
+	-$(MAKE) -C Documentation clean
 	$(RM) $(ext)/Makefile lib/unicorn_http.$(DLEXT)
 	$(RM) $(setup_rb_files) $(t_log)
-	$(RM) -r $(test_prefix)
-
-Manifest:
-	(git ls-files && echo $(ext)/unicorn_http.c) | LC_ALL=C sort > $@+
+	$(RM) -r $(test_prefix) man
+
+man:
+	$(MAKE) -C Documentation install-man
+.manifest: GIT-VERSION-FILE NEWS ChangeLog $(ext)/unicorn_http.c
+	$(MAKE) man
+	(git ls-files && \
+         for i in $@ $^ $(wildcard man/*/*.1); \
+	 do echo $$i; done) | LC_ALL=C sort > $@+
 	cmp $@+ $@ || mv $@+ $@
-	$(RM) -f $@+
+	$(RM) $@+
+
+NEWS: GIT-VERSION-FILE
+	$(rake) -s news_rdoc > $@+
+	mv $@+ $@
+
+ChangeLog: GIT-VERSION-FILE
+	@echo "ChangeLog from $(GIT_URL) ($(GIT_VERSION))" > $@+
+	@echo >> $@+
+	git log | sed -e 's/^/    /' >> $@+
+	mv $@+ $@
+
+news_atom := http://unicorn.bogomips.org/NEWS.atom.xml
+cgit_atom := http://git.bogomips.org/cgit/unicorn.git/atom/?h=master
+atom = <link rel="alternate" title="Atom feed" href="$(1)" \
+             type="application/atom+xml"/>
 
 # using rdoc 2.4.1+
-doc: .document $(ext)/unicorn_http.c
+doc: .document $(ext)/unicorn_http.c NEWS ChangeLog
+	> unicorn.1 && > unicorn_rails.1
 	rdoc -Na -t "$(shell sed -ne '1s/^= //p' README)"
-	install -m644 COPYING doc/COPYING
-	cd doc && ln README.html tmp.html && mv tmp.html index.html
+	install -m644 $(shell grep '^[A-Z]' .document)  doc/
+	$(MAKE) -C Documentation install-html
+	cd doc && for i in unicorn unicorn_rails; do \
+	  sed -e '/"documentation">/r man1/'$$i'.1.html' \
+		< $${i}_1.html > tmp && mv tmp $${i}_1.html; done
+	$(ruby) -i -p -e \
+	  '$$_.gsub!("</title>",%q{\&$(call atom,$(cgit_atom))})' \
+	  doc/ChangeLog.html
+	$(ruby) -i -p -e \
+	  '$$_.gsub!("</title>",%q{\&$(call atom,$(news_atom))})' \
+	  doc/NEWS.html doc/README.html
+	$(rake) -s news_atom > doc/NEWS.atom.xml
+	cd doc && ln README.html tmp && mv tmp index.html
+	$(RM) unicorn.1 unicorn_rails.1
 
 rails_git_url = git://github.com/rails/rails.git
 rails_git := vendor/rails.git
@@ -153,4 +193,52 @@ $(T_r).%.r: export RAILS_GIT_REPO = $(CURDIR)/$(rails_git)
 $(T_r).%.r: $(test_prefix)/.stamp $(rails_git)/info/cloned-stamp
 	$(run_test)
 
-.PHONY: doc $(T) $(slow_tests) Manifest
+ifneq ($(VERSION),)
+rfproject := mongrel
+rfpackage := unicorn
+pkggem := pkg/$(rfpackage)-$(VERSION).gem
+pkgtgz := pkg/$(rfpackage)-$(VERSION).tgz
+release_notes := release_notes-$(VERSION)
+release_changes := release_changes-$(VERSION)
+
+release-notes: $(release_notes)
+release-changes: $(release_changes)
+$(release_changes):
+	$(rake) -s release_changes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+$(release_notes):
+	GIT_URL=$(GIT_URL) $(rake) -s release_notes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+
+# ensures we're actually on the tagged $(VERSION), only used for release
+verify:
+	git rev-parse --verify refs/tags/v$(VERSION)^{}
+	git diff-index --quiet HEAD^0
+	test `git rev-parse --verify HEAD^0` = \
+	     `git rev-parse --verify refs/tags/v$(VERSION)^{}`
+
+$(pkggem): .manifest
+	gem build $(rfpackage).gemspec
+	mkdir -p pkg
+	mv $(@F) $@
+
+$(pkgtgz): distdir = $(basename $@)
+$(pkgtgz): HEAD = v$(VERSION)
+$(pkgtgz): .manifest
+	@test -n "$(distdir)"
+	$(RM) -r $(distdir)
+	mkdir -p $(distdir)
+	tar c `cat .manifest` | (cd $(distdir) && tar x)
+	cd pkg && tar c $(basename $(@F)) | gzip -9 > $(@F)+
+	mv $@+ $@
+
+package: $(pkgtgz) $(pkggem)
+
+release: verify package $(release_notes) $(release_changes)
+	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+	rubyforge add_file \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+endif
+
+.PHONY: .FORCE-GIT-VERSION-FILE doc $(T) $(slow_tests) .manifest man

data/README

@@ -6,7 +6,7 @@
   cut out everything that is better supported by the operating system,
   {nginx}[http://nginx.net/] or {Rack}[http://rack.rubyforge.org/].
 
-* Compatible with both Ruby 1.8 and 1.9, Rubinius support is planned.
+* Compatible with both Ruby 1.8 and 1.9.  Rubinius support is in-progress.
 
 * Process management: Unicorn will reap and restart workers that
   die from broken apps.  There is no need to manage multiple processes
@@ -53,7 +53,7 @@
 
 == Versions
 
-{Current v0.90.0}[http://git.bogomips.org/cgit/unicorn.git/tag/?id=v0.90.0]
+{Current v0.92.0}[http://git.bogomips.org/cgit/unicorn.git/tag/?id=v0.92.0]
 
 {Old Stable v0.8.4}[http://git.bogomips.org/cgit/unicorn.git/tag/?id=v0.8.4]
 
@@ -166,3 +166,4 @@ to post on the mailing list.  No top posting.  Address replies +To:+ (or
 * nntp: nntp://news.gmane.org/gmane.comp.lang.ruby.unicorn.general
 * archives: http://rubyforge.org/pipermail/mongrel-unicorn/
 * subscribe: http://rubyforge.org/mailman/listinfo/mongrel-unicorn/
+* finger: unicorn@bogomips.org

data/Rakefile

@@ -1,38 +1,110 @@
+# -*- encoding: binary -*-
 
-require 'rubygems'
-require 'echoe'
-
-Echoe.new("unicorn") do |p|
-  p.summary = "Rack HTTP server for Unix, fast clients and nothing else"
-  p.author = "Eric Wong"
-  p.email = "normalperson@yhbt.net"
-  p.clean_pattern = ['ext/unicorn_http/*.{bundle,so,o,obj,pdb,lib,def,exp}',
-                     'lib/*.{bundle,so,o,obj,pdb,lib,def,exp}',
-                     'ext/unicorn_http/Makefile',
-                     'pkg', 'lib/*.bundle', '*.gem',
-                     'site/output', '.config', 'coverage',
-                     'test_*.log', 'log', 'doc']
-  p.url = "http://unicorn.bogomips.org/"
-  p.ignore_pattern = /^(pkg|site|projects|doc|log)|CVS|\.log/
-  p.need_tar_gz = false
-  p.need_tgz = true
-  p.dependencies = [ 'rack' ]
-
-  p.extension_pattern = ["ext/**/extconf.rb"]
-
-  # Eric hasn't bothered to figure out running exec tests properly
-  # from Rake, but Eric prefers GNU make to Rake for tests anyways...
-  p.test_pattern = [ 'test/unit/test*.rb' ]
+# most tasks are in the GNUmakefile which offers better parallelism
+
+def old_summaries
+  @old_summaries ||= File.readlines(".CHANGELOG.old").inject({}) do |hash, line|
+    version, summary = line.split(/ - /, 2)
+    hash[version] = summary
+    hash
+  end
+end
+
+def tags
+  timefmt = '%Y-%m-%dT%H:%M:%SZ'
+  @tags ||= `git tag -l`.split(/\n/).map do |tag|
+    next if tag == "v0.0.0"
+    if %r{\Av[\d\.]+\z} =~ tag
+      header, subject, body = `git cat-file tag #{tag}`.split(/\n\n/, 3)
+      header = header.split(/\n/)
+      tagger = header.grep(/\Atagger /).first
+      body ||= "initial"
+      {
+        :time => Time.at(tagger.split(/ /)[-2].to_i).utc.strftime(timefmt),
+        :tagger_name => %r{^tagger ([^<]+)}.match(tagger)[1],
+        :tagger_email => %r{<([^>]+)>}.match(tagger)[1],
+        :id => `git rev-parse refs/tags/#{tag}`.chomp!,
+        :tag => tag,
+        :subject => subject,
+        :body => (old = old_summaries[tag]) ? "#{old}\n#{body}" : body,
+      }
+    end
+  end.compact.sort { |a,b| b[:time] <=> a[:time] }
+end
+
+cgit_url = "http://git.bogomips.org/cgit/unicorn.git"
+
+desc 'prints news as an Atom feed'
+task :news_atom do
+  require 'nokogiri'
+  new_tags = tags[0,10]
+  puts(Nokogiri::XML::Builder.new do
+    feed :xmlns => "http://www.w3.org/2005/Atom" do
+      id! "http://unicorn.bogomips.org/NEWS.atom.xml"
+      title "Unicorn news"
+      subtitle "Rack HTTP server for Unix and fast clients"
+      link! :rel => 'alternate', :type => 'text/html',
+            :href => 'http://unicorn.bogomips.org/NEWS.html'
+      updated new_tags.first[:time]
+      new_tags.each do |tag|
+        entry do
+          title tag[:subject]
+          updated tag[:time]
+          published tag[:time]
+          author {
+            name tag[:tagger_name]
+            email tag[:tagger_email]
+          }
+          url = "#{cgit_url}/tag/?id=#{tag[:tag]}"
+          link! :rel => "alternate", :type => "text/html", :href =>url
+          id! url
+          content(:type => 'text') { tag[:body] }
+        end
+      end
+    end
+  end.to_xml)
 end
 
-#### Ragel builder
+desc 'prints RDoc-formatted news'
+task :news_rdoc do
+  tags.each do |tag|
+    time = tag[:time].tr!('T', ' ').gsub!(/:\d\dZ/, ' UTC')
+    puts "=== #{tag[:tag].sub(/^v/, '')} / #{time}"
+    puts ""
 
-desc "Rebuild the Ragel sources"
-task :ragel do
-  Dir.chdir "ext/unicorn_http" do
-    target = "unicorn_http.c"
-    File.unlink target if File.exist? target
-    sh "ragel unicorn_http.rl -C -G2 -o #{target}"
-    raise "Failed to build C source" unless File.exist? target
+    body = tag[:body]
+    puts tag[:body].gsub(/^/sm, "  ").gsub!(/[ \t]+$/sm, "")
+    puts ""
   end
 end
+
+desc "print release changelog for Rubyforge"
+task :release_changes do
+  version = ENV['VERSION'] or abort "VERSION= needed"
+  version = "v#{version}"
+  vtags = tags.map { |tag| tag[:tag] =~ /\Av/ and tag[:tag] }.sort
+  prev = vtags[vtags.index(version) - 1]
+  system('git', 'diff', '--stat', prev, version) or abort $?
+  puts ""
+  system('git', 'log', "#{prev}..#{version}") or abort $?
+end
+
+desc "print release notes for Rubyforge"
+task :release_notes do
+  require 'rubygems'
+
+  git_url = ENV['GIT_URL'] ||
+            `git config --get remote.origin.url 2>/dev/null`.chomp! ||
+            'git://git.bogomips.org/unicorn.git'
+
+  spec = Gem::Specification.load('unicorn.gemspec')
+  puts spec.description.strip
+  puts ""
+  puts "* #{spec.homepage}"
+  puts "* #{spec.email}"
+  puts "* #{git_url}"
+
+  _, _, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+  print "\nChanges:\n\n"
+  puts body
+end

data/SIGNALS

@@ -1,7 +1,7 @@
 == Signal handling
 
 In general, signals need only be sent to the master process.  However,
-the signals unicorn uses internally to communicate with the worker
+the signals Unicorn uses internally to communicate with the worker
 processes are documented here as well.
 
 === Master Process
@@ -54,9 +54,7 @@ losing any incoming connections.  Doing so will reload all of your
 application code, Unicorn config, Ruby executable, and all libraries.
 The only things that will not change (due to OS limitations) are:
 
-1. The listener backlog size of already-bound sockets
-
-2. The path to the unicorn executable script.  If you want to change to
+1. The path to the unicorn executable script.  If you want to change to
    a different installation of Ruby, you can modify the shebang
    line to point to your alternative interpreter.
 

data/TODO

@@ -1,11 +1,5 @@
-* security audit, fuzz testing
+* Documentation improvements
 
-* manpages (why do so few Ruby executables come with proper manpages?)
+* launchers - add --kill switch to allow DRY pid file path definition
 
-* code cleanups
-
-* launchers - add stop/start/kill/upgrade commands
-
-* Rainbows!
-
-* Rubinius support
+* Rainbows! (http://article.gmane.org/gmane.comp.lang.ruby.unicorn.general/22)

data/bin/unicorn

@@ -1,4 +1,5 @@
 #!/home/ew/bin/ruby
+# -*- encoding: binary -*-
 require 'unicorn/launcher'
 require 'optparse'
 
@@ -64,7 +65,9 @@ opts = OptionParser.new("", 24, '  ') do |opts|
     daemonize = d ? true : false
   end
 
-  opts.on("-P", "--pid FILE", "file to store PID (default: none)") do |f|
+  opts.on("-P", "--pid FILE", "DEPRECATED") do |f|
+    warn %q{Use of --pid/-P is strongly discouraged}
+    warn %q{Use the 'pid' directive in the Unicorn config file instead}
     options[:pid] = File.expand_path(f)
   end
 
@@ -93,7 +96,7 @@ opts = OptionParser.new("", 24, '  ') do |opts|
   opts.separator "Common options:"
 
   opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
+    puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
     exit
   end
 

data/bin/unicorn_rails

@@ -1,4 +1,5 @@
 #!/home/ew/bin/ruby
+# -*- encoding: binary -*-
 require 'unicorn/launcher'
 require 'optparse'
 require 'fileutils'
@@ -78,8 +79,9 @@ opts = OptionParser.new("", 24, '  ') do |opts|
     options[:config_file] = File.expand_path(f)
   end
 
-  opts.on("-P", "--path PATH", "Runs Rails app mounted at a specific path.",
-          "(default: /") do |v|
+  opts.on("-P", "--path PATH", "DEPRECATED") do |v|
+    warn %q{Use of --path/-P is strongly discouraged}
+    warn %q{Use the 'map' directive in the rackup config instead}
     ENV['RAILS_RELATIVE_URL_ROOT'] = map_path = v
   end
 
@@ -91,7 +93,7 @@ opts = OptionParser.new("", 24, '  ') do |opts|
   opts.separator "Common options:"
 
   opts.on_tail("-h", "--help", "Show this message") do
-    puts opts
+    puts opts.to_s.gsub(/^.*DEPRECATED.*$/s, '')
     exit
   end
 

data/ext/unicorn_http/c_util.h

@@ -27,7 +27,7 @@
 #  endif
 #else
 #  error off_t size unknown for this platform!
-#endif
+#endif /* SIZEOF_OFF_T check */
 
 /*
  * capitalizes all lower-case ASCII characters and converts dashes
@@ -56,7 +56,7 @@ static int hexchar2int(int xdigit)
     return xdigit - 'a' + 10;
 
   /* Ragel already does runtime range checking for us in Unicorn: */
-  assert(xdigit >= '0' && xdigit <= '9');
+  assert(xdigit >= '0' && xdigit <= '9' && "invalid digit character");
 
   return xdigit - '0';
 }

data/ext/unicorn_http/common_field_optimization.h

@@ -103,7 +103,8 @@ static VALUE uncommon_field(const char *field, size_t flen)
   VALUE f = rb_str_new(NULL, HTTP_PREFIX_LEN + flen);
   memcpy(RSTRING_PTR(f), HTTP_PREFIX, HTTP_PREFIX_LEN);
   memcpy(RSTRING_PTR(f) + HTTP_PREFIX_LEN, field, flen);
-  assert(*(RSTRING_PTR(f) + RSTRING_LEN(f)) == '\0'); /* paranoia */
+  assert(*(RSTRING_PTR(f) + RSTRING_LEN(f)) == '\0' &&
+         "string didn't end with \\0"); /* paranoia */
   return rb_obj_freeze(f);
 }
 

data/ext/unicorn_http/ext_help.h

@@ -3,10 +3,15 @@
 
 #ifndef RSTRING_PTR
 #define RSTRING_PTR(s) (RSTRING(s)->ptr)
-#endif
+#endif /* !defined(RSTRING_PTR) */
 #ifndef RSTRING_LEN
 #define RSTRING_LEN(s) (RSTRING(s)->len)
-#endif
+#endif /* !defined(RSTRING_LEN) */
+
+#ifndef RUBINIUS
+#  define rb_str_update(x) do {} while (0)
+#  define rb_str_flush(x) do {} while (0)
+#endif /* !RUBINIUS */
 
 #ifndef HAVE_RB_STR_SET_LEN
 /* this is taken from Ruby 1.8.7, 1.8.6 may not have it */
@@ -14,9 +19,29 @@ static void rb_18_str_set_len(VALUE str, long len)
 {
   RSTRING(str)->len = len;
   RSTRING(str)->ptr[len] = '\0';
+  rb_str_flush(str);
 }
 #  define rb_str_set_len(str,len) rb_18_str_set_len(str,len)
-#endif
+#endif /* !defined(HAVE_RB_STR_SET_LEN) */
+
+/* not all Ruby implementations support frozen objects (Rubinius does not) */
+#if defined(OBJ_FROZEN)
+#  define assert_frozen(f) assert(OBJ_FROZEN(f) && "unfrozen object")
+#else
+#  define assert_frozen(f) do {} while (0)
+#endif /* !defined(OBJ_FROZEN) */
+
+#if !defined(OFFT2NUM)
+#  if SIZEOF_OFF_T == SIZEOF_LONG
+#    define OFFT2NUM(n) LONG2NUM(n)
+#  else
+#    define OFFT2NUM(n) LL2NUM(n)
+#  endif
+#endif /* ! defined(OFFT2NUM) */
+
+#ifndef HAVE_RB_STR_MODIFY
+#  define rb_str_modify(x) do {} while (0)
+#endif /* ! defined(HAVE_RB_STR_MODIFY) */
 
 static inline int str_cstr_eq(VALUE val, const char *ptr, size_t len)
 {
@@ -45,4 +70,4 @@ static int str_cstr_case_eq(VALUE val, const char *ptr, size_t len)
 #define STR_CSTR_CASE_EQ(val, const_str) \
   str_cstr_case_eq(val, const_str, sizeof(const_str) - 1)
 
-#endif
+#endif /* ext_help_h */