RSpec-specific analysis for your projects, as an extension to RuboCop.
Just install the
gem install rubocop-rspec
or if you use bundler put this in your
You need to tell RuboCop to load the RSpec extension. There are three ways to do this:
RuboCop configuration file
Put this into your
Now you can run
rubocop and it will automatically load the RuboCop RSpec
cops together with the standard cops.
rubocop --require rubocop-rspec
RuboCop::RakeTask.new do |task| task.requires << 'rubocop-rspec' end
rubocop-rspec is available on Code Climate as part of the rubocop engine. Learn More.
You can read more about RuboCop-RSpec in its official manual.
Inspecting files that don't end with
rubocop-rspec only inspects code within paths ending in
_spec.rb or including
spec/. You can override this setting in your config file by specifying one or more patterns:
# Inspect all files AllCops: RSpec: Patterns: - '.+'
# Inspect only files ending with `_test.rb` AllCops: RSpec: Patterns: - '_test.rb$'
All cops are located under
lib/rubocop/cop/rspec, and contain
.rubocop.yml, you may treat the RSpec cops just like any other
cop. For example:
RSpec/FilePath: Exclude: - spec/my_poorly_named_spec_file.rb
Non-goals of RuboCop RSpec
calculator.compute(line_item).should == 5
is a feature of RSpec itself – you can read about it in the RSpec Documentation
Enforcing an explicit RSpec receiver for top-level methods (disabling monkey patching)
Rspec.describe MyClass do ... end
describe MyClass do ... end
can be achieved using RSpec's
disable_monkey_patching! method, which you can read more about in the RSpec Documentation. This will also prevent
should from being defined on every object in your system.
should you will need all your specs to use the
expect syntax. You can use Transpec, which will do the conversion for you.
Checkout the contribution guidelines.
rubocop-rspec is MIT licensed. See the accompanying file for
the full text.