rails_sql_counter 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5bbc30585158b380077f576278e1cbc18ed380793af58e0520f3d843647d8714
+  data.tar.gz: 9293aababdf01166e3b96b179531e0666efe044fbbd78e95c2f9953d95fc2c3a
+SHA512:
+  metadata.gz: 23b0c23659a1b376cb10c62b79313026e9e5da34b85cb00cb8a09757bf810b8e75e11324657313935dd5f81bbe3142ac28d20d8114204158a6d85755149d1da0
+  data.tar.gz: d6e364fdfa43a107eff3330d2788786aca3baf0bed37c829b766a07b45e734475136dc33a178d380be2e960e4c30542e60c4d98add0efd4fb9d95fd5d76defac

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+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).
+
+## [Unreleased]
+
+## [0.1.0] - 2021-08-17
+
+### Added
+- First version

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_sql_counter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    rails_sql_counter (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails_sql_counter!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 rjurado
+
+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,64 @@
+# RailsSqlCounter
+
+Keep under control how many sql queries are launched in your App
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_sql_counter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_sql_counter
+
+## Doc
+
+### Configuration
+
+* **backtrace**: activates / desactivates sql query backtrace
+* **backtrace_regex**: allows to ignore lines from backtrace (line is ignore if it match)
+
+### Methods
+
+* **start**: starts to count sql queries
+* **end**: ends to count sql queries
+* **counter**: returns number of sql quieries from start
+
+## Usage
+
+Test example:
+
+```ruby
+context '...' do
+  before { RailsSqlCounter.start }
+  after { RailsSqlCounter.end }
+
+  it 'returns results with only one query' do
+    get path
+
+    expect(RailsSqlCounter.counter).to eq(1)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_sql_counter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "rails_sql_counter"
+
+# 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/lib/rails_sql_counter.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'rails_sql_counter/version'
+
+# Count sql queries
+module RailsSqlCounter
+  mattr_accessor :backtrace, default: false
+  mattr_accessor :backtrace_regex, default: /(action|active|pry|rack|puma|rspec|bundle)/
+
+  def self.setup
+    yield self
+  end
+
+  def self.process(event)
+    return unless event.payload[:name]&.match?('Load') && Thread.current[:rails_sql_counter]
+
+    inc
+    show_backtrace if @@backtrace
+  end
+
+  def self.inc
+    Thread.current[:rails_sql_counter] += 1
+  end
+
+  def self.start
+    Thread.current[:rails_sql_counter] = 0
+
+    @@subscriber ||= ActiveSupport::Notifications.subscribe('sql.active_record') do |event|
+      process(event)
+    end
+  end
+
+  def self.end
+    Thread.current[:rails_sql_counter] = nil
+
+    ActiveSupport::Notifications.unsubscribe(@@subscriber)
+    @@subscriber = nil
+  end
+
+  def self.counter
+    Thread.current[:rails_sql_counter]
+  end
+
+  def self.show_backtrace
+    # remove first two entries (gem entries)
+    caller.drop(2).each do |line|
+      next if line.match?(@@backtrace_regex)
+
+      Rails.logger.debug "    -> #{line}"
+    end
+  end
+
+  private_class_method :inc, :show_backtrace
+end

data/lib/rails_sql_counter/version.rb

@@ -0,0 +1,3 @@
+module RailsSqlCounter
+  VERSION = "0.1.1"
+end

data/rails_sql_counter.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/rails_sql_counter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_sql_counter'
+  spec.version       = RailsSqlCounter::VERSION
+  spec.authors       = ['rjurado']
+  spec.email         = ['rjurado@nosolosoftware.es']
+
+  spec.summary       = 'Keep under control how many sql queries are launched in your App'
+  spec.description   = 'Allows to control how many queries are launched between two points'
+  spec.homepage      = 'https://github.com/nosolosoftware/rails_sql_counter'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  # 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.
+  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']
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: rails_sql_counter
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- rjurado
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-19 00:00:00.000000000 Z
+dependencies: []
+description: Allows to control how many queries are launched between two points
+email:
+- rjurado@nosolosoftware.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_sql_counter.rb
+- lib/rails_sql_counter/version.rb
+- rails_sql_counter.gemspec
+homepage: https://github.com/nosolosoftware/rails_sql_counter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Keep under control how many sql queries are launched in your App
+test_files: []