dead_code_detector 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dce82eaea034f691d31a834798cdb2d92cc8fdfb0b204f7e719f82b95a95b95d
+  data.tar.gz: dba4ecbc2b237afa42f7c45837455865d85817c26546d7eb03eb0f82cbdb9ed8
+SHA512:
+  metadata.gz: 885bfe14c814f7f36782f57230eded98707723154d7efb2843caa97113dd30dea8c1d26634269ab45f4c9c92b4e387cf1956831e7fd26dafff996be39b2b18f3
+  data.tar.gz: 71ac7c3bf746b4b18f34a18d6cb78666dadf55f62fe1bfa91625c4cde3ccbfd12e2bf3860bfad5d44d00c4c7589cb1c55e8e0008eef563af04307302159596df

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--colour

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kyle.doliveira@clio.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dead_code_detector.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    dead_code_detector (0.0.7.alpha)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  dead_code_detector!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kyle d'Oliveira
+
+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,148 @@
+# DeadCodeDetector
+
+DeadCodeDetector is a gem which finds code that hasn't been used in production environments so that it can be removed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dead_code_detector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dead_code_detector
+
+## How it works
+
+DeadCodeDetector takes advantage of Ruby's ability to dynamically define methods. For each class that you want to track, it dynamically rewrites every method on that class to track its usage. Here's a simplified version of what it does:
+
+```ruby
+# Consider a class like this
+class Foo
+  def bar
+    puts "hello world"
+  end
+end
+
+# Once DeadCodeDetector wraps the methods (Part 3 - Enabling it) it might look like this
+class Foo
+  def bar
+    begin
+      DeadCodeDetector::InstanceMethodWrapper.track_method(Foo, :bar) # Track that this method was called
+      Foo.define_method(:bar) do
+        puts "hello world"
+      end
+    rescue
+      # To ensure that if DeadCodeDetector breaks it doesn't break the existing code
+    end
+    puts "hello world"
+  end
+end
+
+# That's how the method looks until it is hit once:
+Foo.new.bar
+
+# At this point we know that the method has been hit, so we restore the
+# original version of the method.
+```
+
+Because DeadCodeDetector only records method calls once, the performance overhead at runtime is negligible.
+
+DeadCodeDetector only tracks method calls and does not track which code is used inside the method. If that is what you are after, consider looking at [coverband](https://github.com/danmayer/coverband). It can track code usage at a more granular level, but it has its own tradeoffs.
+
+## Usage
+
+There are four steps to using DeadCodeDetector:
+
+### Part 1 - Configuration
+
+This is where you tell DeadCodeDetector what you want to do. In Rails, the configuration could live in `config/initializers`.
+
+```ruby
+DeadCodeDetector.configure do |config|
+  # Two possible values:
+  #   :memory - In-memory storage, not persisted anywhere else. Useful for test environments.
+  #   :redis  - Data is stored as a set in Redis so that it is persisted across processes.
+  # config.storage = :redis
+  # config.storage = :memory
+
+  # If using the `redis` storage option, this needs to be set.
+  # config.redis = <instance of a Redis client object>
+
+  # This controls whether DeadCodeDetector is enabled for this particular process, and takes either
+  # a boolean or a object that responds to `call` that returns a boolean.
+  # There is some overhead whenever DeadCodeDetector enables itself, so you might not want to enable
+  # it on all of your processes.
+  # config.allowed = true
+  # config.allowed = -> { `hostname`.include?("01") }
+
+  # DeadCodeDetector will filter out methods whose source_location matches this regular expression.
+  # This is useful for filtering out methods from gems (such as the methods from ActiveRecord::Base)
+  # config.ignore_paths = /\/vendor\//
+
+  # A list of classes that DeadCodeDetector will monitor method usage on.
+  # All descendants of these classes will be included.
+  config.classes_to_monitor = [ActiveRecord::Base, ApplicationController]
+end
+```
+
+### Part 2 - Cache Setup
+
+Before DeadCodeDetector can do anything, it needs to calculate and store a list of methods that it's going to track. Call this method from a production console to initialize that database:
+
+```ruby
+DeadCodeDetector::Initializer.refresh_caches
+```
+
+If you add new classes or methods to your code which you want to track, you can call `refresh_caches` again at any time to clear all the accumulated data in Redis and start fresh. Until `refresh_caches` has been called at least once, DeadCodeDetector won't do anything.
+
+### Part 3 - Enabling it
+
+Wrap the code that you want to monitor in an `DeadCodeDetector.enable` block. Any code inside that block will record method calls in DeadCodeDetector's storage when they're called for the first time.
+
+```ruby
+DeadCodeDetector.enable do
+  # Do some stuff
+end
+```
+
+In Rails controllers, this could look like:
+```ruby
+around_perform :enable_dead_code_detector
+
+def enable_dead_code_detector
+  DeadCodeDetector.enable { yield }
+end
+```
+
+### Part 4 - The Report
+
+Once DeadCodeDetector has been running for a while, you can generate a report on what methods have not been called by calling `DeadCodeDetector::Report.unused_methods`
+
+**Note**: This report doesn't say that methods are _never_ called, only that they _haven't_ been called. The longer DeadCodeDetector runs for, the more confident you can be that the method is unused.
+
+Also, it's possible that some methods are being used, but are only called during the application boot process. DeadCodeDetector is unable to track those and may mis-report them as unused.
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/clio/dead_code_detector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DeadCodeDetector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/clio/dead_code_detector/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dead_code_detector"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dead_code_detector.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dead_code_detector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dead_code_detector"
+  spec.version       = DeadCodeDetector::VERSION
+  spec.authors       = ["Kyle d'Oliveira"]
+  spec.email         = ["kyle.doliveira@clio.com"]
+
+  spec.summary       = %q{Help find unused code in production.}
+  spec.description   = %q{This monitors methods being called and can be used to produce a report of all methods that have not been called.}
+  spec.homepage      = "https://github.com/clio/dead_code_detector"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/clio/dead_code_detector"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+end

data/lib/dead_code_detector.rb

@@ -0,0 +1,29 @@
+require "dead_code_detector/version"
+require "dead_code_detector/base_method_wrapper"
+require "dead_code_detector/class_method_wrapper"
+require "dead_code_detector/instance_method_wrapper"
+require "dead_code_detector/storage"
+require "dead_code_detector/initializer"
+require "dead_code_detector/configuration"
+require "dead_code_detector/report"
+
+module DeadCodeDetector
+
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  def self.config
+    @config ||= DeadCodeDetector::Configuration.new
+  end
+
+  def self.enable(&block)
+    begin
+      DeadCodeDetector::Initializer.enable_for_cached_classes!
+      block.call
+    ensure
+      config.storage.flush
+    end
+  end
+
+end

data/lib/dead_code_detector/base_method_wrapper.rb

@@ -0,0 +1,61 @@
+module DeadCodeDetector
+  class BaseMethodWrapper
+
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    class << self
+      def track_method(klass, method_name)
+        DeadCodeDetector.config.storage.delete(record_key(klass.name), method_name)
+      end
+
+      def unwrap_method(klass, original_method)
+        raise NotImplementedError
+      end
+    end
+
+    def wrap_methods!
+      potentially_unused_methods.each do |method_name|
+        wrap_method(get_method(method_name))
+      end
+    end
+
+    def clear_cache
+      DeadCodeDetector.config.storage.clear(self.class.record_key(klass.name))
+    end
+
+    def refresh_cache
+      clear_cache
+      DeadCodeDetector.config.storage.add(self.class.record_key(klass.name), default_methods)
+    end
+
+    private
+
+    def default_methods
+      raise NotImplementedError
+    end
+
+    def get_method(method_name)
+      raise NotImplementedError
+    end
+
+    def wrap_method(original_method)
+      raise NotImplementedError
+    end
+
+    def owned_method?(method_name)
+      raise NotImplementedError
+    end
+
+    # Due to caching, new methods won't show up automatically in this call
+    def potentially_unused_methods
+      stored_methods = DeadCodeDetector.config.storage.get(self.class.record_key(klass.name))
+
+      stored_methods & default_methods.map(&:to_s)
+    end
+
+  end
+end

data/lib/dead_code_detector/class_method_wrapper.rb

@@ -0,0 +1,64 @@
+module DeadCodeDetector
+  class ClassMethodWrapper < BaseMethodWrapper
+
+    class << self
+      def unwrap_method(klass, original_method)
+        if klass.singleton_class == original_method.owner
+          klass.define_singleton_method(original_method.name, original_method)
+        else
+          klass.singleton_class.send(:remove_method, original_method.name)
+        end
+        track_method(klass, original_method.name)
+      end
+
+      def record_key(class_name)
+        "dead_code_detector/record_keeper/#{class_name}/class_methods"
+      end
+    end
+
+    def get_method(method_name)
+      klass.method(method_name)
+    end
+
+    private
+
+    def wrap_method(original_method)
+      original_class = klass
+      klass.define_singleton_method(original_method.name) do |*args, &block|
+        begin
+          DeadCodeDetector::ClassMethodWrapper.unwrap_method(original_class, original_method)
+        rescue StandardError => e
+          if DeadCodeDetector.config.error_handler
+            DeadCodeDetector.config.error_handler.call(e)
+          end
+        end
+        # We may have a method like `ActiveRecord::Base.sti_name`
+        # that begins bound to `ActiveRecord::Base`
+        # However, it may be called from `User.sti_name`
+        # We need to bind the original method to the class that
+        # is calling the method
+        unbound_method = original_method.unbind
+        method_bound_to_caller = unbound_method.bind(self)
+        method_bound_to_caller.call(*args, &block)
+      end
+    end
+
+    def default_methods
+      klass.methods.map(&:to_s).select do |method_name|
+        owned_method?(method_name) && target_directory?(method_name)
+      end
+    end
+
+    def target_directory?(method_name)
+      return true if DeadCodeDetector.config.ignore_paths.nil?
+      source_location = klass.method(method_name).source_location&.first
+      source_location !~ DeadCodeDetector.config.ignore_paths
+    end
+
+    def owned_method?(method_name)
+      original_method = klass.method(method_name)
+      klass.singleton_class <= original_method.owner && !(klass.superclass.singleton_class <= original_method.owner)
+    end
+
+  end
+end

data/lib/dead_code_detector/configuration.rb

@@ -0,0 +1,30 @@
+module DeadCodeDetector
+  class Configuration
+
+    attr_accessor :redis, :classes_to_monitor, :error_handler, :allowed, :cache_expiry, :ignore_paths
+
+    STORAGE_BACKENDS = {
+      memory: Storage::MemoryBackend,
+      redis: Storage::RedisBackend,
+    }
+
+    def initialize
+      @allowed = true
+      @classes_to_monitor = []
+      @cache_expiry = 60 * 60 * 24 * 14
+    end
+
+    def storage=(backend_type)
+      @storage ||= STORAGE_BACKENDS.fetch(backend_type).new
+    end
+
+    def storage
+      if @storage
+        @storage
+      else
+        raise "#{self.class.name}#storage is not configured"
+      end
+    end
+
+  end
+end

data/lib/dead_code_detector/initializer.rb

@@ -0,0 +1,75 @@
+module DeadCodeDetector
+  class Initializer
+
+    class << self
+
+      def refresh_caches
+        DeadCodeDetector.config.classes_to_monitor.each do |klass|
+          refresh_cache_for(klass)
+        end
+      end
+
+      def refresh_cache_for(klass)
+        @enabled = false
+        classes = [klass, *descendants_of(klass)]
+        classes.each do |class_to_enable|
+          cache_methods_for(class_to_enable)
+        end
+      end
+
+      def clear_cache
+        cached_classes.each do |class_name|
+          klass = Object.const_get(class_name) rescue nil
+          if klass
+            DeadCodeDetector::ClassMethodWrapper.new(klass).clear_cache
+            DeadCodeDetector::InstanceMethodWrapper.new(klass).clear_cache
+          end
+        end
+        DeadCodeDetector.config.storage.clear(tracked_classes_key)
+      end
+
+      def enable(klass)
+        DeadCodeDetector::ClassMethodWrapper.new(klass).wrap_methods!
+        DeadCodeDetector::InstanceMethodWrapper.new(klass).wrap_methods!
+      end
+
+      def enable_for_cached_classes!
+        return if @enabled
+        return unless allowed?
+        @enabled = true
+        cached_classes.each do |class_name|
+          klass = Object.const_get(class_name) rescue nil
+          enable(klass) if klass
+        end
+      end
+
+      def allowed?
+        if DeadCodeDetector.config.allowed.respond_to?(:call)
+          DeadCodeDetector.config.allowed.call
+        else
+          DeadCodeDetector.config.allowed
+        end
+      end
+
+      def cached_classes
+        DeadCodeDetector.config.storage.get(tracked_classes_key)
+      end
+
+      private
+      def descendants_of(parent_class)
+        ObjectSpace.each_object(parent_class.singleton_class).select { |klass| klass < parent_class }
+      end
+
+      def cache_methods_for(klass)
+        DeadCodeDetector.config.storage.add(tracked_classes_key, klass.name)
+        DeadCodeDetector::ClassMethodWrapper.new(klass).refresh_cache
+        DeadCodeDetector::InstanceMethodWrapper.new(klass).refresh_cache
+      end
+
+      def tracked_classes_key
+        "dead_code_detector/method_wrapper/tracked_classes"
+      end
+    end
+
+  end
+end

data/lib/dead_code_detector/instance_method_wrapper.rb

@@ -0,0 +1,58 @@
+module DeadCodeDetector
+  class InstanceMethodWrapper < BaseMethodWrapper
+
+    class << self
+      def unwrap_method(klass, original_method)
+        if original_method.owner == klass
+          klass.send(:define_method, original_method.name, original_method)
+        else
+          klass.send(:remove_method, original_method.name)
+        end
+        track_method(klass, original_method.name)
+      end
+
+      def record_key(class_name)
+        "dead_code_detector/record_keeper/#{class_name}/instance_methods"
+      end
+    end
+
+    def get_method(method_name)
+      klass.instance_method(method_name)
+    end
+
+    private
+
+    def wrap_method(original_method)
+      original_class = klass
+      klass.send(:define_method, original_method.name) do |*args, &block|
+        begin
+          DeadCodeDetector::InstanceMethodWrapper.unwrap_method(original_class, original_method)
+        rescue StandardError => e
+          if DeadCodeDetector.config.error_handler
+            DeadCodeDetector.config.error_handler.call(e)
+          end
+        end
+        method_bound_to_caller = original_method.bind(self)
+        method_bound_to_caller.call(*args, &block)
+      end
+    end
+
+    def default_methods
+      klass.instance_methods.map(&:to_s).select do |method_name|
+        owned_method?(method_name) && target_directory?(method_name)
+      end
+    end
+
+    def target_directory?(method_name)
+      return true if DeadCodeDetector.config.ignore_paths.nil?
+      source_location = klass.instance_method(method_name).source_location&.first
+      source_location !~ DeadCodeDetector.config.ignore_paths
+    end
+
+    def owned_method?(method_name)
+      original_method = klass.instance_method(method_name)
+      klass <= original_method.owner && !(klass.superclass <= original_method.owner)
+    end
+
+  end
+end

data/lib/dead_code_detector/report.rb

@@ -0,0 +1,34 @@
+module DeadCodeDetector
+  class Report
+
+    class << self
+
+      def unused_methods
+        Initializer.cached_classes.flat_map do |class_name|
+          unused_methods_for(class_name)
+        end
+      end
+
+      def unused_methods_for(class_name)
+        methods = []
+        unused_class_methods_for(class_name).each_with_object(methods) do |method_name, collection|
+          collection << "#{class_name}.#{method_name}"
+        end
+        unused_instance_methods_for(class_name).each_with_object(methods) do |method_name, collection|
+          collection << "#{class_name}##{method_name}"
+        end
+        methods
+      end
+
+      private
+      def unused_class_methods_for(class_name)
+        DeadCodeDetector.config.storage.get(DeadCodeDetector::ClassMethodWrapper.record_key(class_name))
+      end
+
+      def unused_instance_methods_for(class_name)
+        DeadCodeDetector.config.storage.get(DeadCodeDetector::InstanceMethodWrapper.record_key(class_name))
+      end
+    end
+
+  end
+end

data/lib/dead_code_detector/storage.rb

@@ -0,0 +1,7 @@
+require "dead_code_detector/storage/memory_backend"
+require "dead_code_detector/storage/redis_backend"
+
+module DeadCodeDetector
+  class Storage
+  end
+end

data/lib/dead_code_detector/storage/memory_backend.rb

@@ -0,0 +1,43 @@
+module DeadCodeDetector
+  class Storage
+
+    class MemoryBackend
+
+      attr_accessor :flush_immediately
+      attr_reader :pending_deletions
+
+      def initialize
+        @mapping = Hash.new{|h,k| h[k] = Set.new }
+        @pending_deletions = Hash.new{|h,k| h[k] = Set.new }
+      end
+
+      def clear(key)
+        @mapping.delete(key)
+      end
+
+      def add(key, values)
+        @mapping[key].merge(Array(values))
+      end
+
+      def get(key)
+        if @pending_deletions.key?(key)
+          @mapping[key] - @pending_deletions[key]
+        else
+          @mapping[key]
+        end
+      end
+
+      def delete(key, value)
+        @pending_deletions[key] << value.to_s
+        flush if flush_immediately
+      end
+
+      def flush
+        @pending_deletions.each do |key, values|
+          @mapping[key].subtract(values)
+        end
+        @pending_deletions.clear
+      end
+    end
+  end
+end

data/lib/dead_code_detector/storage/redis_backend.rb

@@ -0,0 +1,46 @@
+module DeadCodeDetector
+  class Storage
+
+    class RedisBackend
+
+      attr_accessor :flush_immediately
+
+      def initialize
+        @pending_deletions = Hash.new{|h,k| h[k] = Set.new }
+      end
+
+      def clear(key)
+        DeadCodeDetector.config.redis.del(key)
+      end
+
+      def add(key, values)
+        values = Array(values)
+        return if values.empty?
+        DeadCodeDetector.config.redis.sadd(key, values)
+        DeadCodeDetector.config.redis.expire(key, DeadCodeDetector.config.cache_expiry)
+      end
+
+      def get(key)
+        members = DeadCodeDetector.config.redis.smembers(key)
+        members = Set.new(members) if members.is_a?(Array)
+        if @pending_deletions.key?(key)
+          members - @pending_deletions[key]
+        else
+          members
+        end
+      end
+
+      def delete(key, value)
+        @pending_deletions[key] << value.to_s
+        flush if flush_immediately
+      end
+
+      def flush
+        @pending_deletions.each do |key, values|
+          DeadCodeDetector.config.redis.srem(key, values.to_a)
+        end
+        @pending_deletions.clear
+      end
+    end
+  end
+end

data/lib/dead_code_detector/version.rb

@@ -0,0 +1,3 @@
+module DeadCodeDetector
+  VERSION = "0.0.8"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: dead_code_detector
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Kyle d'Oliveira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+description: This monitors methods being called and can be used to produce a report
+  of all methods that have not been called.
+email:
+- kyle.doliveira@clio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dead_code_detector.gemspec
+- lib/dead_code_detector.rb
+- lib/dead_code_detector/base_method_wrapper.rb
+- lib/dead_code_detector/class_method_wrapper.rb
+- lib/dead_code_detector/configuration.rb
+- lib/dead_code_detector/initializer.rb
+- lib/dead_code_detector/instance_method_wrapper.rb
+- lib/dead_code_detector/report.rb
+- lib/dead_code_detector/storage.rb
+- lib/dead_code_detector/storage/memory_backend.rb
+- lib/dead_code_detector/storage/redis_backend.rb
+- lib/dead_code_detector/version.rb
+homepage: https://github.com/clio/dead_code_detector
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/clio/dead_code_detector
+  source_code_uri: https://github.com/clio/dead_code_detector
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Help find unused code in production.
+test_files: []