marginalia 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcc2f32dfc16f2e22667bcab682490c5428aa70f
-  data.tar.gz: f76f558831423192621127cc4b5de1a042bed3c9
+  metadata.gz: 5352b63598e762229b9f6a9a7b4b0b27dc42a277
+  data.tar.gz: d45c0855bf418e0dd277e553b5fe45d47b6d3a57
 SHA512:
-  metadata.gz: 05331b951bb74bcfffeeda0873b9d66b7919e97a66a764c07b0f7dcfef088266bf08c0552d16652b20f9ffcdaa3f526af8d828d9bffe97cacd8869a3bf0326f9
-  data.tar.gz: 09ed9f59adc63e455abf796fc5ef365c7756e992a1894643982ac85e3fee5257d61b6f26c0f72104f71fdc9658c1e7f11a19aa5ffbc92e62c028b7445b56e862
+  metadata.gz: 7895a8c8318f85bfb18aa2ba90f8223eaacd54b190d6adc45aff3f139c3ed6a494858c644095b2edcf608f42f9d0c5e4c48bbf432ac0a1c523b7d3c411e2ce1f
+  data.tar.gz: 8e5493b2233a05245de9f6c4b1d346b08cbe3dd6de0021e037a73e1cea35da8599469198802c459306bbd0168974ebc210d1cf8d62f88d48a61e9df7bfa1ed33

data/.travis.yml

@@ -1,10 +1,21 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
+
+sudo: false
+
 script: bundle exec rake db:reset test:all
+
 env:
   - "RAILS_VERSION=3.1.12"
-  - "RAILS_VERSION=3.2.16"
-  - "RAILS_VERSION=4.0.2"
+  - "RAILS_VERSION=3.2.19"
+  - "RAILS_VERSION=4.0.8"
+  - "RAILS_VERSION=4.1.8"
+  - "RAILS_VERSION=4.2.0"
+  - "RAILS_VERSION=3.2.19 TEST_RAILS_API=true"
+  - "RAILS_VERSION=4.0.8 TEST_RAILS_API=true"
+  - "RAILS_VERSION=4.1.8 TEST_RAILS_API=true"
+  - "RAILS_VERSION=4.2.0 TEST_RAILS_API=true"

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 version = ENV["RAILS_VERSION"] || "4.0.2"
+rails_api = ENV["TEST_RAILS_API"] == "true"
 
 rails = case version
 when "master"
@@ -12,3 +13,7 @@ else
 end
 
 gem "rails", rails
+
+if rails_api
+  gem "rails-api", "~> 0.2.1"
+end

data/README.md

@@ -1,4 +1,4 @@
-# marginalia [![Build Status](https://secure.travis-ci.org/basecamp/marginalia.png?branch=master)](http://travis-ci.org/basecamp/marginalia)
+# marginalia [![Build Status](https://travis-ci.org/basecamp/marginalia.svg?branch=master)](https://travis-ci.org/basecamp/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.
@@ -13,24 +13,24 @@ For example, once enabled, your logs will look like:
     /*application:BCX,controller:project_imports,action:show*/
 
 You can also use these query comments along 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.
+to automate identification of controllers and actions that are hotspots for slow 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. It has also been tested for sqlite3 and postgres.
+tested on Rails 2.3.5 through 4.1.x. It has also been tested for sqlite3 and postgres.
 
 Patches are welcome for other database adapters. 
 
 ## Installation
 
-### For Rails 3.x:
+### For Rails 3.x and 4.x:
 
     # Gemfile
     gem 'marginalia'
     
-    #config/application.rb
+    # config/application.rb
     require 'marginalia/railtie'
 
 
@@ -91,6 +91,8 @@ default. In addition, implementation is provided for:
   * `:line` (for file and line number calling query). :line supports
     a configuration by setting a regexp in `Marginalia::Comment.lines_to_ignore`
     to exclude parts of the stacktrace from inclusion in the line comment.
+  * `:controller_with_namespace` to include the full classname (including namespace)
+    of the controller.
 
 Pull requests for other included comment components are welcome.
 
@@ -99,9 +101,10 @@ Pull requests for other included comment components are welcome.
 Start by bundling and creating the test database:
 
     bundle
-    rake db:create
+    rake db:mysql:create
+    rake db:postgresql:create
 
-Then, running `rake` will run the tests on both the `mysql` and `mysql2` adapters:
+Then, running `rake` will run the tests on all the database adapters (`mysql`, `mysql2`, `postgresql` and `sqlite`):
 
     rake
 

data/lib/marginalia.rb

@@ -6,7 +6,6 @@ module Marginalia
 
   module ActiveRecordInstrumentation
     def self.included(instrumented_class)
-      Marginalia::Comment.components = [:application, :controller, :action]
       instrumented_class.class_eval do
         if instrumented_class.method_defined?(:execute)
           alias_method :execute_without_marginalia, :execute

data/lib/marginalia/comment.rb

@@ -3,6 +3,7 @@ require 'socket'
 module Marginalia
   module Comment
     mattr_accessor :components, :lines_to_ignore
+    Marginalia::Comment.components ||= [:application, :controller, :action]
 
     def self.update!(controller = nil)
       @controller = controller
@@ -13,10 +14,10 @@ module Marginalia
       self.components.each do |c|
         component_value = self.send(c)
         if component_value.present?
-          ret << ',' if ret.present?
-          ret << c.to_s << ':' << component_value.to_s
+          ret << "#{c.to_s}:#{component_value.to_s},"
         end
       end
+      ret.chop!
       ret
     end
 
@@ -26,7 +27,7 @@ module Marginalia
 
     private
       def self.application
-        if defined? Rails.application
+        if defined?(Rails.application)
           Marginalia.application_name ||= Rails.application.class.name.split("::").first
         else
           Marginalia.application_name ||= "rails"
@@ -39,6 +40,10 @@ module Marginalia
         @controller.controller_name if @controller.respond_to? :controller_name
       end
 
+      def self.controller_with_namespace
+        @controller.class.name if @controller
+      end
+
       def self.action
         @controller.action_name if @controller.respond_to? :action_name
       end
@@ -71,6 +76,11 @@ module Marginalia
         Process.pid
       end
 
+      def self.request_id
+        if @controller.respond_to?(:request) && @controller.request.respond_to?(:uuid)
+          @controller.request.uuid
+        end
+      end
   end
 
 end

data/lib/marginalia/railtie.rb

@@ -24,7 +24,7 @@ module Marginalia
     end
 
     def self.insert_into_action_controller
-      ActionController::Base.class_eval do
+      controller_instrumentation = <<-EOS
         def record_query_comment
           Marginalia::Comment.update!(self)
           yield
@@ -32,40 +32,36 @@ module Marginalia
           Marginalia::Comment.clear!
         end
         around_filter :record_query_comment
+      EOS
+      ActionController::Base.class_eval(controller_instrumentation)
+      if defined? ActionController::API
+        ActionController::API.class_eval(controller_instrumentation)
       end
     end
 
     def self.insert_into_active_record
       if defined? ActiveRecord::ConnectionAdapters::Mysql2Adapter
-        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
-          ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
-            include Marginalia::ActiveRecordInstrumentation
-          end
+        ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
         end
       end
 
       if defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
-        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
-          ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
-            include Marginalia::ActiveRecordInstrumentation
-          end
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
         end
       end
 
       # SQL queries made through PostgreSQLAdapter#exec_delete will not be annotated.
       if defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
-        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
-            include Marginalia::ActiveRecordInstrumentation
-          end
+        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
         end
       end
 
       if defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
-        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
-          ActiveRecord::ConnectionAdapters::SQLite3Adapter.module_eval do
-            include Marginalia::ActiveRecordInstrumentation
-          end
+        ActiveRecord::ConnectionAdapters::SQLite3Adapter.module_eval do
+          include Marginalia::ActiveRecordInstrumentation
         end
       end
     end

data/marginalia.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test}/*`.split("\n")
   gem.name          = "marginalia"
   gem.require_paths = ["lib"]
-  gem.version       = "1.1.5"
+  gem.version       = "1.2.0"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"

data/test/query_comments_test.rb

@@ -1,10 +1,41 @@
 # -*- coding: utf-8 -*-
-require 'test/unit'
+require 'rails/version'
+
+def using_rails_api?
+  ENV["TEST_RAILS_API"] == true
+end
+
+def request_id_available?
+  Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.2')
+end
+
+require "minitest/autorun"
 require 'mocha/test_unit'
 require 'logger'
 require 'pp'
 require 'active_record'
 require 'action_controller'
+
+if request_id_available?
+  require 'action_dispatch/middleware/request_id'
+end
+
+if using_rails_api?
+  require 'rails-api/action_controller/api'
+end
+
+# Shim for compatibility with older versions of MiniTest
+MiniTest::Test = MiniTest::Unit::TestCase unless defined?(MiniTest::Test)
+
+# From version 4.1, ActiveRecord expects `Rails.env` to be
+# defined if `Rails` is defined
+if defined?(Rails) && !defined?(Rails.env)
+  module Rails
+    def self.env
+    end
+  end
+end
+
 require 'marginalia'
 RAILS_ROOT = File.expand_path(File.dirname(__FILE__))
 
@@ -25,6 +56,22 @@ class PostsController < ActionController::Base
   end
 end
 
+module API
+  module V1
+    class PostsController < ::PostsController
+    end
+  end
+end
+
+if using_rails_api?
+  class PostsApiController < ActionController::API
+    def driver_only
+      ActiveRecord::Base.connection.execute "select id from posts"
+      head :no_content
+    end
+  end
+end
+
 unless Post.table_exists?
   ActiveRecord::Schema.define do
     create_table "posts", :force => true do |t|
@@ -34,7 +81,8 @@ end
 
 Marginalia::Railtie.insert
 
-class MarginaliaTest < Test::Unit::TestCase
+
+class MarginaliaTest < MiniTest::Test
   def setup
     @queries = []
     ActiveSupport::Notifications.subscribe "sql.active_record" do |*args|
@@ -65,20 +113,33 @@ class MarginaliaTest < Test::Unit::TestCase
   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
+
+    if using_rails_api?
+      PostsApiController.action(:driver_only).call(@env)
+      assert_match %r{select id from posts /\*application:rails,controller:posts_api,action:driver_only\*/$}, @queries.second
+    end
   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
+
+    if using_rails_api?
+      PostsApiController.action(:driver_only).call(@env)
+      assert_match %r{/\*application:customapp,controller:posts_api,action:driver_only\*/$}, @queries.second
+    end
   end
 
   def test_configuring_query_components
     Marginalia::Comment.components = [:controller]
     PostsController.action(:driver_only).call(@env)
-
     assert_match %r{/\*controller:posts\*/$}, @queries.first
+
+    if using_rails_api?
+      PostsApiController.action(:driver_only).call(@env)
+      assert_match %r{/\*controller:posts_api\*/$}, @queries.second
+    end
   end
 
   def test_last_line_component
@@ -104,11 +165,39 @@ class MarginaliaTest < Test::Unit::TestCase
     Marginalia::Comment.components = [:hostname, :pid]
     PostsController.action(:driver_only).call(@env)
     assert_match %r{/\*hostname:#{Socket.gethostname},pid:#{Process.pid}\*/$}, @queries.first
+  end
 
+  def test_controller_with_namespace
+    Marginalia::Comment.components = [:controller_with_namespace]
+    API::V1::PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*controller_with_namespace:API::V1::PostsController}, @queries.first
+  end
+
+  if request_id_available?
+    def test_request_id
+      @env["action_dispatch.request_id"] = "some-uuid"
+      Marginalia::Comment.components = [:request_id]
+      PostsController.action(:driver_only).call(@env)
+      assert_match %r{/\*request_id:some-uuid.*}, @queries.first
+
+      if using_rails_api?
+        PostsApiController.action(:driver_only).call(@env)
+        assert_match %r{/\*request_id:some-uuid.*}, @queries.second
+      end
+    end
+
+  else
+    def test_request_id_is_noop_on_old_rails
+      @env["action_dispatch.request_id"] = "some-uuid"
+      Marginalia::Comment.components = [:request_id]
+      PostsController.action(:driver_only).call(@env)
+      assert_match %r{^select id from posts$}, @queries.first
+    end
   end
 
   def teardown
     Marginalia.application_name = nil
+    Marginalia::Comment.lines_to_ignore = nil
     Marginalia::Comment.components = [:application, :controller, :action]
     ActiveSupport::Notifications.unsubscribe "sql.active_record"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Noah Lorang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack