Repository files navigation

Guard::Brakeman allows you to automatically runBrakeman tests when files are modified.

The simplest way to install Guard is to useBundler.Please make sure to haveGuard installed before continue.

Add Guard::Brakeman to yourGemfile:

group :developmentdo  gem'guard-brakeman'end

Add the default Guard::Brakeman template to yourGuardfile by running:

$ guard init brakeman

Check outsublime_guard! It gives you control Guard without leaving the editor. This is even more powerful with Growl notifications. Enter distraction-free mode and never leave!

Please read theGuard usage documentation.

Guard::Brakeman can be adapted to all kind of projects and comes with a default template that looks like this:

guard:brakeman,run_on_start:truedowatch(%r{^app/.+\.(erb|haml|rhtml|rb)$})watch(%r{^config/.+\.rb$})watch(%r{^lib/.+\.rb$})watch('Gemfile')end

Please read theGuard documentation for more information about the Guardfile DSL.

:quiet=>false# set the "quiet" option in brakeman (only results will be printed):ignore_file=>'config/brakeman.ignore':output_files=>%w(donkey.html)# write the results to the specified files:notifications=>false# display Growl notifications, defaults to true:run_on_start=>true# run all checks on startup, defaults to false:min_confidence=>3# only alert on warnings above a threshold, defaults to 1:chatty=>true# notify on ALL changes.  Defaults to false, only new or fixed warnings trigger a Growl:url_safe_methods=>%w(method1method2)# list methods which are safe for use in link_to URLs

You can report issues and feature requests toGitHub Issues. Try to figure outwhere the issue belongs to: Is it an issue with Guard itself or with Guard::Brakeman? Please don'task the question in the issue tracker, instead join us in ourGoogle group or on#guard (irc.freenode.net).

When you file an issue, please try to follow to these simple rules if applicable:

• Make sure you run Guard withbundle exec first.
• Add debug information to the issue by running Guard with the--debug option.
• Add yourGuardfile andGemfile to the issue.
• Make sure that the issue is reproducible with your description.

• Source hosted atGitHub.

Pull requests are very welcome! Please try to follow these simple rules if applicable:

• Please create a topic branch for every separate change you make.
• Make sure your patches are well tested.
• Update the README.
• Update the CHANGELOG for noteworthy changes.
• Pleasedo not change the version number.

For questions please join us in ourGoogle group or on#guard (irc.freenode.net).

• Neil Matatall
• Justin Collins

TheGuard Team for giving us such a nice pice of softwarethat is so easy to extend, onehas to make a plugin for it!

All the authors of the numerousGuards available for making the Guard ecosystemso much growing and comprehensive.

(The MIT License)

Copyright (c) 2010 - 2011 Neil Matatall

Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the'Software'), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall beincluded in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANYCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.