rspec-cassette 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a295971bad6b1f3461dd25a592349835c0944f587d6276098e53c3ac64468267
-  data.tar.gz: 4bde9b73040304c11eef974d844f11ffc97737989eabbe0ed8c9b1a3098c32a0
+  metadata.gz: 81ec6b2f1d492c9ed7a6aa19fcb7b2c4ad0b3eaed666158425cf271a96ddf485
+  data.tar.gz: 218103dde5699758cb6a0d313208ae980403c1ee802dba5606e1c62dbb436a6b
 SHA512:
-  metadata.gz: ef495ef8f33774e6433f6f5bcf1a97391bf056487562e52bb44e63f04e842faed96c3b84cef48e28f920acb6fc77523b4f5b725a0f412f578725c732a3fa0562
-  data.tar.gz: a8299f4c8a17f80c80f6dc7731017b4466fdcbc0e683fca9aa255d2d94985b209bf7216f945694d9a5f46944cd95ece2bb158dcd92aa0412fd9dcc8cad9f5d20
+  metadata.gz: 50b1d99905f0ef3dd2911cebb3a1a51d68b886dbda1c6f746ce3636357c47eceb98bac05cc0e5997e3a2dd702eb5c09be4ab37e57cc1603e7328f5abe5c5a89d
+  data.tar.gz: c15f0926711bd33265db8c142a50dc54c32f65a097d83c320bee452c2f96147d64355301000c2dd12a8650180e775e2d3544ea4986d4d030fa0f7ad64e8ae025

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.0 (2026-02-17)
+
+- Add MetadataResolver to support VCR-compatible `vcr:` metadata alongside existing `use_cassette:` metadata.
+
 ## 0.1.0 (2026-02-16)
 
 - Initial release.

data/README.md

@@ -23,7 +23,7 @@ Require the RSpec integration in your `spec_helper.rb` or `rails_helper.rb`:
 ```ruby
 require "rspec/cassette/rspec_helper"
 
-Rspec::Cassette.configure do |config|
+RSpec::Cassette.configure do |config|
   config.cassettes_dir = "spec/fixtures/cassettes"
   config.default_match_on = %i[method uri]
 end
@@ -48,6 +48,18 @@ it "fetches users", use_cassette: "users/index" do
 end
 ```
 
+VCR metadata compatibility style:
+
+```ruby
+it "fetches users", vcr: true do
+  # cassette name is auto-generated from example descriptions
+end
+
+it "matches request body", vcr: { cassette_name: "users/index", match_requests_on: %i[method uri body] } do
+  # ...
+end
+```
+
 To pass match options per example:
 
 ```ruby

data/lib/rspec/cassette/metadata_resolver.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Cassette
+    class MetadataResolver
+      def initialize(example)
+        @example = example
+      end
+
+      def resolve
+        return resolved_from_use_cassette if metadata.key?(:use_cassette)
+
+        resolved_from_vcr_metadata
+      end
+
+      private
+
+      attr_reader :example
+
+      def metadata
+        example.metadata
+      end
+
+      def resolved_from_use_cassette
+        return nil unless metadata.key?(:use_cassette)
+
+        cassette_name = metadata[:use_cassette]
+        return nil unless cassette_name
+
+        {
+          cassette_name: cassette_name,
+          cassette_options: normalize_cassette_options(metadata[:cassette_options])
+        }
+      end
+
+      def resolved_from_vcr_metadata
+        vcr_metadata = metadata[:vcr]
+        return nil if vcr_metadata.nil? || vcr_metadata == false
+
+        return resolved_from_vcr_hash(vcr_metadata) if vcr_metadata.is_a?(Hash)
+
+        {
+          cassette_name: build_vcr_compatible_cassette_name,
+          cassette_options: {}
+        }
+      end
+
+      def resolved_from_vcr_hash(vcr_metadata)
+        cassette_name = fetch_vcr_cassette_name(vcr_metadata)
+        cassette_options = normalize_vcr_options(vcr_metadata)
+
+        {
+          cassette_name: cassette_name || build_vcr_compatible_cassette_name,
+          cassette_options: cassette_options
+        }
+      end
+
+      def normalize_vcr_options(vcr_metadata)
+        options = copy_hash_without_keys(vcr_metadata, :cassette_name, "cassette_name")
+        normalized_options = symbolize_hash_keys(options)
+
+        if normalized_options.key?(:match_requests_on)
+          normalized_options[:match_on] = normalized_options[:match_requests_on] unless normalized_options.key?(:match_on)
+          normalized_options.delete(:match_requests_on)
+        end
+
+        normalized_options
+      end
+
+      def fetch_vcr_cassette_name(vcr_metadata)
+        return vcr_metadata[:cassette_name] if vcr_metadata.key?(:cassette_name)
+        return vcr_metadata["cassette_name"] if vcr_metadata.key?("cassette_name")
+
+        nil
+      end
+
+      def normalize_cassette_options(options)
+        return {} unless options.is_a?(Hash)
+
+        symbolize_hash_keys(options)
+      end
+
+      def symbolize_hash_keys(hash)
+        hash.each_with_object({}) do |(key, value), normalized|
+          normalized[key.is_a?(String) ? key.to_sym : key] = value
+        end
+      end
+
+      def copy_hash_without_keys(hash, *keys)
+        hash.each_with_object({}) do |(key, value), copied|
+          copied[key] = value unless keys.include?(key)
+        end
+      end
+
+      def build_vcr_compatible_cassette_name
+        parts = example.example_group.parent_groups.reverse.map(&:description)
+        parts << example.description
+
+        parts
+          .compact
+          .map(&:to_s)
+          .map(&:strip)
+          .reject(&:empty?)
+          .map { |part| normalize_cassette_name_part(part) }
+          .join("/")
+      end
+
+      def normalize_cassette_name_part(part)
+        part.split("/").map { |segment| segment.gsub(/[^\w]+/, "_") }.join("/")
+      end
+    end
+  end
+end

data/lib/rspec/cassette/rspec_helper.rb

@@ -24,9 +24,8 @@ RSpec.configure do |config|
   config.include RSpec::Cassette::RSpecHelper
 
   config.around(:each) do |example|
-    cassette_name = example.metadata[:use_cassette]
-    options = example.metadata[:cassette_options] || {}
-    use_cassette(cassette_name, **options) if cassette_name
+    resolved = RSpec::Cassette::MetadataResolver.new(example).resolve
+    use_cassette(resolved[:cassette_name], **resolved[:cassette_options]) if resolved
     example.run
   end
 end

data/lib/rspec/cassette/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Cassette
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rspec/cassette.rb

@@ -5,6 +5,7 @@ require_relative "cassette/errors"
 require_relative "cassette/configuration"
 require_relative "cassette/cassette"
 require_relative "cassette/interaction"
+require_relative "cassette/metadata_resolver"
 require_relative "cassette/stub_registrar"
 
 module RSpec

data/sig/rspec/cassette.rbs

@@ -41,5 +41,10 @@ module RSpec
       def initialize: (Cassette cassette, ?match_on: Array[Symbol] | nil) -> void
       def register!: () -> void
     end
+
+    class MetadataResolver
+      def initialize: (untyped example) -> void
+      def resolve: () -> Hash[Symbol, untyped]?
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-cassette
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yudai Takada
@@ -53,6 +53,7 @@ files:
 - lib/rspec/cassette/configuration.rb
 - lib/rspec/cassette/errors.rb
 - lib/rspec/cassette/interaction.rb
+- lib/rspec/cassette/metadata_resolver.rb
 - lib/rspec/cassette/rspec_helper.rb
 - lib/rspec/cassette/stub_registrar.rb
 - lib/rspec/cassette/version.rb