Reevoocop

20% MonkeyPatch, 80% YAML, 100% Style

Reevoocop uses RuboCop to enforce Reevoo's style guidelines.

"What are the guidelines?", I hear you bellow. Well, check out our commented settings file for more information.

Installation

Add this line to your application's Gemfile:

gem 'reevoocop', require: false

And then execute:

$ bundle

Or install it globally with:

$ gem install reevoocop

Usage

In a Rakefile:

require 'reevoocop/rake_task'
ReevooCop::RakeTask.new(:reevoocop)

This can be quite dramatic if you haven't been using a style checker previously and you have, say, 10 years of code written. Why not only lint files changed in the last N commits? This also makes reevoocop much faster in large codebases as you only have to lint recently changed files.

require 'reevoocop/rake_task'
ReevooCop::RakeTask.new(:reevoocop) do |task|
  task.patterns = reevoocop_files(5)
  task.options = ['-D'] # Dispays name of failing cop in output. 
  exit if task.patterns == []
end

def reevoocop_files(pedantry)
  `git diff-tree --no-commit-id --name-only -r HEAD~#{pedantry} HEAD`
    .split("\n").select { |f| f.match(/(\.rb\z)|Rakefile/) && File.exist?(f) && !f.match(/db/) }
end

You can also use Reevoocop stand-alone:

$ reevoocop

If you are introducing reevoocop to an existing project, or bumping the reevoocop version try:

$ reevoocop -a

Anything that can be auto corrected will be, this will save you a lot of time!

Configuring / Contributing

You can't configure this, thats the point.
If you need to change our style guidelines, update the lib/reevoocop.yml file and open a pull request.
If you have a good reason to break the guidelines, you can switch off the cop for the code like this.
Please don't open a pull request unless you work at Reevoo, if you don't but would like to, look at our website!