query_tracer 0.0.2 → 0.0.3

data/README.markdown

@@ -18,17 +18,17 @@ Rewrite SQL queries adding small trace as a comment. It will show where long run
 
 Add following code to config/initializers/query_tracer.rb:
 
-    QueryTracer::Configuration.set do |tracer|
+    QueryTracer.configure do |tracer|
       tracer.enabled = true
       tracer.colorize = true
       tracer.show_revision = true
       tracer.multiline = true
-      tracer.skip_queries = [%r{FROM sqlite_master}]
+      tracer.exclude_queries << %r{FROM sqlite_master}
     end
 
     QueryTracer::Logger.attach_to :active_record
     
-`skip_queries` will merge one/many regexps into default expressions list (QueryTracer::Tracer::EXCLUDE_SQL) for current DB.
+`exclude_queries` will contain default expressions list for currently selected DB.
 
 ## Example
 

data/lib/query_tracer/logger.rb

@@ -1,6 +1,4 @@
 require 'active_record/log_subscriber'
-
-require 'query_tracer/configuration'
 require 'query_tracer/tracer'
 
 module QueryTracer
@@ -10,21 +8,21 @@ module QueryTracer
     # event.duration
     # event.payload[:sql]
     def sql(event)
-      return unless Configuration.enabled
+      return unless QueryTracer.config.enabled
       
       sql = event.payload[:sql]
       # Skip noisy queries
       trace = Tracer.build_trace(sql)
       return if trace.blank?
       # We're done
-      if Configuration.colorize
+      if QueryTracer.config.colorize
         message = "\e[34m\e[43m^^^^ Called from:\e[0m "
         indent = "\e[34m\e[43m->\e[0m "
       else
         message = '^^^^ Called from: '
         indent = " "
       end
-      logger.send QueryTracer::Configuration.log_level.to_sym, message + trace.join("\n#{indent}")
+      logger.send QueryTracer.config.log_level.to_sym, message + trace.join("\n#{indent}")
     end
   end
 end

data/lib/query_tracer/tracer/revision.rb

@@ -4,14 +4,14 @@ module QueryTracer
     module Revision
       # Detect the current code revision and memoize it for the future.
       def self.current
-        return nil unless QueryTracer::Configuration.show_revision
+        return nil unless QueryTracer.config.show_revision
         
         begin
           # Do we have the code revision memoized?
           unless defined?(@@current_code_revision)
-            @@current_code_revision = if File.exists?("#{Rails.root}/REVISION")
+            @@current_code_revision = if File.exists?("#{QueryTracer.config.root}/REVISION")
               # Capistrano-deployed application, we know where to get current revision
-              File.read("#{Rails.root}/REVISION").chomp.strip
+              File.read("#{QueryTracer.config.root}/REVISION").chomp.strip
             else
               # Try to use git
               rev = `git rev-parse HEAD 2>/dev/null`.chomp.strip

data/lib/query_tracer/tracer.rb

@@ -1,41 +1,21 @@
-require 'query_tracer/configuration'
 require 'query_tracer/tracer/revision'
 
 module QueryTracer
   module Tracer
     extend self
     
-    INCLUDE_CODEPOINTS = [
-      %r{^#{Rails.root}/(app/presenters/.*)},
-      %r{^#{Rails.root}/(app/views/.*)},
-      %r{^#{Rails.root}/(app/controllers/.*)},
-      %r{^#{Rails.root}/(app/models/.*)},
-      %r{^#{Rails.root}/(lib/.*)},
-      %r{^#{Rails.root}/(spec/.*)},
-      %r{^#{Rails.root}/(app/.*)},
-      %r{^#{Rails.root}/(vendor/(?:gems|plugins)/.*)},
-      %r{^#{Rails.root}/(.*)},
-      %r{in `(irb)_binding'}
-    ]
-    # A regular expression used to skip certain code points (gems that do nothing
-    # but add noice to the result).
-    EXCLUDE_CODEPOINT = %r{^(#{Rails.root}/(?:vendor/(?:rails|gems/(?:composite_primary_keys|db-charmer)|plugins/(?:paginating_find|acts_as_sluggable))|config/initializers/mysql_adapter_extensions\.rb|tmp/gems|lib/query_tracer))|\.rvm/|/gems/}
-    # A regular expression to exclude certain SQL queries from processing (who cares
-    # where SHOW TABLES was issues from).
-    EXCLUDE_SQL = []
-
     def build_trace(sql)
       unless skip_query?(sql)
         # Skip noisy codepoints
         lines = caller.inject([]) do |filtered, line|
-          unless line =~ EXCLUDE_CODEPOINT
-            filtered << line unless INCLUDE_CODEPOINTS.select{ |expr| line =~ expr }.blank?
+          unless line =~ QueryTracer.config.exclude_codepoint
+            filtered << line unless QueryTracer.config.include_codepoints.select{ |expr| line =~ expr }.blank?
           end
           filtered
         end
         
         unless lines.blank?
-          lines = lines.first unless QueryTracer::Configuration.multiline
+          lines = lines.first unless QueryTracer.config.multiline
           [QueryTracer::Tracer::Revision.current, lines].flatten
         end
         
@@ -43,7 +23,7 @@ module QueryTracer
     end
 
     def skip_query?(sql)
-      !EXCLUDE_SQL.select { |expr| sql =~ expr }.blank?
+      !QueryTracer.config.exclude_sql.select { |expr| sql =~ expr }.blank?
     end
 
   end

data/lib/query_tracer.rb

@@ -1,4 +1,48 @@
-require 'query_tracer/configuration'
 require 'query_tracer/tracer'
 require 'query_tracer/logger'
-require 'query_tracer/db'
+require 'query_tracer/db'
+
+module QueryTracer
+  
+  def self.configure
+    @config = OpenStruct.new({
+      :enabled       => true,
+      :colorize      => true,
+      :show_revision => true,
+      :multiline     => true,
+      :log_level     => :debug,
+      :exclude_sql   => [],
+      :root          => Rails.root
+    })
+    
+    @config.include_codepoints = [
+      %r{^#{@config.root}/(app/presenters/.*)},
+      %r{^#{@config.root}/(app/views/.*)},
+      %r{^#{@config.root}/(app/controllers/.*)},
+      %r{^#{@config.root}/(app/models/.*)},
+      %r{^#{@config.root}/(lib/.*)},
+      %r{^#{@config.root}/(spec/.*)},
+      %r{^#{@config.root}/(app/.*)},
+      %r{^#{@config.root}/(vendor/(?:gems|plugins)/.*)},
+      %r{^#{@config.root}/(.*)},
+      %r{in `(irb)_binding'}
+    ]
+    
+    @config.exclude_codepoint = %r{^(#{@config.root}/(?:vendor/(?:rails|gems/(?:composite_primary_keys|db-charmer)|plugins/(?:paginating_find|acts_as_sluggable))|config/initializers/mysql_adapter_extensions\.rb|tmp/gems|lib/query_tracer))|\.rvm/|/gems/}
+    
+    @config.db_adapter = ActiveRecord::Base.connection.adapter_name.capitalize
+    
+    begin
+      @config.exclude_sql << QueryTracer::Db.const_get(@config.db_adapter)::SKIP_QUERIES
+      @config.exclude_sql.flatten!
+    rescue
+    end
+    
+    yield @config
+  end
+  
+  def self.config
+    @config
+  end
+    
+end

data/query_tracer.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "query_tracer"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.platform          = Gem::Platform::RUBY
   s.authors           = ["Dmitry Shaposhnik", "Dmytro Shteflyuk"]
   s.email             = ["dmitry@shaposhnik.name", "kpumuk@kpumuk.info"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: query_tracer
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dmitry Shaposhnik
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 +03:00
+date: 2011-04-20 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
@@ -36,7 +36,6 @@ files:
 - README.markdown
 - Rakefile
 - lib/query_tracer.rb
-- lib/query_tracer/configuration.rb
 - lib/query_tracer/db.rb
 - lib/query_tracer/db/mysql.rb
 - lib/query_tracer/db/sqlite.rb

data/lib/query_tracer/configuration.rb

@@ -1,32 +0,0 @@
-module QueryTracer
-  class Configuration
-    
-    class << self
-      
-      attr_accessor :show_revision, :enabled, :colorize
-      attr_accessor :multiline, :log_level
-    
-      def set
-        db_adapter = ActiveRecord::Base.connection.adapter_name.capitalize
-        begin
-          QueryTracer::Tracer::EXCLUDE_SQL << QueryTracer::Db.const_get(db_adapter)::SKIP_QUERIES
-          QueryTracer::Tracer::EXCLUDE_SQL.flatten!
-        rescue
-        end
-        
-        yield self
-      end
-      
-      def log_level
-        @log_level || :debug
-      end
-      
-      def skip_queries=(val)
-        QueryTracer::Tracer::EXCLUDE_SQL << val
-        QueryTracer::Tracer::EXCLUDE_SQL.flatten!
-      end
-      
-    end
-      
-  end
-end