active_record_query_counter 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d653eb9665511008bc78023c7e39ae8eb189e051847d83e16244424b5cbe595
-  data.tar.gz: 6e9643c840a635228ea0a04cb02277b91c34b1ea5e69bd5b93753066be8ab4fb
+  metadata.gz: 752c1c799ab4ee023a24f4f8c3550da35831fdcebf39e71c9bb945bbf4ca7ff9
+  data.tar.gz: ecd642c76f010996f40d0a6d791db96c06515137b2e1393d5655c1feae314b23
 SHA512:
-  metadata.gz: df192239b02e3ed039eac91a64393d5332cad36dce242e9e02948b3ec0cbe23e7ae5d4b23dc58ebf01158fa885680135e6719f444a871abd37779e85a9f85d2d
-  data.tar.gz: '069e6959ba3f7ead49824ae91d35774b3b336afe18248c84800eaca65115daa040bdf5871d0c3e591b648cce2b0d5414078fe51ef39bef8d9f0e777be8e7330d'
+  metadata.gz: b4a88b4283290565e8352d35f6c0b5483515dbcacbd17fb223fc90398b94d50ac2984519f84c6a188a576468cb1f9ea373edfcc6855301e78522676558511e9d
+  data.tar.gz: ff360b2f495c953f79668a27520722c425c94d9cafe6607dcae40d25b65d10dd8f38f7b0d478771495927a5229ecf1e6948328b6adb87be5d6d186c77727d4f2

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.2.1
+
+### Changed
+
+- Classes not required to run the gem are now lazy loaded.
+
+## 2.2.0
+
+### Added
+
+- Added `ActiveRecordQueryCounter.disable` method to allow disabling query counting behavior within a block.
+- Rails 7.1 compatibility.
+
 ## 2.1.0
 
 ### Added

data/README.md

@@ -1,7 +1,9 @@
 # ActiveRecordQueryCounter
 
-![Continuous Integration](https://github.com/bdurand/active_record_query_counter/workflows/Continuous%20Integration/badge.svg)
+[![Continuous Integration](https://github.com/bdurand/active_record_query_counter/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/active_record_query_counter/actions/workflows/continuous_integration.yml)
+[![Regression Test](https://github.com/bdurand/active_record_query_counter/actions/workflows/regression_test.yml/badge.svg)](https://github.com/bdurand/active_record_query_counter/actions/workflows/regression_test.yml)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Gem Version](https://badge.fury.io/rb/active_record_query_counter.svg)](https://badge.fury.io/rb/active_record_query_counter)
 
 This gem injects itself into ActiveRecord to give you insight into how your code is using the database.
 
@@ -60,6 +62,18 @@ Sidekiq.configure_server do |config|
 end
 ```
 
+If you want to disable query counting within a block of code, you can use the `disable` method.
+
+```ruby
+ActiveRecordQueryCounter.count_queries do
+  do_something
+  ActiveRecordQueryCounter.disable do
+    # Queries will not be counted in this block.
+    do_something_else
+  end
+end
+```
+
 ### Notifications
 
 You can also subscribe to ActiveSupport notifications to get notified when query thresholds are exceeded.
@@ -192,6 +206,24 @@ ActiveSupport::Notifications.subscribe('active_record_query_counter.transaction_
 end
 ```
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_query_counter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_record_query_counter
+```
+
 ## Contributing
 
 Open a pull request on GitHub.

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.1

data/lib/active_record_query_counter/connection_adapter_extension.rb

@@ -3,14 +3,38 @@
 module ActiveRecordQueryCounter
   # Module to prepend to the connection adapter to inject the counting behavior.
   module ConnectionAdapterExtension
-    def exec_query(sql, name = nil, binds = [], *args, **kwargs)
-      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      result = super
-      if result.is_a?(ActiveRecord::Result)
-        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+    class << self
+      def inject(connection_class)
+        # Rails 7.1+ uses internal_exec_query instead of exec_query.
+        mod = (connection_class.instance_methods.include?(:internal_exec_query) ? InternalExecQuery : ExecQuery)
+        unless connection_class.include?(mod)
+          connection_class.prepend(mod)
+        end
+      end
+    end
+
+    module ExecQuery
+      def exec_query(sql, name = nil, binds = [], *args, **kwargs)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = super
+        if result.is_a?(ActiveRecord::Result)
+          end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+        end
+        result
+      end
+    end
+
+    module InternalExecQuery
+      def internal_exec_query(sql, name = nil, binds = [], *args, **kwargs)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = super
+        if result.is_a?(ActiveRecord::Result)
+          end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          ActiveRecordQueryCounter.add_query(sql, name, binds, result.length, start_time, end_time)
+        end
+        result
       end
-      result
     end
   end
 end

data/lib/active_record_query_counter/thresholds.rb

@@ -6,6 +6,10 @@ module ActiveRecordQueryCounter
   class Thresholds
     attr_reader :query_time, :row_count, :transaction_time, :transaction_count
 
+    def initialize
+      clear
+    end
+
     def query_time=(value)
       @query_time = value&.to_f
     end
@@ -30,7 +34,7 @@ module ActiveRecordQueryCounter
       values.each do |key, value|
         setter = "#{key}="
         if respond_to?(setter)
-          public_send("#{key}=", value)
+          public_send(:"#{key}=", value)
         else
           raise ArgumentError, "Unknown threshold: #{key}"
         end

data/lib/active_record_query_counter/transaction_manager_extension.rb

@@ -3,6 +3,14 @@
 module ActiveRecordQueryCounter
   # Extension to ActiveRecord::ConnectionAdapters::TransactionManager to count transactions.
   module TransactionManagerExtension
+    class << self
+      def inject(transaction_manager_class)
+        unless transaction_manager_class.include?(self)
+          transaction_manager_class.prepend(self)
+        end
+      end
+    end
+
     def begin_transaction(*args, **kwargs)
       if open_transactions == 0
         @active_record_query_counter_transaction_start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)

data/lib/active_record_query_counter.rb

@@ -2,12 +2,9 @@
 
 require_relative "active_record_query_counter/connection_adapter_extension"
 require_relative "active_record_query_counter/counter"
-require_relative "active_record_query_counter/rack_middleware"
-require_relative "active_record_query_counter/sidekiq_middleware"
 require_relative "active_record_query_counter/thresholds"
 require_relative "active_record_query_counter/transaction_info"
 require_relative "active_record_query_counter/transaction_manager_extension"
-require_relative "active_record_query_counter/version"
 
 # Everything you need to count ActiveRecord queries and row counts within a block.
 #
@@ -19,6 +16,10 @@ require_relative "active_record_query_counter/version"
 #    puts ActiveRecordQueryCounter.row_count
 #  end
 module ActiveRecordQueryCounter
+  autoload :RackMiddleware, "active_record_query_counter/rack_middleware"
+  autoload :SidekiqMiddleware, "active_record_query_counter/sidekiq_middleware"
+  autoload :VERSION, "active_record_query_counter/version"
+
   IGNORED_STATEMENTS = %w[SCHEMA EXPLAIN].freeze
   private_constant :IGNORED_STATEMENTS
 
@@ -48,6 +49,20 @@ module ActiveRecordQueryCounter
       end
     end
 
+    # Disable query counting in a block. Any queries or transactions inside the block will not
+    # be counted.
+    #
+    # @return [Object] the return value of the block
+    def disable(&block)
+      counter = current_counter
+      begin
+        self.current_counter = nil
+        yield
+      ensure
+        self.current_counter = counter
+      end
+    end
+
     # Increment the query counters.
     #
     # @param row_count [Integer] the number of rows returned by the query
@@ -219,11 +234,9 @@ module ActiveRecordQueryCounter
     # @param connection_class [Class] the connection adapter class to extend
     # @return [void]
     def enable!(connection_class)
-      unless connection_class.include?(ConnectionAdapterExtension)
-        connection_class.prepend(ConnectionAdapterExtension)
-      end
-      unless ActiveRecord::ConnectionAdapters::TransactionManager.include?(TransactionManagerExtension)
-        ActiveRecord::ConnectionAdapters::TransactionManager.prepend(TransactionManagerExtension)
+      ActiveSupport.on_load(:active_record) do
+        ConnectionAdapterExtension.inject(connection_class)
+        TransactionManagerExtension.inject(ActiveRecord::ConnectionAdapters::TransactionManager)
       end
 
       @cache_subscription ||= ActiveSupport::Notifications.subscribe("sql.active_record") do |_name, _start_time, _end_time, _id, payload|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_counter
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -46,7 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT_LICENSE
+- MIT_LICENSE.txt
 - README.md
 - VERSION
 - active_record_query_counter.gemspec
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Count total number of ActiveRecord queries and row counts inside a block