sql_tracker 1.1.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8d236c5adb10928d77ae8547ab0a88fffe16c4c
-  data.tar.gz: af52c90be114c030abbe35ee5c4babda01b4a21f
+SHA256:
+  metadata.gz: 7212f79d9a123731752126baff019de8dc807c78442607c594ffc9c4261281f0
+  data.tar.gz: bf99e463dc00c245c49135b7d18d5ed3b0b325d2534cadf9d829232c3e92beb8
 SHA512:
-  metadata.gz: d0231bef73e7f00395eebc0afce207544cade7bd702b57abeea697ffd9dbd9da0b4cb4d42023b85b4a91d2d8c3044a936ffbbee720b59266b0e023cb5c0a08f3
-  data.tar.gz: b41ac6f658f2dfcd9ebeab95bd694c998e8cf6a4d8ec5753564088af0110b918efa437a66fbd4687df206369d5a53927c266427f6c91ea9fbcdfed29eebd762a
+  metadata.gz: 689f6f10d3cb217274ce2b55e7972ba453e69b34a8fbed03837608bc9f1131afee3b3d1315d6323ddcca93a2a44e625771dc58d6fb4c39be7b68c41c16df402f
+  data.tar.gz: 8d9ed0706326a36d886b77a7d8591a1cfc8e117774d149a870750b983eb746630d26e01456be186eca80a83723b6b662c65b32f79c51ab9dfba84a07ce1fa8aa

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test

data/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

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
 
@@ -36,6 +54,28 @@ To generate report, run
 ```bash
 sql_tracker tmp/sql_tracker-*.json
 ```
+The output report looks like this:
+```
+==================================
+Total Unique SQL Queries: 24
+==================================
+Count | Avg Time (ms)   | SQL Query                                                                                                 | Source
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+8     | 0.33            | SELECT `users`.* FROM `users` WHERE `users`.`id` = xxx LIMIT 1                                            | app/controllers/users_controller.rb:125:in `create'
+      |                 |                                                                                                           | app/controllers/projects_controller.rb:9:in `block in update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+4     | 0.27            | SELECT `projects`.* FROM `projects` WHERE `projects`.`user_id` = xxx AND `projects`.`id` = xxx LIMIT 1    | app/controllers/projects_controller.rb:4:in `update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+2     | 0.27            | UPDATE `projects` SET `updated_at` = xxx WHERE `projects`.`id` = xxx                                      | app/controllers/projects_controller.rb:9:in `block in update'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+2     | 1.76            | SELECT projects.* FROM projects WHERE projects.priority BETWEEN xxx AND xxx ORDER BY created_at DESC      | app/controllers/projects_controller.rb:35:in `index'
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+... ...
+```
+By default, the report will be sorted by the total count of each query, you can also choose to sort it by average duration:
+```bash
+sql_tracker tmp/sql_tracker-*.json --sort-by=duration
+```
 
 ## Configurations
 

data/bin/sql_tracker

@@ -1,6 +1,31 @@
 #!/usr/bin/env ruby
+require 'sql_tracker/terminal'
 require 'sql_tracker/report'
 require 'json'
+require 'optparse'
+
+options = {}
+default_options = { sort_by: 'count', terminal_width: SqlTracker::Terminal.width }
+
+parser = OptionParser.new(ARGV) do |o|
+  o.banner = 'Usage: sql_tracker [file.json]+ [--sort-by=COLUMN]'
+
+  o.on('-s', '--sort-by COLUMN', 'The name of column that is used for sorting the table. Options: count, duration') do |arg|
+    options[:sort_by] = arg if %(count duration).include?(arg)
+  end
+
+  o.on('-w', '--terminal-width WIDTH', Integer,
+       "The width of the printed report. " \
+       "Default: #{default_options[:terminal_width]}. " \
+       "Minimum #{SqlTracker::Terminal::MIN_WIDTH}") do |arg|
+    options[:terminal_width] = arg if arg >= SqlTracker::Terminal::MIN_WIDTH
+  end
+end
+
+parser.parse!
+parser.abort(parser.help) if ARGV.empty?
+
+options = default_options.merge(options)
 
 reports = []
 until ARGV.empty?
@@ -23,4 +48,4 @@ if reports.empty?
 end
 
 report = reports.inject(:+)
-report.print_text
+report.print_text(options)

data/lib/sql_tracker.rb

@@ -8,11 +8,21 @@ 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.new
+    config.enabled = true
+    handler = SqlTracker::Handler.new(config)
+    handler.subscribe
+    yield
+    handler.unsubscribe
+    handler.data
+  end
 end
 
 if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3

data/lib/sql_tracker/handler.rb

@@ -12,10 +12,25 @@ 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
 
-      sql = payload[:sql]
+      sql = payload[:sql].dup
       return unless track?(sql)
 
       cleaned_trace = clean_trace(caller)
@@ -47,9 +62,12 @@ module SqlTracker
 
     def clean_sql_query(query)
       query.squish!
-      query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|\w+)/, '\1xxx')
+      query.gsub!(/(\s(=|>|<|>=|<=|<>|!=)\s)('[^']+'|[\$\+\-\w\.]+)/, '\1xxx')
       query.gsub!(/(\sIN\s)\([^\(\)]+\)/i, '\1(xxx)')
-      query.gsub!(/(\sBETWEEN\s)('[^']+'|\w+)(\sAND\s)('[^']+'|\w+)/i, '\1xxx\3xxx')
+      query.gsub!(/(\sBETWEEN\s)('[^']+'|[\+\-\w\.]+)(\sAND\s)('[^']+'|[\+\-\w\.]+)/i, '\1xxx\3xxx')
+      query.gsub!(/(\sVALUES\s)\(.+\)/i, '\1(xxx)')
+      query.gsub!(/(\s(LIKE|ILIKE|SIMILAR TO|NOT SIMILAR TO)\s)('[^']+')/i, '\1xxx')
+      query.gsub!(/(\s(LIMIT|OFFSET)\s)(\d+)/i, '\1xxx')
       query
     end
 

data/lib/sql_tracker/report.rb

@@ -1,6 +1,7 @@
 module SqlTracker
   class Report
     attr_accessor :raw_data
+    attr_accessor :terminal_width
 
     def initialize(data)
       self.raw_data = data
@@ -25,7 +26,9 @@ module SqlTracker
       raw_data['data']
     end
 
-    def print_text(f = STDOUT)
+    def print_text(options)
+      self.terminal_width = options.fetch(:terminal_width)
+      f = STDOUT
       f.puts '=================================='
       f.puts "Total Unique SQL Queries: #{data.keys.size}"
       f.puts '=================================='
@@ -35,7 +38,8 @@ module SqlTracker
       )
       f.puts '-' * terminal_width
 
-      data.values.sort_by { |d| -d['count'] }.each do |row|
+      sorted_data = sort_data(data.values, options[:sort_by])
+      sorted_data.each do |row|
         chopped_sql = wrap_text(row['sql'], sql_width)
         source_list = wrap_list(row['source'].uniq, sql_width - 10)
         avg_duration = row['duration'].to_f / row['count']
@@ -50,15 +54,26 @@ module SqlTracker
           duration = line == 0 ? avg_duration.round(2) : ''
           source = source_list.length > line ? source_list[line] : ''
           query = row['sql'].length > line ? chopped_sql[line] : ''
-          f.printf(
-            "%-#{count_width}s | %-#{duration_width}s | %-#{sql_width}s | %-#{sql_width}s\n",
-            count, duration, query, source
-          )
+          f.printf(row_format, count, duration, query, source)
         end
         f.puts '-' * terminal_width
       end
     end
 
+    def row_format
+      "%-#{count_width}s | %-#{duration_width}s | %-#{sql_width}s | %-#{sql_width}s\n"
+    end
+
+    def sort_data(data, sort_by)
+      data.sort_by do |d|
+        if sort_by == 'duration'
+          -d['duration'].to_f / d['count']
+        else
+          -d['count']
+        end
+      end
+    end
+
     def +(other)
       unless self.class == other.class
         raise ArgumentError, "cannot combine #{other.class}"
@@ -112,29 +127,5 @@ module SqlTracker
     def duration_width
       15
     end
-
-    def terminal_width
-      @terminal_width ||= begin
-        result = unix? ? dynamic_width : 80
-        result < 10 ? 80 : result
-      end
-    end
-
-    def dynamic_width
-      @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
-    end
-
-    def dynamic_width_stty
-      `stty size 2>/dev/null`.split[1].to_i
-    end
-
-    def dynamic_width_tput
-      `tput cols 2>/dev/null`.to_i
-    end
-
-    def unix?
-      RUBY_PLATFORM =~
-        /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
-    end
   end
 end

data/lib/sql_tracker/terminal.rb

@@ -0,0 +1,28 @@
+module SqlTracker
+  class Terminal
+    DEFAULT_WIDTH = 80
+    MIN_WIDTH = 10
+
+    def self.width
+      if unix?
+        result = (dynamic_width_stty.nonzero? || dynamic_width_tput)
+        result < MIN_WIDTH ? DEFAULT_WIDTH : result
+      else
+        DEFAULT_WIDTH
+      end
+    end
+
+    def self.dynamic_width_stty
+      `stty size 2>/dev/null`.split[1].to_i
+    end
+
+    def self.dynamic_width_tput
+      `tput cols 2>/dev/null`.to_i
+    end
+
+    def self.unix?
+      RUBY_PLATFORM =~
+        /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+    end
+  end
+end

data/lib/sql_tracker/version.rb

@@ -1,3 +1,3 @@
 module SqlTracker
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.3.2'.freeze
 end

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.1.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Steven Yue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2021-03-05 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
@@ -74,8 +74,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,6 +89,7 @@ files:
 - lib/sql_tracker/handler.rb
 - lib/sql_tracker/railtie.rb
 - lib/sql_tracker/report.rb
+- lib/sql_tracker/terminal.rb
 - lib/sql_tracker/version.rb
 - sql_tracker.gemspec
 homepage: http://www.github.com/steventen/sql_tracker
@@ -109,8 +111,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.3
 signing_key: 
 specification_version: 4
 summary: Rails SQL Query Tracker

data/.travis.yml

@@ -1,8 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.0
-before_install:
-  - gem install bundler
-  - gem update bundler