rubocop-rspec 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d2c8c126eff832fb8c23b6a53a3e0d1a7e4f9c
-  data.tar.gz: c02b0c96893e673c18b0480f8e2755023ecb6987
+  metadata.gz: cc482ce2af79693a4824889cb1f4e418936466f9
+  data.tar.gz: f0f1ff329a1a1cf4642f38c64258370ae4b269f6
 SHA512:
-  metadata.gz: 1d6c8e1aeaa1e02427d474c2000c3cc50094746cf85e86a98965e1041aafb7b2be35e25616cce96b69f6a6803b2d1679e31647d112ea6e819267bfde52f24cb6
-  data.tar.gz: 643ac89c40e06801a88c7b19d49ee9109389f9a574717f9aee9ca527e48c38f0a95f8586979eecf5d9f26161a5ef3a0a502a1870c7a7fac62ed0ac96fd6b5140
+  metadata.gz: 871f9e04aaa056cbe3d0b3b73ef22b0ebcf6b1d2c242d94dc823e73a5b93a87683ffc24844a81bfe82849a85baf66d27800a07c7e069b62329da563c3467ef46
+  data.tar.gz: 866bf67d2e134be5e153ad066f7c6c04eec42647e2aad769745a4a4708005a93a437cf0427389170a57c00463bd02a66a05995e5d1f5362cfb38d0d7c025c8c6

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## Master (unreleased)
 
+## 1.7.0 (2016-08-24)
+
+* Add support for checking all example groups with `ExampleLength`. ([@backus][])
+* Add support for checking shared example groups for `DescribedClass`. ([@backus][])
+* Add support for checking `its` from [rspec-its](https://github.com/rspec/rspec-its). ([@backus][])
+* Add `EmptyExampleGroup` cop for detecting `describe`s and `context`s without any tests inside. ([@backus][])
+* Add `CustomIncludeMethods` configuration option for `EmptyExampleGroup`. ([@backus][])
+* Add `NestedGroups` cop for detecting excessive example group nesting. ([@backus][])
+* Add `MaxNesting` configuration option for `NestedGroups` cop. ([@backus][])
+* Add `ExpectActual` cop for detecting literal values within `expect(...)`. ([@backus][])
+* Add `MultipleExpectations` cop for detecting multiple `expect(...)` calls within one example. ([@backus][])
+* Add `Max` configuration option for `MultipleExpectations`. ([@backus][])
+* Add `SubjectStub` cop for testing stubbed test subjects. ([@backus][])
+* Add `LetSetup` cop for detecting cases where `let!` is used for test setup. ([@backus][])
+* Change all cops to only inspect files with names following rspec convention (`*/spec/*` and/or `_spec.rb`). ([@backus][])
+* Add `AllCops/RSpec` configuration option for specifying custom spec file patterns. ([@backus][])
+* Add `AssignmentOnly` configuration option for `RSpec/InstanceVariable` cop. ([@backus][])
+* Add `BeEql` cop which looks for expectations that can use `be(...)` instead of `eql(...)`. ([@backus][])
+* Add autocorrect support for `BeEql` cop. ([@backus][])
+* Add `MessageExpectation` cop for enforcing consistent style of either `expect(...).to receive` or `allow(...).to receive`. ([@backus][])
+* Add `MessageChain` cop. ([@bquorning][])
+
 ## 1.6.0 (2016-08-03)
 
 * Add `SkipBlocks` option for `DescribedClass` cop. ([@backus][])

data/README.md

@@ -55,6 +55,29 @@ RuboCop::RakeTask.new do |task|
 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`
+
+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:
+
+```yaml
+# Inspect all files
+AllCops:
+  RSpec:
+    Patterns:
+    - '.+'
+```
+
+```yaml
+# Inspect only files ending with `_test.rb`
+AllCops:
+  RSpec:
+    Patterns:
+    - '_test.rb$'
+```
 
 ## The Cops
 

data/Rakefile

@@ -1,5 +1,8 @@
+require 'open3'
+
 require 'bundler'
 require 'bundler/gem_tasks'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -27,4 +30,19 @@ task :internal_investigation do
   abort('RuboCop failed!') unless result.zero?
 end
 
-task default: [:spec, :internal_investigation]
+desc 'Build config/default.yml'
+task :build_config do
+  sh('bin/build_config')
+end
+
+desc 'Confirm config/default.yml is up to date'
+task confirm_config: :build_config do
+  _, stdout, _, process =
+    Open3.popen3('git diff --exit-code config/default.yml')
+
+  unless process.value.success?
+    raise "default.yml is out of sync:\n\n#{stdout.read}\nRun bin/build_config"
+  end
+end
+
+task default: [:build_config, :spec, :internal_investigation, :confirm_config]

data/config/default.yml

@@ -1,22 +1,42 @@
+---
+AllCops:
+  RSpec:
+    Patterns:
+    - _spec.rb
+    - "(?:^|/)spec/"
+
 RSpec/AnyInstance:
-  Description: 'Check that instances are not being stubbed globally'
+  Description: Check that instances are not being stubbed globally.
+  Enabled: true
+
+RSpec/BeEql:
+  Description: Check for expectations where `be(...)` can replace `eql(...)`.
   Enabled: true
 
+RSpec/HookArgument:
+  Description: Checks the arguments passed to `before`, `around`, and `after`.
+  Enabled: true
+  EnforcedStyle: implicit
+  SupportedStyles:
+  - implicit
+  - each
+  - example
+
 RSpec/DescribeClass:
-  Description: 'Check that the first argument to the top level describe is the tested class or module.'
+  Description: Check that the first argument to the top level describe is a constant.
   Enabled: true
 
 RSpec/DescribedClass:
-  Description: 'Use `described_class` for tested class / module'
+  Description: Checks that tests use `described_class`.
   SkipBlocks: false
   Enabled: true
 
 RSpec/DescribeMethod:
-  Description: 'Checks that the second argument to top level describe is the tested method name.'
+  Description: Checks that the second argument to `describe` specifies a method.
   Enabled: true
 
 RSpec/ExampleWording:
-  Description: 'Do not use should when describing your tests.'
+  Description: Checks that example descriptions do not start with "should".
   Enabled: true
   CustomTransform:
     be: is
@@ -24,44 +44,87 @@ RSpec/ExampleWording:
     not: does not
   IgnoredWords: []
 
+RSpec/EmptyExampleGroup:
+  Description: Checks if an example group does not include any tests.
+  Enabled: true
+  CustomIncludeMethods: []
+
+RSpec/ExpectActual:
+  Description: Checks for `expect(...)` calls containing literal values.
+  Enabled: true
+
+RSpec/MessageChain:
+  Description: Check that chains of messages are not being stubbed.
+  Enabled: true
 
 RSpec/MultipleDescribes:
-  Description: 'Checks for multiple top level describes.'
+  Description: Checks for multiple top level describes.
+  Enabled: true
+
+RSpec/MultipleExpectations:
+  Description: Checks if examples contain too many `expect` calls.
+  Enabled: true
+  Max: 1
+
+RSpec/NestedGroups:
+  Description: Checks for nested example groups.
   Enabled: true
+  MaxNesting: 2
 
 RSpec/InstanceVariable:
-  Description: 'Checks for the usage of instance variables.'
+  Description: Checks for instance variable usage in specs.
+  AssignmentOnly: false
+  Enabled: true
+
+RSpec/LetSetup:
+  Description: Checks unreferenced `let!` calls being used for test setup.
+  Enabled: true
+
+RSpec/LeadingSubject:
+  Description: Checks for `subject` definitions that come after `let` definitions.
   Enabled: true
 
 RSpec/FilePath:
-  Description: 'Checks the file and folder naming of the spec file.'
+  Description: Checks that spec file paths are consistent with the test subject.
   Enabled: true
   CustomTransform:
     RuboCop: rubocop
     RSpec: rspec
 
 RSpec/VerifiedDoubles:
-  Description: 'Prefer using verifying doubles over normal doubles.'
+  Description: Prefer using verifying doubles over normal doubles.
   Enabled: true
   IgnoreSymbolicNames: false
 
 RSpec/NotToNot:
-  Description: 'Enforces the usage of the same method on all negative message expectations.'
+  Description: Checks for consistent method usage for negating expectations.
   EnforcedStyle: not_to
   SupportedStyles:
-    - not_to
-    - to_not
+  - not_to
+  - to_not
   Enabled: true
 
 RSpec/Focus:
-  Description: 'Checks if there are focused specs.'
+  Description: Checks if examples are focused.
   Enabled: true
 
 RSpec/ExampleLength:
-  Description: 'Checks for long example'
+  Description: Checks for long examples.
   Enabled: true
   Max: 5
 
+RSpec/MessageExpectation:
+  Description: Checks for consistent message expectation style.
+  Enabled: true
+  EnforcedStyle: allow
+  SupportedStyles:
+  - allow
+  - expect
+
 RSpec/NamedSubject:
-  Description: 'Name your RSpec subject if you reference it explicitly'
+  Description: Checks for explicitly referenced test subjects.
+  Enabled: true
+
+RSpec/SubjectStub:
+  Description: Checks for stubbed test subjects.
   Enabled: true

data/lib/rubocop-rspec.rb

@@ -1,24 +1,42 @@
+require 'pathname'
+require 'yaml'
+
 require 'rubocop'
 
+require 'rubocop/rspec'
 require 'rubocop/rspec/version'
 require 'rubocop/rspec/inject'
 require 'rubocop/rspec/top_level_describe'
 require 'rubocop/rspec/wording'
 require 'rubocop/rspec/util'
+require 'rubocop/rspec/language'
+require 'rubocop/rspec/language/node_pattern'
+require 'rubocop/rspec/spec_only'
 
 RuboCop::RSpec::Inject.defaults!
 
 # cops
 require 'rubocop/cop/rspec/any_instance'
+require 'rubocop/cop/rspec/be_eql'
 require 'rubocop/cop/rspec/describe_class'
 require 'rubocop/cop/rspec/describe_method'
 require 'rubocop/cop/rspec/described_class'
+require 'rubocop/cop/rspec/empty_example_group'
+require 'rubocop/cop/rspec/example_length'
 require 'rubocop/cop/rspec/example_wording'
+require 'rubocop/cop/rspec/expect_actual'
 require 'rubocop/cop/rspec/file_path'
 require 'rubocop/cop/rspec/focus'
+require 'rubocop/cop/rspec/hook_argument'
 require 'rubocop/cop/rspec/instance_variable'
-require 'rubocop/cop/rspec/example_length'
+require 'rubocop/cop/rspec/leading_subject'
+require 'rubocop/cop/rspec/let_setup'
+require 'rubocop/cop/rspec/message_chain'
+require 'rubocop/cop/rspec/message_expectation'
 require 'rubocop/cop/rspec/multiple_describes'
+require 'rubocop/cop/rspec/multiple_expectations'
 require 'rubocop/cop/rspec/named_subject'
+require 'rubocop/cop/rspec/nested_groups'
 require 'rubocop/cop/rspec/not_to_not'
+require 'rubocop/cop/rspec/subject_stub'
 require 'rubocop/cop/rspec/verified_doubles'

data/lib/rubocop/cop/rspec/any_instance.rb

@@ -1,7 +1,9 @@
 module RuboCop
   module Cop
     module RSpec
-      # Pefer instance doubles over stubbing any instance of a class
+      # Check that instances are not being stubbed globally.
+      #
+      # Prefer instance doubles over stubbing any instance of a class
       #
       # @example
       #   # bad
@@ -19,6 +21,8 @@ module RuboCop
       #     end
       #   end
       class AnyInstance < Cop
+        include RuboCop::RSpec::SpecOnly
+
         MESSAGE = 'Avoid stubbing using `%{method}`'.freeze
 
         ANY_INSTANCE_METHODS = [

data/lib/rubocop/cop/rspec/be_eql.rb

@@ -0,0 +1,58 @@
+module RuboCop
+  module Cop
+    module RSpec
+      # Check for expectations where `be(...)` can replace `eql(...)`.
+      #
+      # The `be` matcher compares by identity while the `eql` matcher
+      # compares using `eql?`. Integers, floats, booleans, and symbols
+      # can be compared by identity and therefore the `be` matcher is
+      # preferable as it is a more strict test.
+      #
+      # @example
+      #
+      #   # bad
+      #   expect(foo).to eql(1)
+      #   expect(foo).to eql(1.0)
+      #   expect(foo).to eql(true)
+      #   expect(foo).to eql(false)
+      #   expect(foo).to eql(:bar)
+      #
+      #   # good
+      #   expect(foo).to be(1)
+      #   expect(foo).to be(1.0)
+      #   expect(foo).to be(true)
+      #   expect(foo).to be(false)
+      #   expect(foo).to be(:bar)
+      #
+      # This cop only looks for instances of `expect(...).to eql(...)`. We
+      # do not check `to_not` or `not_to` since `!eql?` is more strict
+      # than `!equal?`. We also do not try to flag `eq` because if
+      # `a == b`, and `b` is comparable by identity, `a` is still not
+      # necessarily the same type as `b` since the `#==` operator can
+      # coerce objects for comparison.
+      #
+      class BeEql < Cop
+        include RuboCop::RSpec::SpecOnly,
+                RuboCop::Cop::ConfigurableEnforcedStyle
+
+        MSG = 'Prefer `be` over `eql`'.freeze
+
+        def_node_matcher :eql_type_with_identity, <<-PATTERN
+          (send _ :to $(send nil :eql {true false int float sym}))
+        PATTERN
+
+        def on_send(node)
+          eql_type_with_identity(node) do |eql|
+            add_offense(eql, :selector, MSG)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.selector, 'be')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/describe_class.rb

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # Check that the first argument to the top level describe is the tested
-      # class or module.
+      # Check that the first argument to the top level describe is a constant.
       #
       # @example
       #   # bad
@@ -18,7 +17,7 @@ module RuboCop
       #   describe "A feature example", type: :feature do
       #   end
       class DescribeClass < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::TopLevelDescribe
 
         MSG = 'The first argument to describe should be '\
               'the class or module being tested.'.freeze

data/lib/rubocop/cop/rspec/describe_method.rb

@@ -3,8 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      # Checks that the second argument to the top level describe is the tested
-      # method name.
+      # Checks that the second argument to `describe` specifies a method.
       #
       # @example
       #   # bad
@@ -18,7 +17,9 @@ module RuboCop
       #   describe MyClass, '.my_class_method' do
       #   end
       class DescribeMethod < Cop
-        include RuboCop::RSpec::TopLevelDescribe, RuboCop::RSpec::Util
+        include RuboCop::RSpec::SpecOnly,
+                RuboCop::RSpec::TopLevelDescribe,
+                RuboCop::RSpec::Util
 
         MESSAGE = 'The second argument to describe should be the method ' \
                   "being tested. '#instance' or '.class'".freeze

data/lib/rubocop/cop/rspec/described_class.rb

@@ -3,6 +3,8 @@
 module RuboCop
   module Cop
     module RSpec
+      # Checks that tests use `described_class`.
+      #
       # If the first argument of describe is a class, the class is exposed to
       # each example via described_class - this should be used instead of
       # repeating the class.
@@ -18,45 +20,12 @@ module RuboCop
       #     subject { described_class.do_something }
       #   end
       class DescribedClass < Cop
-        include RuboCop::RSpec::TopLevelDescribe
+        include RuboCop::RSpec::SpecOnly, RuboCop::RSpec::TopLevelDescribe
 
         DESCRIBED_CLASS = 'described_class'.freeze
         MSG             = "Use `#{DESCRIBED_CLASS}` instead of `%s`".freeze
 
-        RSPEC_BLOCK_METHODS = '
-          :after
-          :around
-          :before
-          :context
-          :describe
-          :example
-          :example_group
-          :fcontext
-          :fdescribe
-          :feature
-          :fexample
-          :ffeature
-          :fit
-          :focus
-          :fscenario
-          :fspecify
-          :it
-          :let
-          :let!
-          :scenario
-          :specify
-          :xcontext
-          :xdescribe
-          :xexample
-          :xfeature
-          :xit
-          :xscenario
-          :xspecify
-        '.freeze
-
-        def_node_matcher :described_constant, <<-PATTERN
-          (block $(send _ :describe $(const ...)) (args) $_)
-        PATTERN
+        RSPEC_BLOCK_METHODS = RuboCop::RSpec::Language::ALL.to_node_pattern
 
         def_node_matcher :common_instance_exec_closure?, <<-PATTERN
           (block (send (const nil {:Class :Module}) :new ...) ...)