active_record_query_counter 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39b68fd4dd57ebee4f0f338f7a4a3dab45a044fd62739f79113a6caa4d5080a
-  data.tar.gz: 6911749f1967b8b0a25e8d6dc3ef557bb81ce45526194a5ecaad71bfb4c75f5f
+  metadata.gz: 7600a3d02b1c366ac42c06a7d4e781a4b622d84bca14d26e46b4e8aa34a09b32
+  data.tar.gz: f2922c6db0478569029f1d869b2544dcbd0b1535ca95b0188691c5da9cddb561
 SHA512:
-  metadata.gz: 056e36015d9a3e825ae0f24d05a25e2bba69fdb52a19ff5bf54508d743998cf4a25ab0fe74eb68637a10b86da69298c284eaa61fd0ae565060d66e7c7306ddc9
-  data.tar.gz: f1c790acb2a831b86ec9bc5a5a65d73675177262c0fe75b2f0a6141cc1df48ec843742f2a41e9802a6f0cb41d405f091aa9a31aa86e476022b31c1ce69442bf1
+  metadata.gz: 15370172634b6ebbf4a1bcf783e5ff0f0132f01e2a013c1ef457dac95d80369718fad4acf8408ea5e51bf5ffbd6adf96303ad64c1c4e67b2c6817776183b99ab
+  data.tar.gz: b48d6016e2fd9feb9bbb30705e92484dd1b0376658e9c55267a526c17199e19e7d4d104863b1910d2d6a05a009d75ef2332a6bf606090640b055a3b550e852eb

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# Dependabot update strategy
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    allow:
+      # Automatically keep all runtime dependencies updated
+      - dependency-name: "*"
+        dependency-type: "production"
+    versioning-strategy: lockfile-only

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,51 @@
+name: Continuous Integration
+on:
+  push:
+    branches:
+      - master
+      - actions-*
+    tags:
+      - v*
+  pull_request:
+env:
+  BUNDLE_CLEAN: "true"
+  BUNDLE_PATH: vendor/bundle
+  BUNDLE_JOBS: 3
+  BUNDLE_RETRY: 3
+jobs:
+  specs:
+    name: ${{ matrix.job }} ruby-${{ matrix.ruby }} ${{ matrix.activerecord && format('activerecord-{0}', matrix.activerecord) }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6"]
+        activerecord: ["4.2", "5.0", "5.1", "5.2", "6.0"]
+        job: [ rspec ]
+        include:
+          - ruby: "2.7"
+            activerecord: original
+            job: rspec
+          - ruby: "2.7"
+            job: standardrb
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: inject activerecord ${{ matrix.activerecord }}
+        if:   matrix.activerecord != 'original' && matrix.activerecord != null
+        run: | # inject a specific version of activerecord into the Gemfile
+          bundle update
+          bundle exec appraisal generate
+          bundle config set gemfile "gemfiles/activerecord_${{ matrix.activerecord }}.gemfile"
+      - name: install dependencies
+        run:  bundle install
+      - name: specs
+        if:   matrix.job == 'rspec'
+        run:  bundle exec rake spec
+      - name: standardrb
+        if:   matrix.job == 'standardrb'
+        run:  bundle exec rake standard

data/.standard.yml

@@ -0,0 +1,11 @@
+# I really just have issues with the automatic "semantic blocks"
+
+ruby_version: 2.4
+
+format: progress
+
+ignore:
+  - '**/*':
+    - Standard/SemanticBlocks
+  - 'spec/**/*':
+    - Lint/UselessAssignment

data/CHANGE_LOG.md

@@ -1,3 +1,7 @@
+# 1.1.0
+
+* Add transaction counts
+
 # 1.0.0
 
 * Initial release

data/README.md

@@ -1,9 +1,10 @@
 # ActiveRecordQueryCounter
 
-[![Build Status](https://travis-ci.org/bdurand/active_record_query_counter.svg?branch=master)](https://travis-ci.org/bdurand/active_record_query_counter)
+![Continuous Integration](https://github.com/bdurand/active_record_query_counter/workflows/Continuous%20Integration/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/21094ecec0c151983bb1/maintainability)](https://codeclimate.com/github/bdurand/active_record_query_counter/maintainability)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
-This gem injects itself into ActiveRecord to count the number of queries, the number of rows returned, and the amount of time spent on queries within a block.
+This gem injects itself into ActiveRecord to count the number of queries, the number of rows returned, the amount of time spent on queries, the number of transactions, and the amount of time spent inside transactions within a block.
 
 The intended use is to gather instrumentation stats for finding hot spots in your code.
 
@@ -30,7 +31,9 @@ ActiveRecordQueryCounter.count_queries do
   do_something
   puts "Queries: #{ActiveRecordQueryCounter.query_count}"
   puts "Rows: #{ActiveRecordQueryCounter.row_count}"
-  puts "Time: #{ActiveRecordQueryCounter.query_time}"
+  puts "Query Time: #{ActiveRecordQueryCounter.query_time}"
+  puts "Transactions: #{ActiveRecordQueryCounter.transaction_count}"
+  puts "Transaction Time: #{ActiveRecordQueryCounter.transaction_time}"
 end
 ```
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/active_record_query_counter.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |spec|
-  spec.name = 'active_record_query_counter'
+  spec.name = "active_record_query_counter"
   spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
-  spec.authors = ['Brian Durand']
-  spec.email = ['bbdurand@gmail.com']
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
 
   spec.summary = "Count total number of ActiveRecord queries and row counts inside a block"
-  spec.homepage = "https://github.com/bdurand/lumberjack"
+  spec.homepage = "https://github.com/bdurand/active_record_query_counter"
   spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  ignore_files = %w(
+  ignore_files = %w[
     .gitignore
     .travis.yml
     Appraisals
@@ -19,17 +19,16 @@ Gem::Specification.new do |spec|
     Rakefile
     gemfiles/
     spec/
-  )
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  ]
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 4.2"
 
+  spec.add_development_dependency "bundler", "~>2.0"
+  spec.add_development_dependency "rspec", ["~> 3.0"]
   spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency("rspec", ["~> 3.0"])
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "appraisal"
 end

data/lib/active_record_query_counter.rb

@@ -10,14 +10,23 @@
 #    puts ActiveRecordQueryCounter.row_count
 #  end
 module ActiveRecordQueryCounter
+  class Counter
+    attr_accessor :query_count, :row_count, :query_time, :transaction_count, :transaction_time
+    def initialize
+      @query_count = 0
+      @row_count = 0
+      @query_time = 0.0
+      @transaction_count = 0
+      @transaction_time = 0.0
+    end
+  end
 
   class << self
-
     # Enable query counting within a block.
     def count_queries
       current = Thread.current[:database_query_counter]
       begin
-        Thread.current[:database_query_counter] = [0, 0, 0.0]
+        Thread.current[:database_query_counter] = Counter.new
         yield
       ensure
         Thread.current[:database_query_counter] = current
@@ -26,41 +35,60 @@ module ActiveRecordQueryCounter
 
     # Increment the query counters
     def increment(row_count, elapsed_time)
-      current = Thread.current[:database_query_counter]
-      if current.is_a?(Array)
-        current[0] = current[0].to_i + 1
-        current[1] = current[1].to_i + row_count
-        current[2] = current[2].to_f + elapsed_time
+      counter = Thread.current[:database_query_counter]
+      if counter.is_a?(Counter)
+        counter.query_count += 1
+        counter.row_count += row_count
+        counter.query_time += elapsed_time
+      end
+    end
+
+    def increment_transaction(elapsed_time)
+      counter = Thread.current[:database_query_counter]
+      if counter.is_a?(Counter)
+        counter.transaction_count += 1
+        counter.transaction_time += elapsed_time
       end
     end
 
     def query_count
-      current = Thread.current[:database_query_counter]
-      current[0].to_i if current.is_a?(Array)
+      counter = Thread.current[:database_query_counter]
+      counter.query_count if counter.is_a?(Counter)
     end
 
     def row_count
-      current = Thread.current[:database_query_counter]
-      current[1].to_i if current.is_a?(Array)
+      counter = Thread.current[:database_query_counter]
+      counter.row_count if counter.is_a?(Counter)
     end
 
     def query_time
-      current = Thread.current[:database_query_counter]
-      current[2].to_f if current.is_a?(Array)
+      counter = Thread.current[:database_query_counter]
+      counter.query_time if counter.is_a?(Counter)
+    end
+
+    def transaction_count
+      counter = Thread.current[:database_query_counter]
+      counter.transaction_count if counter.is_a?(Counter)
     end
 
-    # Return the query info as a hash with keys :query_count, :row_count, :query_time.
-    # or nil if not inside a block where queries are being counted.
+    def transaction_time
+      counter = Thread.current[:database_query_counter]
+      counter.transaction_time if counter.is_a?(Counter)
+    end
+
+    # Return the query info as a hash with keys :query_count, :row_count, :query_time
+    # :transaction_count, and :transaction_type or nil if not inside a block where queries
+    # are being counted.
     def info
-      current = Thread.current[:database_query_counter]
-      if current
+      counter = Thread.current[:database_query_counter]
+      if counter.is_a?(Counter)
         {
-          :query_count => current[0],
-          :row_count => current[1],
-          :query_time => current[2]
+          query_count: counter.query_count,
+          row_count: counter.row_count,
+          query_time: counter.query_time,
+          transaction_count: counter.transaction_count,
+          transaction_time: counter.transaction_time
         }
-      else
-        nil
       end
     end
 
@@ -69,13 +97,14 @@ module ActiveRecordQueryCounter
       unless connection_class.include?(ConnectionAdapterExtension)
         connection_class.prepend(ConnectionAdapterExtension)
       end
+      unless ActiveRecord::ConnectionAdapters::TransactionManager.include?(TransactionManagerExtension)
+        ActiveRecord::ConnectionAdapters::TransactionManager.prepend(TransactionManagerExtension)
+      end
     end
-
   end
 
   # Module to prepend to the connection adapter to inject the counting behavior.
   module ConnectionAdapterExtension
-
     def exec_query(*args)
       start_time = Time.now
       result = super
@@ -84,12 +113,35 @@ module ActiveRecordQueryCounter
       end
       result
     end
+  end
+
+  module TransactionManagerExtension
+    def begin_transaction(*args)
+      if open_transactions == 0
+        @active_record_query_counter_transaction_start_time = Time.current
+      end
+      super
+    end
+
+    def commit_transaction(*args)
+      if @active_record_query_counter_transaction_start_time && open_transactions == 1
+        ActiveRecordQueryCounter.increment_transaction(Time.current - @active_record_query_counter_transaction_start_time)
+        @active_record_query_counter_transaction_start_time = nil
+      end
+      super
+    end
 
+    def rollback_transaction(*args)
+      if @active_record_query_counter_transaction_start_time && open_transactions == 1
+        ActiveRecordQueryCounter.increment_transaction(Time.current - @active_record_query_counter_transaction_start_time)
+        @active_record_query_counter_transaction_start_time = nil
+      end
+      super
+    end
   end
 
   # Rack middleware to count queries on a request.
   class RackMiddleware
-
     def initialize(app)
       @app = app
     end
@@ -97,16 +149,12 @@ module ActiveRecordQueryCounter
     def call(env)
       ActiveRecordQueryCounter.count_queries { @app.call(env) }
     end
-
   end
 
   # Sidekiq middleware to count queries on a job.
   class SidekiqMiddleware
-
     def call(worker, job, queue, &block)
       ActiveRecordQueryCounter.count_queries(&block)
     end
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_counter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -53,21 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,13 +73,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/continuous_integration.yml"
+- ".standard.yml"
 - CHANGE_LOG.md
 - MIT_LICENSE
 - README.md
 - VERSION
 - active_record_query_counter.gemspec
 - lib/active_record_query_counter.rb
-homepage: https://github.com/bdurand/lumberjack
+homepage: https://github.com/bdurand/active_record_query_counter
 licenses:
 - MIT
 metadata: {}