is_this_used 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6230a093e9c43e76f49f6029109cb16fa0287deb22285e1f01b0d0732fe076dc
+  data.tar.gz: 3e8d0cd036daec5d0feb1a0d17fe94f0a0e1509f24962145ca01dedded5e5ea1
+SHA512:
+  metadata.gz: ccd634c5a840b1c0aa82ac266dda18e6da727e4b65f31829b81ca549eb792e0ae866aaf91eca93d45107149b8b28f8d760c900e95eb174101f5a1f2a8a4e3e80
+  data.tar.gz: 5e1b79de772247fefc0304d75346f507d9de0f88533808a715f3fb2f38057c6703dff0b28ecf83bedfb253b3fb96bd6384ccb0805b2c1d8bb46f2999de661dba

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+
+Gemfile.lock
+
+spec/dummy/
+spec/dummy_app/db/schema.rb
+spec/dummy_app/log/*
+spec/dummy_app/tmp/*

data/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "plugin:@prettier/plugin-ruby"
+  ]
+}

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Appraisals

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Specify here only version constraints that differ from
+# `paper_trail.gemspec`.
+#
+# > The dependencies in your Appraisals file are combined with dependencies in
+# > your Gemfile, so you don't need to repeat anything that's the same for each
+# > appraisal. If something is specified in both the Gemfile and an appraisal,
+# > the version from the appraisal takes precedence.
+# > https://github.com/thoughtbot/appraisal
+#
+#
+appraise "rails-5.2" do
+  gem "rails", "~> 5.2.4"
+end
+
+appraise "rails-6.0" do
+  gem "rails", "~> 6.0.3"
+end
+
+# appraise "rails-6.1" do
+#   gem "rails", "~> 6.1.0"
+#   gem "rails-controller-testing", "~> 1.0.5"
+# end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in is_this_used.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Doug Hughes
+
+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,75 @@
+# IsThisUsed
+
+Do you ever ask yourself, "Is this method even being used?!" Does your app use ActiveRecord? If so, this gem may be
+useful to you!
+
+Large applications can accrue cruft; old methods that might once have been important, but are now unused. The thing is,
+software is _complex_. If the method in question was a part of a larger feature that has changed over time, or possibly
+been removed or disabled, it can be really difficult to tell if it's being used at all. It can be even worse that than.
+The method could be _tested_. 😨 That's bad because now you can tell if you break it and you'll need to maintain it, but
+you have no idea if there's any value in the time and effort to do so.
+
+The gem uses ActiveRecord to write to your database, so that's a dependency. Basically, this is really only useful for
+Rails applications at this point. Also, as of now, only MySQL is supported. Other DBs could be added in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_this_used'
+```
+
+And then execute:
+
+```
+bundle
+```
+
+Or install it yourself as:
+
+```
+gem install is_this_used
+```
+
+You'll need to generate and run the migrations to add the required tables to your database:
+
+```bash
+bundle exec rails generate is_this_used:migration
+bundle exec rails db:migrate 
+```
+
+This will create two tables, `potential_crufts`, which is used to collect information on the methods you're
+investigating, and `potential_cruft_stacks` which contains unique stack traces for when invocations of that method
+actually occur.
+
+## Usage
+
+TODO
+
+## 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/[USERNAME]/is_this_used.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# To run tests
+
+## Rails 5.2
+
+bundle exec appraisal rails-5.2 rake
+
+## Rails 6.0
+
+bundle exec appraisal rails-6.0 rake

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 "is_this_used"
+
+# 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/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.4"
+# gem "rails-controller-testing", "~> 1.0.2"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile.lock

@@ -0,0 +1,206 @@
+PATH
+  remote: ..
+  specs:
+    is_this_used (0.1.0)
+      activerecord (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.6)
+      actionpack (= 5.2.4.6)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.6)
+      actionpack (= 5.2.4.6)
+      actionview (= 5.2.4.6)
+      activejob (= 5.2.4.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.6)
+      actionview (= 5.2.4.6)
+      activesupport (= 5.2.4.6)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.6)
+      activesupport (= 5.2.4.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4.6)
+      activesupport (= 5.2.4.6)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.6)
+      activesupport (= 5.2.4.6)
+    activerecord (5.2.4.6)
+      activemodel (= 5.2.4.6)
+      activesupport (= 5.2.4.6)
+      arel (>= 9.0)
+    activestorage (5.2.4.6)
+      actionpack (= 5.2.4.6)
+      activerecord (= 5.2.4.6)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    mysql2 (0.5.3)
+    nio4r (2.5.8)
+    nokogiri (1.13.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.6)
+      actioncable (= 5.2.4.6)
+      actionmailer (= 5.2.4.6)
+      actionpack (= 5.2.4.6)
+      actionview (= 5.2.4.6)
+      activejob (= 5.2.4.6)
+      activemodel (= 5.2.4.6)
+      activerecord (= 5.2.4.6)
+      activestorage (= 5.2.4.6)
+      activesupport (= 5.2.4.6)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.6)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (5.2.4.6)
+      actionpack (= 5.2.4.6)
+      activesupport (= 5.2.4.6)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.4.1)
+  bundler (~> 1.17)
+  generator_spec (~> 0.9.4)
+  is_this_used!
+  mysql2 (~> 0.5.3)
+  pry-byebug (~> 3.9)
+  rails (~> 5.2.4)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails (~> 5.0.2)
+  rubocop (~> 1.22.2)
+  rubocop-rails (~> 2.12.4)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.5.0)
+
+BUNDLED WITH
+   1.17.2

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.3"
+# gem "rails-controller-testing", "~> 1.0.3"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile.lock

@@ -0,0 +1,218 @@
+PATH
+  remote: ..
+  specs:
+    is_this_used (0.1.0)
+      activerecord (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      activejob (= 6.0.4.4)
+      activerecord (= 6.0.4.4)
+      activestorage (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+      mail (>= 2.7.1)
+    actionmailer (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      actionview (= 6.0.4.4)
+      activejob (= 6.0.4.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.4.4)
+      actionview (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      activerecord (= 6.0.4.4)
+      activestorage (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.4.4)
+      activesupport (= 6.0.4.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.4.4)
+      activesupport (= 6.0.4.4)
+      globalid (>= 0.3.6)
+    activemodel (6.0.4.4)
+      activesupport (= 6.0.4.4)
+    activerecord (6.0.4.4)
+      activemodel (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+    activestorage (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      activejob (= 6.0.4.4)
+      activerecord (= 6.0.4.4)
+      marcel (~> 1.0.0)
+    activesupport (6.0.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    mysql2 (0.5.3)
+    nio4r (2.5.8)
+    nokogiri (1.13.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.4.4)
+      actioncable (= 6.0.4.4)
+      actionmailbox (= 6.0.4.4)
+      actionmailer (= 6.0.4.4)
+      actionpack (= 6.0.4.4)
+      actiontext (= 6.0.4.4)
+      actionview (= 6.0.4.4)
+      activejob (= 6.0.4.4)
+      activemodel (= 6.0.4.4)
+      activerecord (= 6.0.4.4)
+      activestorage (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+      bundler (>= 1.3.0)
+      railties (= 6.0.4.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.0.4.4)
+      actionpack (= 6.0.4.4)
+      activesupport (= 6.0.4.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.5.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.4.1)
+  bundler (~> 1.17)
+  generator_spec (~> 0.9.4)
+  is_this_used!
+  mysql2 (~> 0.5.3)
+  pry-byebug (~> 3.9)
+  rails (~> 6.0.3)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails (~> 5.0.2)
+  rubocop (~> 1.22.2)
+  rubocop-rails (~> 2.12.4)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.5.0)
+
+BUNDLED WITH
+   1.17.2

data/is_this_used.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'is_this_used/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'is_this_used'
+  spec.version = IsThisUsed::VERSION
+  spec.authors = ['Doug Hughes']
+  spec.email = ['doug@doughughes.net']
+
+  spec.summary = 'Provides a system to track method usage somewhat unobtrusively.'
+  spec.description = 'Provides a system to track method usage somewhat unobtrusively.'
+  spec.homepage = 'https://github.com/dhughes/is_this_used'
+  spec.license = 'MIT'
+
+  # 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 { |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_dependency 'activerecord', '>= 5.2'
+
+  spec.add_development_dependency 'appraisal', '~> 2.4.1'
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'generator_spec', '~> 0.9.4'
+  spec.add_development_dependency 'mysql2', '~> 0.5.3'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rails', '>= 5.2'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 5.0.2'
+  spec.add_development_dependency 'rubocop', '~> 1.22.2'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.12.4'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5.0'
+end

data/lib/generators/is_this_used/migration_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module IsThisUsed
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path('templates', __dir__)
+
+    def create_migration_file
+      create_potential_crufts
+      create_potential_cruft_stacks
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    private
+
+    def create_potential_crufts
+      create_table('potential_crufts')
+    end
+
+    def create_potential_cruft_stacks
+      create_table('potential_cruft_stacks')
+    end
+
+    def create_table(table)
+      migration_template(
+        "create_#{table}.rb.erb",
+        "db/migrate/create_#{table}.rb",
+        { migration_version: migration_version }
+      )
+    end
+
+    def migration_version
+      format(
+        '[%d.%d]',
+        ActiveRecord::VERSION::MAJOR,
+        ActiveRecord::VERSION::MINOR
+      )
+    end
+  end
+end

data/lib/generators/is_this_used/templates/create_potential_cruft_stacks.rb.erb

@@ -0,0 +1,12 @@
+# This migration creates the `potential_cruft_stacks` table
+class CreatePotentialCruftStacks < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :potential_cruft_stacks do |t|
+      t.references :potential_cruft, null: false
+      t.string :stack_hash, null: false, index: true
+      t.json :stack, null: false
+      t.integer :occurrences, null: false, index: true, default: 0
+      t.timestamps
+    end
+  end
+end

data/lib/generators/is_this_used/templates/create_potential_crufts.rb.erb

@@ -0,0 +1,16 @@
+# This migration creates the `potential_crufts` table
+class CreatePotentialCrufts < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :potential_crufts do |t|
+      t.string :owner_name, null: false
+      t.string :method_name, null: false
+      t.string :method_type, null: false
+      t.integer :invocations, null: false, default: 0
+      t.timestamps
+
+      t.index :owner_name
+      t.index :method_name
+      t.index %i(owner_name method_name)
+    end
+  end
+end

data/lib/is_this_used/cruft_tracker.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  module CruftTracker
+    extend ActiveSupport::Concern
+
+    INSTANCE_METHOD = 'instance_method'
+    CLASS_METHOD = 'class_method'
+
+    class Recorder
+      def self.record_invocation(potential_cruft)
+        PotentialCruft.increment_counter(
+          :invocations,
+          potential_cruft.id,
+          touch: true
+        )
+        record_stack(potential_cruft)
+      end
+
+      def self.record_stack(potential_cruft)
+        stack = filtered_stack
+        stack_hash = Digest::MD5.hexdigest(stack.to_json)
+
+        potential_cruft_stack =
+          PotentialCruftStack.find_by(
+            potential_cruft: potential_cruft, stack_hash: stack_hash
+          )
+        potential_cruft_stack ||=
+          PotentialCruftStack.new(
+            potential_cruft: potential_cruft,
+            stack_hash: stack_hash,
+            stack: stack
+          )
+
+        potential_cruft_stack.occurrences += 1
+
+        potential_cruft_stack.save
+      end
+
+      def self.filtered_stack
+        caller_locations.reject do |location|
+          location.path.match?(%r{\/lib\/is_this_used\/cruft_tracker.rb$})
+        end.map do |location|
+          {
+            path: location.path,
+            label: location.label,
+            base_label: location.base_label,
+            lineno: location.lineno
+          }
+        end
+      end
+    end
+
+    class_methods do
+      def is_this_used?(method_name, method_type: nil)
+        method_type ||= determine_method_type(method_name)
+        target_method = target_method(method_name, method_type)
+
+        potential_cruft =
+          PotentialCruft.find_or_create_by(
+            owner_name: self.name,
+            method_name: method_name,
+            method_type: method_type
+          )
+
+        target_method.owner.define_method target_method.name do |*args|
+          CruftTracker::Recorder.record_invocation(potential_cruft)
+
+          if method_type == INSTANCE_METHOD
+            target_method.bind(self).call(*args)
+          else
+            target_method.call(*args)
+          end
+        end
+      end
+
+      def target_method(method_name, method_type)
+        case method_type
+        when INSTANCE_METHOD
+          self.instance_method(method_name)
+        when CLASS_METHOD
+          self.method(method_name)
+        end
+      end
+
+      def determine_method_type(method_name)
+        is_instance_method =
+          (self.instance_methods + self.private_instance_methods).include?(
+            method_name
+          )
+        is_class_method =
+          (self.methods + self.private_methods).include?(method_name)
+
+        if is_instance_method && is_class_method
+          raise AmbiguousMethodType.new(self.name, method_name)
+        elsif is_instance_method
+          INSTANCE_METHOD
+        elsif is_class_method
+          CLASS_METHOD
+        else
+          raise NoSuchMethod.new(self.name, method_name)
+        end
+      end
+    end
+  end
+
+  class AmbiguousMethodType < StandardError
+    def initialize(owner_name, ambiguous_method_name)
+      super(
+        "#{owner_name} has instance and class methods named '#{
+          ambiguous_method_name
+        }'. Please specify the correct type."
+      )
+    end
+  end
+
+  class NoSuchMethod < StandardError
+    def initialize(owner_name, missing_method_name)
+      super(
+        "#{owner_name} does not have an instance or class method named '#{
+          missing_method_name
+        }'."
+      )
+    end
+  end
+end

data/lib/is_this_used/models/potential_cruft.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  class PotentialCruft < ActiveRecord::Base
+    has_many :potential_cruft_stacks,
+             dependent: :destroy, class_name: 'IsThisUsed::PotentialCruftStack'
+  end
+end

data/lib/is_this_used/models/potential_cruft_stack.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  class PotentialCruftStack < ActiveRecord::Base
+    belongs_to :potential_cruft, class_name: 'IsThisUsed::PotentialCruft'
+  end
+end

data/lib/is_this_used/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  VERSION = '0.1.0'
+end

data/lib/is_this_used.rb

@@ -0,0 +1,8 @@
+require 'is_this_used/version'
+require 'is_this_used/cruft_tracker'
+require 'is_this_used/models/potential_cruft'
+require 'is_this_used/models/potential_cruft_stack'
+
+module IsThisUsed
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: is_this_used
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Doug Hughes
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+- !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: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !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: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: Provides a system to track method usage somewhat unobtrusively.
+email:
+- doug@doughughes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".prettierrc"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.0.gemfile.lock
+- is_this_used.gemspec
+- lib/generators/is_this_used/migration_generator.rb
+- lib/generators/is_this_used/templates/create_potential_cruft_stacks.rb.erb
+- lib/generators/is_this_used/templates/create_potential_crufts.rb.erb
+- lib/is_this_used.rb
+- lib/is_this_used/cruft_tracker.rb
+- lib/is_this_used/models/potential_cruft.rb
+- lib/is_this_used/models/potential_cruft_stack.rb
+- lib/is_this_used/version.rb
+- log/test.log
+homepage: https://github.com/dhughes/is_this_used
+licenses:
+- MIT
+metadata: {}
+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: Provides a system to track method usage somewhat unobtrusively.
+test_files: []