query_tracer 0.0.4 → 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx-2.0
+  - jruby
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -1 +1,13 @@
+source 'http://rubygems.org'
+
 gemspec
+
+gem "activesupport", '>= 3.0.0'
+gem "activerecord", '>= 3.0.0'
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem 'capybara'
+  gem 'sqlite3'
+end

data/README.markdown

@@ -23,7 +23,7 @@ Add following code to config/initializers/query_tracer.rb:
       tracer.colorize = true
       tracer.show_revision = true
       tracer.multiline = true
-      tracer.exclude_queries << %r{FROM sqlite_master}
+      tracer.exclude_sql << %r{FROM sqlite_master}
     end
 
     QueryTracer::Logger.attach_to :active_record

data/Rakefile

@@ -1,31 +1,8 @@
-begin
-  require "bundler"
-  Bundler.setup
-rescue LoadError
-  $stderr.puts "You need to have Bundler installed to be able build this gem."
-end
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-gemspec = eval(File.read(Dir["*.gemspec"].first))
+task :default => :spec
 
-
-desc "Validate the gemspec"
-task :gemspec do
-  gemspec.validate
-end
-
-desc "Build gem locally"
-task :build => :gemspec do
-  system "gem build #{gemspec.name}.gemspec"
-  FileUtils.mkdir_p "pkg"
-  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
-end
-
-desc "Install gem locally"
-task :install => :build do
-  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
-end
-
-desc "Clean automatically generated files"
-task :clean do
-  FileUtils.rm_rf "pkg"
-end
+desc "Test query_tracer plugin."
+RSpec::Core::RakeTask.new('spec')

data/lib/query_tracer.rb

@@ -1,4 +1,6 @@
 require 'ostruct'
+require 'active_support'
+require 'active_record'
 require 'query_tracer/tracer'
 require 'query_tracer/logger'
 require 'query_tracer/db'
@@ -8,29 +10,21 @@ 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
+      :log_level     => :debug
     })
     
-    @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.default_codepoints = [
+      '(app/presenters/.*)',
+      '(app/views/.*)',
+      '(app/controllers/.*)',
+      '(app/models/.*)',
+      '(lib/.*)',
+      '(spec/.*)',
+      '(app/.*)'
     ]
-    
-    @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
@@ -40,10 +34,30 @@ module QueryTracer
     end
     
     yield @config
+    
+    @config.root ||= ::Rails.root
+    
+    @config.include_codepoints = build_codepoints
+    
+    Logger.attach_to :active_record
   end
   
   def self.config
     @config
   end
+  
+  private
+  def self.build_codepoints
+    @config.default_codepoints.map do |cp| 
+      case cp
+      when String
+        %r{^#{@config.root}/#{cp}}
+      when Regexp
+        cp
+      else
+        nil
+      end
+    end.compact
+  end
     
 end

data/lib/query_tracer/db.rb

@@ -1,5 +1,7 @@
 require 'query_tracer/db/mysql'
+require 'query_tracer/db/mysql2'
 require 'query_tracer/db/sqlite'
+require 'query_tracer/db/sqlite3'
 
 module QueryTracer
   module Db

data/lib/query_tracer/db/mysql2.rb

@@ -0,0 +1,7 @@
+module QueryTracer
+  module Db
+    module Mysql2
+      include QueryTracer::Db::Mysql
+    end
+  end
+end

data/lib/query_tracer/db/sqlite3.rb

@@ -0,0 +1,7 @@
+module QueryTracer
+  module Db
+    module Sqlite3
+      include QueryTracer::Db::Sqlite
+    end
+  end
+end

data/lib/query_tracer/logger.rb

@@ -13,16 +13,12 @@ module QueryTracer
       sql = event.payload[:sql]
       # Skip noisy queries
       trace = Tracer.build_trace(sql)
-      return if trace.blank?
-      # We're done
-      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 = " "
+      unless trace.blank?
+        message = color("^^^^ Called from: ", YELLOW, true)
+        indent  = color("-> ", YELLOW, true)
+
+        send QueryTracer.config.log_level, message + trace.join("\n#{indent}")
       end
-      logger.send QueryTracer.config.log_level.to_sym, message + trace.join("\n#{indent}")
     end
   end
 end

data/lib/query_tracer/tracer.rb

@@ -5,26 +5,31 @@ module QueryTracer
     extend self
     
     def build_trace(sql)
-      unless skip_query?(sql)
-        # Skip noisy codepoints
-        lines = caller.inject([]) do |filtered, line|
-          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.config.multiline
-          [QueryTracer::Tracer::Revision.current, lines].flatten
-        end
-        
+      return nil if skip_query?(sql)
+
+      # Include only selected code points
+      lines = []
+      if QueryTracer.config.multiline
+        caller.each {|line| lines << line if include_line?(line)}
+      else
+        lines << caller.find {|line| include_line?(line)}
+      end
+      
+      unless lines.blank?
+        rev = QueryTracer::Tracer::Revision.current
+        lines << rev unless rev.blank?
       end
+      
+      lines
     end
 
     def skip_query?(sql)
       !QueryTracer.config.exclude_sql.select { |expr| sql =~ expr }.blank?
     end
+    
+    def include_line?(line)
+      !QueryTracer.config.include_codepoints.select{ |expr| line =~ expr }.blank?
+    end
 
   end
 end

data/lib/query_tracer/version.rb

@@ -0,0 +1,3 @@
+module QueryTracer
+  VERSION = "0.1.0"
+end

data/query_tracer.gemspec

@@ -1,30 +1,27 @@
-# coding: UTF-8
+# encoding: UTF-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'query_tracer/version'
 
 Gem::Specification.new do |s|
   s.name              = "query_tracer"
-  s.version           = "0.0.4"
-  s.platform          = Gem::Platform::RUBY
+  s.version           = QueryTracer::VERSION
   s.authors           = ["Dmitry Shaposhnik", "Dmytro Shteflyuk"]
   s.email             = ["dmitry@shaposhnik.name", "kpumuk@kpumuk.info"]
   s.homepage          = "http://github.com/daemon/query_tracer"
   s.summary           = "Query tracer and logger for Rails3"
-  s.description       = ""
-
-  s.required_rubygems_version = ">= 1.3.6"
-  
-  # If you have runtime dependencies, add them here
-  # s.add_runtime_dependency "other", "~> 1.2"
-  
-  # If you have development dependencies, add them here
-  # s.add_development_dependency "another", "= 0.9"
+  s.description       = "This library helps to find where in your rails app sql query was run."
 
   # The list of files to be contained in the gem
   s.files         = `git ls-files`.split("\n")
-  # s.executables   = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  # s.extensions    = `git ls-files ext/extconf.rb`.split("\n")
   
   s.require_path = 'lib'
 
-  # For C extensions
-  # s.extensions = "ext/extconf.rb"
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.add_dependency('activerecord', '>= 3.0.0')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('capybara')
+  
 end

data/spec/query_tracer/logger_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe QueryTracer::Logger do
+  it "should log in debug level" do
+    initialize_logger
+    QueryTracer.config.log_level.should == :debug
+  end
+  
+  it "should use colors if Rails colorize enabled" do
+    # ActiveSupport::LogSubscriber.colorize_logging = true
+    # initialize_logger
+  end
+  
+  it "should not use colors if Rails colorize disabled" do
+    # ActiveSupport::LogSubscriber.colorize_logging = false
+    # initialize_logger
+  end
+  
+end

data/spec/query_tracer/query_tracer_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe QueryTracer do
+  
+  it "should accept configuration" do
+    root = File.expand_path(File.dirname(__FILE__))
+    
+    QueryTracer.configure do |tracer|
+      tracer.enabled = true
+      tracer.show_revision = true
+      tracer.multiline = true
+      tracer.root = root
+    end
+    
+    QueryTracer.config.enabled.should be_true
+    QueryTracer.config.root.should == root
+  end
+
+  it "should load exclude_sql from db adapter" do
+    QueryTracer.config.exclude_sql.should == QueryTracer::Db::Sqlite::SKIP_QUERIES
+  end
+  
+  it "should attach logger to active_record"
+  
+end

data/spec/query_tracer/tracer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe QueryTracer::Tracer do
+  describe "SQLite" do
+    it "should skip queries from matching exclude_sql" do
+      ActiveRecord::Base.connection.stub(:adapter_name).and_return 'Sqlite'
+      initialize_logger
+      QueryTracer::Tracer.build_trace("SELECT name FROM sqlite_master WHERE type='table' ORDER BY name").should be_nil
+    end
+  end
+
+  describe "MySQL" do
+    it "should skip queries from matching exclude_sql" do
+      ActiveRecord::Base.connection.stub(:adapter_name).and_return 'Mysql'
+      initialize_logger
+      QueryTracer::Tracer.build_trace("SHOW TABLES").should be_nil
+    end
+  end
+
+  it "should produce mutliline trace if multiline enabled"
+  it "should produce only codepoint if multiline disabled"
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require "bundler/setup"
+require "active_record"
+require "active_support/all"
+require "query_tracer"
+require 'capybara/rspec'
+# require 'rspec/rails'
+
+RSpec.configure do |config|
+  
+end
+
+def initialize_logger(multiline = true, revision = true)
+  QueryTracer.configure do |tracer|
+    tracer.enabled = true
+    tracer.show_revision = multiline
+    tracer.multiline = revision
+    tracer.root = File.expand_path(File.dirname(__FILE__))
+  end
+end
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :projects, :force => true do |t|
+    t.string :name
+  end
+end
+
+class Project < ActiveRecord::Base
+  # column :name, :string
+  has_many :tasks
+  accepts_nested_attributes_for :tasks
+end
+
+ActiveRecord::Schema.define do
+  create_table :tasks, :force => true do |t|
+    t.integer :project_id
+    t.string :name
+  end
+end
+
+class Task < ActiveRecord::Base
+  # column :project_id, :integer
+  # column :name, :string
+  belongs_to :project
+end
+
+# app = Class.new(Rails::Application)
+# app.config.secret_token = "token"
+# app.config.session_store :cookie_store, :key => "_myapp_session"
+# app.config.active_support.deprecation = :log
+# app.config.action_controller.perform_caching = false
+# app.initialize!

metadata

@@ -1,82 +1,129 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: query_tracer
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Dmitry Shaposhnik
 - Dmytro Shteflyuk
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-19 00:00:00 Z
-dependencies: []
-
-description: ""
-email: 
+date: 2011-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70176486865720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176486865720
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70176486865120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176486865120
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70176486864640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176486864640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70176486863640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176486863640
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70176486863100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70176486863100
+description: This library helps to find where in your rails app sql query was run.
+email:
 - dmitry@shaposhnik.name
 - kpumuk@kpumuk.info
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - README.markdown
 - Rakefile
 - lib/query_tracer.rb
 - lib/query_tracer/db.rb
 - lib/query_tracer/db/mysql.rb
+- lib/query_tracer/db/mysql2.rb
 - lib/query_tracer/db/sqlite.rb
+- lib/query_tracer/db/sqlite3.rb
 - lib/query_tracer/logger.rb
 - lib/query_tracer/tracer.rb
 - lib/query_tracer/tracer/revision.rb
+- lib/query_tracer/version.rb
 - query_tracer.gemspec
-- test/test_helper.rb
+- spec/query_tracer/logger_spec.rb
+- spec/query_tracer/query_tracer_spec.rb
+- spec/query_tracer/tracer_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/daemon/query_tracer
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 712837335364335563
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 712837335364335563
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Query tracer and logger for Rails3
 test_files: []
-