is_this_used 0.1.11 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4abf2fd80c83d0bb580066755b650e74538f9f3b77494d400528b33efa03eedb
-  data.tar.gz: 90185ef813d1d14182b20d1a4cbf4ea6d358867edd8e8b958c8f06ec82636ffe
+  metadata.gz: 9ee3077f21a391a8be63d34431215b2a230b03155cd50ae99466079f796ef7de
+  data.tar.gz: 8df3bc2329e894929843ecc61481cccd8b357ca09fa11cc63f917ade6af7dcb0
 SHA512:
-  metadata.gz: 9f8139f3bdc1006462040512f875697043079c9acdf70738b8388afa1108bc7cb44b89e17f38b40b6d8dfac9138317cbaff645f42fa07b4c9782b1a821c32e3b
-  data.tar.gz: 6d569fafa4e91e7d29727989e35386981a5f095b384cd4b38f230db22aead2d87dd125a6bbf364ae10a8b92fddf48f6cfbbd8be57087318ff62df24aaada795b
+  metadata.gz: 1417d2134db8d73a852036164e7b71cef3ac3cdb4888162abe111734bf28a5e20b1eb13d4206ac5ccd302fa1b680b25a09a15e201075147ceb5727320095e9d8
+  data.tar.gz: ca93f1e66d50095f4e21d7a968c6769a05122259259dcdcac4c8295093ac987e1f736698217f9cb032789b31a5000e620473a296d2773d8a439f92a011f0059b

data/README.md

@@ -40,6 +40,8 @@ actually occur.
 
 ## Usage
 
+### `is_this_used?`
+
 is_this_used is pretty simple. Let's say you have a class (or module) like this...
 
 ```ruby
@@ -75,7 +77,7 @@ in the `potential_crufts` table that looks like this:
 
 | 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 | 
+| 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.
 
@@ -102,7 +104,7 @@ So, having annotated the method, you can check this table after a while. If you
 you have a reasonably good hint that the method may not actually be used. Of course, you should consider that there are
 some processes that are not run frequently at all, so this gem isn't a panacea. Think before you delete!
 
-### Tracking Stacks
+#### Tracking Stacks
 
 In the case that a method _is_ actually invoked, the `invocations` value is incremented and a record is created in
 the `potential_cruft_stacks` table for each unique invocation stacktrace. This can be used to determine which methods
@@ -148,7 +150,7 @@ The `label` and `base_label` fields come from Ruby's `Thread::Backtrace::Locatio
 difference is, as the docs simply say this about `base_label`: "Usually same as label, without decoration". 🤷 Anyhow,
 it's there if you need it.
 
-### Tracking Arguments
+#### Tracking Arguments
 
 In addition to tracking stacks, you can track details about arguments provided to tracked methods. For example, let's say you have the following method:
 
@@ -196,8 +198,11 @@ The above would result in the following records in `potential_cruft_arguments` (
 | 1619ec6af47253461e87ebf1923a8a83 | ["color", "locality"]          | 1           |
 | 88c8205498de97d4ef06b249006bb68b | ["status"]                     | 1           |
 
+### `is_any_of_this_stuff_used?`
 
+Let's say you have a class and you're wondering what, if anything, in that class is used. You probably don't want to tag every single method in that class with `is_this_used?`. Instead, you can add `is_any_of_this_stuff_used?` as the last line in that class. When the class is loaded, is_this_used will identify all of the instance and class methods defined directly on the object itself and track each one of those, just as if you'd tagged them individually with `is_this_used?`.
 
+The `is_any_of_this_stuff_used?` method does not accept any arguments and cannot be used to track arguments. However, you can use both `is_this_used?` and `is_any_of_this_stuff_used?` at the same time. If you want to track everything in a class, but track arguments for a specific method, simply tag that method with `is_this_used?` and specify the `track_arguments` argument. Be sure to place `is_any_of_this_stuff_used?` as the last line within the class. Now that one method will have its arguments tracked while the others will simply be tracked normally.
 
 ## Models
 

data/gemfiles/rails_5.2.gemfile.lock

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

data/gemfiles/rails_6.0.gemfile.lock

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

data/gemfiles/rails_6.1.gemfile.lock

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

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

@@ -7,6 +7,10 @@ class CreatePotentialCruftArguments < ActiveRecord::Migration<%= migration_versi
       t.json :arguments, null: false
       t.integer :occurrences, null: false, index: true, default: 0
       t.timestamps
+
+      t.index %i[potential_cruft_id arguments_hash],
+              unique: true,
+              name: 'index_pca_on_potential_cruft_id_and_arguments_hash'
     end
   end
 end

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

@@ -7,6 +7,10 @@ class CreatePotentialCruftStacks < ActiveRecord::Migration<%= migration_version
       t.json :stack, null: false
       t.integer :occurrences, null: false, index: true, default: 0
       t.timestamps
+
+      t.index %i[potential_cruft_id stack_hash],
+              unique: true,
+              name: 'index_pcs_on_potential_cruft_id_and_stack_hash'
     end
   end
 end

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

@@ -11,7 +11,10 @@ class CreatePotentialCrufts < ActiveRecord::Migration<%= migration_version %>
 
       t.index :owner_name
       t.index :method_name
-      t.index %i(owner_name method_name)
+      t.index %i[owner_name method_name]
+      t.index %i[owner_name method_name method_type],
+              unique: true,
+              name: 'index_pc_on_owner_name_and_method_name_and_method_type'
     end
   end
 end

data/lib/is_this_used/cruft_tracker.rb

@@ -21,18 +21,26 @@ module IsThisUsed
 
         potential_cruft_stack =
           PotentialCruftStack.find_by(
-            potential_cruft: potential_cruft, stack_hash: stack_hash
+            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
+        potential_cruft_stack ||= begin
+                                    PotentialCruftStack.create(
+                                      potential_cruft: potential_cruft,
+                                      stack_hash: stack_hash,
+                                      stack: stack
+                                    )
+                                  rescue ActiveRecord::RecordNotUnique
+                                    PotentialCruftStack.find_by(
+                                      stack_hash: stack_hash
+                                    )
+                                  end
+
+        potential_cruft_stack.with_lock do
+          potential_cruft_stack.reload
+          potential_cruft_stack.occurrences += 1
+          potential_cruft_stack.save!
+        end
       end
 
       def self.filtered_stack
@@ -55,18 +63,24 @@ module IsThisUsed
 
         potential_cruft_argument =
           PotentialCruftArgument.find_by(
-            potential_cruft: potential_cruft, arguments_hash: arguments_hash
+            arguments_hash: arguments_hash
           )
-        potential_cruft_argument ||=
-          PotentialCruftArgument.new(
-            potential_cruft: potential_cruft,
-            arguments_hash: arguments_hash,
-            arguments: arguments
-          )
-
-        potential_cruft_argument.occurrences += 1
-
-        potential_cruft_argument.save
+        potential_cruft_argument ||= begin
+                                       PotentialCruftArgument.create(
+                                         potential_cruft: potential_cruft,
+                                         arguments_hash: arguments_hash,
+                                         arguments: arguments
+                                       )
+                                     rescue ActiveRecord::RecordNotUnique
+                                       PotentialCruftArgument.find_by(
+                                         arguments_hash: arguments_hash
+                                       )
+                                     end
+
+        potential_cruft_argument.with_lock do
+          potential_cruft_argument.occurrences += 1
+          potential_cruft_argument.save!
+        end
       end
     end
 
@@ -75,17 +89,23 @@ module IsThisUsed
     end
 
     module ClassMethods
+      def potentially_crufty_methods_being_tracked
+        @potentially_crufty_methods_being_tracked ||= []
+      end
+
       def is_this_used?(method_name, method_type: nil, track_arguments: false)
         IsThisUsed::Util::LogSuppressor.suppress_logging do
           method_type ||= determine_method_type(method_name)
+
+          tracked_method_identifier = "#{method_name}/#{method_type}"
+          return if potentially_crufty_methods_being_tracked.include?(tracked_method_identifier)
+
           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
-            )
+          potential_cruft = create_or_find_potential_cruft(
+            method_name: method_name,
+            method_type: method_type
+          )
 
           potential_cruft.update(deleted_at: nil) if potential_cruft.deleted_at.present?
 
@@ -106,19 +126,34 @@ module IsThisUsed
               target_method.call(*args)
             end
           end
+
+          potentially_crufty_methods_being_tracked << tracked_method_identifier
         end
-      rescue ActiveRecord::StatementInvalid, NoMethodError => e
+      rescue ActiveRecord::StatementInvalid => e
         raise unless e.cause.present? && e.cause.instance_of?(Mysql2::Error)
 
         Rails.logger.warn(
           'There was an error recording potential cruft. Does the potential_crufts table exist? Have migrations been run?'
         )
+      rescue NoMethodError
+        Rails.logger.warn(
+          'There was an error recording potential cruft. Have migrations been run?'
+        )
       rescue Mysql2::Error::ConnectionError, ActiveRecord::ConnectionNotEstablished
         Rails.logger.warn(
           'There was an error recording potential cruft due to being unable to connect to the database. This may be a non-issue in cases where the database is intentionally not available.'
         )
       end
 
+      def is_any_of_this_stuff_used?
+        own_instance_methods.each do |instance_method|
+          is_this_used?(instance_method, method_type: INSTANCE_METHOD)
+        end
+        own_class_methods.each do |class_method|
+          is_this_used?(class_method, method_type: CLASS_METHOD)
+        end
+      end
+
       def target_method(method_name, method_type)
         case method_type
         when INSTANCE_METHOD
@@ -129,12 +164,8 @@ module IsThisUsed
       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)
+        is_instance_method = all_instance_methods(self).include?(method_name)
+        is_class_method = all_class_methods(self).include?(method_name)
 
         if is_instance_method && is_class_method
           raise AmbiguousMethodType.new(self.name, method_name)
@@ -146,6 +177,47 @@ module IsThisUsed
           raise NoSuchMethod.new(self.name, method_name)
         end
       end
+
+      def all_instance_methods(object)
+        object.instance_methods + object.private_instance_methods
+      end
+
+      def all_class_methods(object)
+        object.methods + object.private_methods
+      end
+
+      def own_instance_methods
+        ancestors_instance_methods =
+          (self.ancestors - [self])
+            .map {|ancestor| all_instance_methods(ancestor)}
+            .flatten
+            .uniq
+
+        all_instance_methods(self) - ancestors_instance_methods
+      end
+
+      def own_class_methods
+        ancestors_class_methods =
+          (self.ancestors - [self])
+            .map {|ancestor| all_class_methods(ancestor)}
+            .flatten
+            .uniq
+
+        all_class_methods(self) -
+          all_instance_methods(IsThisUsed::CruftTracker::ClassMethods) -
+          ancestors_class_methods
+      end
+
+      def create_or_find_potential_cruft(method_name:, method_type:)
+        PotentialCruft.find_or_create_by(owner_name: self.name,
+                                         method_name: method_name,
+                                         method_type: method_type)
+
+      rescue ActiveRecord::RecordNotUnique
+        PotentialCruft.find_by(owner_name: self.name,
+                               method_name: method_name,
+                               method_type: method_type)
+      end
     end
   end
 

data/lib/is_this_used/util/log_suppressor.rb

@@ -7,6 +7,7 @@ module IsThisUsed
         initial_log_level = ActiveRecord::Base.logger.level
         ActiveRecord::Base.logger.level = :error
         yield
+      ensure
         ActiveRecord::Base.logger.level = initial_log_level
       end
     end

data/lib/is_this_used/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: is_this_used
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.14
 platform: ruby
 authors:
 - Doug Hughes
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -253,7 +253,7 @@ homepage: https://github.com/dhughes/is_this_used
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -269,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Provides a system to track method usage somewhat unobtrusively.
 test_files: []