active_record_query_counter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a39b68fd4dd57ebee4f0f338f7a4a3dab45a044fd62739f79113a6caa4d5080a
+  data.tar.gz: 6911749f1967b8b0a25e8d6dc3ef557bb81ce45526194a5ecaad71bfb4c75f5f
+SHA512:
+  metadata.gz: 056e36015d9a3e825ae0f24d05a25e2bba69fdb52a19ff5bf54508d743998cf4a25ab0fe74eb68637a10b86da69298c284eaa61fd0ae565060d66e7c7306ddc9
+  data.tar.gz: f1c790acb2a831b86ec9bc5a5a65d73675177262c0fe75b2f0a6141cc1df48ec843742f2a41e9802a6f0cb41d405f091aa9a31aa86e476022b31c1ce69442bf1

data/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Brian Durand
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# ActiveRecordQueryCounter
+
+[![Build Status](https://travis-ci.org/bdurand/active_record_query_counter.svg?branch=master)](https://travis-ci.org/bdurand/active_record_query_counter)
+[![Maintainability](https://api.codeclimate.com/v1/badges/21094ecec0c151983bb1/maintainability)](https://codeclimate.com/github/bdurand/active_record_query_counter/maintainability)
+
+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.
+
+The intended use is to gather instrumentation stats for finding hot spots in your code.
+
+## Usage
+
+The behavior must be enabled on your database connection adapter from within an initializer.
+
+Postgres:
+
+```ruby
+ActiveRecordQueryCounter.enable!(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+```
+
+MySQL:
+
+```ruby
+ActiveRecordQueryCounter.enable!(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+```
+
+Next you must specify the blocks where you want to count queries.
+
+```ruby
+ActiveRecordQueryCounter.count_queries do
+  do_something
+  puts "Queries: #{ActiveRecordQueryCounter.query_count}"
+  puts "Rows: #{ActiveRecordQueryCounter.row_count}"
+  puts "Time: #{ActiveRecordQueryCounter.query_time}"
+end
+```
+
+This gem includes middleware for both Rack and Sidekiq that will enable query counting.
+
+If you are using Rails with Sidekiq, you can enable both with an initializer.
+
+```ruby
+ActiveSupport.on_load(:active_record) do
+  ActiveRecordQueryCounter.enable!(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+end
+
+Rails.application.config.middleware.use(ActiveRecordQueryCounter::RackMiddleware)
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add ActiveRecordQueryCounter::SidekiqMiddleware
+  end
+end
+```

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/active_record_query_counter.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |spec|
+  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.summary = "Count total number of ActiveRecord queries and row counts inside a block"
+  spec.homepage = "https://github.com/bdurand/lumberjack"
+  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(
+    .gitignore
+    .travis.yml
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    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) } }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "activerecord", ">= 4.2"
+
+  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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+# Everything you need to count ActiveRecord queries and row counts within a block.
+#
+# Usage:
+#
+#  ActiveRecordQueryCounter.count_queries do
+#    yield
+#    puts ActiveRecordQueryCounter.query_count
+#    puts ActiveRecordQueryCounter.row_count
+#  end
+module ActiveRecordQueryCounter
+
+  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]
+        yield
+      ensure
+        Thread.current[:database_query_counter] = current
+      end
+    end
+
+    # 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
+      end
+    end
+
+    def query_count
+      current = Thread.current[:database_query_counter]
+      current[0].to_i if current.is_a?(Array)
+    end
+
+    def row_count
+      current = Thread.current[:database_query_counter]
+      current[1].to_i if current.is_a?(Array)
+    end
+
+    def query_time
+      current = Thread.current[:database_query_counter]
+      current[2].to_f if current.is_a?(Array)
+    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 info
+      current = Thread.current[:database_query_counter]
+      if current
+        {
+          :query_count => current[0],
+          :row_count => current[1],
+          :query_time => current[2]
+        }
+      else
+        nil
+      end
+    end
+
+    # Enable the query counting behavior on a connection adapter class.
+    def enable!(connection_class)
+      unless connection_class.include?(ConnectionAdapterExtension)
+        connection_class.prepend(ConnectionAdapterExtension)
+      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
+      if result.is_a?(ActiveRecord::Result)
+        ActiveRecordQueryCounter.increment(result.length, Time.now - start_time)
+      end
+      result
+    end
+
+  end
+
+  # Rack middleware to count queries on a request.
+  class RackMiddleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    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

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: active_record_query_counter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Durand
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+  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'
+description: 
+email:
+- bbdurand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Count total number of ActiveRecord queries and row counts inside a block
+test_files: []