sql-logging 3.0.9 → 3.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e58e5f101ae2526faab84ad37755deb83fb59b
-  data.tar.gz: 02d77d4c791c74056d557934c598afa32cb29d3d
+  metadata.gz: 9aac99fce0362d4f0b07f0035ec9266dc97e1599
+  data.tar.gz: 0c63f55de965eabc0216a84cad8f889eebbb9d58
 SHA512:
-  metadata.gz: 460b73d5ea7b42e0dcd296d8eabe3c18e5d9bf56850f500d2a41461c11e151e879621ece3cea4dda095beca6314d0f6ea41b0ae362a575172da70c12c53cc647
-  data.tar.gz: 469b866fbde399773894c8469229ed15d94c6dc06526588f96da2605d033b3ea8469cecac2bb55a811183100ae3ba7b5e0670213f280008f188f6c120d7760ba
+  metadata.gz: f135c72dd4b332fcf9e2f08b0ac4fb167090003d1a22ff161c0925f4d9910f973f51a0774e50426d022a3784eb32177ce749f181a7b84468e6e6afe433310335
+  data.tar.gz: 688b7ddf99783b4411d74ea76360775509871654a04e9dbf402fa8afad65a552112e4358f92562989a6f76699207c2be47b6e9b36682618d7b848040d99639b0

data/README.rdoc

@@ -1,5 +1,7 @@
 = SQL Logging
 
+{<img src="https://travis-ci.org/lightyear/sql-logging.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/lightyear/sql-logging]
+
 The SQL Logging gem adds useful SQL debugging tools to ActiveRecord. The gem
 is a repackaging of the old SQL Logging plug-in for Rails 2.x. It, in turn,
 was based on ideas and plug-ins from Adam Doppelt's (standard logging
@@ -32,24 +34,38 @@ The Top 10 summary provides the most options to customize its behavior.
 
 If you want more or fewer than 10 queries, you can easily change that:
 
-  SqlLogging::Statistics.top_sql_queries = 5
+  SqlLogging.configuration.top_sql_queries = 5
 
 If you want the sorted by something other than the total execution time,
 you can instead sort by the median execution time, number of executions
 or rows/bytes returned over all executions of the query:
 
-  SqlLogging::Statistics.show_top_sql_queries = :median_time
-  SqlLogging::Statistics.show_top_sql_queries = :queries
-  SqlLogging::Statistics.show_top_sql_queries = :rows
-  SqlLogging::Statistics.show_top_sql_queries = :bytes
+  SqlLogging.configuration.show_top_sql_queries = :median_time
+  SqlLogging.configuration.show_top_sql_queries = :queries
+  SqlLogging.configuration.show_top_sql_queries = :rows
+  SqlLogging.configuration.show_top_sql_queries = :bytes
 
 You can also turn the list off entirely:
 
-  SqlLogging::Statistics.show_top_sql_queries = false
+  SqlLogging.configuration.show_top_sql_queries = false
 
 If you don't want to see query backtraces:
 
-  SqlLogging::Statistics.show_sql_backtrace = false
+  SqlLogging.configuration.show_sql_backtrace = false
+
+=== General Configuration
+
+In addition to the statistics configuration, more general aspects of the gem can
+be set through the configuration.
+
+For example, the logger can be set here to store results in alternate location:
+
+  SqlLogging.configuration.logger = ActiveSupport::Logger.new(STDOUT)
+
+Additionally, the backtrace cleaner used for generating the call stack can be
+configured here:
+
+  SqlLogging.configuration.backtrace_cleaner.remove_silencers!
 
 = Acknowledgments
 

data/lib/sql-logging.rb

@@ -1 +1,18 @@
+require 'rails'
+require 'active_record'
+require 'action_view'
+require 'singleton'
+
+require 'sql-logging/controller_runtime'
+require 'sql-logging/configuration'
+require 'sql-logging/helper'
+require 'sql-logging/logged_query'
+require 'sql-logging/statistics'
 require 'sql-logging/railtie'
+require 'sql-logging/version'
+
+module SqlLogging
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/sql-logging/configuration.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+module SqlLogging
+  class Configuration
+    DEFAULTS = {
+      show_sql_backtrace: true,
+      show_top_sql_queries: :total_time,
+      top_sql_queries: 10,
+      backtrace_cleaner: nil,
+      logger: nil
+    }.freeze
+
+    attr_writer(*DEFAULTS.keys - [:show_top_sql_queries=])
+    attr_reader(*DEFAULTS.keys - %i(logger backtrace_cleaner))
+
+    def initialize
+      DEFAULTS.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
+    def show_top_sql_queries=(value)
+      validate_allowed([false, :rows, :queries, :bytes, :total_time,
+                        :median_time], value)
+      @show_top_sql_queries = value
+    end
+
+    def backtrace_cleaner
+      @backtrace_cleaner ||= initialize_cleaner
+    end
+
+    def logger
+      @logger ||= Rails.logger
+    end
+
+    private
+
+    def initialize_cleaner
+      Rails.backtrace_cleaner.dup.tap do |cleaner|
+        cleaner.add_silencer { |line| line =~ %r{sql-logging/lib} }
+      end
+    end
+
+    def validate_allowed(allowed_values, value)
+      return if allowed_values.include?(value)
+      method_match = /`(.*)='/.match(caller(1, 1)[0])
+      method_name = method_match ? method_match[1] : 'Argument'
+      raise ArgumentError, "#{method_name} must be one of: " \
+                           "#{allowed_values.map(&:inspect).join(', ')}"
+    end
+  end
+end

data/lib/sql-logging/helper.rb

@@ -0,0 +1,7 @@
+module SqlLogging
+  class Helper
+    include Singleton
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::NumberHelper
+  end
+end

data/lib/sql-logging/railtie.rb

@@ -1,7 +1,3 @@
-require 'sql-logging/statistics'
-require 'rails'
-require 'active_record'
-
 module SqlLogging
   class Railtie < Rails::Railtie
     initializer 'sql_logging.load_adapter_extensions' do

data/lib/sql-logging/statistics.rb

@@ -1,108 +1,119 @@
-require 'singleton'
-require 'sql-logging/logged_query'
-
 module SqlLogging
-  class Helper
-    include Singleton
-    include ActionView::Helpers::TextHelper
-    include ActionView::Helpers::NumberHelper
-  end
-  
   class Statistics
-    @@show_sql_backtrace = true
-    @@show_top_sql_queries = :total_time
-    @@top_sql_queries = 10
-    @@backtrace_cleaner = nil
-  
-    cattr_accessor :show_sql_backtrace, :top_sql_queries
-  
-    def self.show_top_sql_queries
-      @@show_top_sql_queries
-    end
-  
-    def self.show_top_sql_queries=(value)
-      unless [ false, :rows, :queries, :bytes, :total_time, :median_time ].include?(value)
-        raise ArgumentError, "show_top_sql_queries must be one of false, :rows, :queries, :bytes, :total_time or :median_time"
+    class Data
+      COUNTERS = %i(queries bytes rows).freeze
+      attr_accessor(*COUNTERS)
+      attr_reader(:top_queries)
+
+      def initialize
+        reset!
       end
-    
-      @@show_top_sql_queries = value
-    end
 
-    @@queries = @@bytes = @@rows = 0
-    @@top_queries = {}
+      def reset!
+        COUNTERS.each { |v| instance_variable_set("@#{v}", 0) }
+        @top_queries = {}
+      end
 
-    def self.reset_statistics!
-      @@queries = @@bytes = @@rows = 0
-      @@top_queries = {}
+      def add_query(row_counts, bytes)
+        @queries += 1
+        @bytes += bytes
+        @rows += row_counts
+      end
     end
 
-    def self.backtrace_cleaner
-      unless @@backtrace_cleaner
-        @@backtrace_cleaner = Rails.backtrace_cleaner.dup
-        @@backtrace_cleaner.add_silencer { |line| line =~ %r{sql-logging/lib} }
+    class << self
+      extend Forwardable
+
+      def configuration
+        SqlLogging.configuration
       end
-      @@backtrace_cleaner
-    end
 
-    def self.record_query(sql, name, msec, result)
-      unless name.blank? || name =~ / Columns$/ || name == :skip_logging
+      def_delegators :configuration, :show_sql_backtrace, :top_sql_queries,
+                     :show_top_sql_queries, :backtrace_cleaner,
+                     :show_top_sql_queries=, :show_sql_backtrace=,
+                     :top_sql_queries=, :logger
+
+      def data
+        @data ||= Data.new
+      end
+
+      def_delegator :data, :top_queries
+
+      def reset_statistics!
+        data.reset!
+      end
+
+      def record_query(sql, name, msec, result)
+        return if name.blank? || name =~ / Columns$/ || name == :skip_logging
+        ntuples, bytes = tuples_and_bytes_in_result(result)
+
+        data.add_query(ntuples, bytes)
+
+        backtrace = backtrace_cleaner.clean(caller).join("\n    ")
+        add_query_to_top_queries(sql, name, backtrace, msec, ntuples, bytes)
+
+        logger.debug "    #{ntuples} rows, #{bytes} bytes"
+        logger.debug "    #{backtrace}" if show_sql_backtrace
+      end
+
+      def log_report
+        logger.debug "SQL Logging: #{data.queries} statements executed" \
+          ", returning #{data.bytes} bytes"
+
+        return unless top_queries?
+        logger.debug "Top #{top_sql_queries} SQL executions:"
+        sorted_keys = top_queries.keys.sort_by do |k|
+          top_queries[k][show_top_sql_queries]
+        end.reverse
+        sorted_keys.slice(0..top_sql_queries).each do |key|
+          query = top_queries[key]
+          logger.debug format(
+            '  Executed %d times in %.1fms (%.1f/%.1f/%.1fms min/median/max),' \
+            " returning %d rows(%d bytes):\n"\
+            "    %s\n" \
+            "    First exec was: %s\n" \
+            '    %s', query.queries, query.total_time, query.min_time,
+            query.median_time, query.max_time, query.rows, query.bytes,
+            query.name, query.sql, query.backtrace
+          )
+        end
+      end
+
+      private
+
+      def add_query_to_top_queries(sql, name, backtrace, msec, ntuples, bytes)
+        return unless show_top_sql_queries
+        key = "#{name}:#{backtrace}"
+        top_queries[key] ||= LoggedQuery.new(sql, name, backtrace)
+        top_queries[key].log_query(ntuples, bytes, msec)
+      end
+
+      def tuples_and_bytes_in_result(result)
         bytes = 0
-        if result.nil?
-          ntuples = 0
-        else
+        ntuples = 0
+        return [ntuples, bytes] if result.nil?
+        if result.respond_to?(:each)
           result.each do |row|
             row.each do |key, value|
               bytes += key.size if key && key.respond_to?(:size)
               bytes += value.size if value && value.respond_to?(:size)
             end
-          end if result.respond_to?(:each)
-          ntuples = 0
-          if result.respond_to?(:length)
-            ntuples = result.length
-          elsif result.respond_to?(:count)
-            ntuples = result.count
-          elsif result.respond_to?(:num_rows)
-            ntuples = result.num_rows
-          elsif result.respond_to?(:ntuples)
-            ntuples = result.ntuples
           end
         end
-      
-        @@queries += 1
-        @@rows += ntuples
-        @@bytes += bytes
-
-        backtrace = backtrace_cleaner.clean(caller).join("\n    ")
-        unless @@show_top_sql_queries == false
-          key = "#{name}:#{backtrace}"
-          unless query = @@top_queries[key]
-            query = LoggedQuery.new(sql, name, backtrace)
-            @@top_queries[key] = query
-          end
-          query.log_query(ntuples || 0, bytes || 0, msec)
+        if result.respond_to?(:length)
+          ntuples = result.length
+        elsif result.respond_to?(:count)
+          ntuples = result.count
+        elsif result.respond_to?(:num_rows)
+          ntuples = result.num_rows
+        elsif result.respond_to?(:ntuples)
+          ntuples = result.ntuples
         end
-
-        Rails.logger.debug "    #{ntuples} rows, #{bytes} bytes"
-        Rails.logger.debug "    #{backtrace}" if @@show_sql_backtrace
+        [ntuples, bytes]
       end
-    end
-  
-    def self.log_report
-      Rails.logger.debug "SQL Logging: #{@@queries} statements executed, returning #{@@bytes} bytes"
-    
-      unless @@show_top_sql_queries == false || @@top_queries.empty?
-        Rails.logger.debug "Top #{@@top_sql_queries} SQL executions:"
-        sorted_keys = @@top_queries.keys.sort_by { |k| @@top_queries[k][@@show_top_sql_queries] }.reverse
-        sorted_keys.slice(0..@@top_sql_queries).each do |key|
-          query = @@top_queries[key]
-          Rails.logger.debug "  Executed #{query.queries} times in #{'%.1f' % query.total_time}ms " +
-            "(#{'%.1f' % query.min_time}/#{'%.1f' % query.median_time}/#{'%.1f' % query.max_time}ms min/median/max), " +
-            "returning #{query.rows} rows" +
-            "(#{query.bytes} bytes):\n" +
-            "    #{query.name}\n" +
-            "    First exec was: #{query.sql}\n" +
-            "    #{query.backtrace}"
-        end
+
+      def top_queries?
+        show_top_sql_queries && !top_queries.empty?
       end
     end
   end

data/lib/sql-logging/version.rb

@@ -1,3 +1,3 @@
 module SqlLogging
-  VERSION = '3.0.9'
+  VERSION = '3.0.10'
 end

metadata

@@ -1,48 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: sql-logging
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.0.10
 platform: ruby
 authors:
 - Steve Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2017-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '5'
-description: |2
-      sql-logging adds functionality to Rails to debug query performance.
-      SQL triggered by your application includes a stack trace so you can determine
-      what code led to it, and a summary is emitted after each request to highlight
-      the most expensive queries executed.
+        version: 2.11.0
+description: Adds SQL analysis and debugging info to Rails 3 apps.
 email: steve@lightyearsoftware.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- README.rdoc
-- lib/sql-logging.rb
 - lib/sql-logging/adapters/cache_extension.rb
 - lib/sql-logging/adapters/mysql.rb
 - lib/sql-logging/adapters/mysql2.rb
@@ -50,14 +66,17 @@ files:
 - lib/sql-logging/adapters/postgresql.rb
 - lib/sql-logging/adapters/sqlite.rb
 - lib/sql-logging/adapters/sqlite3.rb
+- lib/sql-logging/configuration.rb
 - lib/sql-logging/controller_runtime.rb
+- lib/sql-logging/helper.rb
 - lib/sql-logging/logged_query.rb
 - lib/sql-logging/railtie.rb
 - lib/sql-logging/statistics.rb
 - lib/sql-logging/version.rb
+- lib/sql-logging.rb
+- README.rdoc
 homepage: http://github.com/lightyear/sql-logging
-licenses:
-- MIT
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -65,18 +84,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
-summary: Adds SQL analysis and debugging info to Rails 3+ apps.
+summary: Adds SQL analysis and debugging info to Rails 3 apps.
 test_files: []