webmachine 1.2.2 → 1.3.0

data/lib/webmachine/resource.rb

@@ -53,7 +53,7 @@ module Webmachine
       resource = self
       Application.new do |app|
         app.routes do |router|
-          router.add ["*"], resource
+          router.add [:*], resource
         end
       end.run
     end

data/lib/webmachine/resource/callbacks.rb

@@ -1,3 +1,5 @@
+require 'webmachine/constants'
+
 module Webmachine
   class Resource
     # These methods are the primary way your {Webmachine::Resource}
@@ -123,7 +125,7 @@ module Webmachine
       # @return [Array<String>] allowed methods on this resource
       # @api callback
       def allowed_methods
-        ['GET', 'HEAD']
+        [GET_METHOD, HEAD_METHOD]
       end
 
       # HTTP methods that are known to the resource. Like
@@ -134,7 +136,7 @@ module Webmachine
       # @return [Array<String>] known methods
       # @api callback
       def known_methods
-        ['GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'CONNECT', 'OPTIONS']
+        STANDARD_HTTP_METHODS
       end
 
       # This method is called when a DELETE request should be enacted,
@@ -209,7 +211,7 @@ module Webmachine
       # @return an array of mediatype/handler pairs
       # @api callback
       def content_types_provided
-        [['text/html', :to_html]]
+        [[TEXT_HTML, :to_html]]
       end
 
       # Similarly to content_types_provided, this should return an array
@@ -263,7 +265,7 @@ module Webmachine
       # @api callback
       # @see Encodings
       def encodings_provided
-        {"identity" => :encode_identity }
+        {IDENTITY => :encode_identity }
       end
 
       # If this method is implemented, it should return a list of

data/lib/webmachine/spec/IO_response.body

@@ -0,0 +1 @@
+IO response body

data/lib/webmachine/spec/adapter_lint.rb

@@ -4,32 +4,68 @@ require "net/http"
 shared_examples_for :adapter_lint do
   attr_accessor :client
 
-  before(:all) do
-    configuration = Webmachine::Configuration.default
-    dispatcher = Webmachine::Dispatcher.new
-    dispatcher.add_route ["test"], Test::Resource
+  let(:address) { "127.0.0.1" }
+  let(:port) { s = TCPServer.new(address, 0); p = s.addr[1]; s.close; p }
 
-    @adapter = described_class.new(configuration, dispatcher)
-    @client = Net::HTTP.new(configuration.ip, configuration.port)
+  let(:application) do
+    application = Webmachine::Application.new
+    application.dispatcher.add_route ["test"], Test::Resource
 
-    Thread.abort_on_exception = true
-    @server_thread = Thread.new { @adapter.run }
+    application.configure do |c|
+      c.ip = address
+      c.port = port
+    end
+
+    application
+  end
 
+  let(:client) do
+    client = Net::HTTP.new(application.configuration.ip, port)
     # Wait until the server is responsive
     timeout(5) do
       begin
         client.start
       rescue Errno::ECONNREFUSED
-        sleep(0.1)
+        sleep(0.01)
         retry
       end
     end
+    client
+  end
+
+  before do
+    @adapter = described_class.new(application)
+
+    Thread.abort_on_exception = true
+    @server_thread = Thread.new { @adapter.run }
+    sleep(0.01)
   end
 
-  after(:all) do
-    @adapter.shutdown
-    @client.finish
-    @server_thread.join
+  after do
+    client.finish
+    @server_thread.kill
+  end
+
+  it "provides the request URI" do
+    request = Net::HTTP::Get.new("/test")
+    request["Accept"] = "test/response.request_uri"
+    response = client.request(request)
+    expect(response.body).to eq("http://#{address}:#{port}/test")
+  end
+
+  context do
+    let(:address) { "::1" }
+
+    it "provides the IPv6 request URI" do
+      if RUBY_VERSION =~ /^2\.(0|1)\./
+        skip "Net::HTTP regression in Ruby 2.(0|1)"
+      end
+
+      request = Net::HTTP::Get.new("/test")
+      request["Accept"] = "test/response.request_uri"
+      response = client.request(request)
+      expect(response.body).to eq("http://[#{address}]:#{port}/test")
+    end
   end
 
   it "provides a string-like request body" do
@@ -37,8 +73,8 @@ shared_examples_for :adapter_lint do
     request.body = "Hello, World!"
     request["Content-Type"] = "test/request.stringbody"
     response = client.request(request)
-    response["Content-Length"].should eq("21")
-    response.body.should eq("String: Hello, World!")
+    expect(response["Content-Length"]).to eq("21")
+    expect(response.body).to eq("String: Hello, World!")
   end
 
   it "provides an enumerable request body" do
@@ -46,66 +82,64 @@ shared_examples_for :adapter_lint do
     request.body = "Hello, World!"
     request["Content-Type"] = "test/request.enumbody"
     response = client.request(request)
-    response["Content-Length"].should eq("19")
-    response.body.should eq("Enum: Hello, World!")
+    expect(response["Content-Length"]).to eq("19")
+    expect(response.body).to eq("Enum: Hello, World!")
   end
 
   it "handles missing pages" do
     request = Net::HTTP::Get.new("/missing")
     response = client.request(request)
-    response.code.should eq("404")
-    response["Content-Type"].should eq("text/html")
+    expect(response.code).to eq("404")
+    expect(response["Content-Type"]).to eq("text/html")
   end
 
   it "handles empty response bodies" do
     request = Net::HTTP::Post.new("/test")
     request.body = ""
     response = client.request(request)
-    response.code.should eq("204")
-    # FIXME: Mongrel/WEBrick fail this test. Is there a bug?
-    #response["Content-Type"].should be_nil
-    response["Content-Length"].should be_nil
-    response.body.should be_nil
+    expect(response.code).to eq("204")
+    expect(["0", nil]).to include(response["Content-Length"])
+    expect(response.body).to be_nil
   end
 
   it "handles string response bodies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.stringbody"
     response = client.request(request)
-    response["Content-Length"].should eq("20")
-    response.body.should eq("String response body")
+    expect(response["Content-Length"]).to eq("20")
+    expect(response.body).to eq("String response body")
   end
 
   it "handles enumerable response bodies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.enumbody"
     response = client.request(request)
-    response["Transfer-Encoding"].should eq("chunked")
-    response.body.should eq("Enumerable response body")
+    expect(response["Transfer-Encoding"]).to eq("chunked")
+    expect(response.body).to eq("Enumerable response body")
   end
 
   it "handles proc response bodies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.procbody"
     response = client.request(request)
-    response["Transfer-Encoding"].should eq("chunked")
-    response.body.should eq("Proc response body")
+    expect(response["Transfer-Encoding"]).to eq("chunked")
+    expect(response.body).to eq("Proc response body")
   end
 
   it "handles fiber response bodies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.fiberbody"
     response = client.request(request)
-    response["Transfer-Encoding"].should eq("chunked")
-    response.body.should eq("Fiber response body")
+    expect(response["Transfer-Encoding"]).to eq("chunked")
+    expect(response.body).to eq("Fiber response body")
   end
 
   it "handles io response bodies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.iobody"
     response = client.request(request)
-    response["Content-Length"].should eq("16")
-    response.body.should eq("IO response body")
+    expect(response["Content-Length"]).to eq("17")
+    expect(response.body).to eq("IO response body\n")
   end
 
   it "handles request cookies" do
@@ -113,13 +147,13 @@ shared_examples_for :adapter_lint do
     request["Accept"] = "test/response.cookies"
     request["Cookie"] = "echo=echocookie"
     response = client.request(request)
-    response.body.should eq("echocookie")
+    expect(response.body).to eq("echocookie")
   end
 
   it "handles response cookies" do
     request = Net::HTTP::Get.new("/test")
     request["Accept"] = "test/response.cookies"
     response = client.request(request)
-    response["Set-Cookie"].should eq("cookie=monster, rodeo=clown")
+    expect(response["Set-Cookie"]).to eq("cookie=monster, rodeo=clown")
   end
 end

data/lib/webmachine/spec/test_resource.rb

@@ -17,8 +17,9 @@ module Test
         ["test/response.enumbody", :to_enum],
         ["test/response.procbody", :to_proc],
         ["test/response.fiberbody", :to_fiber],
-        ["test/response.iobody", :to_io],
-        ["test/response.cookies", :to_cookies]
+        ["test/response.iobody", :to_io_body],
+        ["test/response.cookies", :to_cookies],
+        ["test/response.request_uri", :to_request_uri]
       ]
     end
 
@@ -58,8 +59,8 @@ module Test
       end
     end
 
-    def to_io
-      StringIO.new("IO response body")
+    def to_io_body
+      File.new(File.expand_path('../IO_response.body', __FILE__))
     end
 
     def to_cookies
@@ -67,7 +68,12 @@ module Test
       response.set_cookie("rodeo", "clown")
       # FIXME: Mongrel/WEBrick fail if this method returns nil
       # Might be a net/http issue. Is this a bug?
+      # @see Flow#o18, Helpers#encode_body_if_set
       request.cookies["echo"] || ""
     end
+
+    def to_request_uri
+      request.uri.to_s
+    end
   end
 end

data/lib/webmachine/streaming/fiber_encoder.rb

@@ -1,8 +1,4 @@
-begin
-  require 'fiber'
-rescue LoadError
-  require 'webmachine/fiber18'
-end
+require 'fiber'
 
 module Webmachine
   module Streaming

data/lib/webmachine/streaming/io_encoder.rb

@@ -30,6 +30,12 @@ module Webmachine
         end
       end
 
+      # Allows the response body to be converted to a IO object.
+      # @return [IO,nil] the body as a IO object, or nil.
+      def to_io
+        IO.try_convert(body)
+      end
+
       # Returns the length of the IO stream, if known. Returns nil if
       # the stream uses an encoder or charsetter that might modify the
       # length of the stream, or the stream size is unknown.

data/lib/webmachine/trace.rb

@@ -1,3 +1,4 @@
+require 'webmachine/events'
 require 'webmachine/trace/resource_proxy'
 require 'webmachine/trace/fsm'
 require 'webmachine/trace/pstore_trace_store'

data/lib/webmachine/trace/fsm.rb

@@ -4,6 +4,22 @@ module Webmachine
     # tracing is enabled for a resource, enabling the capturing of
     # traces.
     module FSM
+      # Overrides the default resource accessor so that incoming
+      # callbacks are traced.
+      def initialize(_resource, _request, _response)
+        if trace?
+          class << self
+            def resource
+              @resource_proxy ||= ResourceProxy.new(@resource)
+            end
+          end
+        end
+      end
+
+      def trace?
+        Trace.trace?(@resource)
+      end
+
       # Adds the request to the trace.
       # @param [Webmachine::Request] request the request to be traced
       def trace_request(request)
@@ -13,7 +29,7 @@ module Webmachine
           :path => request.uri.request_uri.to_s,
           :headers => request.headers,
           :body => request.body.to_s
-        }
+        } if trace?
       end
 
       # Adds the response to the trace and then commits the trace to
@@ -25,24 +41,18 @@ module Webmachine
           :code => response.code.to_s,
           :headers => response.headers,
           :body => trace_response_body(response.body)
-        }
+        } if trace?
       ensure
         Webmachine::Events.publish('wm.trace.record', {
           :trace_id => resource.object_id.to_s,
           :trace => response.trace
-        })
+        }) if trace?
       end
 
       # Adds a decision to the trace.
       # @param [Symbol] decision the decision being processed
       def trace_decision(decision)
-        response.trace << {:type => :decision, :decision => decision}
-      end
-
-      # Overrides the default resource accessor so that incoming
-      # callbacks are traced.
-      def resource
-        @resource_proxy ||= ResourceProxy.new(@resource)
+        response.trace << {:type => :decision, :decision => decision} if trace?
       end
 
       private

data/lib/webmachine/trace/resource_proxy.rb

@@ -1,3 +1,5 @@
+require 'webmachine/resource'
+
 module Webmachine
   module Trace
     # This class is injected into the decision FSM as a stand-in for

data/lib/webmachine/translation.rb

@@ -1,5 +1,6 @@
+require 'set'
 require 'i18n'
-
+I18n.enforce_available_locales = true if I18n.respond_to?(:enforce_available_locales)
 I18n.config.load_path << File.expand_path("../locale/en.yml", __FILE__)
 
 module Webmachine

data/lib/webmachine/version.rb

@@ -1,8 +1,8 @@
-module Webmachine
+module Webmachine
   # Library version
-  VERSION = "1.2.2"
+  VERSION = "1.3.0".freeze
 
   # String for use in "Server" HTTP response header, which includes
   # the {VERSION}.
-  SERVER_STRING = "Webmachine-Ruby/#{VERSION}"
+  SERVER_STRING = "Webmachine-Ruby/#{VERSION}".freeze
 end

data/memory_test.rb

@@ -0,0 +1,37 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'webmachine'
+
+class Constantized < Webmachine::Resource
+  HELLO_WORLD = "Hello World".freeze
+  ALLOWED_METHODS = ['GET'.freeze].freeze
+  CONTENT_TYPES_PROVIDED = [['text/html'.freeze, :to_html].freeze].freeze
+
+  def allowed_methods
+    ALLOWED_METHODS
+  end
+
+  def content_types_provided
+    CONTENT_TYPES_PROVIDED
+  end
+
+  def to_html
+    HELLO_WORLD
+  end
+end
+
+Webmachine.application.routes do
+  add ['constantized'], Constantized
+end
+
+require 'webmachine/test'
+session = Webmachine::Test::Session.new(Webmachine.application)
+CONSTANTIZED = '/constantized'.freeze
+require 'memory_profiler'
+report = MemoryProfiler.report do
+  100.times do
+    session.get(CONSTANTIZED)
+  end
+end
+
+report.pretty_print
+

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
-$LOAD_PATH << File.expand_path("..", __FILE__)
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-
-require 'rubygems'
-require 'webmachine'
-require 'rspec'
+require "bundler/setup"
+Bundler.require :default, :test, :webservers
 require 'logger'
 
+class NullLogger < Logger
+  def add(severity, message=nil, progname=nil, &block)
+  end
+end
+
 RSpec.configure do |config|
   config.mock_with :rspec
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.formatter = :documentation if ENV['CI']
   if defined?(::Java)
     config.seed = Time.now.utc
@@ -20,11 +20,11 @@ RSpec.configure do |config|
 
   config.before(:suite) do
     options = {
-      :Logger => Logger.new("/dev/null"),
+      :Logger => NullLogger.new(STDERR),
       :AccessLog => []
     }
     Webmachine::Adapters::WEBrick::DEFAULT_OPTIONS.merge! options
-    Webmachine::Adapters::Rack::DEFAULT_OPTIONS.merge! options
+    Webmachine::Adapters::Rack::DEFAULT_OPTIONS.merge! options if defined?(Webmachine::Adapters::Rack)
   end
 end