sql_origin 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@sql_origin --create

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem 'rails', '~> 3.2'
+
+group :development do
+  gem 'yard'
+  gem 'redcarpet'
+
+  gem 'bundler'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.6)
+      actionpack (= 3.2.6)
+      mail (~> 2.4.4)
+    actionpack (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activerecord (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.3)
+    json (1.7.3)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.6)
+      actionmailer (= 3.2.6)
+      actionpack (= 3.2.6)
+      activerecord (= 3.2.6)
+      activeresource (= 3.2.6)
+      activesupport (= 3.2.6)
+      bundler (~> 1.0)
+      railties (= 3.2.6)
+    railties (3.2.6)
+      actionpack (= 3.2.6)
+      activesupport (= 3.2.6)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.2)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  rails (~> 3.2)
+  redcarpet
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tim Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+SQL:Origin
+==========
+
+Adds backtraces to your SQL queries and query logs, so you know where your
+queries are coming from. This only works with Rails, and is only tested with
+Rails 3.2.
+
+Why do I want this?
+-------------------
+
+Simple. To turn this
+
+![Without backtrace logging](https://img.skitch.com/20120614-b5bw4bqxsitde6ej6776was6tx.png)
+
+into this.
+
+![With backtrace logging](https://img.skitch.com/20120614-kcisbjqiaxfwbq82wbjm4iumfa.png)
+
+So now, you needn't wonder where that odd-looking or broken SQL query is coming
+from.
+
+It can also turn this
+
+````
+Reading mysql slow query log from /usr/local/mysql/data/mysqld51-apple-slow.log
+Count: 1  Time=4.32s (4s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT "events".* FROM "events" WHERE "events"."bug_id" = ?
+
+Count: 3  Time=2.53s (7s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT "deploys".* FROM "deploys" WHERE "deploys"."id" = ?
+
+Count: 3  Time=2.13s (6s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT * FROM "slugs" WHERE (LOWER("slugs"."slug") = LOWER(?) AND "slugs"."scope" IS NULL AND "slugs"."sluggable_type" = ?) LIMIT 1
+````
+
+into this.
+
+````
+Reading mysql slow query log from /usr/local/mysql/data/mysqld51-apple-slow.log
+Count: 1  Time=4.32s (4s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT "events".* FROM "events" WHERE "events"."bug_id" = ? /* app/models/project.rb:125:in `_callback_after_617' */
+
+Count: 3  Time=2.53s (7s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT "deploys".* FROM "deploys" WHERE "deploys"."id" = ? /* app/controllers/projects_controller.rb:359:in `require_or_load' */
+
+Count: 3  Time=2.13s (6s)  Lock=0.00s (0s)  Rows=0.0 (0), root[root]@localhost
+ SELECT * FROM "slugs" WHERE (LOWER("slugs"."slug") = LOWER(?) AND "slugs"."scope" IS NULL AND "slugs"."sluggable_type" = ?) LIMIT 1 /* app/models/observers/bug_observer.rb:23:in `create_open_event' */
+````
+
+Installation
+------------
+
+To use, add SQL:Origin to your Gemfile:
+
+```` ruby
+gem 'sql_origin'
+````
+
+If you would like to add three-line backtraces below every SQL query in your
+Rails log, add
+
+```` ruby
+SQLOrigin.append_to_log
+````
+
+somewhere in your Rails initialization (e.g., `application.rb` or a
+`config/initializer` file).
+
+If you would like to add a one-line backtrace comment to every SQL query, add
+
+```` ruby
+SQLOrigin.append_to_query
+````
+
+somewhere in your Rails initialization.
+
+It would be typical to enable `append_to_log` for development and test, and
+`append_to_query` for production, in order to keep production logs small.
+
+### Backtrace Filtering
+
+By default, files not under your Rails root, and files under `vendor`, are
+filtered from your backtrace. If you need to filter other files, add them to
+{SQLOrigin::LIBRARY_PATHS}:
+
+```` ruby
+SQLOrigin::LIBRARY_PATHS << 'config/initializers/active_record_hacks.rb'
+````

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "sql_origin"
+  gem.homepage    = "http://github.com/RISCfuture/sql_origin"
+  gem.license     = "MIT"
+  gem.summary     = %Q{Add backtraces to your query log and queries themselves.}
+  gem.description = %Q{Ever wonder where a SQL query comes from? This gem lets you add abbreviated backtraces to those queries, either in the query log, or as a comment in the query itself.}
+  gem.email       = "rubygems@timothymorgan.info"
+  gem.authors     = ["Tim Morgan"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'yard'
+YARD::Rake::YardocTask.new('doc') do |doc|
+  doc.options << '-m' << 'markdown' << '-M' << 'redcarpet'
+  doc.options << '--protected' << '--no-private'
+  doc.options << '-r' << 'README.md'
+  doc.options << '-o' << 'doc'
+  doc.options << '--title' << 'SQL:Origin Documentation'
+
+  doc.files = %w( lib/**/* README.md )
+end                                                              

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sql_origin/hooks.rb

@@ -0,0 +1,50 @@
+module SQLOrigin
+  # @private
+  module LogHook
+    def log(sql, name = "SQL", binds = [])
+      @instrumenter.instrument(
+          "sql.active_record",
+          :sql           => sql,
+          :name          => name,
+          :connection_id => object_id,
+          :binds         => binds,
+          :backtrace     => SQLOrigin.filtered_backtrace[0, 3]) { yield }
+    rescue Exception => e
+      message = "#{e.class.name}: #{e.message}: #{sql}"
+      @logger.debug message if @logger
+      exception = translate_exception(e, message)
+      exception.set_backtrace e.backtrace
+      raise exception
+    end
+  end
+
+  # @private
+  module LogSubscriber
+    extend ActiveSupport::Concern
+    included { alias_method_chain :sql, :backtrace }
+
+    def sql_with_backtrace(event)
+      sql_without_backtrace event
+
+      if event.payload[:backtrace].any?
+        event.payload[:backtrace].each do |line|
+          debug "    #{color line, "\e[90m", false}"
+        end
+      end
+    end
+  end
+
+  # @private
+  module QueryAppendHook
+    extend ActiveSupport::Concern
+    included { alias_method_chain :execute, :backtrace }
+
+    def execute_with_backtrace(sql, name=nil, binds=[])
+      if (line = SQLOrigin.filtered_backtrace.first)
+        execute_without_backtrace "#{sql} /* #{line} */", name, binds
+      else
+        execute_without_backtrace sql, name, binds
+      end
+    end
+  end
+end

data/lib/sql_origin.rb

@@ -0,0 +1,44 @@
+# Container module for all SQL:Origin methods.
+
+module SQLOrigin
+  # Paths or path prefixes that are filtered from the backtrace.
+  LIBRARY_PATHS = %w(
+    vendor
+  )
+
+  # @return [Array<String>] The backtrace less library paths.
+
+  def self.filtered_backtrace
+    caller.map do |line|
+      line.sub /^#{Regexp.escape Rails.root.to_s}\//, ''
+    end.select do |line|
+      !line.starts_with?("/") &&
+          LIBRARY_PATHS.none? { |path| line.starts_with?(path) }
+    end
+  end
+
+  # Enables SQL:Origin backtrace logging to the Rails log.
+
+  def self.append_to_log
+    %w( PostgreSQLAdapter MysqlAdapter Mysql2Adapter OracleAdapter SQLiteAdapter ).each do |name|
+      adapter = ActiveRecord::ConnectionAdapters.const_get(name.to_sym) rescue nil
+      if adapter
+        adapter.send :include, SQLOrigin::LogHook
+      end
+    end
+    ActiveRecord::LogSubscriber.send :include, SQLOrigin::LogSubscriber
+  end
+
+  # Enables SQL:Origin backtrace logging to SQL query comments.
+
+  def self.append_to_query
+    %w( PostgreSQLAdapter MysqlAdapter Mysql2Adapter OracleAdapter SQLiteAdapter ).each do |name|
+      adapter = ActiveRecord::ConnectionAdapters.const_get(name.to_sym) rescue nil
+      if adapter
+        adapter.send :include, SQLOrigin::QueryAppendHook
+      end
+    end
+  end
+end
+
+require 'sql_origin/hooks'

data/sql_origin.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sql_origin"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Morgan"]
+  s.date = "2012-06-14"
+  s.description = "Ever wonder where a SQL query comes from? This gem lets you add abbreviated backtraces to those queries, either in the query log, or as a comment in the query itself."
+  s.email = "rubygems@timothymorgan.info"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sql_origin.rb",
+    "lib/sql_origin/hooks.rb",
+    "sql_origin.gemspec"
+  ]
+  s.homepage = "http://github.com/RISCfuture/sql_origin"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Add backtraces to your query log and queries themselves."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.2"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.2"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.2"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sql_origin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ever wonder where a SQL query comes from? This gem lets you add abbreviated
+  backtraces to those queries, either in the query log, or as a comment in the query
+  itself.
+email: rubygems@timothymorgan.info
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/sql_origin.rb
+- lib/sql_origin/hooks.rb
+- sql_origin.gemspec
+homepage: http://github.com/RISCfuture/sql_origin
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -915926160300598218
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add backtraces to your query log and queries themselves.
+test_files: []