sql_tagger 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 SlideShare Inc.
+
+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.rdoc

@@ -0,0 +1,14 @@
+= sql_tagger
+
++sql_tagger+ is a gem that inserts comments into SQL queries. These comments
+include a string from <tt>Kernel#caller</tt> that (hopefully) reveals what Ruby
+code was responsible for performing the query.
+
+To use this, just require the appropriate file. For example, to use this with
+the +mysql+ gem, perform <tt>require 'sql_tagger/mysql'</tt> instead of
+<tt>require 'mysql'</tt>.
+
+Before:
+    SELECT 1
+After:
+    /* program.rb:25:in `some_method' */ SELECT 1

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/sql_tagger/mysql.rb

@@ -0,0 +1,21 @@
+require 'sql_tagger'
+require 'mysql'
+
+class Mysql
+  include SqlTagger::Initializer
+
+  # @see Mysql#query
+  def query_with_sql_tagger(sql, &block)
+    query_without_sql_tagger(@sql_tagger.tag(sql), &block)
+  end
+
+  # @see Mysql#prepare
+  def prepare_with_sql_tagger(query)
+    prepare_without_sql_tagger(@sql_tagger.tag(query))
+  end
+
+  ['query', 'prepare'].each do |method|
+    alias_method "#{method}_without_sql_tagger", method
+    alias_method method, "#{method}_with_sql_tagger"
+  end
+end

data/lib/sql_tagger.rb

@@ -0,0 +1,68 @@
+require 'set'
+
+# Instances of this class insert stack trace comments into SQL queries.
+class SqlTagger
+  VERSION = IO.read(
+    File.join(File.dirname(__FILE__), '..', 'VERSION')
+  ).chomp.freeze
+
+  # @return [Regexp]
+  #   regular expression used to match stack strings we should skip (usually
+  #   because such stack strings aren't specific enough, like stack strings
+  #   where the file belongs to a gem)
+  attr_accessor :exclusion_pattern
+
+  # @return [Set] set that holds stack strings we skipped before
+  attr_reader :exclusion_cache
+
+  def initialize
+    @exclusion_pattern = /^#{RbConfig::CONFIG['prefix']}|\/vendor\//
+    @exclusion_cache = Set.new
+  end
+
+  # Returns the given query string with a string from +Kernel#caller+ prepended
+  # as a comment that reveals what code triggered the query.
+  #
+  # For example, given "SELECT 1", this will return something like
+  # "/* program.rb:25:in `some_method' */ SELECT 1".
+  #
+  # @param [String] sql SQL query string
+  # @return [String] query string with a comment at the beginning
+  def tag(sql)
+    caller(2).each do |string|
+      next if @exclusion_cache.member?(string)
+      if string !~ @exclusion_pattern
+        return "/* #{string} */ #{sql}"
+      else
+        @exclusion_cache.add(string)
+      end
+    end
+
+    # Just in case we skip the whole stack somehow ...
+    "/* SqlTagger#tag skipped the whole stack */ #{sql}"
+  end
+
+  @default = self.new
+
+  class << self
+    # @return [SqlTagger] default SqlTagger to use
+    attr_accessor :default
+  end
+
+  # Mixin that monkey patches the receiver's +initialize+ method to set
+  # +@sql_tagger+.
+  module Initializer
+    def self.included(base)
+      base.send(:alias_method, :initialize_without_sql_tagger, :initialize)
+      base.send(:alias_method, :initialize, :initialize_with_sql_tagger)
+    end
+
+    # @return [SqlTagger] the SqlTagger used to tag queries for this instance
+    attr_accessor :sql_tagger
+
+    def initialize_with_sql_tagger(*args, &block)
+      @sql_tagger = SqlTagger.default
+      initialize_without_sql_tagger(*args, &block)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+shared_examples_for 'connections with sql_tagger' do
+  it 'assigns SqlTagger.default to @sql_tagger' do
+    @db.sql_tagger.should == SqlTagger.default
+  end
+end

data/spec/sql_tagger/mysql_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'sql_tagger/mysql'
+
+describe Mysql do
+  before :all do
+    @db = Mysql.new
+  end
+
+  after :all do
+    @db.close
+  end
+
+  it_should_behave_like 'connections with sql_tagger'
+
+  describe '#query' do
+    it 'works' do
+      result = @db.query('SELECT 2')
+      result.fetch_row.should == ['2']
+      result.free
+    end
+
+    it 'works when given a block' do
+      @db.query('SELECT 5') do |result|
+        result.fetch_row.should == ['5']
+      end
+    end
+
+    it 'calls SqlTagger#tag' do
+      @db.sql_tagger.should_receive(:tag).and_return('/* something.rb */ SELECT 1')
+      @db.query('SELECT 1').free
+    end
+  end
+
+  describe '#prepare' do
+    it 'works' do
+      stmt = @db.prepare('SELECT ?')
+      stmt.execute(9)
+      stmt.fetch.should == ['9']
+      stmt.free_result
+      stmt.close
+    end
+
+    it 'calls SqlTagger#tag' do
+      @db.sql_tagger.should_receive(:tag).and_return('/* something.rb */ SELECT 1')
+      @db.prepare('SELECT 1').close
+    end
+  end
+end

data/spec/sql_tagger_spec.rb

@@ -0,0 +1,58 @@
+require 'sql_tagger'
+
+describe SqlTagger do
+  describe '#tag' do
+    before :each do
+      @sql_tagger = SqlTagger.new
+      prefix = '/usr'
+      @sql_tagger.exclusion_pattern = /^#{prefix}/
+
+      @stack_strings_to_skip = [
+        "#{prefix}/lib//gems/activerecord-2.3.5/lib/active_record/base.rb:500",
+        "#{prefix}//gems/actionpack-2.3.5/lib/something.rb:20",
+      ]
+      @valid_stack_string = '/home/app/myapp/lib/user.rb:150'
+      @caller_result = @stack_strings_to_skip + [@valid_stack_string]
+      @sql_tagger.stub!(:caller => @caller_result)
+
+      @sql = 'SELECT 1'
+    end
+
+    it 'skips stack strings that match @exclusion_pattern' do
+      @sql_tagger.tag(@sql).should == "/* #{@valid_stack_string} */ #{@sql}"
+    end
+
+    it 'returns the 1st stack string that does not match @exclusion_pattern' do
+      @caller_result.push(
+        '/home/app/myapp/lib/document.rb:788',
+        '/home/app/myapp/runner.rb:29'
+      )
+      @sql_tagger.tag(@sql).should == "/* #{@valid_stack_string} */ #{@sql}"
+    end
+
+    it 'adds skipped stack strings into @exclusion_cache' do
+      @sql_tagger.exclusion_cache.should be_empty
+      @sql_tagger.tag(@sql)
+      @stack_strings_to_skip.each do |string|
+        @sql_tagger.exclusion_cache.should include(string)
+      end
+      @sql_tagger.exclusion_cache.size.should == @stack_strings_to_skip.length
+    end
+
+    it 'skips strings in @exclusion_cache' do
+      correct_string = '/home/myapp/i.rb:2890'
+      @caller_result.push(correct_string)
+      @sql_tagger.exclusion_cache.add(@valid_stack_string)
+      @sql_tagger.tag(@sql).should == "/* #{correct_string} */ #{@sql}"
+    end
+  end
+
+  describe '.default' do
+    it 'returns a functional SqlTagger' do
+      SqlTagger.default.should be_a(SqlTagger)
+      # The following is to ensure that SqlTagger.default is set after
+      # #initialize is defined.
+      SqlTagger.default.exclusion_pattern.should be_a(Regexp)
+    end
+  end
+end

data/sql_tagger.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = 'sql_tagger'
+  s.version = IO.read('VERSION').chomp
+  s.authors = ['Toby Hsieh']
+  s.homepage = 'https://github.com/SlideShareInc/sql_tagger'
+  s.summary = 'Stack trace comments for SQL queries'
+  s.description = 'sql_tagger inserts stack trace comments into SQL queries.'
+
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('mysql')
+
+  s.files = ['MIT-LICENSE', 'README.rdoc', 'VERSION', 'sql_tagger.gemspec'] +
+    Dir.glob('lib/**/*')
+
+  s.test_files = Dir.glob('spec/**/*')
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: sql_tagger
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Toby Hsieh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: sql_tagger inserts stack trace comments into SQL queries.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.rdoc
+- VERSION
+- sql_tagger.gemspec
+- lib/sql_tagger/mysql.rb
+- lib/sql_tagger.rb
+- spec/spec_helper.rb
+- spec/sql_tagger/mysql_spec.rb
+- spec/sql_tagger_spec.rb
+has_rdoc: true
+homepage: https://github.com/SlideShareInc/sql_tagger
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Stack trace comments for SQL queries
+test_files: 
+- spec/spec_helper.rb
+- spec/sql_tagger/mysql_spec.rb
+- spec/sql_tagger_spec.rb