sql_tracker 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: df1ae4131da0bbeda517829ce0db3dad6c97b5ef
-  data.tar.gz: 8f59accaebfc65e61f5ad7198269dfce0b6d8990
+SHA256:
+  metadata.gz: 56c4c714a20db32a1617afa074c9d3e2f7986b53be0351b5a17a38733731d4e7
+  data.tar.gz: d7f77249ff127d6396aef49e9ba7aab123ee7a1fd84439e092e206112b5a1452
 SHA512:
-  metadata.gz: a5d819a6ec3f09b9d310ae1d4887141b700ea53fad7cf57219a7e864e01087eb32940e73a66afc839229888e6fbb3b6d6897cc88f5569f4c91507cb251eeeab7
-  data.tar.gz: 9635191ad6bf27fee3a658d1f1f02ddba460e1aeb0fce0977f05f6a3035874188601906503f545cf5c3be4863ca195c24a88bad70f373147ddc89dc16020b743
+  metadata.gz: 290ace1cf7e19ebf5c8de2d3288f482d6159370cae8e3cedd5bf529864fe3b9bd7f4ee604776e40fd209a3e2ebd462013a1a6d6d9c666858011a33c1692f99e6
+  data.tar.gz: 7a758d0fd946e3392c618fbecf72fb200a2b9451fb3c4a1081f7b488002f820879076d1ec3ba68786b25e7badb6f0bafbef9e355c3026c3efbf323572f8ec2ec

data/.travis.yml

@@ -2,7 +2,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.0
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 before_install:
   - gem install bundler
   - gem update bundler

data/README.md

@@ -29,6 +29,24 @@ To start tracking, simply start your rails application server. When your server
 
 `sql_tracker` can also track sql queries when running rails tests (e.g. your controller or integration tests), it will dump the data after all the tests are finished.
 
+### Tracking Using a Block
+
+It is also possible to track queries executed within a block. This method uses a new subscriber to `sql.active_record` event notifications for each invocation. Results using this method are not saved to a file.
+
+```ruby
+query_data = SqlTracker.track do
+  # Run some active record queries
+end
+
+query_data.values
+# =>
+# [{
+#  :sql=>"SELECT * FROM users",
+#  :count=>1,
+#  :duration=>1.0,
+#  :source=>["app/models/user.rb:12"]
+# }]
+```
 
 ## Reporting
 

data/lib/sql_tracker/handler.rb

@@ -12,6 +12,21 @@ module SqlTracker
       @data = {} # {key: {sql:, count:, duration, source: []}, ...}
     end
 
+    def subscribe
+      @subscription ||= ActiveSupport::Notifications.subscribe(
+        'sql.active_record',
+        self
+      )
+    end
+
+    def unsubscribe
+      return unless @subscription
+
+      ActiveSupport::Notifications.unsubscribe(@subscription)
+
+      @subscription = nil
+    end
+
     def call(_name, started, finished, _id, payload)
       return unless @config.enabled
 

data/lib/sql_tracker/version.rb

@@ -1,3 +1,3 @@
 module SqlTracker
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/sql_tracker.rb

@@ -8,11 +8,20 @@ module SqlTracker
 
     config = SqlTracker::Config.apply_defaults
     handler = SqlTracker::Handler.new(config)
-    ActiveSupport::Notifications.subscribe('sql.active_record', handler)
+    handler.subscribe
     @already_initialized = true
 
     at_exit { handler.save }
   end
+
+  def self.track
+    config = SqlTracker::Config.apply_defaults
+    handler = SqlTracker::Handler.new(config)
+    handler.subscribe
+    yield
+    handler.unsubscribe
+    handler.data
+  end
 end
 
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3

data/sql_tracker.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = ['sql_tracker']
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'activesupport', '>= 3.0.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracker
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Steven Yue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -109,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Rails SQL Query Tracker