marginalia 1.0.3 → 1.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    marginalia (1.0.2)
+    marginalia (1.1.0)
       actionpack (>= 2.3, < 3.3)
       activerecord (>= 2.3, < 3.3)
 

data/README.md

@@ -27,9 +27,12 @@ Patches are welcome for other database adapters.
 
 ### For Rails 3.x:
 
+    # Gemfile
     gem 'marginalia'
+    
+    #config/application.rb
+    require 'marginalia/railtie'
 
-Then `bundle`, and that's it!
 
 ### For Rails 2.x:
 
@@ -57,6 +60,40 @@ Optionally, you can set the application name shown in the log like so in an init
 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.
 
+You can also configure the components of the comment that will be appended,
+by setting `Marginalia::Comment.components`. By default, this is set to:
+
+    Marginalia::Comment.components = [:application, :controller, :action]
+
+Which results in a comment of
+`application:#{application_name},controller:#{controller.name},action:#{action_name}`.
+
+You can re-order or remove these components. You can also add additional
+comment components of your desire by defining new module methods for
+`Marginalia::Comment` which return a string. For example:
+
+    module Marginalia
+      module Comment
+        def self.mycommentcomponent
+          "TEST"
+        end
+      end
+    end
+
+    Marginalia::Comment.components = [:application, :mycommentcomponent]
+
+Which will result in a comment like
+`application:#{application_name},mycommentcomponent:TEST`
+The calling controller is available to these methods via `@controller`.
+
+Marginalia ships with `:application`, `:controller`, and `:action` enabled by
+default. In addition, implementation is provided for:
+  * `:line` (for file and line number calling query). :line supports
+    a configuration by setting a regexp in `Marignalia::Comment.lines_to_ignore`
+    to exclude parts of the stacktrace from inclusion in the line comment.
+
+Pull requests for other included comment components are welcome.
+
 ## Contributing
 
 Start by bundling and creating the test database:

data/lib/marginalia.rb

@@ -1,13 +1,12 @@
 require 'marginalia/railtie'
+require 'marginalia/comment'
 
 module Marginalia
-  mattr_accessor :comment, :application_name
+  mattr_accessor :application_name
 
   module ActiveRecordInstrumentation
     def self.included(instrumented_class)
-      if defined? Rails.application
-        Marginalia.application_name = Rails.application.class.name.split("::").first
-      end
+      Marginalia::Comment.components = [:application, :controller, :action]
       instrumented_class.class_eval do
         if defined? :execute
           alias_method :execute_without_marginalia, :execute
@@ -17,7 +16,7 @@ module Marginalia
     end
 
     def execute_with_marginalia(sql, name = nil)
-      execute_without_marginalia("#{sql} /*#{Marginalia.comment}*/", name)
+      execute_without_marginalia("#{sql} /*#{Marginalia::Comment.to_s}*/", name)
     end
   end
 

data/lib/marginalia/comment.rb

@@ -0,0 +1,57 @@
+module Marginalia
+  module Comment
+    mattr_accessor :components, :comment, :lines_to_ignore
+
+    def self.update!(controller = nil)
+      @controller = controller
+      self.comment = self.components.collect{|c| "#{c}:#{self.send(c) }" }.join(",")
+    end
+
+    def self.to_s
+      self.comment
+    end
+
+    def self.clear!
+      self.comment = nil
+    end
+
+    private
+      def self.application
+        if defined? Rails.application
+          Marginalia.application_name ||= Rails.application.class.name.split("::").first
+        else
+          Marginalia.application_name ||= "rails"
+        end
+
+        Marginalia.application_name
+      end
+
+      def self.controller
+        @controller.controller_name if @controller.respond_to? :controller_name
+      end
+
+      def self.action
+        @controller.action_name if @controller.respond_to? :action_name 
+      end
+
+      def self.line
+        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor|marginalia|rbenv/
+        last_line = caller.detect { |line| line !~ Marginalia::Comment.lines_to_ignore }
+        if last_line
+          root = if defined?(Rails) && Rails.respond_to?(:root)
+            Rails.root.to_s
+          elsif defined?(RAILS_ROOT)
+            RAILS_ROOT
+          else
+            ""
+          end
+          if last_line.starts_with? root
+            last_line = last_line[root.length..-1]
+          end
+          last_line
+        end
+      end
+
+  end
+
+end

data/lib/marginalia/railtie.rb

@@ -26,10 +26,10 @@ module Marginalia
     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}"
+          Marginalia::Comment.update!(self)
           yield
         ensure
-          Marginalia.comment = nil
+          Marginalia::Comment.clear! 
         end
         around_filter :record_query_comment
       end
@@ -37,29 +37,36 @@ module Marginalia
 
     def self.insert_into_active_record
       if defined? ActiveRecord::ConnectionAdapters::Mysql2Adapter
-        ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
-          include Marginalia::ActiveRecordInstrumentation
+        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter.module_eval do
+            include Marginalia::ActiveRecordInstrumentation
+          end
         end
       end
 
       if defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
-        ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
-          include Marginalia::ActiveRecordInstrumentation
+        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+          ActiveRecord::ConnectionAdapters::MysqlAdapter.module_eval do
+            include Marginalia::ActiveRecordInstrumentation
+          end
         end
       end
 
       if defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
-        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
-          include Marginalia::ActiveRecordInstrumentation
+        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
+            include Marginalia::ActiveRecordInstrumentation
+          end
         end
       end
 
       if defined? ActiveRecord::ConnectionAdapters::SQLiteAdapter
-        ActiveRecord::ConnectionAdapters::SQLiteAdapter.module_eval do
-          include Marginalia::ActiveRecordInstrumentation
+        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLiteAdapter)
+          ActiveRecord::ConnectionAdapters::SQLiteAdapter.module_eval do
+            include Marginalia::ActiveRecordInstrumentation
+          end
         end
       end
-
     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.0.3"
+  gem.version       = "1.1.0"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3", "< 3.3"
   gem.add_runtime_dependency "activerecord", ">= 2.3", "< 3.3"

data/test/query_comments_test.rb

@@ -4,6 +4,7 @@ require 'pp'
 require 'active_record'
 require 'action_controller'
 require 'marginalia'
+RAILS_ROOT = File.expand_path(File.dirname(__FILE__))
 
 ActiveRecord::Base.establish_connection({
   :adapter  => ENV["DRIVER"] || "mysql",
@@ -57,8 +58,29 @@ class MarginaliaTest < Test::Unit::TestCase
     assert_match %r{/\*application:customapp,controller:posts,action:driver_only\*/$}, @queries.first
   end
 
+  def test_configuring_query_components
+    Marginalia::Comment.components = [:controller]
+    PostsController.action(:driver_only).call(@env)
+
+    assert_match %r{/\*controller:posts\*/$}, @queries.first
+  end
+
+  def test_last_line_component
+    Marginalia::Comment.components = [:line]
+    PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*line:test/query_comments_test.rb:[0-9]*:in `call'\*/$}, @queries.first
+  end
+
+  def test_last_line_component_with_lines_to_ignore
+    Marginalia::Comment.lines_to_ignore = /foo bar/
+    Marginalia::Comment.components = [:line]
+    PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*line:.*lib/marginalia/comment.rb:7:in .*?\*/$}, @queries.first
+  end
+
   def teardown
     Marginalia.application_name = nil
+    Marginalia::Comment.components = [:application, :controller, :action]
     ActiveSupport::Notifications.unsubscribe "sql.active_record"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &14527580 !ruby/object:Gem::Requirement
+  requirement: &9071720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -26,10 +26,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *14527580
+  version_requirements: *9071720
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &14526420 !ruby/object:Gem::Requirement
+  requirement: &9070320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -40,10 +40,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *14526420
+  version_requirements: *9070320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14525140 !ruby/object:Gem::Requirement
+  requirement: &9069220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -51,10 +51,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14525140
+  version_requirements: *9069220
 - !ruby/object:Gem::Dependency
   name: mysql
-  requirement: &14514160 !ruby/object:Gem::Requirement
+  requirement: &9058300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -62,10 +62,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14514160
+  version_requirements: *9058300
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &14513460 !ruby/object:Gem::Requirement
+  requirement: &9057600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -73,10 +73,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14513460
+  version_requirements: *9057600
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &14512660 !ruby/object:Gem::Requirement
+  requirement: &9057080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -84,10 +84,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14512660
+  version_requirements: *9057080
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &14511580 !ruby/object:Gem::Requirement
+  requirement: &9055100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -95,7 +95,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14511580
+  version_requirements: *9055100
 description: 
 email:
 - noah@37signals.com
@@ -113,6 +113,7 @@ files:
 - Rakefile
 - init.rb
 - lib/marginalia.rb
+- lib/marginalia/comment.rb
 - lib/marginalia/railtie.rb
 - marginalia.gemspec
 - test/query_comments_test.rb