vcr-log_unmatched_cassettes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5715a8e1d849e98faea2e124290b2fa5d4b74a3e75f7feced17ad4b64457e115
+  data.tar.gz: 7a51740f8bcae35c1ddb986e143a21b5182a9e7b9c38e17a4257428958b18269
+SHA512:
+  metadata.gz: e2cd3c15a2d8a73d93e6a9d78d64cf09436c43191a8dad13064f2f4b13287920e276ac397d41b2b438f9c0a5c413d146deb34df4f1731ab7ad062f8caad213eb
+  data.tar.gz: 67c3705c67566b056274f65fa397b82c95692c8fc5ee2db8de5f6233010be4251d11b719d005dd08f9699fb0f4aceb7fa313b923ae7ed07f49f93ca7d462f51b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 sshaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# VCR::LogUnmatchedCassettes
+
+Make finding and re-recording unmatched [VCR cassettes](https://github.com/vcr/vcr) (test that fail due to `VCR::Errors::UnhandledHTTPRequestError`)
+easier by logging the test and unmatched cassette paths to a CSV.
+
+## Usage
+
+In your `Gemfile`
+
+```rb
+gem "vcr-log_unmatched_cassettes", :group => "test"
+```
+
+In your spec configuration, after loading VCR, call:
+```rb
+VCR::LogUnmatchedCassettes.install
+```
+
+Now tests that fails due to VCR being able to unmatch the request (`VCR::Errors::UnhandledHTTPRequestError`) will be output to the system's temp directory in a CSV.
+If you're using Rails it will be output to `./tmp`.
+
+## Why?
+
+When tests fail due to unmatched HTTP requests the path is output within a large blob of text. This may be fine for a couple of tests but
+with large amounts of tests the path can be a pain track down. This becomes worse when one needs the paths for multiple tests.
+
+Often one needs the path solely to delete the cassette and re-record it. This is often preferred to using VCR's `record: :all` globally as `:all` is a bit heavy-handed.
+
+`record: :all` can be applied per test, but this requires modifying the test so that it can be scoped to `:all`.
+
+Remove all cassettes is an option but this can clutter your git history with needless and _very_ bloated diffs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Author
+
+Skye Shaw [sshaw AT gmail.com]

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/vcr/log_unmatched_cassettes/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VCR
+  module LogUnmatchedCassettes
+    VERSION = "0.0.1"
+  end
+end

data/lib/vcr/log_unmatched_cassettes.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "vcr"
+require "fileutils"
+require "tmpdir"
+require "csv"
+
+module VCR
+  module LogUnmatchedCassettes
+    module MinitestHook         # :nodoc:
+      # Minitest stores the test's exception by running it through
+      # `sanitize_exception` in `capture_exceptions`. A marshable exception is
+      # kept as-is, but VCR::Errors::UnhandledHTTPRequestError is not marshable
+      # (it memoizes the active cassette), so Minitest "neuters" it into a
+      # generic RuntimeError, losing the class and any `cause` chain. Capture
+      # the original exception here so it can still be identified in
+      # `after_teardown` (where `$!` is nil).
+      def sanitize_exception(error)
+        @vcr_unmatched_error = error
+        super
+      end
+
+      def after_teardown
+        super
+
+        vcr_error = VCR::LogUnmatchedCassettes.find_vcr_error(@vcr_unmatched_error)
+        return unless vcr_error
+
+        cassette = VCR.current_cassette
+        return unless cassette
+
+        location = "#{self.class.name}##{name}"
+        path     = cassette.respond_to?(:file) ? cassette.file : cassette.name.to_s
+
+        VCR::LogUnmatchedCassettes.record(location, path)
+      end
+    end
+
+    class << self
+      attr_accessor :enabled, :output_dir
+
+      def install
+        self.enabled = true if enabled.nil?
+        self.output_dir = defined?(Rails) && Rails.respond_to?(:root) ? Rails.root.join("tmp").to_s : Dir.tmpdir
+
+        @failures = []
+
+        if defined?(::RSpec)
+          install_rspec
+        elsif defined?(Minitest)
+          install_minitest
+        else
+          raise "VCR::LogUnmatchedCassettes requires RSpec or Minitest. Neither was found."
+        end
+      end
+
+      def record(location, cassette_path)
+        return if !enabled || cassette_path.nil? || cassette_path.empty?
+
+        @failures << [location, cassette_path]
+      end
+
+      def write_report
+        return if @failures.empty?
+
+        FileUtils.mkdir_p(output_dir)
+
+        timestamp = Time.now.strftime("%Y%m%d%H%M%S")
+        filename  = File.join(output_dir, "vcr-unmatched-cassettes.#{timestamp}.csv")
+
+        CSV.open(filename, "w") do |csv|
+          csv << %w[test cassette]
+
+          @failures.each do |test, cassette|
+            csv << [test, cassette]
+          end
+        end
+
+        warn "\n[VCR::LogUnmatchedCassettes] Wrote #{@failures.size} failed cassette(s) to: #{filename}"
+      end
+
+      # Walks the exception + cause chain looking for UnhandledHTTPRequestError
+      def find_vcr_error(exception)
+        current = exception
+
+        while current
+          return current if current.is_a?(VCR::Errors::UnhandledHTTPRequestError)
+          current = current.cause
+        end
+
+        nil
+      end
+
+      private
+
+      def install_rspec
+        ::RSpec.configure do |config|
+          config.after(:each) do |example|
+            vcr_error = VCR::LogUnmatchedCassettes.find_vcr_error(example.exception)
+            next unless vcr_error
+
+            cassette = VCR.current_cassette
+            next unless cassette
+
+            # :location is "./spec/foo_spec.rb:42"
+            VCR::LogUnmatchedCassettes.record(example.metadata[:location], cassette.file)
+          end
+
+          config.after(:suite) do
+            VCR::LogUnmatchedCassettes.write_report
+          end
+        end
+      end
+
+      def install_minitest
+        Minitest::Test.prepend(MinitestHook)
+
+        Minitest.after_run { VCR::LogUnmatchedCassettes.write_report }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: vcr-log_unmatched_cassettes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+bindir: bin
+cert_chain: []
+date: 2026-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vcr/log_unmatched_cassettes.rb
+- lib/vcr/log_unmatched_cassettes/version.rb
+homepage: https://github.com/sshaw/vcr-log_unmatched_cassettes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/vcr-log_unmatched_cassettes
+  source_code_uri: https://github.com/sshaw/vcr-log_unmatched_cassettes
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Make finding and re-recording unmatched VCR cassettes easier by logging the
+  test and unmatched cassette paths to a CSV
+test_files: []