activerecord-dowsing 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc18bba3486decc5bba5fd562bbfc0bed1319f46
+  data.tar.gz: 2f36e191cf3920cf25f72523be790f8c71bdbe0a
+SHA512:
+  metadata.gz: 5bb5500264c0601106c86aa76fa2529fd34de956462fac86afaa8618da4c71daed6c9e7353b9e8c5d1cd0b33e6e0458b1a20cb1bf0ba434a14b18a6fae72a34e
+  data.tar.gz: 6dff488ed55f0e464083f514f56198a7f75176225075a83d6cc9902dc9487de9a86adeb61f9594b156e6ac8d53f2085da3215b8b0b5369aec64f3dde95105476

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rails'
+
+# Specify your gem's dependencies in activerecord-dowsing.gemspec
+gemspec

data/README.md

@@ -0,0 +1,55 @@
+# Activerecord::Dowsing
+
+Add comment where is it called in your sql automatically. It's useful for code reading.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-dowsing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-dowsing
+
+## Usage
+
+You can enable "activerecord-dowsing" by configuration.
+
+config/application.rb
+
+```
+config.x.activerecord_dowsing.enabled = true
+```
+
+"activerecord-dowsing" changes all queries(with comment).
+
+```
+SELECT `id` FROM `users`
+/* changes */
+SELECT `id` FROM `users` /* /app/controllers/users_controller.rb:12:in `foo' */
+```
+
+If you want to mark for specific application, use `with_app_name` option.
+
+```
+config.x.activerecord_dowsing.with_app_name = true
+```
+
+```
+SELECT `id` FROM `users`
+/* changes */
+SELECT `id` FROM `users` /* /app/controllers/users_controller.rb:12:in `foo'#app_name */
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ReleaseNote.md

@@ -0,0 +1,16 @@
+# 1.0.0 : 2017/4/27
+Remove: Drop configruration `activerecord_dowsing.enabled`. Please use `activerecord_dowsing.x.enabled` instead of.
+Feature: Support postgresql
+
+# 0.1.2 : 2016/1/22
+Feature: Support configruration `activerecord_dowsing.enabled`
+
+# 0.1.1 : 2016/1/22
+
+Fix: Remove `require: 'active_record-dowsing'` in README. No need any more.(Fixed name)
+Fix: Rewrite to modules.
+Fix: Wrong test spec.
+
+# 0.1.0 : 2016/1/21
+
+First Release

data/activerecord-dowsing.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/dowsing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-dowsing'
+  spec.version       = ActiveRecord::Dowsing::VERSION
+  spec.authors       = ['cyrill', 'alpaca-tc']
+  spec.email         = ['siril.taka@gmail.com', 'alpaca-tc@alpaca.tc']
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Mark tiny callers (stacktrace) in your sql.}
+  spec.description   = %q{Add comment where is it called in your sql automatically. It's useful for code reading.}
+  spec.homepage      = 'https://github.com/pixiv/activerecord-dowsing'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'activerecord', '~> 4.2'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/dowsing"
+
+# 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/active_record/dowsing.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require 'active_record/dowsing/version'
+require 'active_record/dowsing/railtie'
+
+module ActiveRecord
+  module Dowsing
+    autoload :Util, 'active_record/dowsing/util'
+    autoload :Patch, 'active_record/dowsing/patch'
+    autoload :PgConnectionPatch, 'active_record/dowsing/pg_connection_patch'
+  end
+end

data/lib/active_record/dowsing/patch.rb

@@ -0,0 +1,11 @@
+module ActiveRecord
+  module Dowsing
+    module Patch
+      private
+
+      def execute(sql, *args)
+        super(Util.append_comment(sql), *args)
+      end
+    end
+  end
+end

data/lib/active_record/dowsing/pg_connection_patch.rb

@@ -0,0 +1,31 @@
+module ActiveRecord
+  module Dowsing
+    module PgConnectionPatch
+      # https://bitbucket.org/ged/ruby-pg/src/050a996456b14e1086581b79b391f37af999d414/ext/pg_connection.c?at=default&fileviewer=file-view-default
+      %i(
+        async_exec
+        exec_params
+        send_query
+      ).each do |method_name|
+        module_eval(<<-INSERT_CALLER_LOCAION, __FILE__, __LINE__ + 1)
+          def #{method_name}(sql, *)
+            sql = Util.append_comment(sql)
+            super
+          end
+        INSERT_CALLER_LOCAION
+      end
+
+      %i(
+        prepare
+        send_prepare
+      ).each do |method_name|
+        module_eval(<<-INSERT_CALLER_LOCAION, __FILE__, __LINE__ + 1)
+          def #{method_name}(_, sql, *)
+            sql = Util.append_comment(sql)
+            super
+          end
+        INSERT_CALLER_LOCAION
+      end
+    end
+  end
+end

data/lib/active_record/dowsing/railtie.rb

@@ -0,0 +1,22 @@
+module ActiveRecord
+  module Dowsing
+    class Railtie < ::Rails::Railtie
+      initializer 'ActiveRecord::Dowsing patch' do
+        next unless Rails.configuration.x.activerecord_dowsing.enabled
+
+        ActiveSupport.on_load :active_record do
+          configuration = ActiveRecord::Base.connection_config
+          resolver = ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new({})
+          adapter_method = resolver.spec(configuration).adapter_method
+          adapter = ActiveRecord::Base.public_send(adapter_method, configuration)
+
+          if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) && adapter.is_a?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+            PG::Connection.prepend(ActiveRecord::Dowsing::PgConnectionPatch)
+          elsif defined?(ActiveRecord::ConnectionAdapters::Mysql2Adapter) && adapter.is_a?(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+            adapter.class.prepend(ActiveRecord::Dowsing::Patch)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record/dowsing/util.rb

@@ -0,0 +1,29 @@
+require 'active_support/core_ext/string/filters'
+
+module ActiveRecord
+  module Dowsing
+    module Util
+      def self.append_comment(sql)
+        location = filter_stacktrace(caller).first
+        "#{sql} /* #{location}#{app_name} */"
+      end
+
+      def self.app_name
+        return unless Rails.application&.initialized? && Rails.configuration.x.activerecord_dowsing.with_app_name
+        "##{Rails.application.class.parent_name.downcase}"
+      end
+
+      def self.filter_stacktrace(stack)
+        @cleaner ||= ActiveSupport::BacktraceCleaner.new.tap do |cleaner|
+          cleaner.add_filter   { |line| line.remove(Rails.root.to_s) }
+          cleaner.add_filter   { |line| line.remove('*') } # Sanitize comment
+
+          cleaner.add_silencer { |line| line =~ %r{activerecord-dowsing/lib} }
+          cleaner.add_silencer { |line| line =~ /gems/ }
+        end
+
+        @cleaner.clean(stack)
+      end
+    end
+  end
+end

data/lib/active_record/dowsing/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Dowsing
+    VERSION = '1.0.0'
+  end
+end

data/lib/activerecord-dowsing.rb

@@ -0,0 +1 @@
+require 'active_record/dowsing'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-dowsing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- cyrill
+- alpaca-tc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Add comment where is it called in your sql automatically. It's useful
+  for code reading.
+email:
+- siril.taka@gmail.com
+- alpaca-tc@alpaca.tc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ReleaseNote.md
+- activerecord-dowsing.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/dowsing.rb
+- lib/active_record/dowsing/patch.rb
+- lib/active_record/dowsing/pg_connection_patch.rb
+- lib/active_record/dowsing/railtie.rb
+- lib/active_record/dowsing/util.rb
+- lib/active_record/dowsing/version.rb
+- lib/activerecord-dowsing.rb
+homepage: https://github.com/pixiv/activerecord-dowsing
+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.11
+signing_key: 
+specification_version: 4
+summary: Mark tiny callers (stacktrace) in your sql.
+test_files: []