vcr-unused_cassettes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2af05df07a5be2c9da47dfc5bfb67ed5d86e016ff456fbe6862454630f294a60
+  data.tar.gz: db5c1c3ba677b989ea8b5ce708209262cfe99bcfb7ba8ff1f561fdb54c5d13a4
+SHA512:
+  metadata.gz: cf304b9c1f3730acbdb05690187cace477ad54f37ad424444422e9073585050ab9662eb29b4f0441595a18a45fb4f655e7f5cfa5a135cdae341dd1fa069462ed
+  data.tar.gz: 13b75a92af78bc193225d1664eb8633ecc6bfda0740b22f2d6523d1f50443bed6be63c15e4e8585afb68598984456820f8c382c3e24abd0be6a9692894baf551

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.3.2

data/.standard.yml

@@ -0,0 +1 @@
+parallel: true

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-01-16
+
+Initial release:
+- support for minitest
+- basic interpretation of variables and constants in the `VCR.use_cassette` call
+- support for multiple persisters and serializers
+- rake task to check for unused cassettes
+- rake tasks to remove unused cassettes

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 9265647+jbockler@users.noreply.github.com . All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jbockler/vcr-unused_cassettes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jbockler/vcr-unused_cassettes/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Pull Requests
+* Fork the repository
+* Create a feature branch
+* Write [good commit messages](https://cbea.ms/git-commit/)
+* comply with the standardrb style

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby File.read(".ruby-version").strip
+
+# Specify your gem's dependencies in vcr-unused_cassettes.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.43"

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    vcr-unused_cassettes (1.0.0)
+      vcr
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.1)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.69.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.43.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.69.1)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    unicode-display_width (3.1.3)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.2.0)
+    zeitwerk (2.7.1)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-23
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.43)
+  vcr-unused_cassettes!
+
+RUBY VERSION
+   ruby 3.3.2p78
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Josch Bockler
+
+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,62 @@
+# Vcr::UnusedCassettes
+
+This gem provides a way to detect unused [VCR](https://github.com/vcr/vcr) cassettes. It is intended to be used in a test suite to ensure that all VCR cassettes are being used. You could run this in your CI pipeline to ensure that no cassettes are being left behind.
+
+
+## Pre-requisites
+
+This gem currently only is supposed to work with minitest, but rspec and cucumber support is planned.
+
+The interpretation of which cassettes are being used is pretty simple at the moment. Only string literals and some basic use of variables and constants is interpreted at the moment. If you do some more magic with the `VCR.use_cassette` calls, it is possible that you get false positives. If you encounter such a case, please open a pr or an issue with a code example.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add vcr-unused_cassettes --group "development, test"
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install vcr-unused_cassettes
+
+This gem require the VCR gem to be installed and configured in the same environment too. 
+
+Additionally you have to load the rake tasks in your application. Add the following line to your `Rakefile`:
+
+```ruby
+require "vcr-unused_cassettes"
+
+spec = Gem::Specification.find_by_name
+rakefile = "#{spec.gem_dir}/lib/vcr/unused_cassettes/Rakefile"
+load rakefile
+```
+
+If you are using Rails you don't have to do that. This gem ships with a Railtie that automatically loads the rake tasks.
+
+## Usage
+
+This gem provides 2 tasks:
+
+### Check for unused cassettes
+    $ rails vcr:unused_cassettes:check
+
+### Remove unused cassettes
+    $ rails vcr:unused_cassettes:remove
+
+## Roadmap
+Open for contributions. Some ideas what could be done in the future:
+- automate manual tests into rspec tests
+- find usages of cassettes when test name is used
+- Add support for rspec and cucumber
+- create multiple run configurations to use e.g. minitest and cucumber in the same repo
+- fancy spinner with progress indicator (configurable for ci environments)
+- parallelize the analysis of the cassettes
+
+## Contributing
+
+Contributions and ideas are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+
+## Code of Conduct
+
+Everyone interacting in the Vcr::UnusedCassettes project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jbockler/vcr-unused_cassettes/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/vcr/unused_cassettes/Rakefile

@@ -0,0 +1,4 @@
+require "vcr/unused_cassettes"
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/vcr/unused_cassettes/call_context.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module VCR::UnusedCassettes
+  class CallContext
+    ValueUnresolveable = Class.new(StandardError)
+
+    def initialize
+      @context = {
+        variables: {},
+        constants: {}
+      }
+    end
+
+    def track(node)
+      reset_local_variables! if new_test_node?(node)
+      case node.type
+      when :local_variable_write_node
+        store_variable(node.name, node.value)
+      when :constant_write_node
+        store_constant(node.name, node.value)
+      when :instance_variable_write_node
+        store_variable(node.name, node.value)
+      end
+    end
+
+    def resolve_variable(variable_name)
+      @context.dig(:variables, variable_name)
+    end
+
+    def resolve_constant(constant_name)
+      @context.dig(:constants, constant_name)
+    end
+
+    def extract_value(node, string_interpolation_error: :raise)
+      case node.type
+      when :nil_node
+        nil
+      when :string_node
+        node.unescaped
+      when :symbol_node
+        node.unescaped.to_sym
+      when :hash_node, :keyword_hash_node
+        node.elements.each_with_object({}) do |element, hash|
+          if element.type == :assoc_splat_node
+            hash.merge(extract_value(element.value, string_interpolation_error: string_interpolation_error))
+            next
+          end
+          key = extract_value(element.key, string_interpolation_error: string_interpolation_error)
+          value = extract_value(element.value, string_interpolation_error: string_interpolation_error)
+          hash[key] = value
+        rescue ValueUnresolveable
+          next
+        end
+      when :array_node
+        node.elements.map do |element|
+          extract_value(element, string_interpolation_error: string_interpolation_error)
+        end
+      when :interpolated_string_node
+        node.parts.map do |part_node|
+          if part_node.type == :embedded_statements_node
+            if part_node.statements.body.size != 1
+              if string_interpolation_error == :raise
+                raise ValueUnresolveable, "Could not resolve value for node: #{part_node.inspect}"
+              elsif string_interpolation_error == :wildcard
+                "*"
+              end
+            else
+              extract_value(part_node.statements.body.first, string_interpolation_error: string_interpolation_error)
+            end
+          else
+            extract_value(part_node, string_interpolation_error: string_interpolation_error)
+          end
+        rescue ValueUnresolveable
+          if string_interpolation_error == :raise
+            raise ValueUnresolveable, "Could not resolve value for node: #{part_node.inspect}"
+          elsif string_interpolation_error == :wildcard
+            "*"
+          end
+        end.join
+      when :local_variable_read_node, :instance_variable_read_node
+        resolve_variable(node.name)
+      when :constant_read_node
+        @context.dig(:constants, node.name)
+      when :assoc_splat_node
+        extract_value(node.value, string_interpolation_error: string_interpolation_error)
+      else
+        if node.respond_to?(:value) && !node.value.is_a?(Prism::Node)
+          node.value
+        else
+          raise ValueUnresolveable, "Could not resolve value for node: #{node.inspect}"
+        end
+      end
+    end
+
+    private
+
+    def reset_local_variables!
+      @context[:variables].select! { |key, _value| key.start_with?("@") }
+    end
+
+    def store_variable(name, value_node)
+      @context[:variables][name] = extract_value(value_node)
+    rescue ValueUnresolveable
+      # todo add debug logging
+    end
+
+    def store_constant(name, value_node)
+      @context[:constants][name] = extract_value(value_node)
+    rescue ValueUnresolveable
+      # todo add debug logging
+    end
+
+    def new_test_node?(node)
+      case node.type
+      when :def_node
+        if node.name.start_with?("test")
+          return true
+        end
+      when :call_node
+        if node.name == :test
+          return true
+        end
+      end
+      false
+    end
+  end
+end

data/lib/vcr/unused_cassettes/cassette_usage_finder.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module VCR::UnusedCassettes
+  class CassetteUsageFinder
+    attr_accessor :filename, :used_cassettes, :warnings, :call_context
+
+    def initialize(filename)
+      self.filename = filename
+      self.used_cassettes = []
+      self.warnings = []
+      self.call_context = CallContext.new
+    end
+
+    def find_cassette_usages
+      parse_result = Prism.parse_file(filename)
+      return [[], []] unless parse_result
+
+      find_cassette_usages_in(parse_result.value)
+
+      [used_cassettes, warnings]
+    end
+
+    def find_cassette_usages_in(node)
+      return if node.nil?
+
+      call_context.track(node)
+
+      if node_contains_call?(node)
+        found_name = find_cassette_name(node)
+        if !found_name.nil? && /[a-zA-Z0-9]/.match?(found_name)
+          cassette_use = {pattern: found_name}
+          cassette_options = extract_options(node)
+          cassette_use[:persister] = cassette_options[:persist_with] if cassette_options&.has_key?(:persist_with)
+          cassette_use[:serializer] = cassette_options[:serialize_with] if cassette_options&.has_key?(:serialize_with)
+          used_cassettes << cassette_use
+        end
+      end
+
+      return if node.child_nodes.nil?
+
+      node.child_nodes.each do |child_node|
+        find_cassette_usages_in(child_node)
+      end
+    end
+
+    def extract_options(node)
+      return nil if node.arguments.arguments.size <= 1
+      node.arguments.arguments.each do |argument_node|
+        next unless argument_node.is_a?(Prism::KeywordHashNode)
+        return call_context.extract_value(argument_node, string_interpolation_error: :raise)
+      end
+      nil
+    rescue CallContext::ValueUnresolveable => error
+      warnings << build_warning(node, error)
+    end
+
+    def node_contains_call?(node)
+      return false unless node.is_a?(Prism::CallNode)
+
+      receiver = node.receiver
+      return false unless receiver.is_a?(Prism::ConstantReadNode) && receiver.name == :VCR
+
+      node.name == :use_cassette
+    end
+
+    def find_cassette_name(node)
+      # cassette is the first argument of the use_cassette call
+      cassette_argument = node.arguments.arguments.first
+      call_context.extract_value(cassette_argument, string_interpolation_error: :wildcard)
+    rescue CallContext::ValueUnresolveable => error
+      warnings << build_warning(node, error)
+      nil
+    end
+
+    def build_warning(node, error)
+      Warning.new.tap do |warning|
+        warning.message = "Could not determine cassette name for #{filename}:#{node.line}"
+        warning.details = error.message
+        warning.backtrace = error.backtrace
+      end
+    end
+  end
+end

data/lib/vcr/unused_cassettes/railtie.rb

@@ -0,0 +1,15 @@
+require "vcr/unused_cassettes"
+require "rails"
+
+module VCR
+  module UnusedCassettes
+    class Railtie < Rails::Railtie
+      railtie_name :vcr_unused_cassettes
+
+      rake_tasks do
+        path = File.expand_path(__dir__)
+        Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+      end
+    end
+  end
+end

data/lib/vcr/unused_cassettes/runner.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module VCR::UnusedCassettes
+  class Runner
+    def find_unused_cassettes
+      existing_cassettes = find_existing_cassettes
+      cassette_uses, warnings = used_cassettes_names_patterns
+      cassette_uses.map! { |cassette_use| path_for_cassette_use(cassette_use) }
+
+      unused_cassettes = existing_cassettes.select do |existing_cassette_name|
+        !cassette_uses.any? { |used_cassette_name| File.fnmatch?(used_cassette_name, existing_cassette_name) }
+      end
+
+      [unused_cassettes, warnings]
+    end
+
+    def used_cassettes_names_patterns
+      used_cassettes = []
+      warnings = []
+
+      file_list = `grep -r -l "VCR.use_cassette" test/`.split("\n")
+      return [[], []] if file_list.empty? || $? != 0
+
+      file_list.each do |file|
+        found_usages, found_warnings = CassetteUsageFinder.new(file).find_cassette_usages
+        used_cassettes += found_usages
+        warnings += found_warnings
+      end
+
+      [used_cassettes, warnings]
+    end
+
+    def find_existing_cassettes
+      cassettes = []
+      all_vcr_persisters.each do |_name, persister|
+        cassettes += Dir.glob(cassette_path_with_wildcard("*", persister))
+      end
+      cassettes.uniq
+    end
+
+    def path_for_cassette(cassette_name, persister)
+      result = persister.absolute_path_to_file(cassette_name)
+      return result.to_s if result
+      raise Error, "Could not determine path for cassette #{cassette_name}"
+    end
+
+    def cassette_path_with_wildcard(name, persister)
+      placeholder = "a_placeholder_that_should_not_exist"
+      full_path = path_for_cassette(name.gsub("*", placeholder), persister)
+      full_path.sub(placeholder, "*")
+    end
+
+    def default_persister
+      @default_persister ||= begin
+        default_persister = VCR.configuration.default_cassette_options[:persist_with]
+        VCR.configuration.cassette_persisters[default_persister]
+      end
+    end
+
+    def default_or_option(type, option_name, cassette_use)
+      cassette_use[type] || VCR.configuration.default_cassette_options[option_name]
+    end
+
+    def path_for_cassette_use(cassette_use)
+      persister_name = default_or_option(:persister, :persist_with, cassette_use)
+      persister = VCR.configuration.cassette_persisters[persister_name]
+
+      serializer_name = default_or_option(:serializer, :serialize_with, cassette_use)
+      serializer = VCR.cassette_serializers[serializer_name]
+      cassette_storage_key = "#{cassette_use[:pattern]}.#{serializer.file_extension}"
+      cassette_path_with_wildcard(cassette_storage_key, persister)
+    end
+
+    def all_vcr_persisters
+      # dirty, but VCR::Cassette::Persisters does not expose the persisters
+      VCR.cassette_persisters.instance_variable_get(:@persisters)
+    end
+  end
+end

data/lib/vcr/unused_cassettes/tasks/vcr/unused_cassettes.rake

@@ -0,0 +1,42 @@
+namespace :vcr do
+  namespace :unused_cassettes do
+    desc "List unused cassettes"
+    task check: :environment do |_task|
+      unused_cassettes, warnings = VCR::UnusedCassettes::Runner.new.find_unused_cassettes
+
+      VCR::UnusedCassettes::Warning.print(warnings)
+
+      if unused_cassettes.empty?
+        puts "Everything is fine! No unused cassettes found."
+        exit(true)
+      end
+
+      puts "Unused cassettes:"
+      unused_cassettes.each { |cassette| puts cassette.gsub(Dir.pwd, ".") }
+      puts "\n"
+
+      abort("There are #{unused_cassettes.size} unused cassettes")
+    end
+
+    desc "Remove unused cassettes"
+    task remove: :environment do |_task|
+      unused_cassettes, warnings = VCR::UnusedCassettes::Runner.new.find_unused_cassettes
+
+      VCR::UnusedCassettes::Warning.print(warnings)
+
+      if unused_cassettes.empty?
+        puts "Everything is fine! No unused cassettes found."
+        exit(true)
+      end
+
+      puts "Removing unused cassettes:"
+      unused_cassettes.each do |cassette|
+        puts cassette.gsub(Dir.pwd, ".")
+        File.delete(cassette)
+      end
+      puts "\n"
+
+      puts "Removed #{unused_cassettes.size} unused cassettes"
+    end
+  end
+end

data/lib/vcr/unused_cassettes/version.rb

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

data/lib/vcr/unused_cassettes/warning.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module VCR::UnusedCassettes
+  class Warning
+    attr_accessor :message, :details, :backtrace
+
+    def self.print(warnings)
+      return if warnings.nil? || warnings.empty?
+
+      puts "Warnings:"
+      warnings.each do |warning|
+        puts warning.message
+      end
+    end
+  end
+end

data/lib/vcr/unused_cassettes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem_extension(VCR)
+loader.setup
+
+module VCR
+  module UnusedCassettes
+    require_relative "unused_cassettes/railtie" if defined?(Rails)
+
+    class Error < StandardError; end
+  end
+end

data/sig/vcr/unused_cassettes.rbs

@@ -0,0 +1,6 @@
+module Vcr
+  module UnusedCassettes
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/vcr-unused_cassettes.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/vcr/unused_cassettes/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vcr-unused_cassettes"
+  spec.version = VCR::UnusedCassettes::VERSION
+  spec.authors = ["Josch Bockler"]
+  spec.email = ["9265647+jbockler@users.noreply.github.com "]
+
+  spec.summary = "Find your unused VCR cassettes"
+  spec.description = "Adds a rake task to find unused VCR cassettes in your project. To check for them in your CI or if you just want to cleanup."
+  spec.homepage = "https://github.com/jbockler/vcr-unused_cassettes"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "vcr"
+  spec.add_dependency "zeitwerk"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: vcr-unused_cassettes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Josch Bockler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-16 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: zeitwerk
+  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'
+description: Adds a rake task to find unused VCR cassettes in your project. To check
+  for them in your CI or if you just want to cleanup.
+email:
+- '9265647+jbockler@users.noreply.github.com '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vcr/unused_cassettes.rb
+- lib/vcr/unused_cassettes/Rakefile
+- lib/vcr/unused_cassettes/call_context.rb
+- lib/vcr/unused_cassettes/cassette_usage_finder.rb
+- lib/vcr/unused_cassettes/configuration.rb
+- lib/vcr/unused_cassettes/railtie.rb
+- lib/vcr/unused_cassettes/runner.rb
+- lib/vcr/unused_cassettes/tasks/vcr/unused_cassettes.rake
+- lib/vcr/unused_cassettes/version.rb
+- lib/vcr/unused_cassettes/warning.rb
+- sig/vcr/unused_cassettes.rbs
+- vcr-unused_cassettes.gemspec
+homepage: https://github.com/jbockler/vcr-unused_cassettes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jbockler/vcr-unused_cassettes
+  source_code_uri: https://github.com/jbockler/vcr-unused_cassettes
+  changelog_uri: https://github.com/jbockler/vcr-unused_cassettes/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Find your unused VCR cassettes
+test_files: []