is_this_used 0.1.7 → 0.1.10
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/Rakefile +23 -4
- data/gemfiles/rails_5.2.gemfile.lock +1 -1
- data/gemfiles/rails_6.0.gemfile.lock +1 -1
- data/gemfiles/rails_6.1.gemfile.lock +1 -1
- data/lib/generators/is_this_used/templates/create_potential_crufts.rb.erb +1 -0
- data/lib/is_this_used/cruft_cleaner.rb +16 -0
- data/lib/is_this_used/cruft_tracker.rb +4 -0
- data/lib/is_this_used/models/potential_cruft.rb +34 -0
- data/lib/is_this_used/railtie.rb +17 -0
- data/lib/is_this_used/registry.rb +21 -0
- data/lib/is_this_used/version.rb +1 -1
- data/lib/is_this_used.rb +5 -0
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1a51a4125a42f72c6050a059472d3c7bed666bd7c39abbfa58c6f932c82e6b7b
|
4
|
+
data.tar.gz: acdcd4f7ed3f6ed71832039ebe06ada62d73eaceb145254f24cb35d3930bf6a1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c0240250e10ce0650da05c7b88fa3f8d224bdaab70ab0c62fbe7d6da54890485bd3b8957bc1daf10e99eeb8479d5456880b5c4288f21e86c7fde099385a6433f
|
7
|
+
data.tar.gz: c5d9e9bce3c1266e74e43c4fde3759458c28598257f1e327b927fecd1eb08f141e02d736f232b322eec4d39c868b242e70daf1f054edbdfc16dc5553ac7f5230
|
data/README.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
Have you ever asked yourself, "Is this method even being used?!" Does your application use ActiveRecord? If the answers
|
1
|
+
Have you ever asked yourself, "Is this method even being used?!" Does your application use Rails and ActiveRecord? If the answers
|
2
2
|
to these two questions are yes, this gem may be of use to you!
|
3
3
|
|
4
4
|
Large applications can accrue cruft; old methods that might once have been important, but are now unused. Unfortunately,
|
@@ -73,9 +73,9 @@ end
|
|
73
73
|
What do you get out of this? Well, as soon as Ruby loads the `SomeOldClass` class, is_this_used will create a new record
|
74
74
|
in the `potential_crufts` table that looks like this:
|
75
75
|
|
76
|
-
| id | owner_name | method_name | method_type | invocations | created_at | updated_at |
|
77
|
-
| --- | ------------ | --------------- | --------------- | ----------- | ------------------- | ------------------- |
|
78
|
-
| 1 | SomeOldClass | some_old_method | instance_method | 0 | 2022-01-21 14:07:48 | 2022-01-21 14:07:48 |
|
76
|
+
| id | owner_name | method_name | method_type | invocations | deleted_at | created_at | updated_at |
|
77
|
+
| --- | ------------ | --------------- | --------------- | ----------- | ---------- | ------------------- | ------------------- |
|
78
|
+
| 1 | SomeOldClass | some_old_method | instance_method | 0 | null | 2022-01-21 14:07:48 | 2022-01-21 14:07:48 |
|
79
79
|
|
80
80
|
This is easily accessed using the `IsThisUsed::PotentialCruft` model class.
|
81
81
|
|
@@ -87,6 +87,7 @@ The fields are:
|
|
87
87
|
- `method_type` - This is either "instance_method" or "class_method", which are the values of the corresponding
|
88
88
|
constants, `IsThisUsed::CruftTracker::INSTANCE_METHOD` and `IsThisUsed::CruftTracker::CLASS_METHOD`.
|
89
89
|
- `invocations` - The number of times the method has been invoked.
|
90
|
+
- `deleted_at` - When set, this indicates that the method is no longer being tracked.
|
90
91
|
- `created_at` - The date/time we started tracking the method.
|
91
92
|
- `updated_at` - The last time this record was updated. IE: the last time the tracked method was invoked.
|
92
93
|
|
@@ -216,6 +217,7 @@ This model represents information about arguments provided to a specific `potent
|
|
216
217
|
|
217
218
|
## Dependencies
|
218
219
|
|
220
|
+
* Rails - Versions 5.2, 6, and 6.1 are supported.
|
219
221
|
* ActiveRecord - ActiveRecord is used to persist information about potentially crufty methods. This gem should happily
|
220
222
|
work with AR 5.2, 6, and 6.1.
|
221
223
|
* MySQL - As of now, only MySQL is supported. PRs are welcome to add support for Postgres, etc.
|
data/Rakefile
CHANGED
@@ -1,5 +1,24 @@
|
|
1
|
-
#
|
2
|
-
require "rspec/core/rake_task"
|
3
|
-
RSpec::Core::RakeTask.new(:spec)
|
1
|
+
# frozen_string_literal: true
|
4
2
|
|
5
|
-
|
3
|
+
require "fileutils"
|
4
|
+
require "bundler"
|
5
|
+
require './spec/support/is_this_used_spec_migrator'
|
6
|
+
Bundler::GemHelper.install_tasks
|
7
|
+
|
8
|
+
desc "Create the database."
|
9
|
+
task :create_db do
|
10
|
+
ENV['RAILS_ENV'] = 'test'
|
11
|
+
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"
|
12
|
+
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"
|
13
|
+
|
14
|
+
Bundler.setup
|
15
|
+
require 'active_record/railtie'
|
16
|
+
require 'is_this_used'
|
17
|
+
require 'rspec/rails'
|
18
|
+
|
19
|
+
require File.expand_path('spec/dummy_app/config/environment', __dir__)
|
20
|
+
::IsThisUsedSpecMigrator.new.migrate
|
21
|
+
end
|
22
|
+
|
23
|
+
desc "Default: run all available test suites"
|
24
|
+
task default: :spec
|
@@ -6,6 +6,7 @@ class CreatePotentialCrufts < ActiveRecord::Migration<%= migration_version %>
|
|
6
6
|
t.string :method_name, null: false
|
7
7
|
t.string :method_type, null: false
|
8
8
|
t.integer :invocations, null: false, default: 0
|
9
|
+
t.datetime :deleted_at
|
9
10
|
t.timestamps
|
10
11
|
|
11
12
|
t.index :owner_name
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module IsThisUsed
|
4
|
+
class CruftCleaner
|
5
|
+
def self.clean🧹
|
6
|
+
IsThisUsed::PotentialCruft.where(deleted_at: nil).each do |potential_cruft|
|
7
|
+
unless potential_cruft.still_exists? && potential_cruft.still_tracked?
|
8
|
+
potential_cruft.update(deleted_at: Time.current)
|
9
|
+
end
|
10
|
+
end
|
11
|
+
rescue StandardError
|
12
|
+
# I'm actively ignoring all errors. Chances are, these are due to something like running rake
|
13
|
+
# tasks in CI when the DB doesn't already exist.
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -87,6 +87,10 @@ module IsThisUsed
|
|
87
87
|
method_type: method_type
|
88
88
|
)
|
89
89
|
|
90
|
+
potential_cruft.update(deleted_at: nil) if potential_cruft.deleted_at.present?
|
91
|
+
|
92
|
+
IsThisUsed::Registry.instance << potential_cruft
|
93
|
+
|
90
94
|
target_method.owner.define_method target_method.name do |*args|
|
91
95
|
IsThisUsed::Util::LogSuppressor.suppress_logging do
|
92
96
|
CruftTracker::Recorder.record_invocation(potential_cruft)
|
@@ -6,5 +6,39 @@ module IsThisUsed
|
|
6
6
|
dependent: :destroy, class_name: 'IsThisUsed::PotentialCruftStack'
|
7
7
|
has_many :potential_cruft_arguments,
|
8
8
|
dependent: :destroy, class_name: 'IsThisUsed::PotentialCruftArgument'
|
9
|
+
|
10
|
+
def still_exists?
|
11
|
+
class_still_exists? && method_still_exists?
|
12
|
+
end
|
13
|
+
|
14
|
+
def still_tracked?
|
15
|
+
IsThisUsed::Registry.instance.include?(self)
|
16
|
+
end
|
17
|
+
|
18
|
+
def ==(other)
|
19
|
+
other.owner_name == owner_name &&
|
20
|
+
other.method_name == method_name &&
|
21
|
+
other.method_type == method_type
|
22
|
+
end
|
23
|
+
|
24
|
+
private
|
25
|
+
|
26
|
+
def class_still_exists?
|
27
|
+
Object.const_defined?(owner_name)
|
28
|
+
end
|
29
|
+
|
30
|
+
def clazz
|
31
|
+
owner_name.constantize
|
32
|
+
end
|
33
|
+
|
34
|
+
def method_still_exists?
|
35
|
+
case method_type
|
36
|
+
when IsThisUsed::CruftTracker::INSTANCE_METHOD
|
37
|
+
(clazz.instance_methods + clazz.private_instance_methods)
|
38
|
+
when IsThisUsed::CruftTracker::CLASS_METHOD
|
39
|
+
(clazz.methods + clazz.private_methods)
|
40
|
+
end.
|
41
|
+
include?(method_name.to_sym)
|
42
|
+
end
|
9
43
|
end
|
10
44
|
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module IsThisUsed
|
4
|
+
class Railtie < Rails::Railtie
|
5
|
+
initializer "is_this_used_railtie.configure_post_initialize_cleanup" do
|
6
|
+
|
7
|
+
config.after_initialize do
|
8
|
+
if Rails.application.config.eager_load
|
9
|
+
IsThisUsed::CruftCleaner.clean🧹
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
rescue StandardError
|
14
|
+
# Swallow all errors to prevent initialization failures.
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module IsThisUsed
|
4
|
+
class Registry
|
5
|
+
include Singleton
|
6
|
+
|
7
|
+
attr_accessor :potential_crufts
|
8
|
+
|
9
|
+
def initialize
|
10
|
+
@potential_crufts = []
|
11
|
+
end
|
12
|
+
|
13
|
+
def <<(potential_cruft)
|
14
|
+
potential_crufts << potential_cruft
|
15
|
+
end
|
16
|
+
|
17
|
+
def include?(potential_cruft)
|
18
|
+
potential_crufts.include?(potential_cruft)
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
data/lib/is_this_used/version.rb
CHANGED
data/lib/is_this_used.rb
CHANGED
@@ -1,5 +1,7 @@
|
|
1
1
|
require 'is_this_used/version'
|
2
2
|
require 'is_this_used/cruft_tracker'
|
3
|
+
require 'is_this_used/cruft_cleaner'
|
4
|
+
require 'is_this_used/registry'
|
3
5
|
require 'is_this_used/models/potential_cruft'
|
4
6
|
require 'is_this_used/models/potential_cruft_stack'
|
5
7
|
require 'is_this_used/models/potential_cruft_argument'
|
@@ -8,3 +10,6 @@ require 'is_this_used/util/log_suppressor'
|
|
8
10
|
module IsThisUsed
|
9
11
|
class Error < StandardError; end
|
10
12
|
end
|
13
|
+
|
14
|
+
require 'is_this_used/railtie' if defined?(Rails)
|
15
|
+
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: is_this_used
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.10
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Doug Hughes
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-03-
|
11
|
+
date: 2022-03-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activerecord
|
@@ -238,10 +238,13 @@ files:
|
|
238
238
|
- lib/generators/is_this_used/templates/create_potential_cruft_stacks.rb.erb
|
239
239
|
- lib/generators/is_this_used/templates/create_potential_crufts.rb.erb
|
240
240
|
- lib/is_this_used.rb
|
241
|
+
- lib/is_this_used/cruft_cleaner.rb
|
241
242
|
- lib/is_this_used/cruft_tracker.rb
|
242
243
|
- lib/is_this_used/models/potential_cruft.rb
|
243
244
|
- lib/is_this_used/models/potential_cruft_argument.rb
|
244
245
|
- lib/is_this_used/models/potential_cruft_stack.rb
|
246
|
+
- lib/is_this_used/railtie.rb
|
247
|
+
- lib/is_this_used/registry.rb
|
245
248
|
- lib/is_this_used/util/log_suppressor.rb
|
246
249
|
- lib/is_this_used/version.rb
|
247
250
|
- log/test.log
|