marginalia 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+tmp

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    marginalia (1.0.0)
+      actionpack (>= 2.3, < 3.3)
+      activerecord (>= 2.3, < 3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    multi_json (1.1.0)
+    mysql (2.8.1)
+    mysql2 (0.3.11)
+    rack (1.3.6)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    tzinfo (0.3.32)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mysql
+  mysql2
+  marginalia!
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+# Copyright (c) 2012 37signals, LLC
+#
+# 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,68 @@
+# marginalia
+
+Attach comments to your ActiveRecord queries. By default, it adds the application, controller, and action names as a
+comment at the end of each query.
+
+This helps when searching log files for queries, and seeing where slow queries came from.
+
+For example, once enabled, your logs will look like:
+
+    Account Load (0.3ms)  SELECT `accounts`.* FROM `accounts` 
+    WHERE `accounts`.`queenbee_id` = 1234567890 
+    LIMIT 1 
+    /*application:BCX,controller:project_imports,action:show*/
+
+You can also these query comments with a tool like [pt-query-digest](http://www.percona.com/doc/percona-toolkit/2.1/pt-query-digest.html#query-reviews) 
+to automate identification of controllers and actions that are hotspots forslow queries.
+
+This gem was created at 37signals. You can read more about how we use it [on
+our blog](http://37signals.com/svn/posts/3130-tech-note-mysql-query-comments-in-rails).
+
+This has been tested and used in production with both the mysql and mysql2 gems, 
+tested on Rails 2.3.5 through 3.2-stable. Patches are welcome for other database adapters. 
+
+## Installation
+
+### For Rails 3.x:
+
+    gem 'marginalia'
+
+Then `bundle`, and that's it!
+
+### For Rails 2.x:
+
+If using cached externals, add to your `config/externals.yml` file.
+
+Or, if your prefer using `config.gem`, you can use:
+
+    config.gem 'marginalia'
+
+Finally, if bundled, you'll need to manually run the initialization step in an
+initializer, e.g.:
+    
+    # Gemfile
+    gem 'marginalia', :require => false
+
+    #config/initializers/marginalia.rb
+    require 'marginalia'
+    Marginalia::Railtie.insert
+
+### Customization
+Optionally, you can set the application name shown in the log like so in an initializer (e.g. `config/initializers/marginalia.rb`):
+
+    Marginalia.application_name = "BCX"
+
+For Rails 3 applications, the name will default to your Rails application name.
+For Rails 2 applications, "rails" is used as the default application name.
+
+## Contributing
+
+Start by bundling and creating the test database:
+
+    bundle
+    rake db:create
+
+Then, running `rake` will run the tests on both the `mysql` and `mysql2` adapters:
+
+    rake
+

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => ['test:all']
+
+namespace :test do
+  desc "test all drivers"
+  task :all => [:mysql, :mysql2]
+
+  desc "test mysql driver"
+  task :mysql do
+    sh "DRIVER=mysql ruby -Ilib -Itest test/*_test.rb"
+  end
+
+  desc "test mysql2 driver"
+  task :mysql2 do
+    sh "DRIVER=mysql2 ruby -Ilib -Itest test/*_test.rb"
+  end
+end
+
+namespace :db do
+  desc "reset database"
+  task :reset => [:drop, :create]
+
+  desc "create database"
+  task :create do
+    sh 'mysql -u root -e "create database marginalia_test;"'
+  end
+
+  desc "drop database"
+  task :drop do
+    sh 'mysql -u root -e "drop database marginalia_test;"'
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'marginalia/railtie'
+Marginalia::Railtie.insert

data/lib/marginalia/railtie.rb

@@ -0,0 +1,53 @@
+require 'marginalia'
+
+module Marginalia
+  if defined? Rails::Railtie
+    require 'rails/railtie'
+
+    class Railtie < Rails::Railtie
+      initializer 'marginalia.insert' do
+        ActiveSupport.on_load :active_record do
+          Marginalia::Railtie.insert_into_active_record
+        end
+
+        ActiveSupport.on_load :action_controller do
+          Marginalia::Railtie.insert_into_action_controller
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      insert_into_active_record
+      insert_into_action_controller
+    end
+
+    def self.insert_into_action_controller
+      ActionController::Base.class_eval do
+        def record_query_comment
+          Marginalia.comment = "application:#{Marginalia.application_name || "rails"},controller:#{controller_name},action:#{action_name}"
+          yield
+        ensure
+          Marginalia.comment = nil
+        end
+        around_filter :record_query_comment
+      end
+    end
+
+    def self.insert_into_active_record
+      if defined? ActiveRecord::ConnectionAdapters::Mysql2Adapter
+        ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
+        end
+      end
+
+      if defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
+        end
+      end
+
+    end
+  end
+end

data/lib/marginalia.rb

@@ -0,0 +1,22 @@
+require 'marginalia/railtie'
+
+module Marginalia
+  mattr_accessor :comment, :application_name
+
+  module ActiveRecordInstrumentation
+    def self.included(instrumented_class)
+      if defined? Rails.application
+        Marginalia.application_name = Rails.application.class.name.split("::").first
+      end
+      instrumented_class.class_eval do
+        alias_method :execute_without_marginalia, :execute
+        alias_method :execute, :execute_with_marginalia
+      end
+    end
+
+    def execute_with_marginalia(sql, name = nil)
+      execute_without_marginalia("#{sql} /*#{Marginalia.comment}*/", name)
+    end
+  end
+
+end

data/marginalia.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ["Noah Lorang", "Nick Quaranto", "Taylor Weibley"]
+  gem.email         = ["noah@37signals.com"]
+  gem.homepage      = "https://github.com/37signals/marginalia"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test}/*`.split("\n")
+  gem.name          = "marginalia"
+  gem.require_paths = ["lib"]
+  gem.version       = "1.0.0"
+
+  gem.add_runtime_dependency "actionpack", ">= 2.3", "< 3.3"
+  gem.add_runtime_dependency "activerecord", ">= 2.3", "< 3.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "mysql"
+  gem.add_development_dependency "mysql2"
+
+  gem.summary = description = %q{Attach comments to your ActiveRecord queries.}
+end

data/test/query_comments_test.rb

@@ -0,0 +1,64 @@
+require 'test/unit'
+require 'logger'
+require 'pp'
+require 'active_record'
+require 'action_controller'
+require 'marginalia'
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => ENV["DRIVER"] || "mysql",
+  :host     => "localhost",
+  :username => "root",
+  :database => "marginalia_test"
+})
+
+class Post < ActiveRecord::Base
+end
+
+class PostsController < ActionController::Base
+  def driver_only
+    ActiveRecord::Base.connection.execute "select id from posts"
+    render :nothing => true
+  end
+end
+
+unless Post.table_exists?
+  ActiveRecord::Schema.define do
+    create_table "posts", :force => true do |t|
+    end
+  end
+end
+
+Marginalia::Railtie.insert
+
+class MarginaliaTest < Test::Unit::TestCase
+  def setup
+    @queries = []
+    ActiveSupport::Notifications.subscribe "sql.active_record" do |*args|
+      @queries << args.last[:sql]
+    end
+    @env = Rack::MockRequest.env_for('/')
+  end
+
+  def test_query_commenting_on_mysql_driver_with_no_action
+    ActiveRecord::Base.connection.execute "select id from posts"
+    assert_match %r{select id from posts /\*\*/$}, @queries.first
+  end
+
+  def test_query_commenting_on_mysql_driver_with_action
+    PostsController.action(:driver_only).call(@env)
+    assert_match %r{select id from posts /\*application:rails,controller:posts,action:driver_only\*/$}, @queries.first
+  end
+
+  def test_configuring_application
+    Marginalia.application_name = "customapp"
+    PostsController.action(:driver_only).call(@env)
+
+    assert_match %r{/\*application:customapp,controller:posts,action:driver_only\*/$}, @queries.first
+  end
+
+  def teardown
+    Marginalia.application_name = nil
+    ActiveSupport::Notifications.unsubscribe "sql.active_record"
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: marginalia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Noah Lorang
+- Nick Quaranto
+- Taylor Weibley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &13238580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *13238580
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &13237460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *13237460
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &13236300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *13236300
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: &13235060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *13235060
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &13234220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *13234220
+description: 
+email:
+- noah@37signals.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/marginalia.rb
+- lib/marginalia/railtie.rb
+- marginalia.gemspec
+- test/query_comments_test.rb
+homepage: https://github.com/37signals/marginalia
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Attach comments to your ActiveRecord queries.
+test_files: []