query_count 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6bf8e6307491ffbb5fb4cb411765d6641b84b97f4af8db094abdc5e9f6fd91d
+  data.tar.gz: 8a70f7fddb6d3200e01f1fe6c7be8b7699bd260d3df0acba109174c3c9cf1cf1
+SHA512:
+  metadata.gz: fe202188d69375b0124215792c42ef186edff113b1616dd069c207bd2f313165e8baef1184c95eec2852cab62415d2f0d110a983d4e1d38596037bc41bbdc8b8
+  data.tar.gz: 9771031807f5599d968154f5771d330d1c3a19c9ab221e0839a0bef241d23c7ec341989015f538be4820045562edfcd21c7d855b2fb8c29e5b6f125f9a903a32

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/Gemfile.lock
+/pkg/
+/spec/reports/
+/spec/support/dummy_rails_app/log/
+/spec/support/dummy_rails_app/tmp/
+/spec/support/dummy_rails_app/db/*.db
+/tmp/
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: [RSpec.describe, context]
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+env:
+  - RAILS_VERSION=5.0
+  - RAILS_VERSION=5.1
+  - RAILS_VERSION=5.2
+  - RAILS_VERSION=6.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0 (2020-05-23)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+if ENV['CI']
+  rails_version = ENV['RAILS_VERSION'] || '6.0'
+  eval_gemfile File.expand_path("../gemfiles/#{rails_version}.gemfile", __FILE__)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dmitriy Tarasov
+
+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,27 @@
+# Query Count
+
+Counts the number of SQL queries performed by the ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_count'
+```
+
+Run `$ bundle install`
+
+## Usage
+
+The gem will automatically include the number of SQL queries  to the Rails log.
+
+```
+ActiveRecord: 34.0ms | SQL Queries: 8 (1 cached)
+```
+
+This log example shows that the total number of queries was 8 and 1 of those queries was cached. Meaning that the database was hit 7 times.
+
+## License
+
+`query_count` © Dmitriy Tarasov. Released under the [MIT](LICENSE.txt) license.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'query_count'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/5.0.gemfile

@@ -0,0 +1,2 @@
+gem 'rails', '~> 5.0.0'
+gem 'sqlite3', '~> 1.3.0'

data/gemfiles/5.1.gemfile

@@ -0,0 +1 @@
+gem 'rails', '~> 5.1.0'

data/gemfiles/5.2.gemfile

@@ -0,0 +1 @@
+gem 'rails', '~> 5.2.0'

data/gemfiles/6.0.gemfile

@@ -0,0 +1 @@
+gem 'rails', '~> 6.0.0'

data/lib/query_count.rb

@@ -0,0 +1,4 @@
+require 'query_count/counter'
+require 'query_count/controller_runtime'
+require 'query_count/railtie'
+require 'query_count/version'

data/lib/query_count/controller_runtime.rb

@@ -0,0 +1,37 @@
+# https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/controller_runtime.rb
+module QueryCount
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages    = super
+        count       = payload[:query_count]
+        count_cache = payload[:query_count_cache]
+
+        messages.push(
+          "SQL Queries: #{count + count_cache}"\
+          " (#{count_cache} cached)"
+        )
+
+        messages
+      end
+    end
+
+    private
+
+      def process_action(action, *args)
+        Counter.reset_counter
+        Counter.reset_counter_cache
+        super
+      end
+
+      def append_info_to_payload(payload)
+        super
+        return unless ActiveRecord::Base.connected?
+
+        payload[:query_count] = Counter.reset_counter
+        payload[:query_count_cache] = Counter.reset_counter_cache
+      end
+  end
+end

data/lib/query_count/counter.rb

@@ -0,0 +1,50 @@
+# https://api.rubyonrails.org/classes/ActiveRecord/LogSubscriber.html
+require 'active_support'
+
+module QueryCount
+  class Counter < ActiveSupport::LogSubscriber
+    IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
+
+    def self.counter=(value)
+      Thread.current['query_count'] = value
+    end
+
+    def self.counter
+      Thread.current['query_count'] ||= 0
+    end
+
+    def self.counter_cache=(value)
+      Thread.current['query_count_cache'] = value
+    end
+
+    def self.counter_cache
+      Thread.current['query_count_cache'] ||= 0
+    end
+
+    def self.reset_counter
+      rc = counter
+      self.counter = 0
+
+      rc
+    end
+
+    def self.reset_counter_cache
+      rcc = counter_cache
+      self.counter_cache = 0
+
+      rcc
+    end
+
+    def sql(event)
+      payload = event.payload
+
+      return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+      if payload[:cached]
+        self.class.counter_cache += 1
+      else
+        self.class.counter += 1
+      end
+    end
+  end
+end

data/lib/query_count/railtie.rb

@@ -0,0 +1,13 @@
+# https://api.rubyonrails.org/classes/Rails/Railtie.html
+require 'rails/railtie'
+
+module QueryCount
+  class Railtie < Rails::Railtie
+    initializer 'query_count.initialize' do
+      QueryCount::Counter.attach_to :active_record
+      ActiveSupport.on_load(:action_controller) do
+        include QueryCount::ControllerRuntime
+      end
+    end
+  end
+end

data/lib/query_count/version.rb

@@ -0,0 +1,3 @@
+module QueryCount
+  VERSION = '1.0.0'.freeze
+end

data/query_count.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/query_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'query_count'
+  spec.version       = QueryCount::VERSION
+  spec.authors       = ['Dmitriy Tarasov']
+  spec.email         = ['info@rubysamurai.com']
+
+  spec.summary       = 'SQL queries counter for Rails apps'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/rubysamurai/query_count'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rails', '>= 5.0'
+
+  spec.add_development_dependency 'rake',  '>= 13.0'
+  spec.add_development_dependency 'rspec', '>= 3.9'
+  spec.add_development_dependency 'sqlite3', '>= 1.3'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: query_count
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dmitriy Tarasov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: SQL queries counter for Rails apps
+email:
+- info@rubysamurai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
+- gemfiles/6.0.gemfile
+- lib/query_count.rb
+- lib/query_count/controller_runtime.rb
+- lib/query_count/counter.rb
+- lib/query_count/railtie.rb
+- lib/query_count/version.rb
+- query_count.gemspec
+homepage: https://github.com/rubysamurai/query_count
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubysamurai/query_count
+  source_code_uri: https://github.com/rubysamurai/query_count
+  bug_tracker_uri: https://github.com/rubysamurai/query_count/issues
+  changelog_uri: https://github.com/rubysamurai/query_count/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: SQL queries counter for Rails apps
+test_files: []