Guard::Rubybeautify

A guard to automatically beautify ruby files in a project.

Please be sure to have Guard installed before continuing.

Add this line to your application's Gemfile:

gem 'guard-rubybeautify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install guard-rubybeautify

Add a guardfile entry:

guard :rubybeautify do
	watch(%r{lib/.+\.rb})
end

or call

$ guard init rubybeautify

to have a section added automatically.

This guard also comes with three options built in:

• count: 1 # The count of indent chars.
• style: :tabs # the type, tab or spaces.
• grace_period: 5 # amount of time to not trigger further beautifies (stops loops).

grace_period is the only one that is unique to this gem. It's the period of time to not monitor for changes. Since the gem will trigger an overwrite, this can trigger specs and doc generation. Which then trigger more beautifies, that trigger more of the other guards.

To avoid this, set this to a period longer then a single modification runs. Since this has no global mode, you don't need to worry about what happens when you press enter. It will only impact open files that are saved.

An example with all the options.

guard :rubybeautify, count: 2, style: :spaces, grace_period: 1 do
	watch(%r{lib/.+\.rb})
end

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.

1. Fork it ( https://github.com/[my-github-username]/guard-rubybeautify/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