arproxy-query_caller_location_annotator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f69f117c8f97f8e92c07576b64f95ed26b2f945e
+  data.tar.gz: c5df8b5ea7f07e2ce0bd7ba8936d79a81a5367e9
+SHA512:
+  metadata.gz: 07d2de906a9c3646818b94ada3d650784ce4be73334ddb125a33ec2fc3224ef3c778ea38ddd4c2574539622e3a9885846e2c583ccc8cecfc7f727c3f038c7b44
+  data.tar.gz: 18a4875a7f99d85bdd1049343539cb0ddb55d40bca4443177ccb5dff1ac505faed07c769c63cec97443c8e348c7206bd6b1f0a947397642b7f9006813fc7c78b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+sudo: false
+branches:
+  only:
+    - master
+rvm:
+  - "2.2.5"
+  - "2.3.1"
+services:
+  - mysql

data/CHANGELOG.md

@@ -0,0 +1 @@
+## CHANGELOG

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in arproxy-query_caller_location_annotator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Taiki Ono
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Arproxy::QueryCallerLocationAnnotator
+[![Build Status](https://travis-ci.org/taiki45/arproxy-query_caller_location_annotator.svg?branch=master)](https://travis-ci.org/taiki45/arproxy-query_caller_location_annotator)
+
+Append query caller method to each ActiveRecord's query log like:
+
+```
+User Load (0.3ms)  SELECT  `users`.* FROM `users` ORDER BY `users`.`id` ASC LIMIT 1 /* app/models/user.rb:3 `xxx` */
+```
+
+This library was originally written by Takatoshi Maeda (@TakatoshiMaeda on GitHub).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'arproxy-query_caller_location_annotator'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+arproxy-query_caller_location_annotator will be setup automatically if you use mysql2 adapter. You can disable it by specifying env var as `DISABLE_QUERY_LOCATION_ANNOTATE=1`.
+
+If you want to setup manually, you can change Gemfile to `require: false` then write a initializer by hand:
+
+```
+# In config/initializers/arpoxy.rb
+require 'arproxy/query_caller_location_annotator/proxy'
+
+if ::Rails.env.development? || ::Rails.env.test?
+  ::Arproxy.configure do |config|
+    config.adapter = 'postgresql' # Your database adapter
+    config.use ::Arproxy::QueryCallerLocationAnnotator::Proxy
+  end
+
+  ::ActiveSupport.on_load :active_record do
+    ::Arproxy.enable!
+  end
+end
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/taiki45/arproxy-query_caller_location_annotator.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+desc 'Run Rails integration test'
+task :test do
+  exit(1) unless ruby('rails_integration_test.rb')
+end

data/arproxy-query_caller_location_annotator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arproxy/query_caller_location_annotator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arproxy-query_caller_location_annotator'
+  spec.version       = Arproxy::QueryCallerLocationAnnotator::VERSION
+  spec.authors       = ['Takatoshi Maeda', 'Taiki Ono']
+  spec.email         = ['taiks.4559@gmail.com']
+
+  spec.summary       = %q{Append query caller to each ActiveRecord's query log.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/taiki45/arproxy-query_caller_location_annotator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'arproxy'
+  spec.add_dependency 'rails'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arproxy/query_caller_location_annotator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/arproxy/query_caller_location_annotator.rb

@@ -0,0 +1,2 @@
+require 'arproxy/query_caller_location_annotator/proxy'
+require 'arproxy/query_caller_location_annotator/railtie'

data/lib/arproxy/query_caller_location_annotator/proxy.rb

@@ -0,0 +1,37 @@
+require 'arproxy'
+
+module Arproxy
+  module QueryCallerLocationAnnotator
+    class Proxy < ::Arproxy::Base
+      def execute(sql, name=nil)
+        return super(sql, name) unless sql =~ /^(SELECT|INSERT|UPDATE|DELETE)/
+
+        location = query_caller_location
+        if location.present?
+          super("#{sql} /* #{location} */", name)
+        else
+          super(sql, name)
+        end
+      end
+
+      private
+
+      def query_caller_location
+        location = caller_locations.find { |l| annotate_location_regexp.match(l.absolute_path) }
+        if location.nil?
+          nil
+        else
+          "app#{location.absolute_path.gsub(annotate_match_location, '')}:#{location.lineno} `#{location.label}`"
+        end
+      end
+
+      def annotate_match_location
+        @annotate_match_location ||= ::Rails.root.join('app').to_s.freeze
+      end
+
+      def annotate_location_regexp
+        @annotate_location_regexp ||= /\A#{Regexp.quote(annotate_match_location)}/.freeze
+      end
+    end
+  end
+end

data/lib/arproxy/query_caller_location_annotator/railtie.rb

@@ -0,0 +1,18 @@
+module Arproxy
+  module QueryCallerLocationAnnotator
+    class Railtie < ::Rails::Railtie
+      initializer 'arproxy.query_caller_location_annotator' do
+        if (::Rails.env.development? || ::Rails.env.test?) && !(ENV['DISABLE_QUERY_LOCATION_ANNOTATE'] == '1')
+          ::Arproxy.configure do |config|
+            config.adapter = 'mysql2'
+            config.use ::Arproxy::QueryCallerLocationAnnotator::Proxy
+          end
+
+          ::ActiveSupport.on_load :active_record do
+            ::Arproxy.enable!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arproxy/query_caller_location_annotator/version.rb

@@ -0,0 +1,5 @@
+module Arproxy
+  module QueryCallerLocationAnnotator
+    VERSION = '0.1.0'
+  end
+end

data/rails_integration_test.rb

@@ -0,0 +1,54 @@
+require 'fileutils'
+require 'open3'
+
+def execute_without_bundler
+  defined?(Bundler) ? Bundler.with_clean_env { yield } : yield
+end
+
+name = 'test_app'
+
+execute_without_bundler do
+  system('bundle install -j8')
+  FileUtils.rm_rf('tmp')
+  FileUtils.mkdir_p('tmp')
+  Dir.chdir('tmp') do
+    system("bundle exec rails new #{name} --skip-bundle")
+    Dir.chdir(name) do
+      lines = File.read('Gemfile').split("\n")
+      lines.reject! {|l| l.match(/sqlite3/) }
+      new = lines.first(1) + [
+        %!gem "mysql2"!,
+        %!gem "arproxy-query_caller_location_annotator", path: "#{__dir__}"!,
+      ] + lines.drop(1)
+      File.open('Gemfile', 'w') {|f| f.puts(new.join("\n")) }
+
+      database_config = File.read('config/database.yml')
+      database_config.gsub!('adapter: sqlite3', 'adapter: mysql2')
+      database_config.gsub!(%r{database: db/\w+.sqlite3}, 'database: arproxy_test_app')
+      File.write('config/database.yml', database_config)
+
+      system('bundle install -j8')
+      system('bin/rails db:drop db:setup')
+      system('bin/rails g model user name:string')
+      system('bin/rails db:migrate')
+
+      File.write('app/models/user.rb', <<-EOF)
+class User < ApplicationRecord
+  def self.xxx
+    first
+  end
+end
+      EOF
+
+      config = File.read('config/environments/development.rb')
+      config << "\nRails.application.config.logger = Logger.new(STDOUT)\n"
+      File.write('config/environments/development.rb', config)
+
+      log, e, s = Open3.capture3(%!bin/rails runner 'User.xxx'!)
+
+      raise("Failed to run script:\n#{e}") unless s.success?
+      raise("File path or line number is missing:\n#{log}") unless log.include?('app/models/user.rb:3')
+      raise("Method name is missing:\n#{log}") unless log.include?('xxx')
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: arproxy-query_caller_location_annotator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takatoshi Maeda
+- Taiki Ono
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arproxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Append query caller to each ActiveRecord's query log.
+email:
+- taiks.4559@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arproxy-query_caller_location_annotator.gemspec
+- bin/console
+- bin/setup
+- lib/arproxy/query_caller_location_annotator.rb
+- lib/arproxy/query_caller_location_annotator/proxy.rb
+- lib/arproxy/query_caller_location_annotator/railtie.rb
+- lib/arproxy/query_caller_location_annotator/version.rb
+- rails_integration_test.rb
+homepage: https://github.com/taiki45/arproxy-query_caller_location_annotator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Append query caller to each ActiveRecord's query log.
+test_files: []