https://github.com/vavgustov/debug-extras
Extras for Rails applications debug
https://github.com/vavgustov/debug-extras
gem ruby
Last synced: about 1 year ago
JSON representation
Extras for Rails applications debug
- Host: GitHub
- URL: https://github.com/vavgustov/debug-extras
- Owner: vavgustov
- License: mit
- Created: 2017-08-02T22:29:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-30T00:02:16.000Z (over 7 years ago)
- Last Synced: 2025-03-27T04:08:28.320Z (about 1 year ago)
- Topics: gem, ruby
- Language: Ruby
- Homepage:
- Size: 52.7 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# DebugExtras
[](https://travis-ci.org/vavgustov/debug-extras)
[](https://codeclimate.com/github/vavgustov/debug-extras/maintainability)
[](https://codeclimate.com/github/vavgustov/debug-extras/test_coverage)
Helper methods for Ruby on Rails applications debugging. [Screenshots](https://github.com/vavgustov/debug-extras#usage).
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [#dd](#dd)
- [#wp](#wp)
- [#dump](#dump)
- [Styling](#styling)
- [License](#license)
## Features
* `dd ` at any `app/` place. Inspired by `dd` function from
[Laravel](https://laravel.com/).
* `wp ` at any `app/` place. Inspired by classic PHP 'print' debug.
It works for HTML pages and bypass other content types like `application/json`.
* `dump ` at your views. It's alternative for `debug` method from
`ActionView::Helpers::DebugHelper` and `ap` from `AwesomePrint`.
## Installation
Add this line to your Gemfile:
```ruby
gem 'debug-extras', group: :development
```
And then execute:
$ bundle
## Usage
### #dd
Call `dd` from any `app/` place:
```ruby
dd @books
```
### #wp
Call `wp` from any `app/` place:
```ruby
wp 'Authors through #wp method (called from controller):'
wp @authors
```
### #dump
Call `dump` from views:
```erb
<%= dump 'Books through #dump method (called from view):' %>
<%= dump @books %>
```
## Styling
DebugExtras inject default CSS to the page on methods call. You can override styles and
set your fonts, margins, etc using `.debug-extras` wrapper. Just look to the page sources to see
them at the end of head section.
Example how to override default fonts in your stylesheet:
```css
.debug-extras pre,
.debug-extras kbd {
font-family: Consolas, SFMono-Regular, Menlo, Monaco, Ubuntu, monospace !important;
font-size: 14px !important;
line-height: 18px !important;
}
```
or may be you want to use `pre-wrap` rendering:
```css
.debug-extras pre {
white-space: pre-wrap !important;
}
```
>Note: if #wp and #dump results looks different compare to the screenshots above then default
styles were overridden by yours.
## License
DebugExtras is released under the [MIT License](https://opensource.org/licenses/MIT).