Installation

$ gem install rubocop
Bash

or using bundler

gem 'rubocop', require: false
Ruby

Quickstart

$ cd my/cool/ruby/project
$ rubocop
Bash

Report example

HTML Formatter

rubocop app -R --format html -o result.html
Bash

Report example

JSON Formatter

rubocop app -R --format json -o result.json
Bash

{
  "metadata": {
    "rubocop_version": "0.9.0",
    "ruby_engine": "ruby",
    "ruby_version": "2.0.0",
    "ruby_patchlevel": "195",
    "ruby_platform": "x86_64-darwin12.3.0"
  },
  "files": [{
      "path": "lib/foo.rb",
      "offenses": []
    }, {
      "path": "lib/bar.rb",
      "offenses": [{
          "severity": "convention",
          "message": "Line is too long. [81/80]",
          "cop_name": "LineLength",
          "corrected": true,
          "location": {
            "line": 546,
            "column": 80,
            "length": 4
          }
        }, {
          "severity": "warning",
          "message": "Unreachable code detected.",
          "cop_name": "UnreachableCode",
          "corrected": false,
          "location": {
            "line": 15,
            "column": 9,
            "length": 10
          }
        }
      ]
    }
  ],
  "summary": {
    "offense_count": 2,
    "target_file_count": 2,
    "inspected_file_count": 2
  }
}
JSON

Awesome Rubocops docs here

http://rubocop.readthedocs.io/en/latest/

Installation

gem install brakeman
Bash

or using bundler:

group :development do
  gem 'brakeman', :require => false
end
Ruby

Usage

brakeman
Bash

The output format is determined by the file extension or by using the -f option. Current options are: text, html, tabs, json, markdown, csv, and codeclimate

brakeman -o output.html -o output.json
Bash

Report example

Who is Using Brakeman?

• Code Climate
• GitHub
• Groupon
• New Relic
• Twitter

Installation

gem install reek
Bash

Run

reek [options] [dir_or_source_file]*
Bash

Example

# Smelly class
class Smelly
  # This will reek of UncommunicativeMethodName
  def x
    y = 10 # This will reek of UncommunicativeVariableName
  end
end
Ruby

$ reek demo.rb
Inspecting 1 file(s):
S

demo.rb -- 2 warnings:
  [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
  [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
Bash

Report example

reek app --format html > report.html
Bash

Getting started

1. Add SimpleCov to your Gemfile and bundle install:

   gem 'simplecov', :require => false, :group => :test
   Ruby

2. Load and launch SimpleCov at the very top of your test/test_helper.rb (or spec_helper.rb, cucumber env.rb, or whatever your preferred test framework uses):

   if ENV['RAILS_ENV'] == 'test'
     require 'simplecov'
     SimpleCov.start 'rails'
     puts "required simplecov"
   end
   Ruby

3. Run your tests, open up coverage/index.html in your browser and check out what you’ve missed so far.

4. Add the following to your .gitignore file to ensure that coverage results are not tracked by Git (optional):

   coverage
   

Example output

Coverage results report, fully browsable locally with sorting and much more:

Source file coverage details view: