https://github.com/joker1007/activerecord-cause

This gem logs where ActiveRecord actually loads record
https://github.com/joker1007/activerecord-cause

Last synced: 2 days ago
JSON representation

This gem logs where ActiveRecord actually loads record

• Host: GitHub
• URL: https://github.com/joker1007/activerecord-cause
• Owner: joker1007
• Created: 2015-04-15T13:22:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T11:49:19.000Z (12 months ago)
• Last Synced: 2024-10-07T02:15:29.620Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 39.1 KB
• Stars: 161
• Watchers: 9
• Forks: 11
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Activerecord::Cause

[![Build Status](https://travis-ci.org/joker1007/activerecord-cause.svg?branch=master)](https://travis-ci.org/joker1007/activerecord-cause)

[![Gem Version](https://badge.fury.io/rb/activerecord-cause.svg)](http://badge.fury.io/rb/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 '

```

## 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

ActiveRecord::Cause.log_mode = :all # default is :single

```

If `log_mode` is `:all`, outputs all matched locations;

```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 '

```

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