fakeweb 1.2.6 → 1.2.7

data/.gitignore

@@ -1,5 +1,6 @@
 /doc
 /rdoc
+/html
 /coverage
 /pkg
 /.idea

data/CHANGELOG

@@ -1,3 +1,14 @@
+fakeweb (1.2.7)
+
+* revert to sorting query params before matching requests against regexps,
+  instead of the 1.2.6 behavior that tried every possible order combination;
+  that was factorial-time, which made matching hang for requests with long query
+  strings [Jason Wadsworth, David Dollar, Blaine Cook]
+
+* print a warning when FakeWeb is loaded before RightHttpConnection or after
+  Samuel, other libs that patch Net::HTTP [Chris Kampmeier, Ben Brinckerhoff]
+
+
 fakeweb (1.2.6)
 
 * fix that query params in a regex would have to be sorted for it to ever match

data/Rakefile

@@ -3,11 +3,14 @@ puts "Using ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
 require 'rubygems'
 require 'rake'
 
+version = File.read(File.join(File.dirname(__FILE__), "lib", "fake_web", "VERSION")).strip
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "fakeweb"
     gem.rubyforge_project = "fakeweb"
+    gem.version = version
     gem.summary = "A tool for faking responses to HTTP requests"
     gem.description = "FakeWeb is a helper for faking web requests in Ruby. It works at a global level, without modifying code or writing extensive stubs."
     gem.email = ["chris@kampers.net", "romeda@gmail.com"]
@@ -27,28 +30,26 @@ end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb")
+  test.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb", "test/vendor")
   test.verbose = false
   test.warning = true
 end
 
-task :default => :test
+task :default => [:check_dependencies, :test]
 
 
 begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |t|
-    t.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb")
+    t.test_files = FileList["test/**/*.rb"].exclude("test/test_helper.rb", "test/vendor")
     t.rcov_opts << "--sort coverage"
     t.rcov_opts << "--exclude gems"
     t.warning = true
   end
-rescue
+rescue LoadError
   print "rcov support disabled "
   if RUBY_PLATFORM =~ /java/
     puts "(running under JRuby)"
-  elsif RUBY_VERSION =~ /^1\.9/
-    puts "(running under Ruby 1.9)"
   else
     puts "(install RCov to enable the `rcov` task)"
   end
@@ -58,7 +59,6 @@ end
 begin
   require 'rdoc/task'
   Rake::RDocTask.new do |rdoc|
-    version = File.exist?('VERSION') ? File.read('VERSION') : ""
     rdoc.main = "README.rdoc"
     rdoc.rdoc_files.include("README.rdoc", "CHANGELOG", "LICENSE.txt", "lib/*.rb")
     rdoc.title = "FakeWeb #{version} API Documentation"

data/fakeweb.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{fakeweb}
-  s.version = "1.2.6"
+  s.version = "1.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Kampmeier", "Blaine Cook"]
-  s.date = %q{2009-08-31}
+  s.date = %q{2009-11-02}
   s.description = %q{FakeWeb is a helper for faking web requests in Ruby. It works at a global level, without modifying code or writing extensive stubs.}
   s.email = ["chris@kampers.net", "romeda@gmail.com"]
   s.extra_rdoc_files = [
@@ -22,9 +22,9 @@ Gem::Specification.new do |s|
      "LICENSE.txt",
      "README.rdoc",
      "Rakefile",
-     "VERSION",
      "fakeweb.gemspec",
      "lib/fake_web.rb",
+     "lib/fake_web/VERSION",
      "lib/fake_web/ext/net_http.rb",
      "lib/fake_web/registry.rb",
      "lib/fake_web/responder.rb",
@@ -44,12 +44,34 @@ Gem::Specification.new do |s|
      "test/test_fake_web_open_uri.rb",
      "test/test_helper.rb",
      "test/test_missing_open_uri.rb",
+     "test/test_other_net_http_libraries.rb",
      "test/test_precedence.rb",
      "test/test_query_string.rb",
      "test/test_regexes.rb",
      "test/test_response_headers.rb",
      "test/test_trailing_slashes.rb",
-     "test/test_utility.rb"
+     "test/test_utility.rb",
+     "test/vendor/right_http_connection-1.2.4/History.txt",
+     "test/vendor/right_http_connection-1.2.4/Manifest.txt",
+     "test/vendor/right_http_connection-1.2.4/README.txt",
+     "test/vendor/right_http_connection-1.2.4/Rakefile",
+     "test/vendor/right_http_connection-1.2.4/lib/net_fix.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/right_http_connection.rb",
+     "test/vendor/right_http_connection-1.2.4/setup.rb",
+     "test/vendor/samuel-0.2.1/.document",
+     "test/vendor/samuel-0.2.1/.gitignore",
+     "test/vendor/samuel-0.2.1/LICENSE",
+     "test/vendor/samuel-0.2.1/README.rdoc",
+     "test/vendor/samuel-0.2.1/Rakefile",
+     "test/vendor/samuel-0.2.1/VERSION",
+     "test/vendor/samuel-0.2.1/lib/samuel.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/net_http.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/request.rb",
+     "test/vendor/samuel-0.2.1/samuel.gemspec",
+     "test/vendor/samuel-0.2.1/test/request_test.rb",
+     "test/vendor/samuel-0.2.1/test/samuel_test.rb",
+     "test/vendor/samuel-0.2.1/test/test_helper.rb",
+     "test/vendor/samuel-0.2.1/test/thread_test.rb"
   ]
   s.homepage = %q{http://github.com/chrisk/fakeweb}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -65,12 +87,23 @@ Gem::Specification.new do |s|
      "test/test_fake_web_open_uri.rb",
      "test/test_helper.rb",
      "test/test_missing_open_uri.rb",
+     "test/test_other_net_http_libraries.rb",
      "test/test_precedence.rb",
      "test/test_query_string.rb",
      "test/test_regexes.rb",
      "test/test_response_headers.rb",
      "test/test_trailing_slashes.rb",
-     "test/test_utility.rb"
+     "test/test_utility.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/net_fix.rb",
+     "test/vendor/right_http_connection-1.2.4/lib/right_http_connection.rb",
+     "test/vendor/right_http_connection-1.2.4/setup.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/net_http.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel/request.rb",
+     "test/vendor/samuel-0.2.1/lib/samuel.rb",
+     "test/vendor/samuel-0.2.1/test/request_test.rb",
+     "test/vendor/samuel-0.2.1/test/samuel_test.rb",
+     "test/vendor/samuel-0.2.1/test/test_helper.rb",
+     "test/vendor/samuel-0.2.1/test/thread_test.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -86,3 +119,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<mocha>, [">= 0.9.5"])
   end
 end
+

data/lib/fake_web.rb

@@ -7,10 +7,13 @@ require 'fake_web/responder'
 require 'fake_web/stub_socket'
 require 'fake_web/utility'
 
+FakeWeb::Utility.record_loaded_net_http_replacement_libs
+FakeWeb::Utility.puts_warning_for_net_http_around_advice_libs_if_needed
+
 module FakeWeb
 
   # Returns the version string for the copy of FakeWeb you have loaded.
-  VERSION = File.read(File.join(File.dirname(__FILE__), "..", "VERSION")).strip
+  VERSION = File.read(File.join(File.dirname(__FILE__), "fake_web", "VERSION")).strip
 
   # Resets the FakeWeb Registry. This will force all subsequent web requests to
   # behave as real requests.

data/lib/fake_web/VERSION

@@ -0,0 +1 @@
+1.2.7

data/lib/fake_web/ext/net_http.rb

@@ -5,8 +5,7 @@ require 'stringio'
 module Net  #:nodoc: all
 
   class BufferedIO
-    alias initialize_without_fakeweb initialize
-    def initialize(io, debug_output = nil)
+    def initialize_with_fakeweb(io, debug_output = nil)
       @read_timeout = 60
       @rbuf = ''
       @debug_output = debug_output
@@ -23,18 +22,20 @@ module Net  #:nodoc: all
       end
       raise "Unable to create local socket" unless @io
     end
+    alias_method :initialize_without_fakeweb, :initialize
+    alias_method :initialize, :initialize_with_fakeweb
   end
 
   class HTTP
     class << self
-      alias socket_type_without_fakeweb socket_type
-      def socket_type
+      def socket_type_with_fakeweb
         FakeWeb::StubSocket
       end
+      alias_method :socket_type_without_fakeweb, :socket_type
+      alias_method :socket_type, :socket_type_with_fakeweb
     end
 
-    alias request_without_fakeweb request
-    def request(request, body = nil, &block)
+    def request_with_fakeweb(request, body = nil, &block)
       protocol = use_ssl? ? "https" : "http"
 
       path = request.path
@@ -62,10 +63,19 @@ module Net  #:nodoc: all
               "Real HTTP connections are disabled. Unregistered request: #{request.method} #{uri}"
       end
     end
+    alias_method :request_without_fakeweb, :request
+    alias_method :request, :request_with_fakeweb
 
-    alias connect_without_fakeweb connect
-    def connect
+
+    def connect_with_fakeweb
+      unless @@alredy_checked_for_net_http_replacement_libs ||= false
+        FakeWeb::Utility.puts_warning_for_net_http_replacement_libs_if_needed
+        @@alredy_checked_for_net_http_replacement_libs = true
+      end
+      nil
     end
+    alias_method :connect_without_fakeweb, :connect
+    alias_method :connect, :connect_with_fakeweb
   end
 
 end

data/lib/fake_web/registry.rb

@@ -74,32 +74,19 @@ module FakeWeb
 
 
     def variations_of_uri_as_strings(uri_object)
-      uris = []
-      normalized_uri = normalize_uri(uri_object)
+      normalized_uri = normalize_uri(uri_object.dup)
+      normalized_uri_string = normalized_uri.to_s
 
-      # all orderings of query parameters
-      query = normalized_uri.query
-      if query.nil? || query.empty?
-        uris << normalized_uri
-      else
-        FakeWeb::Utility.simple_array_permutation(query.split('&')) do |p|
-          current_permutation = normalized_uri.dup
-          current_permutation.query = p.join('&')
-          uris << current_permutation
-        end
-      end
-
-      uri_strings = uris.map { |uri| uri.to_s }
+      variations = [normalized_uri_string]
 
-      # including and omitting the default port
+      # if the port is implied in the original, add a copy with an explicit port
       if normalized_uri.default_port == normalized_uri.port
-        uri_strings += uris.map { |uri|
-          uri.to_s.sub(/#{Regexp.escape(normalized_uri.request_uri)}$/,
-                       ":#{normalized_uri.port}#{normalized_uri.request_uri}")
-        }
+        variations << normalized_uri_string.sub(
+                        /#{Regexp.escape(normalized_uri.request_uri)}$/,
+                        ":#{normalized_uri.port}#{normalized_uri.request_uri}")
       end
 
-      uri_strings
+      variations
     end
 
     def normalize_uri(uri)

data/lib/fake_web/utility.rb

@@ -18,26 +18,37 @@ module FakeWeb
       end
     end
 
-    # Array#permutation wrapper for 1.8.6-compatibility. It only supports the
-    # simple case that returns all permutations (so it doesn't take a numeric
-    # argument).
-    def self.simple_array_permutation(array, &block)
-      # use native implementation if it exists
-      return array.permutation(&block) if array.respond_to?(:permutation)
-
-      yield array if array.length <= 1
+    def self.puts_warning_for_net_http_around_advice_libs_if_needed
+      libs = {"Samuel" => defined?(Samuel)}
+      warnings = libs.select { |_, loaded| loaded }.map do |name, _|
+        <<-TEXT.gsub(/ {10}/, '')
+          \e[1mWarning: FakeWeb was loaded after #{name}\e[0m
+          * #{name}'s code is being ignored when a request is handled by FakeWeb,
+            because both libraries work by patching Net::HTTP.
+          * To fix this, just reorder your requires so that FakeWeb is before #{name}.
+        TEXT
+      end
+      $stderr.puts "\n" + warnings.join("\n") + "\n" if warnings.any?
+    end
 
-      array.length.times do |i|
-        rest = array.dup
-        picked = rest.delete_at(i)
-        next if rest.empty?
+    def self.record_loaded_net_http_replacement_libs
+      libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
+      @loaded_net_http_replacement_libs = libs.map { |name, loaded| name if loaded }.compact
+    end
 
-        simple_array_permutation(rest) do |part_of_rest|
-          yield [picked] + part_of_rest
-        end
+    def self.puts_warning_for_net_http_replacement_libs_if_needed
+      libs = {"RightHttpConnection" => defined?(RightHttpConnection)}
+      warnings = libs.select { |_, loaded| loaded }.
+                    reject { |name, _| @loaded_net_http_replacement_libs.include?(name) }.
+                    map do |name, _|
+        <<-TEXT.gsub(/ {10}/, '')
+          \e[1mWarning: #{name} was loaded after FakeWeb\e[0m
+          * FakeWeb's code is being ignored, because #{name} replaces parts of
+            Net::HTTP without deferring to other libraries. This will break Net::HTTP requests.
+          * To fix this, just reorder your requires so that #{name} is before FakeWeb.
+        TEXT
       end
-
-      array
+      $stderr.puts "\n" + warnings.join("\n") + "\n" if warnings.any?
     end
 
   end

data/test/test_fake_web.rb

@@ -533,7 +533,7 @@ class TestFakeWeb < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal "1.2.6", FakeWeb::VERSION
+    assert_equal "1.2.7", FakeWeb::VERSION
   end
 
 end

data/test/test_other_net_http_libraries.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class TestOtherNetHttpLibraries < Test::Unit::TestCase
+
+  def capture_output_from_requiring(libs, additional_code = "")
+    requires = libs.map { |lib| "require '#{lib}'" }.join("; ")
+    fakeweb_dir = "#{File.dirname(__FILE__)}/../lib"
+    vendor_dirs = Dir["#{File.dirname(__FILE__)}/vendor/*/lib"]
+    load_path_opts = vendor_dirs.unshift(fakeweb_dir).map { |dir| "-I#{dir}" }.join(" ")
+
+    # TODO: use the same Ruby executable that this test was invoked with
+    `ruby #{load_path_opts} -e "#{requires}; #{additional_code}" 2>&1`
+  end
+
+  def test_requiring_samuel_before_fakeweb_prints_warning
+    output = capture_output_from_requiring %w(samuel fakeweb)
+    assert_match %r(Warning: FakeWeb was loaded after Samuel), output
+  end
+
+  def test_requiring_samuel_after_fakeweb_does_not_print_warning
+    output = capture_output_from_requiring %w(fakeweb samuel)
+    assert output.empty?
+  end
+
+  def test_requiring_right_http_connection_before_fakeweb_and_then_connecting_does_not_print_warning
+    additional_code = "Net::HTTP.start('example.com')"
+    output = capture_output_from_requiring %w(right_http_connection fakeweb), additional_code
+    assert output.empty?
+  end
+
+  def test_requiring_right_http_connection_after_fakeweb_and_then_connecting_prints_warning
+    additional_code = "Net::HTTP.start('example.com')"
+    output = capture_output_from_requiring %w(fakeweb right_http_connection), additional_code
+    assert_match %r(Warning: RightHttpConnection was loaded after FakeWeb), output
+  end
+
+end

data/test/test_regexes.rb

@@ -44,17 +44,6 @@ class TestRegexes < Test::Unit::TestCase
     end
   end
 
-  def test_requesting_a_uri_that_matches_two_registered_regexes_with_differently_ordered_query_params_raises_an_error
-    FakeWeb.register_uri(:get, %r[example.com/list\?b=2&a=1], :body => "first")
-    FakeWeb.register_uri(:get, %r[example.com/list\?a=1&b=2], :body => "second")
-    assert_raise FakeWeb::MultipleMatchingURIsError do
-      Net::HTTP.start("example.com") { |query| query.get('/list?a=1&b=2') }
-    end
-    assert_raise FakeWeb::MultipleMatchingURIsError do
-      Net::HTTP.start("example.com") { |query| query.get('/list?b=2&a=1') }
-    end
-  end
-
   def test_requesting_a_uri_that_matches_two_registered_regexes_raises_an_error_including_request_info
     FakeWeb.register_uri(:get, %r|http://example\.com/|, :body => "first")
     FakeWeb.register_uri(:get, %r|http://example\.com/a|, :body => "second")
@@ -142,11 +131,27 @@ class TestRegexes < Test::Unit::TestCase
     assert !FakeWeb.registered_uri?(:get, "http://example.com/list?notimportant=1&unimportant=1")
   end
 
-  def test_registry_matches_with_unsorted_query_params
+  def test_registry_does_not_match_when_regex_has_unsorted_query_params
     FakeWeb.register_uri(:get, %r[example\.com/list\?b=2&a=1], :body => "example")
+    assert !FakeWeb.registered_uri?(:get, "http://example.com/list?b=2&a=1")
+    assert !FakeWeb.registered_uri?(:get, "http://example.com/list?a=1&b=2")
+    assert !FakeWeb.registered_uri?(:get, "https://example.com:443/list?b=2&a=1")
+  end
+
+  def test_registry_matches_when_regex_has_sorted_query_params
+    FakeWeb.register_uri(:get, %r[example\.com/list\?a=1&b=2], :body => "example")
     assert FakeWeb.registered_uri?(:get, "http://example.com/list?b=2&a=1")
     assert FakeWeb.registered_uri?(:get, "http://example.com/list?a=1&b=2")
     assert FakeWeb.registered_uri?(:get, "https://example.com:443/list?b=2&a=1")
   end
 
+  def test_registry_matches_quickly_with_lots_of_query_params
+    # regression test for code that tried to calculate the permutations of the
+    # query params, which hangs with a large number of params
+    FakeWeb.register_uri(:get, %r[example.com], :body => "example")
+    Timeout::timeout(1) do
+      FakeWeb.registered_uri?(:get, "http://example.com/?a=1&b=2&c=3&d=4&e=5&f=6&g=7&h=8")
+    end
+  end
+
 end

data/test/test_utility.rb

@@ -67,25 +67,4 @@ class TestUtility < Test::Unit::TestCase
     assert_equal uri, FakeWeb::Utility.strip_default_port_from_uri(uri)
   end
 
-  def test_simple_array_permutation_with_one_element
-    array, permutations = [1], [[1]]
-    FakeWeb::Utility.simple_array_permutation(array) do |permutation|
-      permutations.delete(permutation)
-    end
-    assert permutations.empty?
-  end
-
-  def test_simple_array_permutation_with_three_elements
-    array = [1, 2, 3]
-    permutations = [[1, 2, 3], [1, 3, 2], [2, 1, 3], [2, 3, 1], [3, 1, 2], [3, 2, 1]]
-    FakeWeb::Utility.simple_array_permutation(array) do |permutation|
-      permutations.delete(permutation)
-    end
-    assert permutations.empty?
-  end
-
-  def test_simple_array_permutation_return_value
-    array = [1, 2, 3]
-    assert array, FakeWeb::Utility.simple_array_permutation(array) { }
-  end
 end