httpkit 0.6.0.pre.3 → 0.6.0.pre.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQ5NTA0NGVmZTllMzYyZDQ2NmFlMGFkMTRiNzZhNWIwMjY3MzQ2Mw==
+  data.tar.gz: !binary |-
+    OWU0MTU3ZGZmYmE3OWVjZjRlOTZjZGYzMTU2MWFiNmQ5OWUxMTczNQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTYyYTczNzczNDA4YWFiMGIwZDE0ZTBkYzcxY2E3NWEwMGM5OTE1Yzg4ZDY2
+    YzI5NWMxY2IxMDA5MjEzNDI0MTU4NDA4NTFlMjljNGYxZDg1YzM3ZWQ1MjE3
+    YWQzYmViMmJhM2QxYmE1ZDI5YTFiOTYwYTI4YjAxMjhlMDkxYjQ=
+  data.tar.gz: !binary |-
+    Y2NiZjliN2Q1NDI1NmMwYWJiMmJmNTA3YTc1Mjc3M2MwNDgyMzc3NGIwMjk4
+    MDNkY2ExNzkyMTVhZWUxOTAwNGEwMjZhZTQxMjlkMWMyYzYxY2M0NTQ3ODQ5
+    Yzg5YjM1OTEyNjEzM2U2MmVmMzBmNmNjY2NmYWY5OTJlOWNjMjI=

data/.rspec

@@ -1,3 +1,2 @@
 --order rand
 --color
---format Fuubar

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 1.9
+  - 2.0
+  - 2.1
   - jruby
-  - rbx
+  - rbx-2
   - ruby-head
   - jruby-head
 matrix:
@@ -12,4 +13,4 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
   fast_finish: true
-script: bundle exec rake -t ci:metrics spec:integration
+script: "bundle exec rake -t ci:metrics spec:integration && (bundle exec rake -t metrics:mutant || true)"

data/Gemfile

@@ -5,8 +5,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
-gem 'fuubar',   git: 'https://github.com/lgierth/fuubar.git',
-                ref: 'static-percentage'
 gem 'awesome_print'
 
 platform :rbx do

data/Gemfile.devtools

@@ -1,9 +1,11 @@
 # encoding: utf-8
 
 group :development do
-  gem 'rake',  '~> 10.1.0'
-  gem 'rspec', '~> 2.14.1'
-  gem 'yard',  '~> 0.8.7'
+  gem 'rake',       '~> 10.3.2'
+  gem 'rspec',      '~> 2.99.0'
+  gem 'rspec-core', '~> 2.99.0'
+  gem 'rspec-its',  '~> 1.0.1'
+  gem 'yard',       '~> 0.8.7.4'
 
   platform :rbx do
     gem 'rubysl-singleton', '~> 2.0.0'
@@ -11,48 +13,51 @@ group :development do
 end
 
 group :yard do
-  gem 'kramdown', '~> 1.2.0'
+  gem 'kramdown', '~> 1.3.3'
 end
 
 group :guard do
-  gem 'guard',         '~> 2.2.4'
+  gem 'guard',         '~> 2.6.1'
   gem 'guard-bundler', '~> 2.0.0'
-  gem 'guard-rspec',   '~> 4.0.4'
-  gem 'guard-rubocop', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 4.2.9'
+  gem 'guard-rubocop', '~> 1.1.0'
 
   # file system change event handling
-  gem 'listen',     '~> 2.2.0'
+  gem 'listen',     '~> 2.7.7'
   gem 'rb-fchange', '~> 0.0.6', require: false
-  gem 'rb-fsevent', '~> 0.9.3', require: false
-  gem 'rb-inotify', '~> 0.9.0', require: false
+  gem 'rb-fsevent', '~> 0.9.4', require: false
+  gem 'rb-inotify', '~> 0.9.5', require: false
 
   # notification handling
-  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'libnotify',               '~> 0.8.3', require: false
   gem 'rb-notifu',               '~> 0.0.4', require: false
   gem 'terminal-notifier-guard', '~> 1.5.3', require: false
 end
 
 group :metrics do
   gem 'coveralls', '~> 0.7.0'
-  gem 'flay',      '~> 2.4.0'
-  gem 'flog',      '~> 4.2.0'
-  gem 'reek',      '~> 1.3.2'
-  gem 'rubocop',   '~> 0.15.0'
-  gem 'simplecov', '~> 0.8.2'
-  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+  gem 'flay',      '~> 2.5.0'
+  gem 'flog',      '~> 4.2.1'
+  gem 'reek',      '~> 1.3.7'
+  gem 'rubocop',   '~> 0.23.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.9'
+
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.23'
+    gem 'mutant-rspec', '~> 0.5.21'
+  end
 
   platforms :ruby_19, :ruby_20 do
-    gem 'mutant',          '~> 0.3.0.rc3', git: 'https://github.com/mbj/mutant.git'
-    gem 'unparser',        '~> 0.1.5',     git: 'https://github.com/mbj/unparser.git'
     gem 'yard-spellcheck', '~> 0.1.5'
   end
 
   platform :rbx do
     gem 'json',               '~> 1.8.1'
-    gem 'racc',               '~> 1.4.10'
+    gem 'racc',               '~> 1.4.11'
     gem 'rubysl-logger',      '~> 2.0.0'
     gem 'rubysl-open-uri',    '~> 2.0.0'
-    gem 'rubysl-prettyprint', '~> 2.0.2'
+    gem 'rubysl-prettyprint', '~> 2.0.3'
   end
 end
 
@@ -62,6 +67,6 @@ end
 
 platform :jruby do
   group :jruby do
-    gem 'jruby-openssl', '~> 0.8.5'
+    gem 'jruby-openssl', '~> 0.9.4'
   end
 end

data/README.md

@@ -1,26 +1,24 @@
-# The HTTP toolkit for Ruby [![Build Status](https://travis-ci.org/lgierth/httpkit.png?branch=master)](https://travis-ci.org/lgierth/httpkit) [![Code Climate](https://codeclimate.com/github/lgierth/httpkit.png)](https://codeclimate.com/github/lgierth/httpkit) [![Coverage Status](https://coveralls.io/repos/lgierth/httpkit/badge.png?branch=master)](https://coveralls.io/r/lgierth/httpkit?branch=master)
+# The HTTP toolkit for Ruby 
 
 HTTPkit is a Ruby toolkit for building HTTP clients and servers,
 as well as compositions of them.
 
-- \#1 feature: readable, high-quality, extendable code with 66.81% mutation coverage (wip)
+[![Build Status](https://travis-ci.org/lgierth/httpkit.png?branch=master)](https://travis-ci.org/lgierth/httpkit) [![Code Climate](https://codeclimate.com/github/lgierth/httpkit.png)](https://codeclimate.com/github/lgierth/httpkit) [![Coverage Status](https://coveralls.io/repos/lgierth/httpkit/badge.png?branch=master)](https://coveralls.io/r/lgierth/httpkit?branch=master)
+
+- \#1 feature: readable, high-quality, extendable code with 71.88% mutation coverage (wip)
 - \#2 feature: sophisticated request and response streaming
-- \#3 feature: compatible with Rack, Faraday, and Webmachine for Ruby (todo)
-- \#4 feature: concurrenct or non-concurrent
-  - Non-concurrent using one-off EventMachine reactor (clients only)
-  - Evented using EventMachine
-  - Synchronously evented using EventMachine and Fibers
-  - Threaded using Celluloid (todo)
+- \#3 feature: compatible with Rack, Faraday, Webmachine for Ruby, and VCR (all todo)
+- \#4 feature: backed by Celluloid (wip) or Eventmachine
 
-*Note:* The `master` branch contains the latest development effort. Look at the
-`0.5.x` branch for stable, but very old releases. HTTPkit used to be called
-Hatetepe.
+*Note:* The `master` branch contains the in-progress rewrite towards
+HTTPkit 1.0. Look at the `0.5.x` branch for stable, but outdated and largely
+unmaintained releases. HTTPkit used to be called Hatetepe.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'httpkit'
+    gem 'httpkit', '0.6.0.pre.3'
 
 And then execute:
 
@@ -28,7 +26,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install httpkit
+    $ gem install httpkit --pre
 
 ## Usage
 

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 8
-total_score: 181
+threshold: 10
+total_score: 279

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 10.0
+threshold: 10.8

data/config/reek.yml

@@ -31,7 +31,8 @@ IrresponsibleModule:
   exclude: []
 LongParameterList:
   enabled: true
-  exclude: []
+  exclude:
+  - "HTTPkit::Request#initialize"
   max_params: 2
   overrides:
     initialize:
@@ -49,7 +50,8 @@ NestedIterators:
   ignore_iterators: []
 NilCheck:
   enabled: true
-  exclude: []
+  exclude:
+  - "HTTPkit::Body#length_known?"
 RepeatedConditional:
   enabled: true
   exclude: []
@@ -58,15 +60,19 @@ TooManyInstanceVariables:
   enabled: true
   exclude:
   - HTTPkit::Connection::EventMachine
-  max_instance_variables: 4
+  - HTTPkit::Request
+  - HTTPkit::Client
+  max_instance_variables: 5
 TooManyMethods:
   enabled: true
-  exclude: []
-  max_methods: 11
+  exclude:
+  - HTTPkit::Response
+  max_methods: 13
 TooManyStatements:
   enabled: true
   exclude:
   - each
+  - "HTTPkit::Request#initialize"
   max_statements: 5
 UncommunicativeMethodName:
   enabled: true

data/config/rubocop.yml

@@ -1,16 +1,22 @@
 AllCops:
-  Includes:
+  Include:
     - '**/*.rake'
     - 'Gemfile'
     - 'Gemfile.devtools'
-  Excludes:
+  Exclude:
     - '**/vendor/**'
     - '**/benchmarks/**'
 
 # Avoid parameter lists longer than five parameters.
 ParameterLists:
-  Max: 4
-  CountKeywordArgs: true
+  Enabled: false
+
+MethodLength:
+  CountComments: false
+  Max: 10
+
+ClassLength:
+  Enabled: false
 
 # Avoid more than `Max` levels of nesting.
 BlockNesting:
@@ -25,7 +31,7 @@ CollectionMethods:
     find_all: 'select'
 
 AccessModifierIndentation:
-  EnforcedStyle: indent
+  Enabled: false
 
 # Limit line length
 LineLength:
@@ -47,6 +53,9 @@ CaseEquality:
 ConstantName:
   Enabled: false
 
+ClassAndModuleChildren:
+  Enabled: false
+
 # Not all trivial readers/writers can be defined with attr_* methods
 TrivialAccessors:
   Enabled: false
@@ -54,3 +63,36 @@ TrivialAccessors:
 SignalException:
   # Valid values are: semantic, only_raise and only_fail
   EnforcedStyle: only_raise
+
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false
+
+# Allow empty lines around body
+EmptyLinesAroundBody:
+  Enabled: false
+
+# Prefer String#% over Kernel#sprintf
+FormatString:
+  Enabled: false
+
+# Use square brackets for literal Array objects
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': '[]'
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+GuardClause:
+  Enabled: false
+
+# Disabled because reduce vs each_with_object is not a question of style, ffs.
+# See lib/httpkit/support/handler_manager.rb
+EachWithObject:
+  Enabled: false

data/examples/echo_server.rb

@@ -19,7 +19,7 @@ class EchoServer
   end
 
   def serialize(request, response)
-    writer     = response.body.closed.method(:progress)
+    writer     = response.body.method(:write)
     serializer = HTTPkit::Serializer.new(request, writer)
     serializer.serialize
   end
@@ -28,7 +28,7 @@ end
 HTTPkit.start do
   HTTPkit::Server.start(address:  ENV.fetch('ADDRESS', '127.0.0.1'),
                         port:     ENV.fetch('PORT', 3000).to_i,
-                        handlers: [HTTPkit::Server::KeepAlive.new,
+                        handlers: [HTTPkit::Server::KeepAliveHandler.new,
                                    EchoServer.new])
 
   Signal.trap(:INT)  { HTTPkit.stop }

data/examples/getting_started.rb

@@ -4,11 +4,14 @@ require 'httpkit'
 
 class HelloServer
   def serve(request, served)
-    p request.http_method # => :get
-    p request.uri         # => "/"
-    p request.headers     # => {"Host"=>"127.0.0.1:3000",
-                          #     "Content-Length"=>"0"}
-    p request.body.to_s   # => ""
+    p request.http_method
+    # => :get
+    p request.uri
+    # => "/"
+    p request.headers
+    # => {"Host"=>"127.0.0.1:3000", "Content-Length"=>"0"}
+    p request.body.to_s
+    # => ""
 
     served.fulfill(response)
   end
@@ -26,9 +29,12 @@ HTTPkit.run do
 
   response = client.request(:get, '/')
 
-  p response.status      # => 200
-  p response.status_name # => "OK"
-  p response.headers     # => {"Content-Type"=>"text/plain",
-                         #     "Content-Length"=>"5"}
-  p response.body.to_s   # => "hello"
+  p response.status
+  # => 200
+  p response.status_name
+  # => "OK"
+  p response.headers
+  # => {"Content-Type"=>"text/plain", "Content-Length"=>"5"}
+  p response.body.to_s
+  # => "hello"
 end

data/httpkit.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "eventmachine"
-  spec.add_dependency "http_parser.rb"
-  spec.add_dependency "promise.rb", "~> 0.6"
+  spec.add_dependency "eventmachine", "~> 1.0"
+  spec.add_dependency "http_parser.rb", "~> 0.6.0"
+  spec.add_dependency "promise.rb", "~> 0.6.0"
+  spec.add_dependency "adamantium", "~> 0.2.0"
 
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/httpkit.rb

@@ -5,6 +5,7 @@ require 'fiber'
 require 'promise'
 require 'http/parser'
 require 'time'
+require 'adamantium'
 
 require 'httpkit/version'
 
@@ -18,15 +19,18 @@ require 'httpkit/response'
 
 require 'httpkit/connection/eventmachine'
 require 'httpkit/connection/status'
-require 'httpkit/serializer/encoding'
 require 'httpkit/serializer'
 
 require 'httpkit/client'
-require 'httpkit/client/keep_alive'
-require 'httpkit/client/timeouts'
+require 'httpkit/client/body_handler'
+require 'httpkit/client/mandatory_handler'
+require 'httpkit/client/keep_alive_handler'
+require 'httpkit/client/timeouts_handler'
 require 'httpkit/server'
-require 'httpkit/server/keep_alive'
-require 'httpkit/server/timeouts'
+require 'httpkit/server/body_handler'
+require 'httpkit/server/mandatory_handler'
+require 'httpkit/server/keep_alive_handler'
+require 'httpkit/server/timeouts_handler'
 
 module HTTPkit
   def self.run
@@ -46,4 +50,10 @@ module HTTPkit
     EM.stop
     EM.next_tick {}
   end
+
+  def self.sleep(duration)
+    promise = Promise.new
+    EM.add_timer(duration) { promise.fulfill }
+    promise.sync
+  end
 end

data/lib/httpkit/body.rb

@@ -2,66 +2,77 @@
 
 module HTTPkit
   class Body
-    def self.build(arg)
-      if arg.is_a?(Body)
-        arg
+    include Adamantium::Mutable
+
+    def self.build(source = nil, length = nil)
+      if source.is_a?(self)
+        source
       else
-        body = new(arg.to_s)
-        body.closed.fulfill
-        body
+        new(source, length)
       end
     end
 
     attr_reader :closed
 
-    # TODO: eliminate string param
-    def initialize(string = '')
-      @io = StringIO.new(string)
+    # @param [String,#each,nil] source
+    def initialize(source = nil, length = nil, closed = Promise.new)
+      @source, @length = source, length
+      @closed = closed
+      @chunks = []
 
-      @closed = Promise.new
-      closed.on_progress { |str| @io.write(str) }
+      apply_source
+      @closed.fulfill if source
     end
 
-    # don't optimize the sync call, we don't wanna search in @io.string
-    # because search time increases with its size.
-    def gets(*args)
-      closed.sync
-      @io.gets(*args)
+    def length
+      @length || 0
     end
 
-    def read(length = nil, buffer = nil)
-      closed.sync unless optimized_read?(length)
-      @io.read(length, buffer)
+    def length_known?
+      !@length.nil?
     end
 
-    def rewind
-      closed.sync
-      @io.rewind
+    def write(chunk)
+      if @closed.pending? && !chunk.empty?
+        @chunks << chunk
+        @closed.progress(chunk)
+      end
     end
 
     def each(&block)
-      yield_string(&block)
-      closed.on_progress(&block)
-      closed.sync
+      return to_enum(__method__) unless block
+
+      if @source.respond_to?(:each)
+        @source.each(&block)
+      else
+        each_chunk(&block)
+      end
     end
 
     def to_s
-      closed.sync
-      @io.string
+      each.to_a.join
     end
 
-    def string
-      @io.string
+    def inspect
+      len = length_known? ? length : 'unknown'
+      sprintf('#<%s:0x%d @length=%s>', self.class.name, object_id, len)
     end
 
     private
 
-    def optimized_read?(length)
-      length && length < (@io.length - pos)
+    def apply_source
+      if @source.respond_to?(:to_str) && (chunk = @source.to_str)
+        @length = chunk.bytesize
+        write(chunk)
+      elsif @source.respond_to?(:bytesize)
+        @length = @source.bytesize
+      end
     end
 
-    def yield_string(&block)
-      block.call(@io.string) unless @io.string.empty?
+    def each_chunk(&block)
+      @closed.on_progress(&block)
+      @chunks.dup.each(&block)
+      @closed.sync
     end
   end
 end