sql_tracer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98ce5725d8ff7895f2d497d33d9d56368e6074bb
-  data.tar.gz: 1cc0510f0278227e89a946e1f6bb760c4935bc91
+  metadata.gz: 60a8e3f163f3a5ca7ba930ad31ebf984ad1ce764
+  data.tar.gz: 9b36a32e8f60a9074c49a356da9fcda1f259776c
 SHA512:
-  metadata.gz: a13325d7bcbe611d574b58459ee606e6ea8e34b541975cfaa80706e2d51f787c3f0ac116f315f716b7759022e31f1d7a8000ecbeb829b83dc4f58c8f2fa9ef64
-  data.tar.gz: a944447d1bb4e19965ce4ae1359aea5e02ae7c6e1c012b155bd3fa5160b7985e9f755447bebf5da7aee0138b60c77d19bc7959f50b06d3b3453c61ad7667cdac
+  metadata.gz: e294b9f7e22f3766521ed4006bdf31e8c60b0024900b6eca514f411db959af31391b8fabacc84bf24086d54ef45cc9f199b23a048cad4743240b3c0fc56b43cc
+  data.tar.gz: 3e62d68b3b7b9b6d3d991dbfd346b767f1d22b40f532a63157c7c168883c76b984eda8e1e92048718fef34b9815d84d9f34f3ca271d285d1cd5574df8b886ac1

data/lib/sql_tracer/adapters/mysql2.rb

@@ -0,0 +1,16 @@
+require 'active_record/connection_adapters/mysql2_adapter'
+
+module ActiveRecord::ConnectionAdapters
+  module Mysql2SqlLogger
+    def execute(*args)
+      SqlTracer::SqlLogger.log_sql(args.first)
+      super(*args)
+    end
+  end
+
+  class Mysql2Adapter
+    prepend Mysql2SqlLogger
+  end
+
+end
+

data/lib/sql_tracer/adapters/postgresql.rb

@@ -0,0 +1,14 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module ActiveRecord::ConnectionAdapters
+  module PostgreSqlLogger
+    def execute(sql, *args)
+      SqlTracer::SqlLogger.log_sql(sql)
+      super(sql, *args)
+    end
+  end
+
+  class PostgreSQLAdapter
+    prepend PostgreSqlLogger
+  end
+end

data/lib/sql_tracer/adapters/sqlite.rb

@@ -0,0 +1,12 @@
+module ActiveRecord::ConnectionAdapters
+  module SqliteSqlLogger
+    def execute(sql, name = nil)
+      SqlTracer::SqlLogger.log_sql(sql)
+      super(sql, name)
+    end
+  end
+
+  class SQLiteAdapter
+    prepend SqliteSqlLogger
+  end
+end

data/lib/sql_tracer/adapters/sqlite3.rb

@@ -0,0 +1 @@
+require 'sql_tracer/adapters/sqlite'

data/lib/sql_tracer/config.rb

@@ -1,9 +1,20 @@
 module SqlTracer
   module Config
+    DEFAULTS = {
+      SQL_TRACER_SKIP_LIB_PATH: true, # method call paths in /.rvm directory won't be output, default true
+      SQL_TRACER_CONSOLE_OUTPUT_DISABLED: false, # sqls won't be output in back-end console if set to true, default false
+      SQL_TRACER_OUTPUT_SELECT_SQL_ENABLED: false, # output select type sql. By default, only (insert|update|delete) sql will be output
+      # sql which contains any element of this array won't be output
+      SQL_TRACER_SQL_FILTER: [],
+      # request url which contains any element of this array won't be output
+      SQL_TRACER_URL_FILTER: [],
+      # call stack path which contains any element of this array won't be output
+      SQL_TRACER_PATH_FILTER: []
+    }.freeze
 
     def self.get(name)
       @config ||= load_config
-      @config ? @config[name.to_s] : nil
+      @config ? @config[name.to_s] : DEFAULTS[name]
     end
 
     private

data/lib/sql_tracer/formatter.rb

@@ -1,9 +1,7 @@
-require 'anbt-sql-formatter/formatter'
-
 module SqlTracer
   class Formatter
-    HEADER_PROMPT= '='*10 << '>'
-    FOOTER_PROMPT= '<' << '='*10
+    HEADER_PROMPT= '='*20 << '>'
+    FOOTER_PROMPT= '<' << '='*20
 
     def self.start_print
       puts HEADER_PROMPT
@@ -14,30 +12,29 @@ module SqlTracer
     end
 
     def self.print_tips
-      puts 'SqlTracer is watching and will capture backtrace when sql is executed.'
-      puts 'open http://127.0.0.1:3000/sql_tracer/index for detailed information'
+      puts 'SqlTracer is watching and will capture backtrace when sql is executed, '\
+      'open http://127.0.0.1:3000/sql_tracer/index for detailed information'
     end
 
     def self.print_sql(sql)
       puts 'SQL:'
       return sql if sql.blank?
-      formatted_sql = '  ' << (Helper.format_sql_enabled? ? colorize(sql_formatter.format(sql.squeeze(' ')), 32) : sql)
+      formatted_sql = '  ' << sql
       puts formatted_sql
     end
 
     def self.print_backtrace(backtrace)
       puts Helper.should_skip_lib? ? 'Backtrace: note that paths in ruby libs have been hidden' : 'Backtrace:'
       backtrace.each do |line|
-        line = format_line(line) if Helper.format_stack_enabled?
         (puts '  ' << line) if line.present?
       end
     end
 
     def self.print_all(sql, backtrace)
-      Formatter.start_print
-      Formatter.print_sql(sql)
-      Formatter.print_backtrace(backtrace)
-      Formatter.end_print
+      start_print
+      print_sql(sql)
+      print_backtrace(backtrace)
+      end_print
     end
 
     def self.remove_filtered_path(backtrace)
@@ -46,28 +43,5 @@ module SqlTracer
         path
       end.compact
     end
-
-    def self.sql_formatter
-      return @formatter if @formatter
-      rule = AnbtSql::Rule.new
-      rule.keyword = AnbtSql::Rule::KEYWORD_UPPER_CASE
-      rule.function_names += %w(count sum)
-      rule.indent_string = '  '
-      @formatter = AnbtSql::Formatter.new(rule)
-    end
-
-    def self.format_line(line)
-      parts = line.match(/^(?<file>.+):(?<line>\d+):in `(?<code>.*)'$/)
-      if parts
-        "#{colorize(parts[:file], 32)}:#{colorize(parts[:line], 36)}:#{colorize(parts[:code], 31)}"
-      else
-        "#{colorize(line, 32)}"
-      end
-    end
-
-    def self.colorize(text, color_code)
-      "\e[#{color_code}m#{text}\e[0m"
-    end
-
   end
 end

data/lib/sql_tracer/helper.rb

@@ -1,32 +1,23 @@
-require 'anbt-sql-formatter/formatter'
 
 module SqlTracer
   class Helper
 
     class << self
-      def format_sql_enabled?
-        @format_sql_enabled ||= (config.get(:SQL_TRACER_FORMAT_SQL_ENABLED) || false)
-      end
-
-      def format_stack_enabled?
-        @format_stack_enabled ||= (config.get(:SQL_TRACER_FORMAT_STACK_ENABLED) || false)
-      end
-
       def output_select_sql_enabled?
-        @output_select_sql_enabled ||= (config.get(:SQL_TRACER_OUTPUT_SELECT_SQL_ENABLED) || false)
+        @output_select_sql_enabled ||= config.get(:SQL_TRACER_OUTPUT_SELECT_SQL_ENABLED)
       end
 
       def should_skip_lib?
-        @should_skip_lib ||= (config.get(:SQL_TRACER_SKIP_LIB_PATH) == false ? false : true)
+        @should_skip_lib ||= config.get(:SQL_TRACER_SKIP_LIB_PATH)
       end
 
       def should_skip_sql_by_keywords?(sql)
-        @sql_keywords ||= (config.get(:SQL_TRACER_SQL_FILTER) || [])
+        @sql_keywords ||= config.get(:SQL_TRACER_SQL_FILTER)
         @sql_keywords.any? { |keyword| sql.include?(keyword) }
       end
 
       def should_skip_url_by_keywords?(url)
-        @url_keywords ||= (config.get(:SQL_TRACER_URL_FILTER) || [])
+        @url_keywords ||= config.get(:SQL_TRACER_URL_FILTER)
         @url_keywords.any? { |keyword| url.include?(keyword) }
       end
 
@@ -36,7 +27,7 @@ module SqlTracer
       end
 
       def disable_console_output?
-        @console_output_disabled ||= (config.get(:SQL_TRACER_CONSOLE_OUTPUT_DISABLED) || false)
+        @console_output_disabled ||= config.get(:SQL_TRACER_CONSOLE_OUTPUT_DISABLED)
       end
 
       def should_output_sql?(sql)
@@ -45,7 +36,6 @@ module SqlTracer
         return sql =~ /^\s*(#{reg})\s/i && !Helper.should_skip_sql_by_keywords?(sql)
       end
 
-
       private
 
       def build_path_filter

data/lib/sql_tracer/railtie.rb

@@ -0,0 +1,26 @@
+module SqlLogging
+  class Railtie < Rails::Railtie
+    initializer 'sql_logging.load_adapter_extensions' do
+      ActiveSupport.on_load(:active_record, :after => 'active_record.initialize_database') do
+        adapter = ActiveRecord::Base.configurations[Rails.env]['adapter']
+        begin
+          require "sql_tracer/adapters/#{adapter}"
+          SqlTracer::Formatter.print_tips
+        rescue LoadError => e
+          Rails.logger.error('Failed to injuect SqlTracer to ActiveRecord due to :' + e.message)
+        end
+      end
+    end
+
+
+    initializer 'sql_logging.load_adapter_extensions' do
+      begin
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Base.send(:include, SqlTracer::RequestLogger)
+        end
+      rescue LoadError, NameError => e
+        Rails.logger.error('Failed to injuect RequestLogger to Controller due to :' + e.message)
+      end
+    end
+  end
+end

data/lib/sql_tracer/request_logger.rb

@@ -9,7 +9,8 @@ module SqlTracer
           if SqlTracer::Helper.should_skip_url_by_keywords?(request.path)
             SqlTracer::SqlStack.abandon_request
           else
-            SqlTracer::SqlStack.push("#{request.method} #{request.path}")
+            # Processed by #{self.class} ##{params[:action]}
+            SqlTracer::SqlStack.push("#{request.method} #{request.path} ")
           end
         rescue => e
           Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"

data/lib/sql_tracer/sql_logger.rb

@@ -1,26 +1,16 @@
-require 'anbt-sql-formatter/formatter'
-
 module SqlTracer
   module SqlLogger
-    extend ActiveSupport::Concern
-    included do
-      alias_method :execute_without_sql_tracer, :execute
-
-      def execute(*args)
-        begin
-          sql = args.first
-
-          if Helper.should_output_sql?(sql)
-            backtrace = Thread.current.backtrace
-            backtrace = Formatter.remove_filtered_path(backtrace)
-            Formatter.print_all(sql, backtrace) unless Helper.disable_console_output?
-            SqlTracer::SqlStack.sql_stack << { :sql => sql, :stack => backtrace }
-          end
-        rescue => e
-          Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"
-          Rails.logger.error e.backtrace.join("\n")
+    def self.log_sql(sql)
+      begin
+        if Helper.should_output_sql?(sql)
+          backtrace = Thread.current.backtrace
+          backtrace = Formatter.remove_filtered_path(backtrace)
+          Formatter.print_all(sql, backtrace) unless Helper.disable_console_output?
+          SqlTracer::SqlStack.sql_stack << { :sql => sql, :stack => backtrace }
         end
-        execute_without_sql_tracer(*args)
+      rescue => e
+        Rails.logger.error "Failed to log sql in SqlTracer. Error: #{e.message}"
+        Rails.logger.error e.backtrace.join("\n")
       end
     end
   end

data/lib/sql_tracer/sql_stack.rb

@@ -10,8 +10,8 @@ module SqlTracer
         @sql_stacks = []
       end
 
-      def push(url)
-        @sql_stacks << { :url => "[#{Time.now.strftime('%H:%M:%S')}] #{url}", :sqls => @sql_stack }
+      def push(url_info)
+        @sql_stacks << { :url => "[#{Time.now.strftime('%H:%M:%S')}] #{url_info}", :sqls => @sql_stack }
         @sql_stack = []
       end
 

data/lib/sql_tracer/version.rb

@@ -1,3 +1,3 @@
 module SqlTracer
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/sql_tracer.rb

@@ -1,27 +1,13 @@
 require 'sql_tracer/engine'
+require 'sql_tracer/railtie'
 
 module SqlTracer
   autoload :RequestLogger, 'sql_tracer/request_logger'
   autoload :SqlLogger, 'sql_tracer/sql_logger'
   autoload :SqlStack, 'sql_tracer/sql_stack'
+  autoload :Railtie, 'sql_tracer/railtie'
   autoload :Helper, 'sql_tracer/helper'
   autoload :Formatter, 'sql_tracer/formatter'
   autoload :Config, 'sql_tracer/config'
 end
 
-# why does not work when wrapped in block ActiveSupport.on_load(:active_record) do
-begin
-  require 'active_record/connection_adapters/mysql2_adapter'
-  ActiveRecord::ConnectionAdapters::Mysql2Adapter.send(:include, SqlTracer::SqlLogger)
-  SqlTracer::Formatter.print_tips
-
-  ActiveSupport.on_load(:action_controller) do
-    ActionController::Base.send(:include, SqlTracer::RequestLogger)
-  end
-rescue LoadError, NameError => e
-  Rails.logger.error('Failed to injuect SqlTracer to ActiveRecord due to :' + e.message)
-end
-
-
-
-

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sql_tracer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - qzhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: anbt-sql-formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.5
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies: []
 description: It helps you figure out what sqls are executed and trace method call
   stack
 email:
@@ -32,20 +18,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- app/assets/stylesheets/sql_tracer/application.css
+- app/assets/stylesheets/sql_tracer/style.css
+- app/controllers/sql_tracer/sql_tracer_controller.rb
+- app/views/sql_tracer/sql_tracer/index.html.erb
+- config/routes.rb
+- lib/sql_tracer.rb
+- lib/sql_tracer/adapters/mysql2.rb
+- lib/sql_tracer/adapters/postgresql.rb
+- lib/sql_tracer/adapters/sqlite.rb
+- lib/sql_tracer/adapters/sqlite3.rb
 - lib/sql_tracer/config.rb
 - lib/sql_tracer/engine.rb
 - lib/sql_tracer/formatter.rb
 - lib/sql_tracer/helper.rb
+- lib/sql_tracer/railtie.rb
 - lib/sql_tracer/request_logger.rb
 - lib/sql_tracer/sql_logger.rb
 - lib/sql_tracer/sql_stack.rb
 - lib/sql_tracer/version.rb
-- lib/sql_tracer.rb
-- config/routes.rb
-- app/assets/stylesheets/sql_tracer/application.css
-- app/assets/stylesheets/sql_tracer/style.css
-- app/controllers/sql_tracer/sql_tracer_controller.rb
-- app/views/sql_tracer/sql_tracer/index.html.erb
 homepage: https://git.dev.fwmrm.net/qzhang/sql_tracer
 licenses: []
 metadata: {}
@@ -55,18 +46,19 @@ 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.0.14.1
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: log backtrace when sql is executed
 test_files: []
+has_rdoc: