rack-middleware-query_tracer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c02198ebe278a54ea01421ce4e7df4628e9e62d
+  data.tar.gz: 93584615ce58b9f9fd889c995f8c046e812d2af0
+SHA512:
+  metadata.gz: 4465790bb53bac9000546c617424a1318dca39d236b19ade0d3e17b43bfed5e073b3c69dd177d4cd571ad95524809476bdc63675f496e63f55adac9a7daab605
+  data.tar.gz: a8e8a930737130d94d7fa8607e069ed0126c9c50c5f5c28099b3a0d3ab1035fd9df49eefba7f3c951177132a2ccac673b1b9b601e8653af2e9daf2df72ad6913

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Keiichiro Nagano
+
+MIT License
+
+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,47 @@
+# Rack::Middleware::QueryTracer
+
+Dumps SQL queries with their positions in the source code.  For debugging purposes.
+
+ex:
+
+```
+[QueryTracing] [/manage/users?utf8=%E2%9C%93&id=&code=&nickname=a&udid=&commit=Search] [QueryTracer] [/app/views/manage/users/_users_list.html.slim:16:in `_app_views_manage_users__users_list_html_slim__2039225012774348846_70304982918140'] SELECT COUNT(*) FROM `users`  WHERE (nickname LIKE 'a%')
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-middleware-query_tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-middleware-query_tracer
+
+## Usage
+
+(Rails app) Create config/initializers/query_tracer.rb as follows:
+
+```
+Rails.application.config.middleware.use Rack::Middleware::QueryTracer, Rails.logger if Rails.env.development?
+```
+
+(non-Rails app) Not tested. Patches are welcome.
+
+## Credits
+
+@mitaku
+
+## Contributing
+
+1. Fork it ( https://github.com/knagano/rack-middleware-query_tracer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/middleware/query_tracer.rb

@@ -0,0 +1,87 @@
+require "rack/middleware/query_tracer/version"
+require "arproxy"
+
+module Rack
+  module Middleware
+    class QueryTracer
+      def initialize(app, logger = ::Arproxy.logger)
+        @app = app
+        @logger = logger
+
+        ::Arproxy.configure do |config|
+          config.adapter = ActiveRecord::Base.connection.adapter_name.downcase # "mysql2" # A DB Apdapter name which is used in your database.yml
+          config.use ProxyImpl, @logger
+        end
+      end
+
+      def call(env)
+        request = ActionDispatch::Request.new(env)
+        @logger.tagged("QueryTracing") do
+          ::Arproxy.enable!
+          begin
+            if request.filtered_path.blank?
+              @app.call(env)
+            else
+              @logger.tagged(request.filtered_path) do
+                @app.call(env)
+              end
+            end
+          ensure
+            ::Arproxy.disable!
+          end
+        end
+      end
+
+      class ProxyImpl < ::Arproxy::Base
+        def initialize(logger)
+          @logger = logger
+        end
+
+        def execute(sql, name = nil)
+          code_position_tag = "#{caller.select { |n| /\/app\// =~ n }[0].to_s.sub(/^.+?(\/app\/)/, '\1')}"
+          do_logging(code_position_tag, sql)
+          super(sql, name)
+        end
+
+        private
+
+        def do_logging(tag, sql)
+          @logger.tagged("QueryTracer") do
+            @logger.tagged(tag) do
+              @logger.info sql
+
+              case sql
+              when /SELECT/, /UPDATE/
+                case sql
+                when /1=0/
+                  @logger.tagged("ALERT") do
+                    @logger.info("1=0 QUERY: #{sql}")
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        #TODO
+        # def analyzer(sql, name=nil)
+        #   case sql
+        #   when /SELECT/, /UPDATE/
+        #     explain_sql     = "EXPLAIN #{sql}"
+        #     _result = super(explain_sql, name)
+        #
+        #     Rails.logger.tagged("EXPLAIN") do
+        #       result = ActiveRecord::Result.new(_result.fields, _result.to_a)
+        #       case sql
+        #       when /1=0/
+        #         Rails.logger.tagged("ALERT") do
+        #           Rails.logger.info "1=0 QUERY: #{sql}"
+        #         end
+        #       end
+        #     end
+        #   end
+        # end
+      end
+    end
+  end
+end

data/lib/rack/middleware/query_tracer/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Middleware
+    class QueryTracer
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rack-middleware-query_tracer.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/middleware/query_tracer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-middleware-query_tracer"
+  spec.version       = Rack::Middleware::QueryTracer::VERSION
+  spec.authors       = ["Keiichiro Nagano"]
+  spec.email         = ["knagano@CPAN.org"]
+  spec.summary       = %q{Dumps SQL queries with their positions in the source code}
+  spec.description   = %q{Dumps SQL queries with their positions in the source code}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "arproxy", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rack-middleware-query_tracer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keiichiro Nagano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arproxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Dumps SQL queries with their positions in the source code
+email:
+- knagano@CPAN.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/middleware/query_tracer.rb
+- lib/rack/middleware/query_tracer/version.rb
+- rack-middleware-query_tracer.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Dumps SQL queries with their positions in the source code
+test_files: []