is_this_used 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 777036cad1719ed293fa2d1807dde0268776149b3d88ffe70e9d1b80a0666eb7
-  data.tar.gz: c837438870b48369ebbd6378f61329c9685225382c3289df5b25b62ab0e1f926
+  metadata.gz: 6d99ea88778f65e0685fa42ec856e9a61b5414ad87e1963f21f8d8941ee62eea
+  data.tar.gz: 7f5bf7cb77f3688c14035480a1ed16130998f004a6add05afc125bd18f21b6fa
 SHA512:
-  metadata.gz: e1d08ac4789a1208b60cb63f242b26dcf4f79a07cfec9d79bcf9c33d8a30dc20b3b8dcecba5437cee963ea6234d139babb114ceecf406ff8425f50d6207d7022
-  data.tar.gz: 6b4c8f9f86fa53873c02ee650327aa2c824408c92560e9b952b44d3f59c40b62346b72420f742e23a576fbaaad30d0d9d1fd9ddebd822c5dbdd1910e0e8fc385
+  metadata.gz: 5e7acfe828e892998c319ca07bc6bc2ff2bf91c5c2e9e65debbb67f7aacd9c07f9561af8e2fc37dfc140f2ade3d97530fcaf5b9e65a5c13b8a15c60320cc0c92
+  data.tar.gz: dc4363da4d9030568766e2d37cf2c932f5b5bf35d8c5b20d6587c45f12f3c4953357048155e9664523059da54e4d3f8e534578ebd9bc76d9e601c55bb46888b6

data/README.md

@@ -1,4 +1,4 @@
-Have you ever asked yourself, "Is this method even being used?!" Does your application use ActiveRecord? If the answers
+Have you ever asked yourself, "Is this method even being used?!" Does your application use Rails and ActiveRecord? If the answers
 to these two questions are yes, this gem may be of use to you!
 
 Large applications can accrue cruft; old methods that might once have been important, but are now unused. Unfortunately,
@@ -73,9 +73,9 @@ end
 What do you get out of this? Well, as soon as Ruby loads the `SomeOldClass` class, is_this_used will create a new record
 in the `potential_crufts` table that looks like this:
 
-| id  | owner_name   | method_name     | method_type     | invocations | created_at          | updated_at          |
-| --- | ------------ | --------------- | --------------- | ----------- | ------------------- | ------------------- |
-| 1   | SomeOldClass | some_old_method | instance_method | 0           | 2022-01-21 14:07:48 | 2022-01-21 14:07:48 |
+| id  | owner_name   | method_name     | method_type     | invocations | deleted_at | created_at          | updated_at          |
+| --- | ------------ | --------------- | --------------- | ----------- | ---------- | ------------------- | ------------------- |
+| 1   | SomeOldClass | some_old_method | instance_method | 0           | null       | 2022-01-21 14:07:48 | 2022-01-21 14:07:48 | 
 
 This is easily accessed using the `IsThisUsed::PotentialCruft` model class.
 
@@ -87,6 +87,7 @@ The fields are:
 - `method_type` - This is either "instance_method" or "class_method", which are the values of the corresponding
   constants, `IsThisUsed::CruftTracker::INSTANCE_METHOD` and `IsThisUsed::CruftTracker::CLASS_METHOD`.
 - `invocations` - The number of times the method has been invoked.
+- `deleted_at` - When set, this indicates that the method is no longer being tracked.
 - `created_at` - The date/time we started tracking the method.
 - `updated_at` - The last time this record was updated. IE: the last time the tracked method was invoked.
 
@@ -216,6 +217,7 @@ This model represents information about arguments provided to a specific `potent
 
 ## Dependencies
 
+* Rails - Versions 5.2, 6, and 6.1 are supported.
 * ActiveRecord - ActiveRecord is used to persist information about potentially crufty methods. This gem should happily
   work with AR 5.2, 6, and 6.1.
 * MySQL - As of now, only MySQL is supported. PRs are welcome to add support for Postgres, etc.

data/Rakefile

@@ -1,5 +1,24 @@
-# require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
+# frozen_string_literal: true
 
-task :default => :spec
+require "fileutils"
+require "bundler"
+require './spec/support/is_this_used_spec_migrator'
+Bundler::GemHelper.install_tasks
+
+desc "Create the database."
+task :create_db do
+  ENV['RAILS_ENV'] = 'test'
+  system "mysqladmin -f -h #{ENV.fetch('IS_THIS_USED_DB_HOST', 'localhost')} -P #{ENV.fetch('IS_THIS_USED_DB_PORT', 3306)} -u #{ENV.fetch('IS_THIS_USED_DB_USER', 'root')} --password=#{ENV.fetch('IS_THIS_USED_DB_PASSWORD', 'dev')} drop is_this_used_test"
+  system "mysqladmin -h #{ENV.fetch('IS_THIS_USED_DB_HOST', 'localhost')} -P #{ENV.fetch('IS_THIS_USED_DB_PORT', 3306)} -u #{ENV.fetch('IS_THIS_USED_DB_USER', 'root')} --password=#{ENV.fetch('IS_THIS_USED_DB_PASSWORD', 'dev')} create is_this_used_test"
+
+  Bundler.setup
+  require 'active_record/railtie'
+  require 'is_this_used'
+  require 'rspec/rails'
+
+  require File.expand_path('spec/dummy_app/config/environment', __dir__)
+  ::IsThisUsedSpecMigrator.new.migrate
+end
+
+desc "Default: run all available test suites"
+task default: :spec

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    is_this_used (0.1.5)
+    is_this_used (0.1.7)
       activerecord (>= 5.2)
 
 GEM

data/gemfiles/rails_6.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    is_this_used (0.1.5)
+    is_this_used (0.1.7)
       activerecord (>= 5.2)
 
 GEM

data/gemfiles/rails_6.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    is_this_used (0.1.5)
+    is_this_used (0.1.7)
       activerecord (>= 5.2)
 
 GEM

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

@@ -6,6 +6,7 @@ class CreatePotentialCrufts < ActiveRecord::Migration<%= migration_version %>
       t.string :method_name, null: false
       t.string :method_type, null: false
       t.integer :invocations, null: false, default: 0
+      t.datetime :deleted_at
       t.timestamps
 
       t.index :owner_name

data/lib/is_this_used/cruft_cleaner.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  class CruftCleaner
+    def self.clean🧹
+      IsThisUsed::PotentialCruft.where(deleted_at: nil).each do |potential_cruft|
+        unless potential_cruft.still_exists? && potential_cruft.still_tracked?
+          potential_cruft.update(deleted_at: Time.current)
+        end
+      end
+    end
+  end
+end

data/lib/is_this_used/cruft_tracker.rb

@@ -87,6 +87,8 @@ module IsThisUsed
               method_type: method_type
             )
 
+          IsThisUsed::Registry.instance << potential_cruft
+
           target_method.owner.define_method target_method.name do |*args|
             IsThisUsed::Util::LogSuppressor.suppress_logging do
               CruftTracker::Recorder.record_invocation(potential_cruft)

data/lib/is_this_used/models/potential_cruft.rb

@@ -6,5 +6,39 @@ module IsThisUsed
              dependent: :destroy, class_name: 'IsThisUsed::PotentialCruftStack'
     has_many :potential_cruft_arguments,
              dependent: :destroy, class_name: 'IsThisUsed::PotentialCruftArgument'
+
+    def still_exists?
+      class_still_exists? && method_still_exists?
+    end
+
+    def still_tracked?
+      IsThisUsed::Registry.instance.include?(self)
+    end
+
+    def ==(other)
+      other.owner_name == owner_name &&
+        other.method_name == method_name &&
+        other.method_type == method_type
+    end
+
+    private
+
+    def class_still_exists?
+      Object.const_defined?(owner_name)
+    end
+
+    def clazz
+      owner_name.constantize
+    end
+
+    def method_still_exists?
+      case method_type
+      when IsThisUsed::CruftTracker::INSTANCE_METHOD
+        (clazz.instance_methods + clazz.private_instance_methods)
+      when IsThisUsed::CruftTracker::CLASS_METHOD
+        (clazz.methods + clazz.private_methods)
+      end.
+        include?(method_name.to_sym)
+    end
   end
 end

data/lib/is_this_used/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  class Railtie < Rails::Railtie
+    initializer "is_this_used_railtie.configure_post_initialize_cleanup" do
+
+      config.after_initialize do
+        IsThisUsed::CruftCleaner.clean🧹
+      end
+
+    rescue StandardError
+      # Swallow all errors to prevent initialization failures.
+    end
+  end
+end

data/lib/is_this_used/registry.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module IsThisUsed
+  class Registry
+    include Singleton
+
+    attr_accessor :potential_crufts
+
+    def initialize
+      @potential_crufts = []
+    end
+
+    def <<(potential_cruft)
+      potential_crufts << potential_cruft
+    end
+
+    def include?(potential_cruft)
+      potential_crufts.include?(potential_cruft)
+    end
+  end
+end

data/lib/is_this_used/version.rb

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

data/lib/is_this_used.rb

@@ -1,5 +1,7 @@
 require 'is_this_used/version'
 require 'is_this_used/cruft_tracker'
+require 'is_this_used/cruft_cleaner'
+require 'is_this_used/registry'
 require 'is_this_used/models/potential_cruft'
 require 'is_this_used/models/potential_cruft_stack'
 require 'is_this_used/models/potential_cruft_argument'
@@ -8,3 +10,6 @@ require 'is_this_used/util/log_suppressor'
 module IsThisUsed
   class Error < StandardError; end
 end
+
+require 'is_this_used/railtie' if defined?(Rails)
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: is_this_used
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Doug Hughes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -238,10 +238,13 @@ files:
 - 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_cleaner.rb
 - lib/is_this_used/cruft_tracker.rb
 - lib/is_this_used/models/potential_cruft.rb
 - lib/is_this_used/models/potential_cruft_argument.rb
 - lib/is_this_used/models/potential_cruft_stack.rb
+- lib/is_this_used/railtie.rb
+- lib/is_this_used/registry.rb
 - lib/is_this_used/util/log_suppressor.rb
 - lib/is_this_used/version.rb
 - log/test.log