kcar 0.1.2 → 0.2.0

data/.gitignore

@@ -18,3 +18,5 @@ pkg/
 /man
 tags
 TAGS
+/tmp
+/LATEST

data/.wrongdoc.yml

@@ -0,0 +1,4 @@
+---
+cgit_url: http://bogomips.org/kcar.git
+git_url: git://bogomips.org/kcar.git
+rdoc_url: http://bogomips.org/kcar/

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v0.1.2.GIT
+DEF_VER=v0.2.0.GIT
 
 LF='
 '

data/GNUmakefile

@@ -1,198 +1,17 @@
-# use GNU Make to run tests in parallel, and without depending on RubyGems
 all::
-RUBY = ruby
-RAKE = rake
+RSYNC_DEST := bogomips.org:/srv/bogomips/kcar
 RAGEL = ragel
-GIT_URL = git://git.bogomips.org/kcar.git
 RLFLAGS = -G2
-RSYNC = rsync
-
-GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
-	@./GIT-VERSION-GEN
--include GIT-VERSION-FILE
--include local.mk
-ifeq ($(DLEXT),) # "so" for Linux
-  DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts Config::CONFIG["DLEXT"]')
-endif
-ifeq ($(RUBY_VERSION),)
-  RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
-endif
-
-install: $(bins)
-	$(prep_setup_rb)
-	$(RM) -r .install-tmp
-	mkdir .install-tmp
-	cp -p bin/* .install-tmp
-	$(RUBY) setup.rb all
-	$(RM) $^
-	mv .install-tmp/* bin/
-	$(RM) -r .install-tmp
-	$(prep_setup_rb)
-
-setup_rb_files := .config InstalledFiles
-prep_setup_rb := @-$(RM) $(setup_rb_files);$(MAKE) -C $(ext) clean
-
-clean:
-	-$(MAKE) -C ext/kcar clean
-	$(RM) $(setup_rb_files) ext/kcar/Makefile
-
-pkg_extra := GIT-VERSION-FILE NEWS ChangeLog ext/kcar/kcar.c
-manifest: $(pkg_extra)
-	$(RM) .manifest
-	$(MAKE) .manifest
-
-.manifest:
-	(git ls-files && \
-         for i in $@ $(pkg_extra) $(man1_paths); \
-	 do echo $$i; done) | LC_ALL=C sort > $@+
-	cmp $@+ $@ || mv $@+ $@
-	$(RM) $@+
-
-NEWS: GIT-VERSION-FILE
-	$(RAKE) -s news_rdoc > $@+
-	mv $@+ $@
-
-latest: NEWS
-	@awk 'BEGIN{RS="=== ";ORS=""}NR==2{sub(/\n$$/,"");print RS""$$0 }' $<
-
-SINCE = 0.1.0
-ChangeLog: LOG_VERSION = \
-  $(shell git rev-parse -q "$(GIT_VERSION)" >/dev/null 2>&1 && \
-          echo $(GIT_VERSION) || git describe)
-ifneq ($(SINCE),)
-ChangeLog: log_range = v$(SINCE)..$(LOG_VERSION)
-endif
-ChangeLog: GIT-VERSION-FILE
-	@echo "ChangeLog from $(GIT_URL) ($(log_range))" > $@+
-	@echo >> $@+
-	git log $(log_range) | sed -e 's/^/    /' >> $@+
-	mv $@+ $@
-
-news_atom := http://bogomips.org/kcar/NEWS.atom.xml
-cgit_atom := http://git.bogomips.org/cgit/kcar.git/atom/?h=master
-atom = <link rel="alternate" title="Atom feed" href="$(1)" \
-             type="application/atom+xml"/>
-
-# using rdoc 2.5.x
-doc: .document NEWS ChangeLog
-	rdoc -a -t "$(shell sed -ne '1s/^= //p' README)"
-	install -m644 COPYING doc/COPYING
-	install -m644 $(shell grep '^[A-Z]' .document) doc/
-	$(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
-
-ifneq ($(VERSION),)
 rfproject := rainbows
 rfpackage := kcar
-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:
-	test x"$(shell umask)" = x0022
-	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)^{}`
-
-fix-perms:
-	-git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
-	-git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
-
-gem: $(pkggem)
-
-install-gem: $(pkggem)
-	gem install $(CURDIR)/$<
-
-$(pkggem): manifest fix-perms
-	gem build $(rfpackage).gemspec
-	mkdir -p pkg
-	mv $(@F) $@
-
-$(pkgtgz): distdir = $(basename $@)
-$(pkgtgz): HEAD = v$(VERSION)
-$(pkgtgz): manifest fix-perms
-	@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)
-
-test-release: verify package $(release_notes) $(release_changes)
-release: verify package $(release_notes) $(release_changes)
-	# make tgz release on RubyForge
-	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
-	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
-	# push gem to Gemcutter
-	gem push $(pkggem)
-	# in case of gem downloads from RubyForge releases page
-	-rubyforge add_file \
-	  $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
-else
-gem install-gem: GIT-VERSION-FILE
-	$(MAKE) $@ VERSION=$(GIT_VERSION)
-endif
-
-ext := ext/kcar/kcar_ext.$(DLEXT)
-hdr := $(wildcard $(addprefix ext/kcar/,*.h))
-ragel: $(ext)
-ext/kcar/Makefile: ext/kcar/extconf.rb
-	cd $(@D) && $(RUBY) extconf.rb
-
+pkg_extra += ext/kcar/kcar.c
 ext/kcar/kcar.c: ext/kcar/kcar.rl ext/kcar/kcar_http_common.rl
 	cd $(@D) && $(RAGEL) kcar.rl -C $(RLFLAGS) -o $(@F)
-
-$(ext): ext/kcar/kcar.c $(hdr) ext/kcar/Makefile
-	$(MAKE) -C $(@D)
-
-all:: test
-
-build: $(ext)
-test_units := $(wildcard test/test_*.rb)
-test: test-unit
-test-unit: $(test_units)
-$(test_units): build
-	$(RUBY) -w -I lib:ext/kcar $@
-
-# this requires GNU coreutils variants
-publish_doc:
-	-git set-file-times
-	$(RM) -r doc ChangeLog NEWS
-	$(MAKE) doc LOG_VERSION=$(shell git tag -l | tail -1)
-	$(MAKE) -s latest > doc/LATEST
-	find doc/images doc/js -type f | \
-		TZ=UTC xargs touch -d '1970-01-01 00:00:00' doc/rdoc.css
-	$(MAKE) doc_gz
-	chmod 644 $$(find doc -type f)
-	$(RSYNC) -av doc/ dcvr:/srv/bogomips/kcar/
-	git ls-files | xargs touch
-
-# Create gzip variants of the same timestamp as the original so nginx
-# "gzip_static on" can serve the gzipped versions directly.
-doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
-doc_gz:
-	touch doc/NEWS.atom.xml -d "$$(awk 'NR==1{print $$4,$$5,$$6}' NEWS)"
-	for i in $(docs); do \
-	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
-
-.PHONY: .FORCE-GIT-VERSION-FILE doc manifest man test $(test_units)
+include pkg.mk
+$(ext_pfx)/$(ext)/kcar.c: ext/kcar/kcar.c
+$(ext_pfx)/$(ext)/Makefile: ext/kcar/kcar.c
+ifneq ($(VERSION),)
+release::
+	$(RAKE) raa_update VERSION=$(VERSION)
+	$(RAKE) publish_news VERSION=$(VERSION)
+endif

data/README

@@ -5,8 +5,6 @@ kcar features an HTTP parser that will convert a bytestream into a
 agnostic, so it may be used with HTTP streams over Unix domain sockets,
 regular files, FIFOs, StringIOs as well as traditional TCP sockets.
 
-A drop-in, Net::HTTP-compatible interface is planned.
-
 == Features
 
 * RFC2616-compliant Ragel+C parser adapted from Unicorn and Mongrel
@@ -64,13 +62,13 @@ through the body with body.each.
 
 You can get the latest source via git from the following locations:
 
-  git://git.bogomips.org/kcar.git
+  git://bogomips.org/kcar.git
   git://repo.or.cz/kcar.git (mirror)
 
 You may browse the code from the web and download the latest snapshot
 tarballs here:
 
-* http://git.bogomips.org/cgit/kcar.git (cgit)
+* http://bogomips.org/cgit/kcar.git (cgit)
 * http://repo.or.cz/w/kcar.git (gitweb)
 
 Inline patches (from "git format-patch") to the mailing list are

data/Rakefile

@@ -1,8 +1,26 @@
-desc "read news article from STDIN and post to rubyforge"
+# -*- encoding: binary -*-
+require 'wrongdoc'
+cgit_url = Wrongdoc.config[:cgit_url]
+git_url = Wrongdoc.config[:git_url]
+
+desc "post news article to rubyforge"
 task :publish_news do
   require 'rubyforge'
-  IO.select([STDIN], nil, nil, 1) or abort "E: news must be read from stdin"
-  msg = STDIN.readlines
+  spec = Gem::Specification.load('kcar.gemspec')
+  tmp = Tempfile.new('rf-news')
+  _, subject, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+  tmp.puts subject
+  tmp.puts
+  tmp.puts spec.description.strip
+  tmp.puts ""
+  tmp.puts "* #{spec.homepage}"
+  tmp.puts "* #{spec.email}"
+  tmp.puts "* #{git_url}"
+  tmp.print "\nChanges:\n\n"
+  tmp.puts body
+  tmp.flush
+  system(ENV["VISUAL"], tmp.path) or abort "#{ENV["VISUAL"]} failed: #$?"
+  msg = File.readlines(tmp.path)
   subject = msg.shift
   blank = msg.shift
   blank == "\n" or abort "no newline after subject!"
@@ -14,105 +32,8 @@ task :publish_news do
   rf.post_news('rainbows', subject, body)
 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 => body,
-      }
-    end
-  end.compact.sort { |a,b| b[:time] <=> a[:time] }
-end
-
-cgit_url = "http://git.bogomips.org/cgit/kcar.git"
-git_url = ENV['GIT_URL'] || 'git://git.bogomips.org/kcar.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://kcar.rubyforge.org/NEWS.atom.xml"
-      title "Kcar news"
-      subtitle File.readlines("README").first
-      link! :rel => 'alternate', :type => 'text/html',
-            :href => 'http://bogomips.org/kcar/'
-      updated( (new_tags.first[:time] rescue nil) || Time.now )
-      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
-
-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 ""
-
-    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'
-
-  spec = Gem::Specification.load('kcar.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
-
 desc "post to RAA"
 task :raa_update do
-  require 'rubygems'
   require 'net/http'
   require 'net/netrc'
   rc = Net::Netrc.locate('kcar-raa') or abort "~/.netrc not found"

data/TODO

@@ -1,6 +1,2 @@
 Patches to kcar@librelist.com (via git format-patch + git send-email) for
 these would be greatly appreciated
-
-* optional drop-in monkey patch for Net::HTTP
-* optional EventMachine support
-* optional Rev support

data/ext/kcar/ext_help.h

@@ -8,24 +8,17 @@
 #define RSTRING_LEN(s) (RSTRING(s)->len)
 #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
 #  ifdef RUBINIUS
-#    define rb_str_set_len(str,len) rb_str_resize(str,len)
-#  else /* 1.8.6 optimized version */
+#    error we should never get here with current Rubinius (1.x)
+#  endif
 /* this is taken from Ruby 1.8.7, 1.8.6 may not have it */
 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 /* ! RUBINIUS */
+# define rb_str_set_len(str,len) rb_18_str_set_len(str,len)
 #endif /* !defined(HAVE_RB_STR_SET_LEN) */
 
 /* not all Ruby implementations support frozen objects (Rubinius does not) */

data/ext/kcar/kcar.rl

@@ -175,9 +175,9 @@ static void write_value(VALUE hdr, struct http_parser *hp,
   VALUE f, v;
   VALUE hclass;
   const char *fptr = PTR_TO(start.field);
-  long flen = hp->s.field_len;
+  size_t flen = hp->s.field_len;
   const char *vptr;
-  long vlen;
+  size_t vlen;
 
   HP_FL_SET(hp, HASHEADER);
 
@@ -191,8 +191,8 @@ static void write_value(VALUE hdr, struct http_parser *hp,
   vlen = LEN(mark, p);
   VALIDATE_MAX_LENGTH(vlen, FIELD_VALUE);
   VALIDATE_MAX_LENGTH(flen, FIELD_NAME);
-  f = rb_str_new(fptr, flen);
-  v = rb_str_new(vptr, vlen);
+  f = rb_str_new(fptr, (long)flen);
+  v = rb_str_new(vptr, (long)vlen);
 
   /* needs more tests for error-checking here */
   /*
@@ -500,8 +500,6 @@ static VALUE headers(VALUE self, VALUE hdr, VALUE data)
 {
   struct http_parser *hp = data_get(self);
 
-  rb_str_update(data);
-
   http_parser_execute(hp, hdr, RSTRING_PTR(data), RSTRING_LEN(data));
   VALIDATE_MAX_LENGTH(hp->offset, HEADER);
 
@@ -600,7 +598,6 @@ static VALUE filter_body(VALUE self, VALUE buf, VALUE data)
   char *dptr;
   long dlen;
 
-  rb_str_update(data);
   dptr = RSTRING_PTR(data);
   dlen = RSTRING_LEN(data);
 

data/kcar.gemspec

@@ -1,40 +1,25 @@
 ENV["VERSION"] or abort "VERSION= must be specified"
 manifest = File.readlines('.manifest').map! { |x| x.chomp! }
-summary = File.readlines("README")[0].gsub(/\A=\s+\S+[^\w]+/, '').strip
-description = File.read("README").split(/\n\n/)[1].strip
+require 'wrongdoc'
+extend Wrongdoc::Gemspec
+name, summary, title = readme_metadata
 
 Gem::Specification.new do |s|
   s.name = %q{kcar}
-  s.version = ENV["VERSION"]
-
-  s.homepage = 'http://bogomips.org/kcar/'
+  s.version = ENV["VERSION"].dup
+  s.homepage = Wrongdoc.config[:rdoc_url]
   s.authors = ["kcar hackers"]
   s.date = Time.now.utc.strftime('%Y-%m-%d')
-  s.description = description
-  s.email = %q{kcar@librelist.com}
-
-  s.extra_rdoc_files = File.readlines('.document').map! do |x|
-    x.chomp!
-    if File.directory?(x)
-      manifest.grep(%r{\A#{x}/})
-    elsif File.file?(x)
-      x
-    else
-      nil
-    end
-  end.flatten.compact
-
+  s.description = readme_description
+  s.email = %q{kcar@librelist.org}
+  s.extra_rdoc_files = extra_rdoc_files(manifest)
   s.files = manifest
-  s.rdoc_options = [
-    "-a",
-    "-t",
-    summary
-  ]
-  s.require_paths = %w(lib ext)
+  s.rdoc_options = rdoc_options
   s.rubyforge_project = %q{rainbows}
   s.summary = summary
   s.test_files = Dir['test/test_*.rb']
   s.extensions = %w(ext/kcar/extconf.rb)
+  s.add_development_dependency('wrongdoc', '~> 1.5')
 
   # s.license = %w(GPL Ruby) # disabled for compatibility with older RubyGems
 end

data/lib/kcar.rb

@@ -1,8 +1,10 @@
 # -*- encoding: binary -*-
 module Kcar
 
-  # current version, currently 0.1.2
-  VERSION = '0.1.2'
+  # current version of Kcar, currently 0.2.0
+  # This constant is deprecated and will be removed in the next
+  # release.  Use +respond_to?+ or +defined?+ instead to test for features.
+  VERSION = "0.2.0"
 
   autoload :Response, 'kcar/response'
 end

data/lib/kcar/parser.rb

@@ -1,6 +1,5 @@
 # -*- encoding: binary -*-
-module Kcar
-class Parser
+class Kcar::Parser
 
   # extract trailers that were set in the header object as
   # an array of arrays
@@ -34,6 +33,4 @@ class Parser
 
     trailers
   end
-
-end # class Parser
 end # module Kcar

data/lib/kcar/response.rb

@@ -1,14 +1,15 @@
 # -*- encoding: binary -*-
 
-module Kcar
 
 # This may be used to generate a Rack response
 #
-class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
+class Kcar::Response
+  attr_accessor :sock, :hdr, :unchunk, :buf, :parser
 
   # :stopdoc:
   LAST_CHUNK = "0\r\n"
   CRLF = "\r\n"
+  Parser = Kcar::Parser
   # :startdoc:
 
   # By default we readpartial at most 16K off a socket at once
@@ -18,7 +19,7 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
   # method.  +unchunk+ may be set to disable transparent unchunking
   # +hdr+ may be a Hash, Array, or Rack::Utils::HeaderHash
   def initialize(sock, hdr = {}, unchunk = true)
-    super(sock, hdr, unchunk, "", Parser.new)
+    @sock, @hdr, @unchunk, @buf, @parser = sock, hdr, unchunk, "", Parser.new
   end
 
   # returns a 3-element array that resembles a Rack response, but is
@@ -33,9 +34,9 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
   # +unchunk+ must be true to guarantee trailers will be stored in the
   # returned +header+ object
   def read
-    buf << sock.readpartial(READ_SIZE) if buf.empty?
-    while (response = parser.headers(hdr, buf)).nil?
-      buf << sock.readpartial(READ_SIZE)
+    @buf << @sock.readpartial(READ_SIZE) if @buf.empty?
+    until response = @parser.headers(@hdr, @buf)
+      @buf << @sock.readpartial(READ_SIZE)
     end
     response << self
   end
@@ -47,7 +48,7 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
   # but the body returned will be this Kcar::Response handler itself.
   # It is not guaranteed that trailers will be stored in the returned +header+
   def rack
-    self.unchunk = false
+    @unchunk = false
     read
   end
 
@@ -55,23 +56,25 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
   # our given +sock+ object if keepalive is not used otherwise it
   # will just reset the parser and clear the header object
   def close
-    parser.keepalive? ? reset : sock.close
+    @parser.keepalive? ? reset : @sock.close
   end
 
   # this method allows our Kcar::Response object to be used as a Rack response
   # body.  It may only be called once (usually by a Rack server) as it streams
   # the response body off the our socket object.
-  def each(&block)
-    if parser.body_eof?
+  def each
+    if @parser.body_eof?
       return
     end
-    if unchunk
-      parser.chunked? ? each_unchunk(&block) : each_identity(&block)
+    if @unchunk
+      @parser.chunked? ? each_unchunk { |x| yield x } :
+                         each_identity { |x| yield x }
     else
-      if parser.keepalive?
-        parser.chunked? ? each_rechunk(&block) : each_identity(&block)
+      if @parser.keepalive?
+        @parser.chunked? ? each_rechunk { |x| yield x } :
+                           each_identity { |x| yield x }
       else
-        each_until_eof(&block) # fastest path
+        each_until_eof { |x| yield x } # fastest path
       end
     end
     rescue EOFError
@@ -79,11 +82,11 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
 
   # :stopdoc:
   def reset
-    parser.reset
-    hdr.clear
+    @parser.reset
+    @hdr.clear
   end
 
-  def each_rechunk(&block)
+  def each_rechunk
     # We have to filter_body to keep track of parser state
     # (which sucks).  Also, as a benefit to clients we'll rechunk
     # to increase the likelyhood of network transfers being on
@@ -91,43 +94,43 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
     # other people's code :)
     dst = ""
     begin
-      parser.filter_body(dst, buf) and break
+      @parser.filter_body(dst, @buf) and break
       size = dst.size
       if size > 0
         yield("#{size.to_s(16)}\r\n")
         yield(dst << CRLF)
       end
-      break if parser.body_eof?
-    end while buf << sock.readpartial(READ_SIZE, dst)
+      break if @parser.body_eof?
+    end while @buf << @sock.readpartial(READ_SIZE, dst)
 
     yield LAST_CHUNK
 
-    while parser.trailers(hdr, buf).nil?
-      buf << sock.readpartial(READ_SIZE, dst)
+    until @parser.trailers(@hdr, @buf)
+      @buf << @sock.readpartial(READ_SIZE, dst)
     end
 
     # since Rack does not provide a way to explicitly send trailers
     # in the response, we'll just yield a stringified version to our
     # server and pretend it's part of the body.
-    trailers = parser.extract_trailers(hdr)
+    trailers = @parser.extract_trailers(@hdr)
     yield(trailers.map! { |k,v| "#{k}: #{v}\r\n" }.join("") << CRLF)
   end
 
-  def each_until_eof(&block)
-    yield buf unless buf.empty?
+  def each_until_eof
+    yield @buf unless @buf.empty?
     # easy, just read and write everything until EOFError
-    dst = sock.readpartial(READ_SIZE)
+    dst = @sock.readpartial(READ_SIZE)
     begin
       yield dst
-    end while sock.readpartial(READ_SIZE, dst)
+    end while @sock.readpartial(READ_SIZE, dst)
   end
 
-  def each_identity(&block)
-    len = parser.body_bytes_left
-    if len.nil?
-      each_until_eof(&block)
+  def each_identity
+    len = @parser.body_bytes_left
+    if len == nil
+      each_until_eof { |x| yield x }
     else
-      dst = buf
+      dst = @buf
       if dst.size > 0
         # in case of keepalive we need to read the second response,
         # so modify buf so that the second response is at the front
@@ -135,7 +138,7 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
         if dst.size >= len
           tmp = dst[len, dst.size]
           dst = dst[0, len]
-          buf.replace(tmp)
+          @buf.replace(tmp)
         end
 
         len -= dst.size
@@ -144,30 +147,28 @@ class Response < Struct.new(:sock, :hdr, :unchunk, :buf, :parser)
 
       if len > 0
         begin
-          len -= sock.readpartial(len > READ_SIZE ? READ_SIZE : len, dst).size
+          len -= @sock.readpartial(len > READ_SIZE ? READ_SIZE : len, dst).size
           yield dst
         end while len > 0
-        dst.respond_to?(:clear) ? dst.clear : self.buf = ''
+        dst.respond_to?(:clear) ? dst.clear : @buf = ""
       end
     end
   end
 
-  def each_unchunk(&block)
+  def each_unchunk
     dst = ""
     begin
-      parser.filter_body(dst, buf) and break
+      @parser.filter_body(dst, @buf) and break
       yield dst if dst.size > 0
-      parser.body_eof? and break
-    end while buf << sock.readpartial(READ_SIZE, dst)
+      @parser.body_eof? and break
+    end while @buf << @sock.readpartial(READ_SIZE, dst)
 
     # we can't pass trailers to the client since we unchunk
     # the response, so just read them off the socket and
     # stash them in hdr just in case...
-    while parser.headers(hdr, buf).nil?
-      buf << sock.readpartial(READ_SIZE, dst)
+    until @parser.headers(@hdr, @buf)
+      @buf << @sock.readpartial(READ_SIZE, dst)
     end
   end
   # :startdoc:
-
-end # class Response
-end # module Kcar
+end

data/pkg.mk

@@ -0,0 +1,171 @@
+RUBY = ruby
+RAKE = rake
+RSYNC = rsync
+WRONGDOC = wrongdoc
+
+GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE
+	@./GIT-VERSION-GEN
+-include GIT-VERSION-FILE
+-include local.mk
+DLEXT := $(shell $(RUBY) -rrbconfig -e 'puts RbConfig::CONFIG["DLEXT"]')
+RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
+RUBY_ENGINE := $(shell $(RUBY) -e 'puts((RUBY_ENGINE rescue "ruby"))')
+lib := lib
+
+ifeq ($(shell test -f script/isolate_for_tests && echo t),t)
+isolate_libs := tmp/isolate/$(RUBY_ENGINE)-$(RUBY_VERSION)/isolate.mk
+$(isolate_libs): script/isolate_for_tests
+	@$(RUBY) script/isolate_for_tests
+-include $(isolate_libs)
+lib := $(lib):$(ISOLATE_LIBS)
+endif
+
+ext := $(firstword $(wildcard ext/*))
+ifneq ($(ext),)
+ext_pfx := tmp/ext/$(RUBY_ENGINE)-$(RUBY_VERSION)
+ext_h := $(wildcard $(ext)/*/*.h $(ext)/*.h)
+ext_src := $(wildcard $(ext)/*.c $(ext_h))
+ext_pfx_src := $(addprefix $(ext_pfx)/,$(ext_src))
+ext_d := $(ext_pfx)/$(ext)/.d
+$(ext)/extconf.rb: $(wildcard $(ext)/*.h)
+	@>> $@
+$(ext_d):
+	@mkdir -p $(@D)
+	@> $@
+$(ext_pfx)/$(ext)/%: $(ext)/% $(ext_d)
+	install -m 644 $< $@
+$(ext_pfx)/$(ext)/Makefile: $(ext)/extconf.rb $(ext_d) $(ext_h)
+	$(RM) -f $(@D)/*.o
+	cd $(@D) && $(RUBY) $(CURDIR)/$(ext)/extconf.rb
+ext_sfx := _ext.$(DLEXT)
+ext_dl := $(ext_pfx)/$(ext)/$(notdir $(ext)_ext.$(DLEXT))
+$(ext_dl): $(ext_src) $(ext_pfx_src) $(ext_pfx)/$(ext)/Makefile
+	@echo $^ == $@
+	$(MAKE) -C $(@D)
+lib := $(lib):$(ext_pfx)/$(ext)
+build: $(ext_dl)
+else
+build:
+endif
+
+pkg_extra += GIT-VERSION-FILE NEWS ChangeLog LATEST
+ChangeLog: GIT-VERSION-FILE .wrongdoc.yml
+	$(WRONGDOC) prepare
+NEWS LATEST: ChangeLog
+
+manifest:
+	$(RM) .manifest
+	$(MAKE) .manifest
+
+.manifest: $(pkg_extra)
+	(git ls-files && for i in $@ $(pkg_extra); do echo $$i; done) | \
+		LC_ALL=C sort > $@+
+	cmp $@+ $@ || mv $@+ $@
+	$(RM) $@+
+
+doc:: .document .wrongdoc.yml $(pkg_extra)
+	-find lib -type f -name '*.rbc' -exec rm -f '{}' ';'
+	-find ext -type f -name '*.rbc' -exec rm -f '{}' ';'
+	$(RM) -r doc
+	$(WRONGDOC) all
+	install -m644 COPYING doc/COPYING
+	install -m644 $(shell grep '^[A-Z]' .document) doc/
+
+ifneq ($(VERSION),)
+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):
+	$(WRONGDOC) release_changes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+$(release_notes):
+	$(WRONGDOC) release_notes > $@+
+	$(VISUAL) $@+ && test -s $@+ && mv $@+ $@
+
+# ensures we're actually on the tagged $(VERSION), only used for release
+verify:
+	test x"$(shell umask)" = x0022
+	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)^{})
+
+fix-perms:
+	-git ls-tree -r HEAD | awk '/^100644 / {print $$NF}' | xargs chmod 644
+	-git ls-tree -r HEAD | awk '/^100755 / {print $$NF}' | xargs chmod 755
+
+gem: $(pkggem)
+
+install-gem: $(pkggem)
+	gem install $(CURDIR)/$<
+
+$(pkggem): manifest fix-perms
+	gem build $(rfpackage).gemspec
+	mkdir -p pkg
+	mv $(@F) $@
+
+$(pkgtgz): distdir = $(basename $@)
+$(pkgtgz): HEAD = v$(VERSION)
+$(pkgtgz): manifest fix-perms
+	@test -n "$(distdir)"
+	$(RM) -r $(distdir)
+	mkdir -p $(distdir)
+	tar cf - $$(cat .manifest) | (cd $(distdir) && tar xf -)
+	cd pkg && tar cf - $(basename $(@F)) | gzip -9 > $(@F)+
+	mv $@+ $@
+
+package: $(pkgtgz) $(pkggem)
+
+test-release:: verify package $(release_notes) $(release_changes)
+	# make tgz release on RubyForge
+	@echo rubyforge add_release -f \
+	  -n $(release_notes) -a $(release_changes) \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+	@echo gem push $(pkggem)
+	@echo rubyforge add_file \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+release:: verify package $(release_notes) $(release_changes)
+	# make tgz release on RubyForge
+	rubyforge add_release -f -n $(release_notes) -a $(release_changes) \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkgtgz)
+	# push gem to RubyGems.org
+	gem push $(pkggem)
+	# in case of gem downloads from RubyForge releases page
+	rubyforge add_file \
+	  $(rfproject) $(rfpackage) $(VERSION) $(pkggem)
+else
+gem install-gem: GIT-VERSION-FILE
+	$(MAKE) $@ VERSION=$(GIT_VERSION)
+endif
+
+all:: test
+test_units := $(wildcard test/test_*.rb)
+test: test-unit
+test-unit: $(test_units)
+$(test_units): build
+	$(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
+
+# this requires GNU coreutils variants
+ifneq ($(RSYNC_DEST),)
+publish_doc:
+	-git set-file-times
+	$(MAKE) doc
+	find doc/images -type f | \
+		TZ=UTC xargs touch -d '1970-01-01 00:00:06' doc/rdoc.css
+	$(MAKE) doc_gz
+	$(RSYNC) -av doc/ $(RSYNC_DEST)/
+	git ls-files | xargs touch
+endif
+
+# Create gzip variants of the same timestamp as the original so nginx
+# "gzip_static on" can serve the gzipped versions directly.
+doc_gz: docs = $(shell find doc -type f ! -regex '^.*\.\(gif\|jpg\|png\|gz\)$$')
+doc_gz:
+	for i in $(docs); do \
+	  gzip --rsyncable -9 < $$i > $$i.gz; touch -r $$i $$i.gz; done
+
+.PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest

data/test/test_response.rb

@@ -496,6 +496,7 @@ class TestSession < Test::Unit::TestCase
     @s.close
     @response = Kcar::Response.new(@c, [])
     status, headers, body = @response.rack
+    assert_kind_of Array, headers
     assert_equal status, "200 OK"
     tmp = []
     assert ! body.parser.keepalive?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kcar
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - kcar hackers
@@ -15,16 +15,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-30 00:00:00 +00:00
+date: 2011-02-24 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wrongdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id001
 description: |-
   kcar features an HTTP parser that will convert a bytestream into a
   3-element array suitable for use as a Rack response.  It is IO interface
   agnostic, so it may be used with HTTP streams over Unix domain sockets,
   regular files, FIFOs, StringIOs as well as traditional TCP sockets.
-email: kcar@librelist.com
+email: kcar@librelist.org
 executables: []
 
 extensions: 
@@ -43,11 +57,13 @@ files:
 - .document
 - .gitignore
 - .manifest
+- .wrongdoc.yml
 - COPYING
 - ChangeLog
 - GIT-VERSION-FILE
 - GIT-VERSION-GEN
 - GNUmakefile
+- LATEST
 - LICENSE
 - NEWS
 - README
@@ -63,6 +79,7 @@ files:
 - lib/kcar.rb
 - lib/kcar/parser.rb
 - lib/kcar/response.rb
+- pkg.mk
 - setup.rb
 - test/test_parser.rb
 - test/test_response.rb
@@ -72,12 +89,12 @@ licenses: []
 
 post_install_message: 
 rdoc_options: 
-- -a
 - -t
-- bytestream to Rack response converter
+- kcar - bytestream to Rack response converter
+- -W
+- http://bogomips.org/kcar.git/tree/%s
 require_paths: 
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -99,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rainbows
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: bytestream to Rack response converter