marginalia 1.8.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2bf4536bf33fce1b7c806d0b2fec3cbe221b166
-  data.tar.gz: ed2d7dfeac456ce8a9f63f5257e63e7d05526f6d
+SHA256:
+  metadata.gz: 8dba7f58a767008578f36af3a2bedc77139f11b62025e1dcd022c1ebd3658c3c
+  data.tar.gz: 9d4728cbc7b673514cce7076a60c28592646fbc68ac59d8310c7ebe3aa71eac6
 SHA512:
-  metadata.gz: 255f216a7e47faa1a4d5e36f38a922d6abca36ce2f3a9c3189f2849a50c543237c9be76c1bf8abe9064f1b97d0c9d78379883271405e3e3781359be22ec08ed3
-  data.tar.gz: 0983b7a057ecb4cf56cd031572d6f498c8906daf8b7f67b8a5d7a9e7944128d23d27f78b8020d93c52ef5f6670d127e1a1c47da4aee6d96df1a7b0104f65887f
+  metadata.gz: 35dfdc97e0745484719266a9c616c257072dfbdf0ee8ff6b4c7055d051510a562bf12d863eae670c382f14eda7ba895f4a988baa031ea43904fd9a2a31fd7c0e
+  data.tar.gz: 3fbfdeacc57e3a8e78490e991527610a3249c0b3e748de7410a427e9e085e6b420a12d916b0c15d87a7240743a81e9be14727508743d25d7cc82d850924ad126

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.6.6

data/.travis.yml

@@ -1,10 +1,21 @@
 language: ruby
 sudo: false
 
+services:
+  - mysql
+  - postgresql
+
 rvm:
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+
+services:
+  - mysql
+  - postgresql
 
 script: "bundle exec rake db:reset test:all"
 
@@ -14,3 +25,10 @@ gemfile:
   - gemfiles/5.0.gemfile
   - gemfiles/5.1.gemfile
   - gemfiles/5.2.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.gemfile
+    - rvm: 2.7
+      gemfile: gemfiles/4.2.api.gemfile

data/lib/marginalia.rb

@@ -67,32 +67,43 @@ module Marginalia
       sql
     end
 
-    def execute_with_marginalia(sql, name = nil)
-      execute_without_marginalia(annotate_sql(sql), name)
+    def execute_with_marginalia(sql, *args)
+      execute_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :execute_with_marginalia if respond_to?(:ruby2_keywords, true)
 
-    def exec_query_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_query_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_query_with_marginalia(sql, *args)
+      exec_query_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_query_with_marginalia if respond_to?(:ruby2_keywords, true)
 
     if ActiveRecord::VERSION::MAJOR >= 5
-      def exec_query_with_marginalia(sql, name = 'SQL', binds = [], options = {})
+      def exec_query_with_marginalia(sql, *args, **options)
         options[:prepare] ||= false
-        exec_query_without_marginalia(annotate_sql(sql), name, binds, options)
+        exec_query_without_marginalia(annotate_sql(sql), *args, **options)
       end
     end
 
-    def exec_delete_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_delete_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_delete_with_marginalia(sql, *args)
+      exec_delete_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_delete_with_marginalia if respond_to?(:ruby2_keywords, true)
 
-    def exec_update_with_marginalia(sql, name = 'SQL', binds = [])
-      exec_update_without_marginalia(annotate_sql(sql), name, binds)
+    def exec_update_with_marginalia(sql, *args)
+      exec_update_without_marginalia(annotate_sql(sql), *args)
     end
+    ruby2_keywords :exec_update_with_marginalia if respond_to?(:ruby2_keywords, true)
 
+if ActiveRecord::VERSION::MAJOR >= 5
     def execute_and_clear_with_marginalia(sql, *args, &block)
       execute_and_clear_without_marginalia(annotate_sql(sql), *args, &block)
     end
+    ruby2_keywords :execute_and_clear_with_marginalia if respond_to?(:ruby2_keywords, true)
+ else
+   def execute_and_clear_with_marginalia(sql, *args, &block)
+     execute_and_clear_without_marginalia(annotate_sql(sql), *args, &block)
+   end
+ end
   end
 
   module ActionControllerInstrumentation

data/lib/marginalia/comment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'socket'
 
 module Marginalia
@@ -18,11 +20,11 @@ module Marginalia
     end
 
     def self.construct_comment
-      ret = ''
+      ret = String.new
       self.components.each do |c|
         component_value = self.send(c)
         if component_value.present?
-          ret << "#{c.to_s}:#{component_value.to_s},"
+          ret << "#{c}:#{component_value},"
         end
       end
       ret.chop!
@@ -102,11 +104,14 @@ module Marginalia
       end
 
       def self.sidekiq_job
-        marginalia_job["class"] if marginalia_job
+        marginalia_job["class"] if marginalia_job && marginalia_job.respond_to?(:[])
       end
 
+      DEFAULT_LINES_TO_IGNORE_REGEX = %r{\.rvm|/ruby/gems/|vendor/|marginalia|rbenv|monitor\.rb.*mon_synchronize}
+
       def self.line
-        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv/
+        Marginalia::Comment.lines_to_ignore ||= DEFAULT_LINES_TO_IGNORE_REGEX
+
         last_line = caller.detect do |line|
           line !~ Marginalia::Comment.lines_to_ignore
         end

data/marginalia.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.authors       = ["Noah Lorang", "Nick Quaranto", "Taylor Weibley"]
-  gem.email         = ["noah@37signals.com", "arthurnn@github.com"]
+  gem.email         = ["arthurnn@github.com"]
   gem.homepage      = "https://github.com/basecamp/marginalia"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -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.8.0"
+  gem.version       = "1.10.1"
   gem.license       = "MIT"
 
   gem.add_runtime_dependency "actionpack", ">= 2.3"

data/test/query_comments_test.rb

@@ -121,6 +121,7 @@ class MarginaliaTest < MiniTest::Test
       @queries << args.last[:sql]
     end
     @env = Rack::MockRequest.env_for('/')
+    ActiveJob::Base.queue_adapter = :inline
   end
 
   def test_double_annotate
@@ -215,6 +216,16 @@ class MarginaliaTest < MiniTest::Test
     assert_match %r{/\*line:.*lib/marginalia/comment.rb:[0-9]+}, @queries.first
   end
 
+  def test_default_lines_to_ignore_regex
+    line = "/gems/a_gem/lib/a_gem.rb:1:in `some_method'"
+    call_stack = [line] + caller
+
+    assert_match(
+      call_stack.detect { |line| line !~ Marginalia::Comment::DEFAULT_LINES_TO_IGNORE_REGEX },
+      line
+    )
+  end
+
   def test_hostname_and_pid
     Marginalia::Comment.components = [:hostname, :pid]
     PostsController.action(:driver_only).call(@env)
@@ -282,6 +293,15 @@ class MarginaliaTest < MiniTest::Test
       Post.first
       refute_match %{job:PostsJob}, @queries.last
     end
+
+    def test_active_job_with_sidekiq
+      Marginalia::Comment.components = [:job, :sidekiq_job]
+      PostsJob.perform_later
+      assert_match %{job:PostsJob}, @queries.first
+
+      Post.first
+      refute_match %{job:PostsJob}, @queries.last
+    end
   end
 
   def test_sidekiq_job
@@ -290,13 +310,14 @@ class MarginaliaTest < MiniTest::Test
 
     # Test harness does not run Sidekiq middlewares by default so include testing middleware.
     Sidekiq::Testing.server_middleware do |chain|
-     chain.add Marginalia::SidekiqInstrumentation::Middleware
+      chain.add Marginalia::SidekiqInstrumentation::Middleware
     end
 
     Sidekiq::Testing.fake!
     PostsSidekiqJob.perform_async
     PostsSidekiqJob.drain
     assert_match %{sidekiq_job:PostsSidekiqJob}, @queries.first
+
     Post.first
     refute_match %{sidekiq_job:PostsSidekiqJob}, @queries.last
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: marginalia
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Noah Lorang
 - Nick Quaranto
 - Taylor Weibley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-25 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -140,7 +140,6 @@ dependencies:
         version: '0'
 description: Attach comments to your ActiveRecord queries.
 email:
-- noah@37signals.com
 - arthurnn@github.com
 executables: []
 extensions: []
@@ -169,7 +168,7 @@ homepage: https://github.com/basecamp/marginalia
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Attach comments to your ActiveRecord queries.
 test_files: []