rails_sql_counter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bbc30585158b380077f576278e1cbc18ed380793af58e0520f3d843647d8714
-  data.tar.gz: 9293aababdf01166e3b96b179531e0666efe044fbbd78e95c2f9953d95fc2c3a
+  metadata.gz: a3da1f83702e6199bfe68eb3dd67ce419f97b529e157d6e6b1cf4f5ef92f158d
+  data.tar.gz: 9ab44fbbed52564fcdb72552843c195dacccfe203299b544fd9d1885fa5cce36
 SHA512:
-  metadata.gz: 23b0c23659a1b376cb10c62b79313026e9e5da34b85cb00cb8a09757bf810b8e75e11324657313935dd5f81bbe3142ac28d20d8114204158a6d85755149d1da0
-  data.tar.gz: d6e364fdfa43a107eff3330d2788786aca3baf0bed37c829b766a07b45e734475136dc33a178d380be2e960e4c30542e60c4d98add0efd4fb9d95fd5d76defac
+  metadata.gz: 830489aefd50d4ee2efaa57d2b7cc63a26f9808e084ee59e56b8c31e3325c81dc6aac264e0653e7b5faf73f84dbf7037729a1280d453f277bfd026fee3c8a53e
+  data.tar.gz: 66bf1ccdb4f39433ca921b5c012661b9e963c077c07f4f0400383574045fa4a3e6a416de2b153ebd2156349832410c090ced7e2b60a3536bb9ca77f5241cfcb0

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+*.gem
+
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -4,7 +4,20 @@ 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.2.0] - 2021-08-25
+
+### Added
+- `.profile` method has been added
+- ActiveSupport has been added as explicit dependency
+
+### Changed
+- `.end` doesn't reset the counter
+- `.process` has been redeclared as private member
+
+## [0.1.1] - 2021-08-18
+
+### Fixed
+- Clean subscriber after end
 
 ## [0.1.0] - 2021-08-17
 

data/Gemfile.lock

@@ -2,11 +2,22 @@ PATH
   remote: .
   specs:
     rails_sql_counter (0.1.1)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
     rake (12.3.3)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -21,6 +32,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -29,12 +29,12 @@ Or install it yourself as:
 
 * **start**: starts to count sql queries
 * **end**: ends to count sql queries
-* **counter**: returns number of sql quieries from start
+* **counter**: returns number of sql queries from start
+* **profile**: syntax sugar to facilitate start/end
 
 ## Usage
 
 Test example:
-
 ```ruby
 context '...' do
   before { RailsSqlCounter.start }
@@ -46,6 +46,32 @@ context '...' do
     expect(RailsSqlCounter.counter).to eq(1)
   end
 end
+
+# You could also use .profile
+context '...' do
+  it 'returns results with only one query' do
+    RailsSqlCounter.profile { get path }
+
+    expect(RailsSqlCounter.counter).to eq(1)
+  end
+end
+```
+You may want to wrap the tests as:
+
+```ruby
+config.around(:each, :max_queries) do |example|
+  RailsSqlCounter.profile { example.run }
+
+  if RailsSqlCounter.counter > example.metadata[:max_queries]
+    raise 'Maximum number of queries overpassed.'
+  end
+end
+
+(...)
+
+it 'returns results with only one query', max_queries: 1 do
+  get path
+end
 ```
 
 ## Development

data/lib/rails_sql_counter/version.rb

@@ -1,3 +1,3 @@
 module RailsSqlCounter
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'.freeze
 end

data/lib/rails_sql_counter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails_sql_counter/version'
+require 'active_support'
 
 # Count sql queries
 module RailsSqlCounter
@@ -30,9 +31,14 @@ module RailsSqlCounter
     end
   end
 
-  def self.end
-    Thread.current[:rails_sql_counter] = nil
+  def self.profile(&block)
+    start
+    block.call
+  ensure
+    self.end
+  end
 
+  def self.end
     ActiveSupport::Notifications.unsubscribe(@@subscriber)
     @@subscriber = nil
   end
@@ -50,5 +56,5 @@ module RailsSqlCounter
     end
   end
 
-  private_class_method :inc, :show_backtrace
+  private_class_method :inc, :show_backtrace, :process
 end

data/rails_sql_counter.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails_sql_counter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - rjurado
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
-dependencies: []
+date: 2021-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allows to control how many queries are launched between two points
 email:
 - rjurado@nosolosoftware.es
@@ -49,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Keep under control how many sql queries are launched in your App