activerecord-cause 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb40767d288b56d2b5cba6f76da6a01246fd2307
+  data.tar.gz: 35038b8eee805737e7ad5ecdbdbe6ef7e7b82590
+SHA512:
+  metadata.gz: ad68f66803727c23c1dce8e8faf0c0207f51556250c9150df0d4da00e592578bf2743172df9e42d1c6343c3987ccee87a5b256e7fef540fe0e46735c6506f77e
+  data.tar.gz: 99ac93d77d69c7140d17aac2c4e1a17d5cb7de004ab58e8da0a98ae21ed4cd0d31dbca292b7e0afbe4ab74035ecf5e0d73fd5adf190fc7f7212d561f2ec8a0c1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.1
+  - 2.1
+gemfile:
+  - gemfiles/activerecord-32.gemfile
+  - gemfiles/activerecord-40.gemfile
+  - gemfiles/activerecord-41.gemfile

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+# Activerecord::Cause
+[![Build Status](https://travis-ci.org/joker1007/activerecord-cause.svg?branch=master)](https://travis-ci.org/joker1007/activerecord-cause)
+
+This gem logs where ActiveRecord actually loads record
+
+ex.
+```
+D, [2015-04-15T22:13:46.928908 #66812] DEBUG -- :   User Load (0.1ms)  SELECT "users".* FROM "users"
+D, [2015-04-15T22:13:46.929038 #66812] DEBUG -- :   User Load (ActiveRecord::Cause)  caused by /Users/joker/srcs/activerecord-cause/spec/activerecord/cause_spec.rb:16:in `block (3 levels) in <top (required)>'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-cause'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-cause
+
+## Usage
+
+```ruby
+ActiveRecord::Cause.match_paths = [
+  /spec\/spec_helper/,
+] # default is []
+ActiveRecord::Cause.log_with_sql = true # default is false
+```
+```ruby
+# spec/spec_helper.rb
+User.all
+
+# output to log file.
+# D, [2015-04-15T22:13:46.928908 #66812] DEBUG -- :   User Load (0.1ms)  SELECT "users".* FROM "users"
+# D, [2015-04-15T22:13:46.929038 #66812] DEBUG -- :   User Load (ActiveRecord::Cause)  SELECT "users".* FROM "users" caused by /Users/joker/srcs/activerecord-cause/spec/activerecord/cause_spec.rb:16:in `block (3 levels) in <top (required)>'
+```
+
+on Rails, `Activerecord::Cause.match_paths` has default `[/#{Rails.root.join("app").to_s}/]`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/joker1007/activerecord-cause/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,25 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+pwd = File.expand_path('../', __FILE__)
+
+namespace :spec do
+  %w(activerecord-32 activerecord-40 activerecord-41 activerecord-42).each do |gemfile|
+    desc "Run Tests by #{gemfile}.gemfile"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='#{pwd}/gemfiles/#{gemfile}.gemfile' bundle install --path #{pwd}/.bundle"
+      sh "BUNDLE_GEMFILE='#{pwd}/gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
+    end
+  end
+
+  desc "Run All Tests"
+  task :all do
+    %w(activerecord-32 activerecord-40 activerecord-41 activerecord-42).each do |gemfile|
+      Rake::Task["spec:#{gemfile}"].invoke
+    end
+  end
+end

data/activerecord-cause.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/cause/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-cause"
+  spec.version       = ActiveRecord::Cause::VERSION
+  spec.authors       = ["joker1007"]
+  spec.email         = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{This gem logs where ActiveRecord actually loads record}
+  spec.description   = %q{This gem logs where ActiveRecord actually loads record}
+  spec.homepage      = "https://github.com/joker1007/activerecord-cause"
+
+  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_runtime_dependency "activerecord", ">= 3.2"
+
+  spec.add_development_dependency "bundler", ">= 1.6"
+  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 "activerecord/cause"
+
+# 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/gemfiles/activerecord-32.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 3.2.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord-40.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord-41.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/activerecord-42.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+
+gemspec :path => "../"

data/lib/activerecord/cause.rb

@@ -0,0 +1,84 @@
+require "active_record"
+
+require "activerecord/cause/version"
+
+module ActiveRecord
+  module Cause
+    include ActiveSupport::Configurable
+
+    config_accessor :match_paths, instance_accessor: false do
+      []
+    end
+
+    config_accessor :log_with_sql, instance_accessor: false do
+      false
+    end
+
+    class LogSubscriber < ActiveSupport::LogSubscriber
+      IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN"]
+
+      def initialize
+        super
+        @odd = false
+      end
+
+      def sql(event)
+        return if ActiveRecord::Cause.match_paths.empty?
+        return unless logger.debug?
+
+        payload = event.payload
+
+        return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+        loc = caller_locations.find do |l|
+          ActiveRecord::Cause.match_paths.any? do |re|
+            re.match(l.absolute_path)
+          end
+        end
+
+        return unless loc
+
+        name  = "#{payload[:name]} (ActiveRecord::Cause)"
+        sql   = payload[:sql]
+        binds = nil
+
+        unless (payload[:binds] || []).empty?
+          binds = "  " + payload[:binds].map { |col,v|
+            render_bind(col, v)
+          }.inspect
+        end
+
+        if odd?
+          name = color(name, CYAN, true)
+          sql  = color(sql, nil, true)
+        else
+          name = color(name, MAGENTA, true)
+        end
+        cause = color(loc.to_s, nil, true)
+
+        output =
+          if ActiveRecord::Cause.log_with_sql
+            "  #{name}  #{sql}#{binds} caused by #{cause}"
+          else
+            "  #{name}  caused by #{cause}"
+          end
+
+        debug(output)
+      end
+
+      def odd?
+        @odd = !@odd
+      end
+
+      def logger
+        ActiveRecord::Base.logger
+      end
+    end
+  end
+end
+
+require "activerecord/cause/railtie" if defined?(Rails)
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Cause::LogSubscriber.attach_to :active_record
+end

data/lib/activerecord/cause/railtie.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Cause
+    class Railtie < ::Rails::Railtie
+      initializer "activerecord-cause" do
+        ActiveRecord::Cause.match_paths = [/#{Rails.root.join("app").to_s}/]
+      end
+    end
+  end
+end

data/lib/activerecord/cause/version.rb

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

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-cause
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: This gem logs where ActiveRecord actually loads record
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-cause.gemspec
+- bin/console
+- bin/setup
+- gemfiles/activerecord-32.gemfile
+- gemfiles/activerecord-40.gemfile
+- gemfiles/activerecord-41.gemfile
+- gemfiles/activerecord-42.gemfile
+- lib/activerecord/cause.rb
+- lib/activerecord/cause/railtie.rb
+- lib/activerecord/cause/version.rb
+homepage: https://github.com/joker1007/activerecord-cause
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: This gem logs where ActiveRecord actually loads record
+test_files: []