activerecord-commentator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0adde2431f9bafcbb0d02dff9531fc7496c7e38d
+  data.tar.gz: 63d673b2db58b68ba95b71ec2bb84e8305e05af9
+SHA512:
+  metadata.gz: 72f64658d81b4a17d444aa753fb43dda9902d58730525e90f8a49bd1e899033356e48ed11aa18a4ac5163d7845c293e208888617b5af8306987d564f32e32967
+  data.tar.gz: 7ab383e87ee05f736ddd6acc4afa4f7c406e54cb76e3fc9df3f059e665143dcd015c310c5b2b8e19dbd5e33d12107acb7ecef4c6cbe5cd35ab524af51f38eaef

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.6
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,74 @@
+# ActiveRecord::Commentator
+
+ActiveRecord::Commentator adds `caller_location` (filename, line-number and method-name) as SQL comment that invokes SQL statement.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-commentator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-commentator
+
+## Usage
+
+### in Rails app
+
+```ruby
+# in config/initializers/commentator.rb
+require "active_record/commentator"
+
+ActiveRecord::Commentator::Configuration.paths = [
+  /#{Rails.root.join("app").to_s}|#{Rails.root.join("lib").to_s}/
+]
+ActiveRecord::Base.connection.class.prepend(ActiveRecord::Commentator)
+```
+
+### Start server and visit localhost:3000
+
+```
+bundle exec rails server
+```
+
+## Rails application log
+
+```
+# execute sql at model
+(0.3ms)  SELECT  `favorites`.`product_id` FROM `favorites` /* /Users/hisaichi5518/projects/github.com/sample/app/models/product.rb:28:in `block in <class:Product>' */
+
+# execute sql at view
+Info Load (0.5ms)  SELECT  `infos`.* FROM `infos` /* /Users/hisaichi5518/projects/github.com/sample/app/cells/infos/index.html.erb:3:in `_app_cells_infos_index_html_erb___2113458239111152552_70242821135200' */
+```
+
+## Database slow log
+
+```
+# Time: 198723 23:21:34
+# User@Host: ... @ localhost []
+# Query_time: 1.90872  Lock_time: 0.90879 Rows_sent: 1  Rows_examined: 9802714
+...
+SELECT  `favorites`.`product_id` FROM `favorites` /* /Users/hisaichi5518/projects/github.com/sample/app/models/product.rb:28:in `block in <class:Product>' */
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake rspec` 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 to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hisaichi5518/activerecord-commentator.
+
+## See also
+
+- https://github.com/joker1007/activerecord-cause
+- https://metacpan.org/pod/DBIx::Sunny

data/Rakefile

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

data/activerecord-commentator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/commentator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-commentator"
+  spec.version       = ActiveRecord::Commentator::VERSION
+  spec.authors       = ["hisaichi5518"]
+  spec.email         = ["hisaichi5518@gmail.com"]
+
+  spec.summary       = %q{adds `caller_location` as SQL comment}
+  spec.description   = %q{ActiveRecord::Commentator adds execute location (filename, line-number and method-name) as SQL comment that invokes SQL statement.}
+  spec.homepage      = "https://github.com/hisaichi5518/activerecord-commentator"
+
+  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.required_ruby_version = '>= 2.1.6'
+
+  spec.add_runtime_dependency "activerecord", ">= 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/commentator"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_record/commentator.rb

@@ -0,0 +1,26 @@
+require "active_record/commentator/version"
+require "active_record/commentator/configuration"
+
+module ActiveRecord
+  module Commentator
+    # ActiveRecord::ConnectionAdapters::DatabaseStatements#execute
+    def execute(sql, name = nil)
+      new_sql = write_comment_to_sql(sql, fetch_execute_location)
+      super(new_sql, name)
+    end
+
+    private
+    def fetch_execute_location
+      locations = caller_locations.select do |location|
+        ::ActiveRecord::Commentator::Configuration.paths.any? { |re| re.match(location.absolute_path) }
+      end
+
+      locations.first
+    end
+
+    def write_comment_to_sql(sql, comment)
+      return sql unless comment
+      sql + " /* #{comment.to_s.chomp} */ "
+    end
+  end
+end

data/lib/active_record/commentator/configuration.rb

@@ -0,0 +1,14 @@
+require "active_support/configurable"
+
+module ActiveRecord
+  module Commentator
+    module Configuration
+      include ActiveSupport::Configurable
+
+      config_accessor :paths, instance_accessor: false do
+        []
+      end
+    end
+  end
+end
+

data/lib/active_record/commentator/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Commentator
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-commentator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hisaichi5518
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord::Commentator adds execute location (filename, line-number
+  and method-name) as SQL comment that invokes SQL statement.
+email:
+- hisaichi5518@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-commentator.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/commentator.rb
+- lib/active_record/commentator/configuration.rb
+- lib/active_record/commentator/version.rb
+homepage: https://github.com/hisaichi5518/activerecord-commentator
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: adds `caller_location` as SQL comment
+test_files: []