rubocop / rubocop-rspec_rails

Code style checking for Rails-related RSpec files.

RuboCop RSpec Rails

RSpec Rails-specific analysis for your projects, as an extension to RuboCop.

Installation

This gem implicitly depends on the rubocop-rspec gem, so you should install it first. Just install the rubocop-rspec and rubocop-rspec_rails gem

gem install rubocop-rspec rubocop-rspec_rails

or if you use bundler put this in your Gemfile

gem 'rubocop-rspec', require: false
gem 'rubocop-rspec_rails', require: false

Usage

You need to tell RuboCop to load the RSpec Rails extension. There are three ways to do this:

RuboCop configuration file

Put this into your .rubocop.yml.

require: rubocop-rspec_rails

Alternatively, use the following array notation when specifying multiple extensions.

require:
  - rubocop-rspec
  - rubocop-rspec_rails

Now you can run rubocop and it will automatically load the RuboCop RSpec Rails cops together with the standard cops.

Command line

rubocop --require rubocop-rspec_rails

Rake task

RuboCop::RakeTask.new do |task|
  task.requires << 'rubocop-rspec_rails'
end

Documentation

You can read more about RuboCop RSpec Rails in its official manual.

The Cops

All cops are located under lib/rubocop/cop/rspec_rails, and contain examples/documentation.

In your .rubocop.yml, you may treat the RSpec Rails cops just like any other cop. For example:

RSpecRails/AvoidSetupHook:
  Exclude:
    - spec/my_poorly_named_spec_file.rb

Contributing

Checkout the contribution guidelines.

License

rubocop-rspec_rails is MIT licensed. See the accompanying file for the full text.