marginalia 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5352b63598e762229b9f6a9a7b4b0b27dc42a277
-  data.tar.gz: d45c0855bf418e0dd277e553b5fe45d47b6d3a57
+  metadata.gz: 6f9f187276b089ab51a1f5e267f8e58e125b1ec6
+  data.tar.gz: 011dbacbca884d0c40b757e408603a51e4b75639
 SHA512:
-  metadata.gz: 7895a8c8318f85bfb18aa2ba90f8223eaacd54b190d6adc45aff3f139c3ed6a494858c644095b2edcf608f42f9d0c5e4c48bbf432ac0a1c523b7d3c411e2ce1f
-  data.tar.gz: 8e5493b2233a05245de9f6c4b1d346b08cbe3dd6de0021e037a73e1cea35da8599469198802c459306bbd0168974ebc210d1cf8d62f88d48a61e9df7bfa1ed33
+  metadata.gz: b4992f558f137d11af12f9cc4208dcfa7d9a2d8c2bf7be426bdca1668cf44aca39777206f4abe8f51cb12acbbea07683883ec4cc6956bf46a0ce7770594fe4b2
+  data.tar.gz: 639570873d23475c04fe0ba94bcb84c317efd4bbaee87d3a978dc013c8cd6191ce8ee077d6fc8001940d57267335f26c9846a419a5adc7faba77d5487866c52d

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.0

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2
 
 sudo: false
 

data/Gemfile

@@ -2,9 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-version = ENV["RAILS_VERSION"] || "4.0.2"
-rails_api = ENV["TEST_RAILS_API"] == "true"
-
+version = ENV["RAILS_VERSION"] || "4.2.0"
 rails = case version
 when "master"
   {:github => "rails/rails"}
@@ -14,6 +12,6 @@ end
 
 gem "rails", rails
 
-if rails_api
+if ENV["TEST_RAILS_API"] == "true"
   gem "rails-api", "~> 0.2.1"
 end

data/README.md

@@ -93,6 +93,7 @@ default. In addition, implementation is provided for:
     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.
+  * `:job` to include the classname of the ActiveJob being performed.
 
 Pull requests for other included comment components are welcome.
 

data/lib/marginalia.rb

@@ -21,6 +21,21 @@ module Marginalia
             alias_method :exec_query, :exec_query_with_marginalia
           end
         end
+
+        is_postgres = defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) &&
+          ActiveRecord::ConnectionAdapters::PostgreSQLAdapter == instrumented_class
+        # Instrument exec_delete and exec_update on AR 3.2+, since they don't
+        # call execute internally
+        if is_postgres && ActiveRecord::VERSION::STRING > "3.1"
+          if instrumented_class.method_defined?(:exec_delete)
+            alias_method :exec_delete_without_marginalia, :exec_delete
+            alias_method :exec_delete, :exec_delete_with_marginalia
+          end
+          if instrumented_class.method_defined?(:exec_update)
+            alias_method :exec_update_without_marginalia, :exec_update
+            alias_method :exec_update, :exec_update_with_marginalia
+          end
+        end
       end
     end
 
@@ -40,6 +55,28 @@ module Marginalia
     def exec_query_with_marginalia(sql, name = 'SQL', binds = [])
       exec_query_without_marginalia(annotate_sql(sql), name, binds)
     end
+
+    def exec_delete_with_marginalia(sql, name = 'SQL', binds = [])
+      exec_delete_without_marginalia(annotate_sql(sql), name, binds)
+    end
+
+    def exec_update_with_marginalia(sql, name = 'SQL', binds = [])
+      exec_update_without_marginalia(annotate_sql(sql), name, binds)
+    end
   end
 
+  module ActionControllerInstrumentation
+    def self.included(instrumented_class)
+      instrumented_class.class_eval do
+        around_filter :record_query_comment
+      end
+    end
+
+    def record_query_comment
+      Marginalia::Comment.update!(self)
+      yield
+    ensure
+      Marginalia::Comment.clear!
+    end
+  end
 end

data/lib/marginalia/comment.rb

@@ -6,7 +6,11 @@ module Marginalia
     Marginalia::Comment.components ||= [:application, :controller, :action]
 
     def self.update!(controller = nil)
-      @controller = controller
+      self.marginalia_controller = controller
+    end
+
+    def self.update_job!(job)
+      self.marginalia_job = job
     end
 
     def self.construct_comment
@@ -22,10 +26,30 @@ module Marginalia
     end
 
     def self.clear!
-      @controller = nil
+      self.marginalia_controller = nil
+    end
+
+    def self.clear_job!
+      self.marginalia_job = nil
     end
 
     private
+      def self.marginalia_controller=(controller)
+        Thread.current[:marginalia_controller] = controller
+      end
+
+      def self.marginalia_controller
+        Thread.current[:marginalia_controller]
+      end
+
+      def self.marginalia_job=(job)
+        Thread.current[:marginalia_job] = job
+      end
+
+      def self.marginalia_job
+        Thread.current[:marginalia_job]
+      end
+
       def self.application
         if defined?(Rails.application)
           Marginalia.application_name ||= Rails.application.class.name.split("::").first
@@ -36,16 +60,20 @@ module Marginalia
         Marginalia.application_name
       end
 
+      def self.job
+        marginalia_job.class.name if marginalia_job
+      end
+
       def self.controller
-        @controller.controller_name if @controller.respond_to? :controller_name
+        marginalia_controller.controller_name if marginalia_controller.respond_to? :controller_name
       end
 
       def self.controller_with_namespace
-        @controller.class.name if @controller
+        marginalia_controller.class.name if marginalia_controller
       end
 
       def self.action
-        @controller.action_name if @controller.respond_to? :action_name
+        marginalia_controller.action_name if marginalia_controller.respond_to? :action_name
       end
 
       def self.line
@@ -77,8 +105,8 @@ module Marginalia
       end
 
       def self.request_id
-        if @controller.respond_to?(:request) && @controller.request.respond_to?(:uuid)
-          @controller.request.uuid
+        if marginalia_controller.respond_to?(:request) && marginalia_controller.request.respond_to?(:uuid)
+          marginalia_controller.request.uuid
         end
       end
   end

data/lib/marginalia/railtie.rb

@@ -13,6 +13,10 @@ module Marginalia
         ActiveSupport.on_load :action_controller do
           Marginalia::Railtie.insert_into_action_controller
         end
+
+        ActiveSupport.on_load :active_job do
+          Marginalia::Railtie.insert_into_active_job
+        end
       end
     end
   end
@@ -21,21 +25,28 @@ module Marginalia
     def self.insert
       insert_into_active_record
       insert_into_action_controller
+      insert_into_active_job
     end
 
-    def self.insert_into_action_controller
-      controller_instrumentation = <<-EOS
-        def record_query_comment
-          Marginalia::Comment.update!(self)
-          yield
-        ensure
-          Marginalia::Comment.clear!
+    def self.insert_into_active_job
+      if defined? ActiveJob::Base
+        ActiveJob::Base.class_eval do
+          around_perform do |job, block|
+            begin
+              Marginalia::Comment.update_job! job
+              block.call
+            ensure
+              Marginalia::Comment.clear_job!
+            end
+          end
         end
-        around_filter :record_query_comment
-      EOS
-      ActionController::Base.class_eval(controller_instrumentation)
+      end
+    end
+
+    def self.insert_into_action_controller
+      ActionController::Base.send(:include, ActionControllerInstrumentation)
       if defined? ActionController::API
-        ActionController::API.class_eval(controller_instrumentation)
+        ActionController::API.send(:include, ActionControllerInstrumentation)
       end
     end
 
@@ -52,7 +63,6 @@ module Marginalia
         end
       end
 
-      # SQL queries made through PostgreSQLAdapter#exec_delete will not be annotated.
       if defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
         ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.module_eval do
           include Marginalia::ActiveRecordInstrumentation

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.2.0"
+  gem.version       = "1.3.0"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "mysql2"
   gem.add_development_dependency "pg"
   gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "minitest"
   gem.add_development_dependency "mocha"
 
   gem.summary = gem.description = %q{Attach comments to your ActiveRecord queries.}

data/test/query_comments_test.rb

@@ -9,6 +9,10 @@ def request_id_available?
   Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.2')
 end
 
+def active_job_available?
+  Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.2')
+end
+
 require "minitest/autorun"
 require 'mocha/test_unit'
 require 'logger'
@@ -20,6 +24,10 @@ if request_id_available?
   require 'action_dispatch/middleware/request_id'
 end
 
+if active_job_available?
+  require 'active_job'
+end
+
 if using_rails_api?
   require 'rails-api/action_controller/api'
 end
@@ -63,6 +71,14 @@ module API
   end
 end
 
+if active_job_available?
+  class PostsJob < ActiveJob::Base
+    def perform
+      Post.first
+    end
+  end
+end
+
 if using_rails_api?
   class PostsApiController < ActionController::API
     def driver_only
@@ -110,6 +126,22 @@ class MarginaliaTest < MiniTest::Test
     end
   end
 
+  if ENV["DRIVER"] =~ /^postgres/
+    def test_query_commenting_on_postgres_update
+      ActiveRecord::Base.connection.expects(:annotate_sql).returns("update posts set id = 1").once
+      ActiveRecord::Base.connection.send(:exec_update, "update posts set id = 1")
+    ensure
+      ActiveRecord::Base.connection.unstub(:annotate_sql)
+    end
+
+    def test_query_commenting_on_postgres_delete
+      ActiveRecord::Base.connection.expects(:annotate_sql).returns("delete from posts where id = 1").once
+      ActiveRecord::Base.connection.send(:exec_delete, "delete from posts where id = 1")
+    ensure
+      ActiveRecord::Base.connection.unstub(:annotate_sql)
+    end
+  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
@@ -195,6 +227,17 @@ class MarginaliaTest < MiniTest::Test
     end
   end
 
+  if active_job_available?
+    def test_active_job
+      Marginalia::Comment.components = [:job]
+      PostsJob.perform_later
+      assert_match %{job:PostsJob}, @queries.first
+
+      Post.first
+      refute_match %{job:PostsJob}, @queries.last
+    end
+  end
+
   def teardown
     Marginalia.application_name = nil
     Marginalia::Comment.lines_to_ignore = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Noah Lorang
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -110,6 +110,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.