columns_trace 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c654a6d0c0772fffa33bb28544ba4e3299272b2673f8f4a138a4526a16a7f036
-  data.tar.gz: f8f2d7914dec1d9b1a39182626ba0f37736bdf2b3a618ade7f9cb1b5b204850a
+  metadata.gz: 9b9167813d7f9a2089f1eb2380bc62de8289384ed56f33fc4983ca716b76c0a9
+  data.tar.gz: 0ce77996e83a1af64bb9d64acc7231965e1a46263b9be30bb870a3e3a0a6a140
 SHA512:
-  metadata.gz: 408421ba16b44441a4be3e24c46b0ef7e31bfbcb58d6eacc229c51882c00bd2fbb2956bf16a51572f8d2fab94a9ed515bebb4e8450efdea64b1e849bcffcffb7
-  data.tar.gz: 3ef7b2f0cf92cce13760dd581ef68a59fe833ce1fe646c9c9c5476ed6163f024efad6bf67732c6f4f338bf92a2a50deed2b560c9b923605d68a2d7d482d6c539
+  metadata.gz: a2f63e4cc55f26f7f86670c65378f203e8ea4e703ccd8079e5a4c201729eddb2de42277f654108ef80b61dc29c31ba5211a97fec44f05076480234e65a3221b5
+  data.tar.gz: 3fbddc61ae15705ecb191b3d1856f726b292c59d6973b80c4f464555765e423551572fea0e17a21e3019839b9b109e1f0803fc86db588ab9ac3752da8f3d6a3b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master (unreleased)
 
+## 0.3.0 (2023-11-09)
+
+  - Add ability to trace columns usage in custom code
+  - Trace unused columns in mailers
+
 ## 0.2.0 (2023-10-13)
 
 - Allow to use custom reporters

data/README.md

@@ -25,7 +25,7 @@ $ bundle install
 
 ## Usage
 
-Hit a controller action or run `ActiveJob` (or `Sidekiq`) job, open `log/columns_trace.log`,
+Hit a controller or email action or run `ActiveJob` (or `Sidekiq`) job, open `log/columns_trace.log`,
 and see the output:
 
 ```
@@ -54,6 +54,18 @@ ImportProjectJob
   ↳ app/jobs/import_project_job.rb:24:in `perform'
 ```
 
+### Tracing custom code
+
+To get columns usage in the custom code, you can manually wrap it by `ColumnsTrace.report`:
+
+```ruby
+task my_rake_task: :environment do
+  ColumnsTrace.report("my_rake_task") do
+    # do stuff
+  end
+end
+```
+
 ## Configuration
 
 You can override the following default options:

data/lib/columns_trace/rails_integration.rb

@@ -14,18 +14,20 @@ module ColumnsTrace
   end
 
   ActiveSupport.on_load(:action_controller) do
-    before_action { Registry.clear }
+    around_action do |controller, action|
+      ColumnsTrace.report("#{controller.class.name}##{action_name}", &action)
+    end
+  end
 
-    after_action do
-      ColumnsTrace.reporter.report("#{self.class.name}##{action_name}", Registry.created_records)
+  ActiveSupport.on_load(:action_mailer) do
+    around_action do |mailer, action|
+      ColumnsTrace.report("#{mailer.class.name}##{action_name}", &action)
     end
   end
 
   ActiveSupport.on_load(:active_job) do
-    before_perform { Registry.clear }
-
-    after_perform do
-      ColumnsTrace.reporter.report(self.class.name, Registry.created_records)
+    around_perform do |job, perform|
+      ColumnsTrace.report("#{job.class.name}#perform", &perform)
     end
   end
 end

data/lib/columns_trace/sidekiq_integration.rb

@@ -3,10 +3,8 @@
 module ColumnsTrace
   # @private
   class SidekiqMiddleware
-    def call(worker, _job, _queue)
-      Registry.clear
-      yield
-      ColumnsTrace.reporter.report(worker.class.name, Registry.created_records)
+    def call(worker, _job, _queue, &block)
+      ColumnsTrace.report("#{worker.class.name}#perform", &block)
     end
   end
 end

data/lib/columns_trace/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColumnsTrace
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/columns_trace.rb

@@ -11,6 +11,23 @@ require_relative "columns_trace/railtie" if defined?(Rails)
 
 module ColumnsTrace
   class << self
+    # Manually trace columns usage in an arbitrary code.
+    #
+    # @param title [String] title of the reporting, e.g. controller action etc
+    #
+    # @example
+    #   task my_rake_task: :environment do
+    #     ColumnsTrace.report("my_rake_task") do
+    #       # do stuff
+    #     end
+    #   end
+    #
+    def report(title)
+      Registry.clear
+      yield
+      reporter.report(title, Registry.created_records)
+    end
+
     # @private
     attr_reader :ignored_models
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: columns_trace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-13 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord