active-record-query-count 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61cf944e309b8f269e891b003e767b657f9c89bf78934337199e6189d7f7599b
-  data.tar.gz: a0b055c5fc44099ad356d366d6ffc259c9c783eaad05ce7585df3034826972a3
+  metadata.gz: d095bdca093b9cc7bf7f2e765855daa33c256a6eb6a23f7e7efb70001675f881
+  data.tar.gz: 50cf40d3cd40b1ee75096a5518e83289739fcbe381afa484d9db6c4395370a83
 SHA512:
-  metadata.gz: e1c83e3b6ecde6b6e1a5eed1e17c844be5ad83430c8ba21d21c24961a4ab2d9dd79c6c1b33e7950e357976bd14e5b7040aed1d77606257ae29ad5d254412c19a
-  data.tar.gz: c5d0981a4a35f9189fe5aa0e722a326ca1ed83df442d118556898daf63290463d37b385b5fdc5d39d5924066429bcb2e53f04eaa76da0c8472d9316bb486b8ba
+  metadata.gz: c13044996330b7784b78afef3a0243d9199c9f694ce5998d9349db9e2fc930d33f22e5425dc235c653c3d1c2283bf811dd484c7ffa7363c606ac0a191d7cfddb
+  data.tar.gz: c8f60440c96860f2dff53cd739718a1c28815de9113a7a323def118dbcb63b72442368ef1f90a24ed026c9c5d74c223a14e083ed57c0ae2a3f3988abebe20a8c

data/README.md

@@ -1,14 +1,14 @@
 # ActiveRecordQueryCount
 
-`ActiveRecordQueryCount` is a Ruby gem designed to help you visualize and track SQL queries executed by your ActiveRecord models on a block of code.
+`ActiveRecordQueryCount` is a Ruby gem designed to help you visualize and track the SQL queries executed by your ActiveRecord models within a block of code.
 
-By subscribing to ActiveSupport notifications, it provides detailed insights into the quantity of queries being run, including the tables involved and the locations in your code where the queries are generated.
+By subscribing to ActiveSupport notifications, it provides detailed insights into the number of queries being run, the time taken by the code at specific locations (by adding the time each query took in that place), the tables involved, and the locations in your code where the queries were generated.
 
-There are three things this gem allows you to do:
+This gem offers three key features:
 
-1. See an overview of all the queries that a code block executes and their origin locations in a graph, a table, or in the console.
-2. Benchmark two blocks of code to view the difference in SQL counts at different locations, with a graph or a table.
-3. See an overview of the current request on a controller action with a button on the top left corner of the screen.
+1. View an overview of all queries executed by a block of code, including the time taken and their origin locations, presented in a graph, an HTML table, or directly in the console.
+2. Benchmark two blocks of code to compare SQL query counts at different locations, with results displayed in a graph or table.
+3. Get an overview of SQL queries for the current request in a controller action, accessible via a button in the top-left corner of the screen.
 
 ## Installation
 

data/assets/style.css

@@ -4,10 +4,9 @@
     width: 100%;
     border-collapse: collapse;
     margin-top: 20px;
-
     height: 100%;
-    overflow:auto;
-    display: block; /* Ensure the table behaves as a block element */
+    overflow: auto;
+    display: block;
     box-sizing: border-box;
   }
   th, td {
@@ -17,11 +16,12 @@
   th {
     background-color: #f2f2f2;
   }
-  tr:nth-child(even) {
-    background-color: #f9f9f9;
+  tr.main-row.even, tr.sub-row.even {
+    background-color: #f2f2f2;
   }
-  .sub-row {
-    background-color: #f9f9f9;
+
+  tr.main-row.odd, tr.sub-row.odd {
+    background-color: #ffffff;
   }
 
   .center-container {
@@ -39,4 +39,4 @@
   #queryTable {
     display: table;
   }
-}
+}

data/assets/template_base_query_counter.html.erb

@@ -3,9 +3,10 @@
 </style>
 <div id='query_counter_report_gem'>
   <h2>Query Count Report</h2>
-  <p>Total query count on process: <%= total_query_count %></p>
-  <p>The table will show only tables with more than <%= ::ActiveRecordQueryCount::Configuration.ignore_table_count %> queries</p>
-  <p>Only the top  <%= ::ActiveRecordQueryCount::Configuration.max_locations_per_table %> locations with the most occurrences will be shown.</p>
+  <p>Total number of queries in this process: <%= total_query_count %></p>
+  <p>Total time spent on queries in this process (ms): <%= total_duration_time %></p>
+  <p>Only tables with <%= ::ActiveRecordQueryCount::Configuration.ignore_table_count %> or more queries will be displayed.</p>
+  <p>The top <%= ::ActiveRecordQueryCount::Configuration.max_locations_per_table %> locations with the highest occurrences will be shown for each table.</p>
   <button id="toggleButton" onclick="toggleView()">Show Chart View</button>
   <button id="toggleColumnButton" onclick="toggleColumnContent()">Show SQL</button>
 
@@ -19,14 +20,15 @@
       <th id="columnHeader">File Path</th>
       <th>Method</th>
       <th>Location Count</th>
+      <th>Total Duration(ms)</th>
     </tr>
-    <% filter_data(data).each do |table, info| %>
-      <tr>
+    <% filter_data(data).each_with_index do |(table, info), index| %>
+      <tr class="main-row <%= index.even? ? 'even' : 'odd' %>">
         <td rowspan="<%= info[:location].size + 1 %>"><%= table %></td>
         <td rowspan="<%= info[:location].size + 1 %>"><%= info[:count] %></td>
       </tr>
       <% info[:location].each do |loc, detail| %>
-        <tr class="sub-row">
+        <tr class="sub-row <%= index.even? ? 'even' : 'odd' %>">
           <% match = loc&.match(/^(?<file_path>.*):in.*`(?<method>.*)'$/) %>
           <% file_path = match ? match[:file_path] : loc %>
           <% method = match ? match[:method] : nil %>
@@ -36,6 +38,7 @@
           </td>
           <td class="method-column"><%= method %></td>
           <td><%= detail[:count] %></td>
+          <td><%= detail[:duration] %></td>
         </tr>
       <% end %>
     <% end %>

data/lib/active-record-query-count.rb

@@ -1,17 +1,26 @@
-require 'active_support/notifications'
-require_relative 'active_record_query_count/version'
-require_relative 'active_record_query_count/configuration'
-require_relative 'active_record_query_count/printer/base'
-require_relative 'active_record_query_count/printer/console'
-require_relative 'active_record_query_count/printer/html'
-require_relative 'active_record_query_count/recording/base'
-require_relative 'active_record_query_count/recording/tracker'
-require_relative 'active_record_query_count/compare/comparator'
-require_relative 'active_record_query_count/middleware'
-require_relative 'active_record_query_count/printer/html_compare'
-
 module ActiveRecordQueryCount
+  autoload :VERSION,       'active_record_query_count/version'
+  autoload :Configuration, 'active_record_query_count/configuration'
+  autoload :Middleware,    'active_record_query_count/middleware'
+
+  module Printer
+    autoload :Base,        'active_record_query_count/printer/base'
+    autoload :Console,     'active_record_query_count/printer/console'
+    autoload :Html,        'active_record_query_count/printer/html'
+    autoload :HtmlCompare, 'active_record_query_count/printer/html_compare'
+  end
+
+  module Recording
+    autoload :Base,    'active_record_query_count/recording/base'
+    autoload :Tracker, 'active_record_query_count/recording/tracker'
+  end
+
+  module Compare
+    autoload :Comparator, 'active_record_query_count/compare/comparator'
+  end
+
   extend Recording::Base
+
   if defined?(Rails::Railtie)
     class QueryCountRailtie < Rails::Railtie
       initializer 'active_record_query_count.configure_rails_initialization' do |app|
@@ -26,7 +35,7 @@ module ActiveRecordQueryCount
     end
 
     def tracker
-      Thread.current[:query_counter_data] ||= Tracker.new
+      Thread.current[:query_counter_data] ||= Recording::Tracker.new
     end
 
     def compare

data/lib/active_record_query_count/configuration.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_support/core_ext/module/attribute_accessors'
 
 module ActiveRecordQueryCount

data/lib/active_record_query_count/printer/base.rb

@@ -1,3 +1,4 @@
+require 'json'
 module ActiveRecordQueryCount
   module Printer
     class Base
@@ -11,6 +12,11 @@ module ActiveRecordQueryCount
       INJECT_TEMPLATE_PATH = File.join(parent_dir, 'assets', 'template_for_inject.html.erb')
 
       def filter_data data
+        data.each_value do |info|
+          info[:location].each_value do |detail|
+            detail[:duration] = detail[:duration].truncate(2)
+          end
+        end
         data = data.select { |_, v| v[:count] >= Configuration.ignore_table_count }
         data = data.sort_by { |_, v| -v[:count] }.each do |_category, info|
           info[:location] = info[:location].sort_by do |_, detail|
@@ -30,6 +36,7 @@ module ActiveRecordQueryCount
       end
 
       def open_file html_dest
+        require 'launchy'
         if ENV['WSL_DISTRIBUTION']
           Launchy.open("file://wsl%24/#{ENV['WSL_DISTRIBUTION']}#{html_dest}")
         else

data/lib/active_record_query_count/printer/console.rb

@@ -1,5 +1,3 @@
-require 'colorize'
-
 module ActiveRecordQueryCount
   module Printer
     class Console < Base
@@ -9,6 +7,7 @@ module ActiveRecordQueryCount
       end
 
       def print
+        require 'colorize'
         data = filter_data(@data)
         puts '[ActiveRecordQueryCount] Query count per table:'.colorize(:blue)
         puts "Total query count: #{data.values.sum { |v| v[:count] }}\n\n"
@@ -21,6 +20,7 @@ module ActiveRecordQueryCount
           info[:location].each do |loc, details|
             puts "    - File location: #{loc}"
             puts "        Query count: #{details[:count].to_s.colorize(:blue)}"
+            puts "        Total Duration(ms): #{details[:duration]}"
           end
           puts
         end

data/lib/active_record_query_count/printer/html.rb

@@ -1,8 +1,4 @@
 require 'erb'
-require 'tempfile'
-require 'launchy'
-require 'pry-byebug'
-require 'json'
 
 module ActiveRecordQueryCount
   module Printer
@@ -14,13 +10,21 @@ module ActiveRecordQueryCount
       end
 
       def chart_data
-        @chart_data ||= generate_chart_data(data)
+        @chart_data ||= generate_chart_js_data(data)
       end
 
       def total_query_count
         @total_query_count ||= data.values.sum { |v| v[:count] }
       end
 
+      def total_duration_time
+        @total_duration_time ||= data.sum do |_, info|
+          info[:location].sum do |_, detail|
+            detail[:duration]
+          end
+        end.truncate(2)
+      end
+
       def inject_in_html
         ERB.new(inject_template_content).result(binding)
       end
@@ -36,13 +40,13 @@ module ActiveRecordQueryCount
 
       private
 
-      def generate_chart_data(data)
+      def generate_chart_js_data(data)
         chart_data = { labels: [], data: [], locations: {} }
         data.each do |table, info|
           chart_data[:labels] << table
           chart_data[:data] << info[:count]
           chart_data[:locations][table] = info[:location].map do |loc, detail|
-            { location: loc, count: detail[:count] }
+            { location: loc, count: detail[:count], duration: detail[:duration] }
           end
         end
         chart_data

data/lib/active_record_query_count/printer/html_compare.rb

@@ -1,8 +1,4 @@
 require 'erb'
-require 'tempfile'
-require 'launchy'
-require 'pry-byebug'
-require 'json'
 
 module ActiveRecordQueryCount
   module Printer
@@ -25,7 +21,7 @@ module ActiveRecordQueryCount
         tables = data_1.keys | data_2.keys
         total_query_count_1 = data_1.values.sum { |v| v[:count] }
         total_query_count_2 = data_2.values.sum { |v| v[:count] }
-        chart_data = generate_chart_data_compare(data_1, data_2)
+        chart_data = generate_chart_js_data_compare(data_1, data_2)
         # end
         html_dest = generate_html(binding)
         open_file(html_dest)
@@ -33,7 +29,7 @@ module ActiveRecordQueryCount
 
       private
 
-      def generate_chart_data_compare(data_1, data_2)
+      def generate_chart_js_data_compare(data_1, data_2)
         labels = (data_1.keys | data_2.keys).sort
         chart_data = { labels: [], data_1: {}, data_2: {}, locations: {} }
         chart_data[:data_1][:name] = @script_1_name

data/lib/active_record_query_count/recording/tracker.rb

@@ -1,40 +1,46 @@
+require 'active_support/notifications'
+
 module ActiveRecordQueryCount
-  class Tracker
-    REGEX_TABLE_SQL = /FROM\s+"(?<table>[^"]+)"/
-    attr_accessor :active_record_query_tracker, :subscription
+  module Recording
+    class Tracker
+      REGEX_TABLE_SQL = /FROM\s+"(?<table>[^"]+)"/
+      attr_accessor :active_record_query_tracker, :subscription
 
-    def initialize
-      reset_query_count
-    end
+      def initialize
+        reset_query_count
+      end
 
-    # This assums that in the same location of the code it will always be the same sql query
-    def reset_query_count
-      @active_record_query_tracker = Hash.new do |hash, key|
-        hash[key] = { count: 0, location: Hash.new do |loc_hash, loc_key|
-                                            loc_hash[loc_key] = { count: 0, sql: nil }
-                                          end }
+      # This assums that in the same location of the code it will always be the same sql query
+      def reset_query_count
+        @active_record_query_tracker = Hash.new do |hash, key|
+          hash[key] = { count: 0, location: Hash.new do |loc_hash, loc_key|
+                                              loc_hash[loc_key] = { count: 0, sql: nil }
+                                            end }
+        end
       end
-    end
 
-    def subscribe
-      return unless subscription.nil?
+      def subscribe
+        return unless subscription.nil?
 
-      @subscription = ActiveSupport::Notifications.subscribe('sql.active_record') do |_a, _b, _c, _d, payload|
-        caller_from_sql = caller
-        sql = payload[:sql]
-        match = sql.match(REGEX_TABLE_SQL)
-        if match.present? && match[:table]
-          actual_location = Rails.backtrace_cleaner.clean(caller_from_sql).first
-          active_record_query_tracker[match[:table]][:count] += 1
-          active_record_query_tracker[match[:table]][:location][actual_location][:count] += 1
-          active_record_query_tracker[match[:table]][:location][actual_location][:sql] = sql
+        @subscription = ActiveSupport::Notifications.subscribe('sql.active_record') do |_a, start, finish, _d, payload|
+          caller_from_sql = caller
+          sql = payload[:sql]
+          match = sql.match(REGEX_TABLE_SQL)
+          if match.present? && match[:table]
+            actual_location = Rails.backtrace_cleaner.clean(caller_from_sql).first
+            active_record_query_tracker[match[:table]][:count] += 1
+            active_record_query_tracker[match[:table]][:location][actual_location][:duration] ||= 0
+            active_record_query_tracker[match[:table]][:location][actual_location][:duration] += (finish - start) * 1000
+            active_record_query_tracker[match[:table]][:location][actual_location][:count] += 1
+            active_record_query_tracker[match[:table]][:location][actual_location][:sql] = sql
+          end
         end
       end
-    end
 
-    def unsubscribe
-      ActiveSupport::Notifications.unsubscribe(@subscription)
-      @subscription = nil
+      def unsubscribe
+        ActiveSupport::Notifications.unsubscribe(@subscription)
+        @subscription = nil
+      end
     end
   end
 end

data/lib/active_record_query_count/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordQueryCount
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

data/scripts_for_testing/script_compare_html.rb

@@ -1,4 +1,4 @@
-require_relative '../lib/active-record-query-count'
+require 'active-record-query-count'
 require 'pry-byebug'
 
 data_1 = File.read('scripts_for_testing/example_script_unoptimize.yaml')

data/scripts_for_testing/script_printer_html.rb

@@ -1,5 +1,5 @@
-require_relative '../lib/active-record-query-count'
 require 'pry-byebug'
+require 'active-record-query-count'
 
 data = File.read('scripts_for_testing/example_script_unoptimize.yaml')
 data = YAML.safe_load(data, permitted_classes: [Proc, Symbol])

data/scripts_for_testing/scripts_console.rb.rb

@@ -1,5 +1,5 @@
-require_relative '../lib/active-record-query-count'
 require 'pry-byebug'
+require 'active-record-query-count'
 
 data = File.read('scripts_for_testing/example_script_unoptimize.yaml')
 data = YAML.safe_load(data, permitted_classes: [Proc, Symbol])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active-record-query-count
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Jose Lara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'
@@ -275,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.15
 signing_key: 
 specification_version: 4
 summary: Display an overview of the quantity of queries being made and their origins