vcr-log_unmatched_cassettes 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5715a8e1d849e98faea2e124290b2fa5d4b74a3e75f7feced17ad4b64457e115
-  data.tar.gz: 7a51740f8bcae35c1ddb986e143a21b5182a9e7b9c38e17a4257428958b18269
+  metadata.gz: 6d72754d5764e97b62b6ea59ee4a147d4a9534dc8aafd00d22d57c461ebc1a71
+  data.tar.gz: 1811f85b5fd64fdfbc75d6f4c5baf1e609b57d0864cf5c883c1bd7ee7904b0b9
 SHA512:
-  metadata.gz: e2cd3c15a2d8a73d93e6a9d78d64cf09436c43191a8dad13064f2f4b13287920e276ac397d41b2b438f9c0a5c413d146deb34df4f1731ab7ad062f8caad213eb
-  data.tar.gz: 67c3705c67566b056274f65fa397b82c95692c8fc5ee2db8de5f6233010be4251d11b719d005dd08f9699fb0f4aceb7fa313b923ae7ed07f49f93ca7d462f51b
+  metadata.gz: 38e933db7f083f77c926580f00c75fbb058fb8c175769d6f7852427384272a947f2af3a0ae3b33b5884bc3ebfba6192436a0b8730257789e5700ffe06ddeb973
+  data.tar.gz: f164ffa88ca3f56c519d2b1fb08774e428e44be35ee811ef1936ac58911e38dda155debb876e6248579df72358314eb962ad060dcc7ef78d15d14f2b603e6594

data/README.md

@@ -1,5 +1,7 @@
 # VCR::LogUnmatchedCassettes
 
+[![Ruby](https://github.com/sshaw/vcr-log_unmatched_cassettes/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/sshaw/vcr-log_unmatched_cassettes/actions/workflows/main.yml)
+
 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.
 
@@ -8,7 +10,8 @@ easier by logging the test and unmatched cassette paths to a CSV.
 In your `Gemfile`
 
 ```rb
-gem "vcr-log_unmatched_cassettes", :group => "test"
+# development for Rake task access
+gem "vcr-log_unmatched_cassettes", :group => %w[test development]
 ```
 
 In your spec configuration, after loading VCR, call:
@@ -16,9 +19,26 @@ In your spec configuration, after loading VCR, call:
 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.
+Now tests that fail 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`.
 
+## Deleting Cassettes
+
+Load the Rake task to delete cassettes listed in the `cassette` column of the latest report:
+
+```rb
+# Rakefile
+require "vcr/log_unmatched_cassettes/rake"
+```
+
+Then run:
+
+```
+rake vcr:log_unmatched_cassettes:delete_cassettes
+```
+
+Under Rails it is loaded automatically via a Railtie.
+
 ## 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
@@ -28,7 +48,11 @@ Often one needs the path solely to delete the cassette and re-record it. This is
 
 `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.
+Removing all cassettes is an option but this can clutter your git history with needless and _very_ bloated diffs.
+
+## See Also
+
+[vcr-unused_cassettes](https://github.com/jbockler/vcr-unused_cassettes) - Find unused VCR cassettes
 
 ## License
 

data/lib/vcr/log_unmatched_cassettes/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VCR
+  module LogUnmatchedCassettes
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load File.expand_path("rake.rb", __dir__)
+      end
+    end
+  end
+end

data/lib/vcr/log_unmatched_cassettes/rake.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "rake"
+require "csv"
+require "fileutils"
+require "vcr/log_unmatched_cassettes"
+
+module VCR
+  module LogUnmatchedCassettes
+    module Rake
+      class << self
+        # Deletes the files listed in the +cassette+ column of the latest
+        # report and returns the paths that were removed.
+        def delete_cassettes(report = latest_report_file)
+          return [] unless report && File.file?(report)
+
+          report_path = File.expand_path(report)
+          deleted     = []
+
+          CSV.foreach(report, headers: true) do |row|
+            path = row["cassette"]
+            next if path.nil? || path.strip.empty?
+
+            path = File.expand_path(path)
+            next if path == report_path || deleted.include?(path) || !File.file?(path)
+
+            FileUtils.rm(path)
+            deleted << path
+          end
+
+          deleted
+        end
+
+        private
+
+        # The most recently written report. Reports from previous runs are
+        # ignored, as their cassettes have presumably been dealt with already.
+        def latest_report_file
+          Dir[File.join(report_dir, "#{REPORT_PREFIX}.*.csv")]
+            .select { |path| File.file?(path) }
+            .max_by { |path| [File.mtime(path), File.basename(path)] }
+        end
+
+        def report_dir
+          LogUnmatchedCassettes.output_dir || LogUnmatchedCassettes.default_output_dir
+        end
+      end
+    end
+  end
+end
+
+namespace :vcr do
+  namespace :log_unmatched_cassettes do
+    desc "Delete the cassettes listed in the latest vcr-unmatched-cassettes report"
+    task :delete_cassettes do
+      log   = VCR::LogUnmatchedCassettes
+      tasks = VCR::LogUnmatchedCassettes::Rake
+
+      if log.enabled == false
+        warn "[VCR::LogUnmatchedCassettes] Disabled, not deleting anything."
+        next
+      end
+
+      dir     = log.output_dir || log.default_output_dir
+      deleted = tasks.delete_cassettes
+
+      if deleted.empty?
+        warn "[VCR::LogUnmatchedCassettes] Nothing to delete from the latest report in #{dir}."
+        next
+      end
+
+      warn "[VCR::LogUnmatchedCassettes] Deleted #{deleted.size} cassette(s) from the latest report in #{dir}:"
+
+      deleted.each { |path| warn "  #{path}" }
+    end
+  end
+end

data/lib/vcr/log_unmatched_cassettes/version.rb

@@ -2,6 +2,6 @@
 
 module VCR
   module LogUnmatchedCassettes
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/vcr/log_unmatched_cassettes.rb

@@ -7,6 +7,13 @@ require "csv"
 
 module VCR
   module LogUnmatchedCassettes
+    REPORT_PREFIX = "vcr-unmatched-cassettes"
+
+    # Sentinels from VCR's UnhandledHTTPRequestError message. Used as a fallback
+    # when the exception class itself can no longer be reached (see
+    # `find_vcr_error`).
+    UNHANDLED_REQUEST_MESSAGE = "An HTTP request has been made that VCR does not know how to handle"
+
     module MinitestHook         # :nodoc:
       # Minitest stores the test's exception by running it through
       # `sanitize_exception` in `capture_exceptions`. A marshable exception is
@@ -41,7 +48,7 @@ module VCR
 
       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
+        self.output_dir = default_output_dir
 
         @failures = []
 
@@ -54,6 +61,14 @@ module VCR
         end
       end
 
+      def default_output_dir
+        if defined?(Rails) && Rails.respond_to?(:root) && Rails.root
+          Rails.root.join("tmp").to_s
+        else
+          Dir.tmpdir
+        end
+      end
+
       def record(location, cassette_path)
         return if !enabled || cassette_path.nil? || cassette_path.empty?
 
@@ -66,7 +81,7 @@ module VCR
         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")
+        filename  = File.join(output_dir, "#{REPORT_PREFIX}.#{timestamp}.csv")
 
         CSV.open(filename, "w") do |csv|
           csv << %w[test cassette]
@@ -79,12 +94,20 @@ module VCR
         warn "\n[VCR::LogUnmatchedCassettes] Wrote #{@failures.size} failed cassette(s) to: #{filename}"
       end
 
-      # Walks the exception + cause chain looking for UnhandledHTTPRequestError
+      # Walks the exception + cause chain looking for UnhandledHTTPRequestError.
+      #
+      # Some frameworks re-raise VCR's error as a different class after it has
+      # crossed a thread boundary (e.g. Capybara's app server). Re-raising a
+      # fresh exception object replaces the cause chain, so the VCR error is no
+      # longer reachable via `cause`. In that case the only thing left is its
+      # message, which VCR's wrapper embeds into its own message. Match on the
+      # message as a fallback.
       def find_vcr_error(exception)
         current = exception
 
         while current
           return current if current.is_a?(VCR::Errors::UnhandledHTTPRequestError)
+          return current if current.message.to_s.include?(UNHANDLED_REQUEST_MESSAGE)
           current = current.cause
         end
 
@@ -120,3 +143,5 @@ module VCR
     end
   end
 end
+
+require "vcr/log_unmatched_cassettes/railtie" if defined?(::Rails::Railtie)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vcr-log_unmatched_cassettes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Skye Shaw
 bindir: bin
 cert_chain: []
-date: 2026-10-22 00:00:00.000000000 Z
+date: 2026-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -117,6 +117,8 @@ files:
 - README.md
 - Rakefile
 - lib/vcr/log_unmatched_cassettes.rb
+- lib/vcr/log_unmatched_cassettes/railtie.rb
+- lib/vcr/log_unmatched_cassettes/rake.rb
 - lib/vcr/log_unmatched_cassettes/version.rb
 homepage: https://github.com/sshaw/vcr-log_unmatched_cassettes
 licenses: