Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yhirano55/trace_location
🔍Help you get reading the huge open souce libraries in Ruby and trace its source locations
https://github.com/yhirano55/trace_location
codereader rails tracepoints
Last synced: 28 days ago
JSON representation
🔍Help you get reading the huge open souce libraries in Ruby and trace its source locations
- Host: GitHub
- URL: https://github.com/yhirano55/trace_location
- Owner: yhirano55
- License: mit
- Created: 2019-05-01T10:15:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T20:39:12.000Z (3 months ago)
- Last Synced: 2024-09-30T09:41:28.468Z (about 1 month ago)
- Topics: codereader, rails, tracepoints
- Language: Ruby
- Homepage:
- Size: 280 KB
- Stars: 244
- Watchers: 5
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# TraceLocation
[](https://travis-ci.org/yhirano55/trace_location)
TraceLocation helps you trace the source location to ease reading huge open-source libraries in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'trace_location'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install trace_location
## Usage
### Example: Track establish connection in Active Record
```ruby
config = Rails.application.config.database_configuration[Rails.env]
TraceLocation.trace do
# You just surround you want to track the process.
ActiveRecord::Base.establish_connection(config)
end
```
Then you can get logs like this: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_establish_connection/result.md), [.log](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_establish_connection/result.log), [.csv](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_establish_connection/result.csv)
### Trace method options
| name | content | example |
|:-----|:--------|:--------|
| format | `:md`, `:log`, `:csv` (default: `:md`) | `:md` |
| match | Regexp, Symbol, String or Array for allow list | `[:activerecord, :activesupport]` |
| ignore | Regexp, Symbol, String or Array for deny list | `/bootsnap\|activesupport/` |
| methods | Symbol or Array of method names | `[:call]` |
## More examples
### Example: Track the validation process of Active Record
```ruby
book = Book.new(title: "My Book Title")
TraceLocation.trace(match: /activerecord/) { book.validate }
```
Results: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_validation_process/result.md), [.log](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_validation_process/result.log), [.csv](https://github.com/yhirano55/trace_location/blob/master/examples/active_record_validation_process/result.csv)
### Example: Track the lifecycle of Rails application
```ruby
env = Rack::MockRequest.env_for('http://localhost:3000/books')
TraceLocation.trace do
status, headers, body = Rails.application.call(env)
end
```
Results: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/lifecycle_of_rails_application/result.md), [.log](https://github.com/yhirano55/trace_location/blob/master/examples/lifecycle_of_rails_application/result.log), [.csv](https://github.com/yhirano55/trace_location/blob/master/examples/lifecycle_of_rails_application/result.csv)
### Example: Track the `has_secure_password` in User model
```ruby
class User < ApplicationRecord
# temporary surrounding with TraceLocation#trace
TraceLocation.trace(format: :md, ignore: /activesupport/) do
has_secure_password
end
```
Results: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/has_secure_password/result.md), [.log](https://github.com/yhirano55/trace_location/blob/master/examples/has_secure_password/result.log), [.csv](https://github.com/yhirano55/trace_location/blob/master/examples/has_secure_password/result.csv)
### Example: Track the rendering process of action in controller class
```ruby
class BooksController < ApplicationController
before_action :set_book, only: [:show, :update, :destroy]
# GET /books
def index
@books = Book.all
# temporary surrounding with TraceLocation#trace
TraceLocation.trace(format: :md, ignore: /activesupport|rbenv|concurrent-ruby/) do
render json: @books
end
end
```
Results: [.md](https://github.com/yhirano55/trace_location/blob/master/examples/rendering_process/result.md), [.log](https://github.com/yhirano55/trace_location/blob/master/examples/rendering_process/result.log), [.csv](https://github.com/yhirano55/trace_location/blob/master/examples/rendering_process/result.csv)
## License
[MIT License](https://opensource.org/licenses/MIT)