vcr 6.4.0 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '029f040c2799268426ac716845881b02d589948a361736e8448eac26b15da750'
-  data.tar.gz: 33334bf1404877fbbe62172c2f1f18ca54849c4e5b4ed8fa9e5f5ca0f1defce5
+  metadata.gz: 8d9f32f07f523abec1ff78ce1c27771cbc7dd0568c80952075c4f28757b6261f
+  data.tar.gz: f4cb9ab001e861be14abee247c834aa5364b4858576bbb4e7dd11ce590f23692
 SHA512:
-  metadata.gz: 417c8864eb697e8009d16941ddceb796e4ebb36b8d4163ff6f8ff94be40a188f4d70a27091c1a6d4ef9972cd73baa9aed24aaa12fcc71d2abb7c8c8d50613bbb
-  data.tar.gz: 327d05ab66eac55749a5e455cb80e2d953277fc557bb1a47bb0d707b734c82149fb59060eafce34373586755b58a9af9aa6a591cecfa646429344b9e1a98d0dd
+  metadata.gz: 4069dfa5b9bf2f682fcff97d9c81fbd4364466a75b1126e3360af71668771d4d1fe0bfd6d6c13f5fa7d0335c4c7ad6eacf655a3ed818a7a5d0851d6aff25270d
+  data.tar.gz: 992c507dcde216017705d4c9550ba9343a8171fe6cc5f633c4c1faca20f0c4bc177906eed9d3831235bdc051141de6dbe225d9fc9dcec85b36afed695fcabe7d

data/lib/vcr/cassette/erb_renderer.rb

@@ -23,7 +23,7 @@ module VCR
 
         raise Errors::MissingERBVariableError.new(
           "The ERB in the #{@cassette_name} cassette file references undefined variable #{e.name}.  " +
-          "Pass it to the cassette using :erb => #{ example_hash.inspect }."
+          "Pass it to the cassette using erb: #{ example_hash.inspect }."
         )
       end
 

data/lib/vcr/cassette/migrator.rb

@@ -102,7 +102,7 @@ module VCR
       end
 
       EMPTY_STRING = if String.method_defined?(:force_encoding)
-        ''.force_encoding("US-ASCII")
+        String.new.force_encoding("US-ASCII")
       else
         ''
       end

data/lib/vcr/cassette.rb

@@ -64,7 +64,7 @@ module VCR
       extract_options
       raise_error_unless_valid_record_mode
 
-      log "Initialized with options: #{@options.inspect}"
+      log "Initialized with options: #{format_options_for_log(@options)}"
     end
 
     # Ejects the current cassette. The cassette will no longer be used.
@@ -147,10 +147,17 @@ module VCR
 
     # @return [Hash] The hash that will be serialized when the cassette is written to disk.
     def serializable_hash
-      {
+      hash = {
         "http_interactions" => interactions_to_record.map(&:to_hash),
         "recorded_with"     => "VCR #{VCR.version}"
       }
+      hash["metadata"] = metadata unless metadata.empty?
+      hash
+    end
+
+    # @return [Hash] Custom metadata associated with the cassette.
+    def metadata
+      @metadata ||= recording? ? {} : (deserialized_hash['metadata'] || {})
     end
 
     # @return [Time, nil] The `recorded_at` time of the first HTTP interaction
@@ -214,6 +221,7 @@ module VCR
       @previously_recorded_interactions ||= if !raw_cassette_bytes.to_s.empty?
         deserialized_hash['http_interactions'].map { |h| HTTPInteraction.from_hash(h) }.tap do |interactions|
           invoke_hook(:before_playback, interactions)
+          invoke_hook(:recompress_response, interactions)
 
           interactions.reject! do |i|
             i.request.uri.is_a?(String) && VCR.request_ignorer.ignore?(i.request)
@@ -338,6 +346,16 @@ module VCR
       @log_prefix ||= "[Cassette: '#{name}'] "
     end
 
+    # Use the legacy `{:key=>val}` format (Ruby 3.4 changed Hash#inspect for symbol keys).
+    def format_options_for_log(value)
+      case value
+      when Hash
+        "{#{value.map { |k, v| "#{k.inspect}=>#{format_options_for_log(v)}" }.join(', ')}}"
+      else
+        value.inspect
+      end
+    end
+
     def request_summary(request)
       super(request, match_requests_on)
     end

data/lib/vcr/configuration.rb

@@ -39,7 +39,7 @@ module VCR
     #   @return [void]
     # @example
     #   VCR.configure do |c|
-    #     c.default_cassette_options = { :record => :new_episodes }
+    #     c.default_cassette_options = { record: :new_episodes }
     #   end
     # @note {VCR#insert_cassette} for the list of valid options.
     attr_reader :default_cassette_options
@@ -184,7 +184,7 @@ module VCR
     #    end
     #  end
     #
-    #  VCR.use_cassette("my_cassette", :match_requests_on => [:method, :host, :port]) do
+    #  VCR.use_cassette("my_cassette", match_requests_on: [:method, :host, :port]) do
     #    # ...
     #  end
     #
@@ -490,14 +490,14 @@ module VCR
       @allow_http_connections_when_no_cassette = nil
       @rspec_metadata_configured = false
       @default_cassette_options = {
-        :record            => :once,
-        :record_on_error   => true,
-        :match_requests_on => RequestMatcherRegistry::DEFAULT_MATCHERS,
-        :allow_unused_http_interactions => true,
-        :drop_unused_requests => false,
-        :serialize_with    => :yaml,
-        :persist_with      => :file_system,
-        :persister_options => {}
+        record:            :once,
+        record_on_error:   true,
+        match_requests_on: RequestMatcherRegistry::DEFAULT_MATCHERS,
+        allow_unused_http_interactions: true,
+        drop_unused_requests: false,
+        serialize_with:    :yaml,
+        persist_with:      :file_system,
+        persister_options: {}
       }
 
       self.uri_parser = URI
@@ -566,8 +566,10 @@ module VCR
       lambda { |arg| arg.send(object) }
     end
 
+    define_hook :recompress_response
+
     def register_built_in_hooks
-      before_playback(:recompress_response) do |interaction|
+      recompress_response(tag_filter_from(:recompress_response)) do |interaction|
         interaction.response.recompress if interaction.response.vcr_decompressed?
       end
 

data/lib/vcr/errors.rb

@@ -157,8 +157,8 @@ module VCR
         lines = current_cassettes.inject(lines) do |memo, cassette|
           memo.concat([
              "  - #{cassette.file}",
-             "    - :record => #{cassette.record_mode.inspect}",
-             "    - :match_requests_on => #{cassette.match_requests_on.inspect}"
+             "    - record: #{cassette.record_mode.inspect}",
+             "    - match_requests_on: #{cassette.match_requests_on.inspect}"
           ])
         end
 
@@ -192,27 +192,27 @@ module VCR
 
       # List of suggestions for how to configure VCR to handle the request.
       ALL_SUGGESTIONS = {
-        :use_new_episodes => [
+        use_new_episodes: [
           ["You can use the :new_episodes record mode to allow VCR to",
            "record this new request to the existing cassette"],
           "https://benoittgt.github.io/vcr/?v=%s#/record_modes/new_episodes"
         ],
 
-        :delete_cassette_for_once => [
+        delete_cassette_for_once: [
           ["The current record mode (:once) does not allow new requests to be recorded",
            "to a previously recorded cassette. You can delete the cassette file and re-run",
            "your tests to allow the cassette to be recorded with this request"],
           "https://benoittgt.github.io/vcr/?v=%s#/record_modes/once"
         ],
 
-        :deal_with_none => [
+        deal_with_none: [
           ["The current record mode (:none) does not allow requests to be recorded. You",
            "can temporarily change the record mode to :once, delete the cassette file ",
            "and re-run your tests to allow the cassette to be recorded with this request"],
           "https://benoittgt.github.io/vcr/?v=%s#/record_modes/none"
         ],
 
-        :none_without_file => [
+        none_without_file: [
           ["The current record mode (:none) does not allow requests to be recorded.",
            "One or more cassette names registered was not found. Use ",
            ":new_episodes or :once record modes to record a new cassette"],
@@ -220,27 +220,27 @@ module VCR
         ],
           
 
-        :use_a_cassette => [
+        use_a_cassette: [
           ["If you want VCR to record this request and play it back during future test",
            "runs, you should wrap your test (or this portion of your test) in a",
            "`VCR.use_cassette` block"],
           "https://benoittgt.github.io/vcr/?v=%s#/getting_started"
         ],
 
-        :allow_http_connections_when_no_cassette => [
+        allow_http_connections_when_no_cassette: [
           ["If you only want VCR to handle requests made while a cassette is in use,",
            "configure `allow_http_connections_when_no_cassette = true`. VCR will",
            "ignore this request since it is made when there is no cassette"],
           "https://benoittgt.github.io/vcr/?v=%s#/configuration/allow_http_connections_when_no_cassette"
         ],
 
-        :ignore_request => [
+        ignore_request: [
           ["If you want VCR to ignore this request (and others like it), you can",
            "set an `ignore_request` callback"],
           "https://benoittgt.github.io/vcr/?v=%s#/configuration/ignore_request"
         ],
 
-        :allow_playback_repeats => [
+        allow_playback_repeats: [
           ["The cassette contains an HTTP interaction that matches this request,",
            "but it has already been played back. If you wish to allow a single HTTP",
            "interaction to be played back multiple times, set the `:allow_playback_repeats`",
@@ -248,7 +248,7 @@ module VCR
           "https://benoittgt.github.io/vcr/?v=%s#/request_matching/playback_repeats"
         ],
 
-        :match_requests_on => [
+        match_requests_on: [
           ["The cassette contains %s not been",
            "played back. If your request is non-deterministic, you may need to",
            "change your :match_requests_on cassette option to be more lenient",
@@ -256,7 +256,7 @@ module VCR
           "https://benoittgt.github.io/vcr/?v=%s#/request_matching"
         ],
 
-        :try_debug_logger => [
+        try_debug_logger: [
           ["If you're surprised VCR is raising this error",
            "and want insight about how VCR attempted to handle the request,",
            "you can use the debug_logger configuration option to log more details"],

data/lib/vcr/library_hooks/typhoeus.rb

@@ -40,13 +40,13 @@ module VCR
 
         def on_stubbed_by_vcr_request
           response = ::Typhoeus::Response.new \
-            :http_version   => stubbed_response.http_version,
-            :code           => stubbed_response.status.code,
-            :status_message => stubbed_response.status.message,
-            :headers        => stubbed_response_headers,
-            :body           => stubbed_response.body,
-            :effective_url  => stubbed_response.adapter_metadata.fetch('effective_url', request.url),
-            :mock           => true
+            http_version:   stubbed_response.http_version,
+            code:           stubbed_response.status.code,
+            status_message: stubbed_response.status.message,
+            headers:        stubbed_response_headers,
+            body:           stubbed_response.body,
+            effective_url:  stubbed_response.adapter_metadata.fetch('effective_url', request.url),
+            mock:           true
 
           first_header_line = "HTTP/#{stubbed_response.http_version} #{response.code} #{response.status_message}\r\n"
           response.instance_variable_set(:@first_header_line, first_header_line)

data/lib/vcr/library_hooks/webmock.rb

@@ -122,9 +122,9 @@ module VCR
 
         def on_stubbed_by_vcr_request
           {
-            :body    => stubbed_response.body.dup, # Excon mutates the body, so we must dup it :-(
-            :status  => [stubbed_response.status.code.to_i, stubbed_response.status.message],
-            :headers => stubbed_response.headers
+            body:    stubbed_response.body.dup, # Excon mutates the body, so we must dup it :-(
+            status:  [stubbed_response.status.code.to_i, stubbed_response.status.message],
+            headers: stubbed_response.headers
           }
         end
       end
@@ -135,7 +135,7 @@ module VCR
         global_hook_disabled?(req) ? nil : RequestHandler.new(req).handle
       end
 
-      ::WebMock.after_request(:real_requests_only => true) do |request, response|
+      ::WebMock.after_request(real_requests_only: true) do |request, response|
         unless VCR.library_hooks.disabled?(:webmock)
           http_interaction = VCR::HTTPInteraction.new \
             typed_request_for(request), vcr_response_for(response)

data/lib/vcr/middleware/excon.rb

@@ -102,9 +102,9 @@ module VCR
 
         def on_stubbed_by_vcr_request
           request_params[:response] = {
-            :body     => stubbed_response.body.dup, # Excon mutates the body, so we must dup it :-(
-            :headers  => normalized_headers(stubbed_response.headers || {}),
-            :status   => stubbed_response.status.code
+            body:    stubbed_response.body.dup, # Excon mutates the body, so we must dup it :-(
+            headers: normalized_headers(stubbed_response.headers || {}),
+            status:  stubbed_response.status.code
           }
         end
 

data/lib/vcr/middleware/faraday.rb

@@ -100,7 +100,7 @@ module VCR
         def on_stubbed_by_vcr_request
           headers = env[:response_headers] ||= ::Faraday::Utils::Headers.new
           headers.update stubbed_response.headers if stubbed_response.headers
-          env.update :status => stubbed_response.status.code, :body => stubbed_response.body
+          env.update status: stubbed_response.status.code, body: stubbed_response.body
 
           @vcr_response = stubbed_response
 

data/lib/vcr/middleware/rack.rb

@@ -33,7 +33,7 @@ module VCR
     #   app = Rack::Builder.new do
     #     use VCR::Middleware::Rack do |cassette, env|
     #       cassette.name "rack/#{env['SERVER_NAME']}"
-    #       cassette.options :record => :new_episodes
+    #       cassette.options record: :new_episodes
     #     end
     #
     #     run MyRackApp

data/lib/vcr/request_matcher_registry.rb

@@ -77,14 +77,14 @@ module VCR
     #   without_timestamp = VCR.request_matchers.uri_without_param(:timestamp)
     #
     #   # use it directly...
-    #   VCR.use_cassette('example', :match_requests_on => [:method, without_timestamp]) { }
+    #   VCR.use_cassette('example', match_requests_on: [:method, without_timestamp]) { }
     #
     #   # ...or register it as a named matcher
     #   VCR.configure do |c|
     #     c.register_request_matcher(:uri_without_timestamp, &without_timestamp)
     #   end
     #
-    #   VCR.use_cassette('example', :match_requests_on => [:method, :uri_without_timestamp]) { }
+    #   VCR.use_cassette('example', match_requests_on: [:method, :uri_without_timestamp]) { }
     #
     # @param ignores [Array<#to_s>] The names of the query parameters to ignore
     # @return [#call] the request matcher

data/lib/vcr/structs.rb

@@ -38,7 +38,7 @@ module VCR
           # ASCII-8BIT just means binary, so encoding to it is nonsensical
           # and yet "\u00f6".encode("ASCII-8BIT") raises an error.
           # Instead, we'll force encode it (essentially just tagging it as binary)
-          return string.force_encoding(encoding) if encoding == Encoding::BINARY
+          return string.dup.force_encoding(encoding) if encoding == Encoding::BINARY
 
           string.encode(encoding)
         rescue EncodingError => e
@@ -366,8 +366,10 @@ module VCR
     end
 
     # Checks if the type of encoding is one of "gzip" or "deflate".
+    # An empty body is never compressed, whatever the header says: a HEAD
+    # response carries the Content-Encoding of the GET it describes.
     def compressed?
-      %w[ gzip deflate ].include? content_encoding
+      !body.to_s.empty? && %w[ gzip deflate ].include?(content_encoding)
     end
 
     # Checks if VCR decompressed the response body
@@ -381,6 +383,8 @@ module VCR
     # @raise [VCR::Errors::UnknownContentEncodingError] if the content encoding
     #  is not a known encoding.
     def decompress
+      return self if body.to_s.empty?
+
       self.class.decompress(body, content_encoding) { |new_body|
         self.body = new_body
         update_content_length_header
@@ -399,7 +403,7 @@ module VCR
       new_body = begin
         case type
         when 'gzip'
-          body_str = ''
+          body_str = String.new
           writer = Zlib::GzipWriter.new(StringIO.new(body_str), encoding: 'ASCII-8BIT')
           writer.write(body)
           writer.close
@@ -545,11 +549,23 @@ module VCR
       def filter!(text, replacement_text)
         text, replacement_text = text.to_s, replacement_text.to_s
         return self if [text, replacement_text].any? { |t| t.empty? }
+        ensure_mutable_strings!(self)
         filter_object!(self, text, replacement_text)
       end
 
     private
 
+      # Walk the interaction and replace any String values with a dup'd copy
+      # so that subsequent in-place mutations (e.g. gsub!) don't trigger
+      # "literal string will be frozen" warnings on Ruby 3.4+.
+      def ensure_mutable_strings!(object)
+        if object.respond_to?(:each_pair) && object.respond_to?(:[]=)
+          object.each_pair { |name, v| v.is_a?(String) ? object[name] = v.dup : ensure_mutable_strings!(v) }
+        elsif object.is_a?(Array)
+          object.each_with_index { |o, i| o.is_a?(String) ? object[i] = o.dup : ensure_mutable_strings!(o) }
+        end
+      end
+
       def filter_object!(object, text, replacement_text)
         if object.respond_to?(:gsub)
           object.gsub!(text, replacement_text) if object.include?(text)

data/lib/vcr/test_frameworks/cucumber.rb

@@ -25,7 +25,7 @@ module VCR
     #
     # @param tag_names [Array<String,Hash>] the cucumber scenario tags. If
     #  the last argument is a hash it is treated as cassette options.
-    #   - `:use_scenario_name => true` to automatically name the
+    #   - `use_scenario_name: true` to automatically name the
     #     cassette according to the scenario name.
     def tags(*tag_names)
       original_options = tag_names.last.is_a?(::Hash) ? tag_names.pop : {}
@@ -71,7 +71,7 @@ module VCR
         end
 
         @main_object.After(tag_name) do |scenario|
-          VCR.eject_cassette(:skip_no_unused_interactions_assertion => scenario.failed?)
+          VCR.eject_cassette(skip_no_unused_interactions_assertion: scenario.failed?)
         end
 
         self.class.add_tag(tag_name)

data/lib/vcr/test_frameworks/rspec.rb

@@ -30,7 +30,7 @@ module VCR
       def configure!
         ::RSpec.configure do |config|
 
-          when_tagged_with_vcr = { :vcr => lambda { |v| !!v } }
+          when_tagged_with_vcr = { vcr: lambda { |v| !!v } }
 
           config.before(:each, when_tagged_with_vcr) do |ex|
             example = ex.respond_to?(:metadata) ? ex : ex.example
@@ -54,7 +54,7 @@ module VCR
 
           config.after(:each, when_tagged_with_vcr) do |ex|
             example = ex.respond_to?(:metadata) ? ex : ex.example
-            VCR.eject_cassette(:skip_no_unused_interactions_assertion => !!example.exception)
+            VCR.eject_cassette(skip_no_unused_interactions_assertion: !!example.exception)
           end
         end
       end

data/lib/vcr/version.rb

@@ -10,7 +10,7 @@ module VCR
   #   * `parts` [Array<Integer>] List of the version parts.
   def version
     @version ||= begin
-      string = +'6.4.0'
+      string = +'6.4.1'
 
       def string.parts
         split('.').map { |p| p.to_i }

data/lib/vcr.rb

@@ -56,7 +56,7 @@ module VCR
   # `:record` option.
   #
   # @example
-  #   VCR.insert_cassette('twitter', :record => :new_episodes)
+  #   VCR.insert_cassette('twitter', record: :new_episodes)
   #
   #   # ...later, after making an HTTP request:
   #
@@ -140,7 +140,7 @@ module VCR
       cassette
     elsif !ignore_cassettes?
       message = "VCR is turned off.  You must turn it on before you can insert a cassette.  " +
-                "Or you can use the `:ignore_cassettes => true` option to completely ignore cassette insertions."
+                "Or you can use the `ignore_cassettes: true` option to completely ignore cassette insertions."
       raise TurnedOffError.new(message)
     end
   end
@@ -152,7 +152,7 @@ module VCR
   # @param options [Hash] Eject options.
   # @option options :skip_no_unused_interactions_assertion [Boolean]
   #  If `true` is given, this will skip the "no unused HTTP interactions"
-  #  assertion enabled by the `:allow_unused_http_interactions => false`
+  #  assertion enabled by the `allow_unused_http_interactions: false`
   #  cassette option. This is intended for use when your test has had
   #  an error, but your test framework has already handled it.
   # @return [VCR::Cassette, nil] the ejected cassette if there was one
@@ -168,7 +168,7 @@ module VCR
   # block, and ejects the cassette.
   #
   # @example
-  #   VCR.use_cassette('twitter', :record => :new_episodes) do
+  #   VCR.use_cassette('twitter', record: :new_episodes) do
   #     # make an HTTP request
   #   end
   #
@@ -246,7 +246,7 @@ module VCR
   # @example
   #   VCR.cucumber_tags do |t|
   #     t.tags "tag1", "tag2"
-  #     t.tag "@some_other_tag", :record => :new_episodes
+  #     t.tag "@some_other_tag", record: :new_episodes
   #   end
   #
   # @yield the cucumber tags configuration block
@@ -434,10 +434,10 @@ private
 
   def dup_context(context)
     {
-      :turned_off => context[:turned_off],
-      :ignore_cassettes => context[:ignore_cassettes],
-      :cassettes => [],
-      :linked_context => context
+      turned_off:       context[:turned_off],
+      ignore_cassettes: context[:ignore_cassettes],
+      cassettes:        [],
+      linked_context:   context
     }
   end
 
@@ -462,10 +462,10 @@ private
     initialize_fibers
     @context = {
       MainThread => {
-        :turned_off => false,
-        :ignore_cassettes => false,
-        :cassettes => [],
-        :linked_context => nil
+        turned_off:       false,
+        ignore_cassettes: false,
+        cassettes:        [],
+        linked_context:   nil
       }
     }
     @configuration = Configuration.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcr
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.4.1
 platform: ruby
 authors:
 - Myron Marston
@@ -63,7 +63,7 @@ licenses:
 - Hippocratic-2.1
 - MIT
 metadata:
-  changelog_uri: https://github.com/vcr/vcr/blob/v6.4.0/CHANGELOG.md
+  changelog_uri: https://github.com/vcr/vcr/blob/v6.4.1/CHANGELOG.md
   funding_uri: https://opencollective.com/vcr
 rdoc_options: []
 require_paths:
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.14
 specification_version: 4
 summary: Record your test suite's HTTP interactions and replay them during future
   test runs for fast, deterministic, accurate tests.