/pictureframe

Frame your debug code!

Primary LanguageRubyMIT LicenseMIT

Pictureframe Gem Version

This is a gem to help organize and finding your debug statements in your server logs.

Installation

Add this line to your application's Gemfile:

gem 'pictureframe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pictureframe

Usage

For this example, we will be debugging @account

In your server code, you can use picture frame like so:

require 'pictureframe'

# ...

width = 28
frame(@account.email, width)
frame @account.email

And in your server, you will see this as an output:

   ___________________________
  | ._______________________. |
  | |                       | |
  | | teampalmer.apps@gmail | |
  | | .com                  | |
  | ._______________________. |
   ___________________________
   _______________________________
  | .___________________________. |
  | |                           | |
  | | teampalmer.apps@gmail.com | |
  | .___________________________. |
   _______________________________

I have also added aliases, so you can quickly use #f, #pf, and #frame. So these are all going to have the same output:

Pictureframe.frame 'hello'
frame 'hello'
pf 'hello'
f 'hello'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cdpalmer/pictureframe.

License

The gem is available as open source under the terms of the MIT License.