active_record_query_counter 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb19f1f7e8a7678f3cdf3079b05e9aa26353b33b809c240943e0899f584dac6a
-  data.tar.gz: 7bcbce0b2d06c4f871074898651071f1400cd87c7ee8ee514837ee80caac6774
+  metadata.gz: 9d653eb9665511008bc78023c7e39ae8eb189e051847d83e16244424b5cbe595
+  data.tar.gz: 6e9643c840a635228ea0a04cb02277b91c34b1ea5e69bd5b93753066be8ab4fb
 SHA512:
-  metadata.gz: 80c468ec96c069bb4043a0e210d4fb4b1d82714d2aa0b69bd07ac9fd23bb04255ffcf4b175fcfa66b7aa0afd8434c211645e70f4fd8d05ad9c10faa4ee95c679
-  data.tar.gz: fb972d526b98c97f98230a29eb9412726746a58c3d4a05406ab9ccc046d6eb0ec5007fa8d52d26a40c9a966ad2af4c50c045c1d9257cd15ce90dd21c5dedbcfa
+  metadata.gz: df192239b02e3ed039eac91a64393d5332cad36dce242e9e02948b3ec0cbe23e7ae5d4b23dc58ebf01158fa885680135e6719f444a871abd37779e85a9f85d2d
+  data.tar.gz: '069e6959ba3f7ead49824ae91d35774b3b336afe18248c84800eaca65115daa040bdf5871d0c3e591b648cce2b0d5414078fe51ef39bef8d9f0e777be8e7330d'

data/CHANGELOG.md

@@ -4,6 +4,16 @@ 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.1.0
+
+### Added
+
+- Added count of queries that hit the query cache instead of being sent to the database.
+
+### Removed
+
+- Dropped support for ActiveRecord 5.0.
+
 ## 2.0.0
 
 ### Added

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/active_record_query_counter.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activerecord", ">= 5.1"
 
   spec.add_development_dependency "bundler"
 

data/lib/active_record_query_counter/counter.rb

@@ -3,17 +3,30 @@
 module ActiveRecordQueryCounter
   # Data structure for storing query information encountered within a block.
   class Counter
-    attr_accessor :query_count, :row_count, :query_time
+    attr_accessor :query_count, :row_count, :query_time, :cached_query_count
     attr_reader :thresholds
 
     def initialize
       @query_count = 0
       @row_count = 0
       @query_time = 0.0
+      @cached_query_count = 0
       @transactions_hash = {}
       @thresholds = ActiveRecordQueryCounter.default_thresholds.dup
     end
 
+    # Return the percentage of queries that used the query cache instead of going to the database.
+    #
+    # @return [Float]
+    def cache_hit_rate
+      total_queries = query_count + cached_query_count
+      if total_queries > 0
+        (cached_query_count.to_f / total_queries)
+      else
+        0.0
+      end
+    end
+
     # Return an array of transaction information for any transactions that have been tracked
     # by the counter.
     #

data/lib/active_record_query_counter.rb

@@ -19,7 +19,7 @@ require_relative "active_record_query_counter/version"
 #    puts ActiveRecordQueryCounter.row_count
 #  end
 module ActiveRecordQueryCounter
-  IGNORED_STATEMENTS = %w[CACHE SCHEMA EXPLAIN].freeze
+  IGNORED_STATEMENTS = %w[SCHEMA EXPLAIN].freeze
   private_constant :IGNORED_STATEMENTS
 
   class << self
@@ -107,6 +107,16 @@ module ActiveRecordQueryCounter
       counter.query_count if counter.is_a?(Counter)
     end
 
+    # Return the number of queries that hit the query cache and were not sent to the database
+    # that have been counted within the current block.  Returns nil if not inside a block where
+    # queries are being counted.
+    #
+    # @return [Integer, nil]
+    def cached_query_count
+      counter = current_counter
+      counter.cached_query_count if counter.is_a?(Counter)
+    end
+
     # Return the number of rows that have been counted within the current block.
     # Returns nil if not inside a block where queries are being counted.
     #
@@ -182,6 +192,8 @@ module ActiveRecordQueryCounter
           query_count: counter.query_count,
           row_count: counter.row_count,
           query_time: counter.query_time,
+          cached_query_count: counter.cached_query_count,
+          cache_hit_rate: counter.cache_hit_rate,
           transaction_count: counter.transaction_count,
           transaction_time: counter.transaction_time
         }
@@ -213,6 +225,13 @@ module ActiveRecordQueryCounter
       unless ActiveRecord::ConnectionAdapters::TransactionManager.include?(TransactionManagerExtension)
         ActiveRecord::ConnectionAdapters::TransactionManager.prepend(TransactionManagerExtension)
       end
+
+      @cache_subscription ||= ActiveSupport::Notifications.subscribe("sql.active_record") do |_name, _start_time, _end_time, _id, payload|
+        if payload[:cached]
+          counter = current_counter
+          counter.cached_query_count += 1 if counter
+        end
+      end
     end
 
     private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_counter
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-09 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement