instructure-marginalia 1.1.3 → 1.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 412b0d5c9d4e67775eddfadc06b23cf0cffd4590
+  data.tar.gz: 69b196fda9c7a270da2d4b69d68139af458839cd
+SHA512:
+  metadata.gz: b8d717d6ac49cff823ac18e7f5c625221a61052540673f418d9d0037c356c5d64013a2c23886c0edb8fea5b8bd92e9d4d12b8d4f09e82d811f11c114e5bce54a
+  data.tar.gz: 821d4ca7ba4833cc1296d5de71ad14dad7eca4eef490b9ef9ae8b598f2345dfa89156e26dfe96995075f4c5d012ab8723d8d0ae54b062918befc0ba4b94be8df

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 tmp
 marginalia_test
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1
 script: bundle exec rake db:reset test:all
+env:
+  - "RAILS_VERSION=3.1.12"
+  - "RAILS_VERSION=3.2.19"
+  - "RAILS_VERSION=4.0.8"

data/Gemfile

@@ -1,3 +1,14 @@
 source "https://rubygems.org"
 
 gemspec
+
+version = ENV["RAILS_VERSION"] || "4.0.2"
+
+rails = case version
+when "master"
+  {:github => "rails/rails"}
+else
+  "~> #{version}"
+end
+
+gem "rails", rails

data/README.md

@@ -1,4 +1,4 @@
-# marginalia [![Build Status](https://secure.travis-ci.org/37signals/marginalia.png?branch=master)](http://travis-ci.org/37signals/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.
@@ -19,23 +19,18 @@ 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.0-stable. It has also been tested for sqlite3 and postgres.
 
 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:
+### For Rails 3.x and 4.0:
 
     # Gemfile
     gem 'marginalia'
     
-    #config/application.rb
+    # config/application.rb
     require 'marginalia/railtie'
 
 

data/lib/marginalia.rb

@@ -8,21 +8,41 @@ module Marginalia
     def self.included(instrumented_class)
       Marginalia::Comment.components = [:application, :controller, :action]
       instrumented_class.class_eval do
-        if method_defined? :execute
+        if instrumented_class.method_defined?(:execute)
           alias_method :execute_without_marginalia, :execute
           alias_method :execute, :execute_with_marginalia
         end
 
-        if method_defined? :exec_query
-          alias_method :exec_query_without_marginalia, :exec_query
-          alias_method :exec_query, :exec_query_with_marginalia
+        is_mysql2 = defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) &&
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter == instrumented_class
+        # Dont instrument exec_query on mysql2 and AR 3.2+, as it calls execute internally
+        unless is_mysql2 && ActiveRecord::VERSION::STRING > "3.1"
+          if instrumented_class.method_defined?(:exec_query)
+            alias_method :exec_query_without_marginalia, :exec_query
+            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
 
     def annotate_sql(sql)
       comment = Marginalia::Comment.construct_comment
-      if comment.present? && !sql.match(comment)
+      if comment.present? && !sql.include?(comment)
         "#{sql} /*#{comment}*/"
       else
         sql
@@ -36,6 +56,14 @@ 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
 
 end

data/lib/marginalia/comment.rb

@@ -13,10 +13,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
 
@@ -40,11 +40,11 @@ module Marginalia
       end
 
       def self.action
-        @controller.action_name if @controller.respond_to? :action_name 
+        @controller.action_name if @controller.respond_to? :action_name
       end
 
       def self.line
-        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor|marginalia|rbenv/
+        Marginalia::Comment.lines_to_ignore ||= /\.rvm|gem|vendor\/|marginalia|rbenv/
         last_line = caller.detect do |line|
           line !~ Marginalia::Comment.lines_to_ignore
         end

data/lib/marginalia/railtie.rb

@@ -29,7 +29,7 @@ module Marginalia
           Marginalia::Comment.update!(self)
           yield
         ensure
-          Marginalia::Comment.clear! 
+          Marginalia::Comment.clear!
         end
         around_filter :record_query_comment
       end
@@ -61,9 +61,9 @@ module Marginalia
         end
       end
 
-      if defined? ActiveRecord::ConnectionAdapters::SQLiteAdapter
-        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLiteAdapter)
-          ActiveRecord::ConnectionAdapters::SQLiteAdapter.module_eval do
+      if defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
+        if ActiveRecord::Base.connection.is_a?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+          ActiveRecord::ConnectionAdapters::SQLite3Adapter.module_eval do
             include Marginalia::ActiveRecordInstrumentation
           end
         end

data/marginalia.gemspec

@@ -8,15 +8,17 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test}/*`.split("\n")
   gem.name          = "instructure-marginalia"
   gem.require_paths = ["lib"]
-  gem.version       = "1.1.3"
+  gem.version       = "1.1.6"
+  gem.license       = "MIT"
 
-  gem.add_runtime_dependency "actionpack", ">= 2.3", "< 3.3"
-  gem.add_runtime_dependency "activerecord", ">= 2.3", "< 3.3"
+  gem.add_runtime_dependency "actionpack", ">= 2.3"
+  gem.add_runtime_dependency "activerecord", ">= 2.3"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "mysql"
   gem.add_development_dependency "mysql2"
   gem.add_development_dependency "pg"
   gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "mocha"
 
-  gem.summary = description = %q{Attach comments to your ActiveRecord queries.}
+  gem.summary = gem.description = %q{Attach comments to your ActiveRecord queries.}
 end

data/test/query_comments_test.rb

@@ -1,4 +1,6 @@
+# -*- coding: utf-8 -*-
 require 'test/unit'
+require 'mocha/test_unit'
 require 'logger'
 require 'pp'
 require 'active_record'
@@ -41,11 +43,41 @@ class MarginaliaTest < Test::Unit::TestCase
     @env = Rack::MockRequest.env_for('/')
   end
 
+  def test_double_annotate
+    ActiveRecord::Base.connection.expects(:annotate_sql).returns("select id from posts").once
+    ActiveRecord::Base.connection.send(:select, "select id from posts")
+  ensure
+    ActiveRecord::Base.connection.unstub(:annotate_sql)
+  end
+
   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 /\*application:rails\*/$}, @queries.first
   end
 
+  if ENV["DRIVER"] =~ /^mysql/
+    def test_query_commenting_on_mysql_driver_with_binary_chars
+      ActiveRecord::Base.connection.execute "select id from posts /* \x81\x80\u0010\ */"
+      assert_equal "select id from posts /* \x81\x80\u0010 */ /*application:rails*/", @queries.first
+    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

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instructure-marginalia
 version: !ruby/object:Gem::Version
-  version: 1.1.3
-  prerelease: 
+  version: 1.1.6
 platform: ruby
 authors:
 - Noah Lorang
@@ -11,144 +10,131 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Attach comments to your ActiveRecord queries.
 email:
 - noah@37signals.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rbenv-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -159,27 +145,28 @@ files:
 - marginalia.gemspec
 - test/query_comments_test.rb
 homepage: https://github.com/37signals/marginalia
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.3.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Attach comments to your ActiveRecord queries.
 test_files: []
+has_rdoc: 

data/.rbenv-version

@@ -1 +0,0 @@
-1.9.3-p0

data/Gemfile.lock

@@ -1,67 +0,0 @@
-PATH
-  remote: .
-  specs:
-    marginalia (1.1.0)
-      actionpack (>= 2.3, < 3.3)
-      activerecord (>= 2.3, < 3.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      i18n (~> 0.6)
-      rack (~> 1.3.5)
-      rack-cache (~> 1.1)
-      rack-mount (~> 0.8.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.0.3)
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
-      builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      arel (~> 2.2.1)
-      tzinfo (~> 0.3.29)
-    activesupport (3.1.3)
-      multi_json (~> 1.0)
-    arel (2.2.1)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    multi_json (1.1.0)
-    mysql (2.8.1)
-    mysql2 (0.3.11)
-    pg (0.13.2)
-    rack (1.3.6)
-    rack-cache (1.1)
-      rack (>= 0.4)
-    rack-mount (0.8.3)
-      rack (>= 1.0.0)
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rake (0.9.2.2)
-    sprockets (2.0.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    tilt (1.3.3)
-    tzinfo (0.3.32)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  marginalia!
-  mysql
-  mysql2
-  pg
-  rake
-  sqlite3