marginalia 1.1.0 → 1.1.1

data/README.md

@@ -23,6 +23,11 @@ tested on Rails 2.3.5 through 3.2-stable. It has also been tested for sqlite3 an
 
 Patches are welcome for other database adapters. 
 
+**The preferred way to get support is to send an email to
+marginalia@librelist.com. Github issues
+and pull requests will be checked occassionally, but email is the
+fastest way to get help.**
+
 ## Installation
 
 ### For Rails 3.x:
@@ -89,7 +94,7 @@ 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`
+    a configuration by setting a regexp in `Marginalia::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.

data/lib/marginalia/comment.rb

@@ -1,18 +1,27 @@
+require 'socket'
+
 module Marginalia
   module Comment
-    mattr_accessor :components, :comment, :lines_to_ignore
+    mattr_accessor :components, :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
+    def self.construct_comment
+      ret = ''
+      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
+        end
+      end
+      ret
     end
 
     def self.clear!
-      self.comment = nil
+      @controller = nil
     end
 
     private
@@ -36,7 +45,9 @@ module Marginalia
 
       def self.line
         Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor|marginalia|rbenv/
-        last_line = caller.detect { |line| line !~ Marginalia::Comment.lines_to_ignore }
+        last_line = caller.detect do |line|
+          line !~ Marginalia::Comment.lines_to_ignore
+        end
         if last_line
           root = if defined?(Rails) && Rails.respond_to?(:root)
             Rails.root.to_s
@@ -52,6 +63,14 @@ module Marginalia
         end
       end
 
+      def self.hostname
+        @cached_hostname ||= Socket.gethostname
+      end
+
+      def self.pid
+        Process.pid
+      end
+
   end
 
 end

data/lib/marginalia/railtie.rb

@@ -52,6 +52,7 @@ module Marginalia
         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

data/lib/marginalia.rb

@@ -11,12 +11,28 @@ module Marginalia
         if defined? :execute
           alias_method :execute_without_marginalia, :execute
           alias_method :execute, :execute_with_marginalia
+        elsif defined? :exec_query
+          alias_method :exec_query_without_marginalia, :exec_query
+          alias_method :exec_query, :exec_query_with_marginalia
         end
       end
     end
 
+    def annotate_sql(sql)
+      comment = Marginalia::Comment.construct_comment
+      if comment.present?
+        "#{sql} /*#{comment}*/"
+      else
+        sql
+      end
+    end
+
     def execute_with_marginalia(sql, name = nil)
-      execute_without_marginalia("#{sql} /*#{Marginalia::Comment.to_s}*/", name)
+      execute_without_marginalia(annotate_sql(sql), name)
+    end
+
+    def exec_query_with_marginalia(sql, name = 'SQL', binds = [])
+      exec_query_without_marginalia(annotate_sql(sql), name, binds)
     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.0"
+  gem.version       = "1.1.1"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3", "< 3.3"
   gem.add_runtime_dependency "activerecord", ">= 2.3", "< 3.3"

data/test/query_comments_test.rb

@@ -43,7 +43,7 @@ class MarginaliaTest < Test::Unit::TestCase
 
   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
+    assert_match %r{select id from posts /\*application:rails\*/$}, @queries.first
   end
 
   def test_query_commenting_on_mysql_driver_with_action
@@ -68,14 +68,27 @@ class MarginaliaTest < Test::Unit::TestCase
   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
+
+    # Because "lines_to_ignore" by default includes "marginalia" and "gem", the
+    # extracted line line will be from the line in this file that actually
+    # triggers the query.
+    assert_match %r{/\*line:test/query_comments_test.rb:[0-9]+:in `driver_only'\*/$}, @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
+    # Because "lines_to_ignore" does not include "marginalia", the extracted
+    # line will be from marginalia/comment.rb.
+    assert_match %r{/\*line:.*lib/marginalia/comment.rb:[0-9]+}, @queries.first
+  end
+
+  def test_hostname_and_pid
+    Marginalia::Comment.components = [:hostname, :pid]
+    PostsController.action(:driver_only).call(@env)
+    assert_match %r{/\*hostname:#{Socket.gethostname},pid:#{Process.pid}\*/$}, @queries.first
+
   end
 
   def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &9071720 !ruby/object:Gem::Requirement
+  requirement: &14428020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -26,10 +26,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *9071720
+  version_requirements: *14428020
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &9070320 !ruby/object:Gem::Requirement
+  requirement: &14425760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -40,10 +40,10 @@ dependencies:
         version: '3.3'
   type: :runtime
   prerelease: false
-  version_requirements: *9070320
+  version_requirements: *14425760
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &9069220 !ruby/object:Gem::Requirement
+  requirement: &14424740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -51,10 +51,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9069220
+  version_requirements: *14424740
 - !ruby/object:Gem::Dependency
   name: mysql
-  requirement: &9058300 !ruby/object:Gem::Requirement
+  requirement: &14423440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -62,10 +62,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9058300
+  version_requirements: *14423440
 - !ruby/object:Gem::Dependency
   name: mysql2
-  requirement: &9057600 !ruby/object:Gem::Requirement
+  requirement: &14422580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -73,10 +73,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9057600
+  version_requirements: *14422580
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &9057080 !ruby/object:Gem::Requirement
+  requirement: &17277820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -84,10 +84,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9057080
+  version_requirements: *17277820
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &9055100 !ruby/object:Gem::Requirement
+  requirement: &17276680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -95,7 +95,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9055100
+  version_requirements: *17276680
 description: 
 email:
 - noah@37signals.com