vcr 2.9.3 → 3.0.0

data/features/support/env.rb

@@ -1,41 +1,44 @@
-require 'rubygems'
 require 'bundler'
 Bundler.setup
 
-require 'ruby-debug' if !defined?(RUBY_ENGINE) && RUBY_VERSION != '1.9.3' && !ENV['CI']
+ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
 
 require 'aruba/cucumber'
 require 'aruba/jruby' if RUBY_PLATFORM == 'java'
 
-additional_paths = []
-Before('@rspec-1') do
-  additional_paths << File.join(%w[ .. .. vendor rspec-1 bin ])
-end
-
-Before do
-  load_paths, requires = ['../../lib'], []
-
-  # Put any bundler-managed gems (such as :git gems) on the load path for when aruba shells out.
-  # Alternatively, we could hook up aruba to use bundler when it shells out, but invoking bundler
-  # for each and every time aruba starts ruby would slow everything down. We really only need it for
-  # bundler-managed gems.
-  load_paths.push($LOAD_PATH.grep %r|bundler/gems|)
-
-  if RUBY_VERSION < '1.9'
-    requires << "rubygems"
+gem_specs = Bundler.load.specs
+load_paths = Dir.glob(gem_specs.map { |spec|
+  if spec.respond_to?(:lib_dirs_glob)
+    spec.lib_dirs_glob
   else
-    load_paths << '.'
+    spec.load_paths
   end
+}.flatten)
 
-  requires << '../../features/support/vcr_cucumber_helpers'
-  requires.map! { |r| "-r#{r}" }
-  set_env('RUBYOPT', "-I#{load_paths.join(':')} #{requires.join(' ')}")
+load_paths << File.expand_path("../../../spec", __FILE__)
+rubyopt = "-rsupport/cucumber_helpers"
 
-  if additional_paths.any?
-    existing_paths = ENV['PATH'].split(':')
-    set_env('PATH', (additional_paths + existing_paths).join(':'))
+if RUBY_VERSION > '1.9'
+  load_paths.unshift(".")
+  rubyopt = "--disable-gems #{rubyopt}" if "ruby" == ruby_engine
+end
+
+Before do
+  @aruba_timeout_seconds = 30
+  if "jruby" == ruby_engine
+    @aruba_io_wait_seconds = 0.1
+  else
+    @aruba_io_wait_seconds = 0.02
   end
+end
 
-  @aruba_timeout_seconds = 60
+Before("~@with-bundler") do
+  set_env("RUBYLIB", load_paths.join(":"))
+  set_env("RUBYOPT", rubyopt)
 end
 
+Before("@with-bundler") do
+  set_env("RUBYLIB", ".:#{ENV["RUBYLIB"]}:#{load_paths.last}")
+  set_env("RUBYOPT", "#{ENV["RUBYOPT"]} -rsupport/cucumber_helpers")
+  set_env("BUNDLE_GEMFILE", Bundler.default_gemfile.expand_path.to_s)
+end

data/features/support/http_lib_filters.rb

@@ -1,10 +1,3 @@
-# make the values of the example row cells available as an array...
-Cucumber::Ast::OutlineTable::ExampleRow.class_eval do
-  def cell_values
-    @cells.map { |c| c.value  }
-  end
-end
-
 if RUBY_VERSION == '1.8.7'
   # We get timeouts on 1.8.7 w/ Patron for some reason.
   UNSUPPORTED_HTTP_LIBS = %w[ patron ]

data/features/test_frameworks/cucumber.feature

@@ -1,3 +1,4 @@
+@with-bundler
 Feature: Usage with Cucumber
 
   VCR can be used with cucumber in two basic ways:
@@ -35,7 +36,7 @@ Feature: Usage with Cucumber
     Given a file named "lib/server.rb" with:
       """ruby
       if ENV['WITH_SERVER'] == 'true'
-        start_sinatra_app(:port => 7777) do
+        $server = start_sinatra_app do
           get('/:path') { "Hello #{params[:path]}" }
         end
       end
@@ -49,6 +50,9 @@ Feature: Usage with Cucumber
       VCR.configure do |c|
         c.hook_into :webmock
         c.cassette_library_dir     = 'features/cassettes'
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
       end
 
       VCR.cucumber_tags do |t|
@@ -62,15 +66,17 @@ Feature: Usage with Cucumber
       require 'net/http'
 
       When /^a request is made to "([^"]*)"$/ do |url|
-        @response = Net::HTTP.get_response(URI.parse(url))
+        uri = URI.parse(url)
+        uri.port = $server.port if $server
+        @response = Net::HTTP.get_response(uri)
       end
 
-      When /^(.*) within a cassette named "([^"]*)"$/ do |step, cassette_name|
-        VCR.use_cassette(cassette_name) { When step }
+      When /^(.*) within a cassette named "([^"]*)"$/ do |step_name, cassette_name|
+        VCR.use_cassette(cassette_name) { step(step_name) }
       end
 
       Then /^the response should be "([^"]*)"$/ do |expected_response|
-        @response.body.should == expected_response
+        expect(@response.body).to eq(expected_response)
       end
       """
     And a file named "features/vcr_example.feature" with:
@@ -122,11 +128,6 @@ Feature: Usage with Cucumber
     And the directory "features/cassettes" does not exist
     When I run `cucumber WITH_SERVER=true features/vcr_example.feature`
     Then it should fail with "5 scenarios (2 failed, 3 passed)"
-    And the output should contain each of the following:
-      | An HTTP request has been made that VCR does not know how to handle:               |
-      |   GET http://localhost:7777/disallowed_1                                          |
-      | An HTTP request has been made that VCR does not know how to handle:               |
-      |   GET http://localhost:7777/disallowed_2                                          |
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "Hello localhost_request_1"
     And the file "features/cassettes/cucumber_tags/localhost_request.yml" should contain "Hello localhost_request_2"
     And the file "features/cassettes/nested_cassette.yml" should contain "Hello nested_cassette"

data/features/test_frameworks/rspec_macro.feature

@@ -1,3 +1,4 @@
+@with-bundler
 Feature: Usage with RSpec macro
 
   VCR provides a macro that makes it easy to use a VCR cassette for an RSpec
@@ -28,7 +29,7 @@ Feature: Usage with RSpec macro
         | spec/cassettes/net_http_example.yml                                        |
     And a file named "spec/sinatra_app.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { "Hello" }
       end
       """
@@ -38,14 +39,14 @@ Feature: Usage with RSpec macro
 
       describe "VCR-RSpec integration" do
         def make_http_request
-          Net::HTTP.get_response('localhost', '/', 7777).body
+          Net::HTTP.get_response('localhost', '/', $server.port).body
         end
 
         context "without an explicit cassette name" do
           use_vcr_cassette
 
           it 'records an http request' do
-            make_http_request.should == 'Hello'
+            expect(make_http_request).to eq('Hello')
           end
         end
 
@@ -53,7 +54,7 @@ Feature: Usage with RSpec macro
           use_vcr_cassette "net_http_example"
 
           it 'records an http request' do
-            make_http_request.should == 'Hello'
+            expect(make_http_request).to eq('Hello')
           end
         end
       end
@@ -78,29 +79,3 @@ Feature: Usage with RSpec macro
     Then the output should contain "2 examples, 0 failures"
      And the file "spec/cassettes/VCR-RSpec_integration/without_an_explicit_cassette_name.yml" should contain "Hello"
      And the file "spec/cassettes/net_http_example.yml" should contain "Hello"
-
-  @rspec-1 @exclude-jruby
-  Scenario: Use `use_vcr_cassette` macro with RSpec 1
-    Given a file named "spec/spec_helper.rb" with:
-      """ruby
-      require 'sinatra_app'
-
-      require 'spec'
-      require 'spec/autorun'
-
-      require 'vcr'
-
-      VCR.configure do |c|
-        c.cassette_library_dir = 'spec/cassettes'
-        c.hook_into :webmock
-      end
-
-      Spec::Runner.configure do |c|
-        c.extend VCR::RSpec::Macros
-      end
-      """
-    When I run `spec spec/vcr_example_spec.rb`
-    Then the output should contain "2 examples, 0 failures"
-     And the file "spec/cassettes/VCR-RSpec_integration/without_an_explicit_cassette_name.yml" should contain "Hello"
-     And the file "spec/cassettes/net_http_example.yml" should contain "Hello"
-

data/features/test_frameworks/rspec_metadata.feature

@@ -1,3 +1,4 @@
+@with-bundler
 Feature: Usage with RSpec metadata
 
   VCR provides easy integration with RSpec using metadata. To set this
@@ -57,35 +58,35 @@ Feature: Usage with RSpec metadata
   Scenario: Use `:vcr` metadata
     Given a file named "spec/vcr_example_spec.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { "Hello" }
       end
 
       def make_http_request
-        Net::HTTP.get_response('localhost', '/', 7777).body
+        Net::HTTP.get_response('localhost', '/', $server.port).body
       end
 
       require 'spec_helper'
 
       describe "VCR example group metadata", :vcr do
         it 'records an http request' do
-          make_http_request.should == 'Hello'
+          expect(make_http_request).to eq('Hello')
         end
 
         it 'records another http request' do
-          make_http_request.should == 'Hello'
+          expect(make_http_request).to eq('Hello')
         end
 
         context 'in a nested example group' do
           it 'records another one' do
-            make_http_request.should == 'Hello'
+            expect(make_http_request).to eq('Hello')
           end
         end
       end
 
       describe "VCR example metadata" do
         it 'records an http request', :vcr do
-          make_http_request.should == 'Hello'
+          expect(make_http_request).to eq('Hello')
         end
       end
       """
@@ -137,11 +138,11 @@ Feature: Usage with RSpec metadata
       vcr_options = { :cassette_name => "example", :record => :new_episodes }
       describe "Using an options hash", :vcr => vcr_options do
         it 'uses the provided cassette name' do
-          VCR.current_cassette.name.should == "example"
+          expect(VCR.current_cassette.name).to eq("example")
         end
 
         it 'sets the given options' do
-          VCR.current_cassette.record_mode.should == :new_episodes
+          expect(VCR.current_cassette.record_mode).to eq(:new_episodes)
         end
       end
       """

data/features/test_frameworks/test_unit.feature

@@ -6,7 +6,7 @@ Feature: Usage with Test::Unit
   Scenario: Use `VCR.use_cassette` in a test
     Given a file named "test/test_server.rb" with:
       """ruby
-      start_sinatra_app(:port => 7777) do
+      $server = start_sinatra_app do
         get('/') { "Hello" }
       end
       """
@@ -19,6 +19,9 @@ Feature: Usage with Test::Unit
       VCR.configure do |c|
         c.hook_into :webmock
         c.cassette_library_dir = 'test/fixtures/vcr_cassettes'
+        c.default_cassette_options = {
+          :match_requests_on => [:method, :host, :path]
+        }
       end
       """
     And a file named "test/vcr_example_test.rb" with:
@@ -28,7 +31,7 @@ Feature: Usage with Test::Unit
       class VCRExampleTest < Test::Unit::TestCase
         def test_use_vcr
           VCR.use_cassette('test_unit_example') do
-            response = Net::HTTP.get_response('localhost', '/', 7777)
+            response = Net::HTTP.get_response('localhost', '/', $server ? $server.port : 0)
             assert_equal "Hello", response.body
           end
         end

data/lib/vcr.rb

@@ -22,6 +22,12 @@ module VCR
 
   extend self
 
+  # Mutex to synchronize access to cassettes in a threaded environment
+  CassetteMutex = Mutex.new
+
+  # The main thread in which VCR was loaded
+  MainThread = Thread.current
+
   autoload :CucumberTags,       'vcr/test_frameworks/cucumber'
   autoload :InternetConnection, 'vcr/util/internet_connection'
 
@@ -201,7 +207,7 @@ module VCR
 
   # @return [VCR::Configuration] the VCR configuration.
   def configuration
-    @configuration ||= Configuration.new
+    @configuration
   end
 
   # Sets up `Before` and `After` cucumber hooks in order to
@@ -256,13 +262,13 @@ module VCR
                                 "You must eject it before you can turn VCR off."
     end
 
-    @ignore_cassettes = options[:ignore_cassettes]
+    set_context_value(:ignore_cassettes, options[:ignore_cassettes])
     invalid_options = options.keys - [:ignore_cassettes]
     if invalid_options.any?
       raise ArgumentError.new("You passed some invalid options: #{invalid_options.inspect}")
     end
 
-    @turned_off = true
+    set_context_value(:turned_off, true)
   end
 
   # Turns on VCR, if it has previously been turned off.
@@ -271,7 +277,7 @@ module VCR
   # @see #turned_off
   # @see #turned_on?
   def turn_on!
-    @turned_off = false
+    set_context_value(:turned_off, false)
   end
 
   # @return whether or not VCR is turned on
@@ -281,7 +287,7 @@ module VCR
   # @see #turn_off!
   # @see #turned_off
   def turned_on?
-    !@turned_off
+    !context_value(:turned_off)
   end
 
   # @private
@@ -293,32 +299,32 @@ module VCR
   # @private
   def real_http_connections_allowed?
     return current_cassette.recording? if current_cassette
-    !!(configuration.allow_http_connections_when_no_cassette? || @turned_off)
+    !!(configuration.allow_http_connections_when_no_cassette? || !turned_on?)
   end
 
   # @return [RequestMatcherRegistry] the request matcher registry
   def request_matchers
-    @request_matchers ||= RequestMatcherRegistry.new
+    @request_matchers
   end
 
   # @private
   def request_ignorer
-    @request_ignorer ||= RequestIgnorer.new
+    @request_ignorer
   end
 
   # @private
   def library_hooks
-    @library_hooks ||= LibraryHooks.new
+    @library_hooks
   end
 
   # @private
   def cassette_serializers
-    @cassette_serializers ||= Cassette::Serializers.new
+    @cassette_serializers
   end
 
   # @private
   def cassette_persisters
-    @cassette_persisters ||= Cassette::Persisters.new
+    @cassette_persisters
   end
 
   # @private
@@ -329,18 +335,84 @@ module VCR
     cassette.record_http_interaction(interaction)
   end
 
+  # @private
+  def link_context(from_thread, to_key)
+    @context[to_key] = get_context(from_thread)
+  end
+
+  # @private
+  def unlink_context(key)
+    @context.delete(key)
+  end
+
+  # @private
+  def fibers_available?
+    @fibers_available
+  end
+
 private
+  def current_context
+    get_context(Thread.current, Fiber.current)
+  end
+
+  def get_context(thread_key, fiber_key = nil)
+    context = @context[fiber_key] if fiber_key
+    context ||= @context[thread_key]
+    if context
+      context
+    else
+      @context[thread_key] = dup_context(@context[MainThread])
+    end
+  end
+
+  def context_value(name)
+    current_context[name]
+  end
+
+  def set_context_value(name, value)
+    current_context[name] = value
+  end
+
+  def dup_context(context)
+    {
+      :turned_off => context[:turned_off],
+      :ignore_cassettes => context[:ignore_cassettes].dup,
+      :cassettes => context[:cassettes].dup
+    }
+  end
 
   def ignore_cassettes?
-    @ignore_cassettes
+    context_value(:ignore_cassettes)
   end
 
   def cassettes
-    @cassettes ||= []
+    context_value(:cassettes)
+  end
+
+  def initialize_fibers
+    begin
+      require 'fiber'
+      @fibers_available = true
+    rescue LoadError
+      @fibers_available = false
+    end
   end
 
   def initialize_ivars
-    @turned_off = false
+    initialize_fibers
+    @context = {
+      MainThread => {
+        :turned_off => false,
+        :ignore_cassettes => [],
+        :cassettes => []
+      }
+    }
+    @configuration = Configuration.new
+    @request_matchers = RequestMatcherRegistry.new
+    @request_ignorer = RequestIgnorer.new
+    @library_hooks = LibraryHooks.new
+    @cassette_serializers = Cassette::Serializers.new
+    @cassette_persisters = Cassette::Persisters.new
   end
 
   initialize_ivars # to avoid warnings