rubocop-rspec 1.7.0 → 3.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,17 @@
+# The RuboCop Community Code of Conduct
+
+**Note:** We have picked the following code of conduct based on [Ruby's own
+code of conduct](https://www.ruby-lang.org/en/conduct/).
+
+This document provides a few simple community guidelines for a safe, respectful,
+productive, and collaborative place for any person who is willing to contribute
+to the RuboCop community. It applies to all "collaborative spaces", which are
+defined as community communications channels (such as mailing lists, submitted
+patches, commit comments, etc.).
+
+- Participants will be tolerant of opposing views.
+- Participants must ensure that their language and actions are free of personal
+  attacks and disparaging personal remarks.
+- When interpreting the words and actions of others, participants should always
+  assume good intentions.
+- Behaviour which can be reasonably considered harassment will not be tolerated.

data/MIT-LICENSE.md

@@ -1,5 +1,4 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
 
 Copyright (c) 2014 Ian MacLeod <ian@nevir.net>
 

data/README.md

@@ -1,14 +1,20 @@
 # RuboCop RSpec
 
+[![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)
 [![Gem Version](https://badge.fury.io/rb/rubocop-rspec.svg)](https://rubygems.org/gems/rubocop-rspec)
-[![Dependency Status](https://gemnasium.com/nevir/rubocop-rspec.svg)](https://gemnasium.com/nevir/rubocop-rspec)
-[![Build Status](https://secure.travis-ci.org/nevir/rubocop-rspec.svg?branch=master)](http://travis-ci.org/nevir/rubocop-rspec)
-[![Coverage Status](https://codeclimate.com/github/nevir/rubocop-rspec/badges/coverage.svg)](https://codeclimate.com/github/nevir/rubocop-rspec/coverage)
-[![Code Climate](https://codeclimate.com/github/nevir/rubocop-rspec.svg)](https://codeclimate.com/github/nevir/rubocop-rspec)
+![CI](https://github.com/rubocop/rubocop-rspec/workflows/CI/badge.svg)
 
-RSpec-specific analysis for your projects, as an extension to
-[RuboCop](https://github.com/bbatsov/rubocop).
+[RSpec](https://rspec.info/)-specific analysis for your projects, as an extension to
+[RuboCop](https://github.com/rubocop/rubocop).
 
+- [Installation](#installation)
+  - [Upgrading to RuboCop RSpec v3.x](#upgrading-to-rubocop-rspec-v3x)
+  - [Upgrading to RuboCop RSpec v2.x](#upgrading-to-rubocop-rspec-v2x)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [The Cops](#the-cops)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
 
@@ -20,10 +26,17 @@ gem install rubocop-rspec
 
 or if you use bundler put this in your `Gemfile`
 
+```ruby
+gem 'rubocop-rspec', require: false
 ```
-gem 'rubocop-rspec'
-```
 
+### Upgrading to RuboCop RSpec v3.x
+
+Read all the details in our [Upgrade to Version 3.x](https://docs.rubocop.org/rubocop-rspec/3.0/upgrade_to_version_3.html) document.
+
+### Upgrading to RuboCop RSpec v2.x
+
+Read all the details in our [Upgrade to Version 2.x](https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html) document.
 
 ## Usage
 
@@ -34,10 +47,18 @@ ways to do this:
 
 Put this into your `.rubocop.yml`.
 
-```
+```yaml
 require: rubocop-rspec
 ```
 
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-rspec
+```
+
 Now you can run `rubocop` and it will automatically load the RuboCop RSpec
 cops together with the standard cops.
 
@@ -57,27 +78,11 @@ end
 
 ### Code Climate
 
-rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://codeclimate.com/changelog/55a433bbe30ba00852000fac).
-
-## Inspecting files that don't end with `_spec.rb`
+rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://marketing.codeclimate.com/changelog/55a433bbe30ba00852000fac/).
 
-By default, `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:
+## Documentation
 
-```yaml
-# Inspect all files
-AllCops:
-  RSpec:
-    Patterns:
-    - '.+'
-```
-
-```yaml
-# Inspect only files ending with `_test.rb`
-AllCops:
-  RSpec:
-    Patterns:
-    - '_test.rb$'
-```
+You can read more about RuboCop RSpec in its [official manual](https://docs.rubocop.org/rubocop-rspec).
 
 ## The Cops
 
@@ -89,19 +94,14 @@ In your `.rubocop.yml`, you may treat the RSpec cops just like any other
 cop. For example:
 
 ```yaml
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Exclude:
     - spec/my_poorly_named_spec_file.rb
 ```
 
-
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
 
 ## License