Merge pull request #912 from zdennis/features/file-path-cop-spec-suffix-only

Add SpecSuffixOnly option to RSpec/FilePath cop

Author: bquorning

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Add new `RSpec/VariableName` cop. ([@tejasbubane][])
 * Add new `RSpec/VariableDefinition` cop. ([@tejasbubane][])
 * Expand `Capybara/VisibilityMatcher` to support more than just `have_selector`. ([@twalpole][])
+* Add new `SpecSuffixOnly` option to `RSpec/FilePath` cop. ([@zdennis][])
 
 ## 1.39.0 (2020-05-01)
 
@@ -508,3 +509,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@AlexWayfer]: https://github.com/AlexWayfer
 [@tejasbubane]: https://github.com/tejasbubane
 [@twalpole]: https://github.com/twalpole
+[@zdennis]: https://github.com/zdennis

config/default.yml

@@ -191,12 +191,13 @@ RSpec/ExpectOutput:
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectOutput
 
 RSpec/FilePath:
-  Description: Checks that spec file paths are consistent with the test subject.
+  Description: Checks that spec file paths are consistent and well-formed.
   Enabled: true
   CustomTransform:
     RuboCop: rubocop
     RSpec: rspec
   IgnoreMethods: false
+  SpecSuffixOnly: false
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/FilePath
 
 RSpec/Focus:

lib/rubocop/cop/rspec/file_path.rb

@@ -3,10 +3,11 @@
 module RuboCop
   module Cop
     module RSpec
-      # Checks that spec file paths are consistent with the test subject.
+      # Checks that spec file paths are consistent and well-formed.
       #
-      # Checks the path of the spec file and enforces that it reflects the
-      # described class/module and its optionally called out method.
+      # By default, this checks that spec file paths are consistent with the
+      # test subject and and enforces that it reflects the described
+      # class/module and its optionally called out method.
       #
       # With the configuration option `IgnoreMethods` the called out method will
       # be ignored when determining the enforced path.
@@ -15,6 +16,10 @@ module RSpec
       # be specified that should not as usual be transformed from CamelCase to
       # snake_case (e.g. 'RuboCop' => 'rubocop' ).
       #
+      # With the configuration option `SpecSuffixOnly` test files will only
+      # be checked to ensure they end in '_spec.rb'. This option disables
+      # checking for consistency in the test subject or test methods.
+      #
       # @example
       #   # bad
       #   whatever_spec.rb         # describe MyClass
@@ -41,6 +46,16 @@ module RSpec
       #   # good
       #   my_class_spec.rb         # describe MyClass, '#method'
       #
+      # @example when configuration is `SpecSuffixOnly: true`
+      #   # good
+      #   whatever_spec.rb         # describe MyClass
+      #
+      #   # good
+      #   my_class_spec.rb         # describe MyClass
+      #
+      #   # good
+      #   my_class_spec.rb         # describe MyClass, '#method'
+      #
       class FilePath < Cop
         include RuboCop::RSpec::TopLevelDescribe
 
@@ -70,9 +85,15 @@ def routing_spec?(args)
         end
 
         def glob_for((described_class, method_name))
+          return glob_for_spec_suffix_only? if spec_suffix_only?
+
           "#{expected_path(described_class)}#{name_glob(method_name)}*_spec.rb"
         end
 
+        def glob_for_spec_suffix_only?
+          '*_spec.rb'
+        end
+
         def name_glob(name)
           return unless name&.str_type?
 
@@ -111,6 +132,10 @@ def filename_ends_with?(glob)
         def relevant_rubocop_rspec_file?(_file)
           true
         end
+
+        def spec_suffix_only?
+          cop_config['SpecSuffixOnly']
+        end
       end
     end
   end

manual/cops_rspec.md

@@ -1164,10 +1164,11 @@ Enabled by default | Supports autocorrection
 --- | ---
 Enabled | No
 
-Checks that spec file paths are consistent with the test subject.
+Checks that spec file paths are consistent and well-formed.
 
-Checks the path of the spec file and enforces that it reflects the
-described class/module and its optionally called out method.
+By default, this checks that spec file paths are consistent with the
+test subject and and enforces that it reflects the described
+class/module and its optionally called out method.
 
 With the configuration option `IgnoreMethods` the called out method will
 be ignored when determining the enforced path.
@@ -1176,6 +1177,10 @@ With the configuration option `CustomTransform` modules or classes can
 be specified that should not as usual be transformed from CamelCase to
 snake_case (e.g. 'RuboCop' => 'rubocop' ).
 
+With the configuration option `SpecSuffixOnly` test files will only
+be checked to ensure they end in '_spec.rb'. This option disables
+checking for consistency in the test subject or test methods.
+
 ### Examples
 
 ```ruby
@@ -1203,6 +1208,18 @@ whatever_spec.rb         # describe MyClass
 # good
 my_class_spec.rb         # describe MyClass
 
+# good
+my_class_spec.rb         # describe MyClass, '#method'
+```
+#### when configuration is `SpecSuffixOnly: true`
+
+```ruby
+# good
+whatever_spec.rb         # describe MyClass
+
+# good
+my_class_spec.rb         # describe MyClass
+
 # good
 my_class_spec.rb         # describe MyClass, '#method'
 ```
@@ -1213,6 +1230,7 @@ Name | Default value | Configurable values
 --- | --- | ---
 CustomTransform | `{"RuboCop"=>"rubocop", "RSpec"=>"rspec"}` | 
 IgnoreMethods | `false` | Boolean
+SpecSuffixOnly | `false` | Boolean
 
 ### References
 

spec/rubocop/cop/rspec/file_path_spec.rb

@@ -204,4 +204,21 @@
       RUBY
     end
   end
+
+  context 'when configured with SpecSuffixOnly' do
+    let(:cop_config) { { 'SpecSuffixOnly' => true } }
+
+    it 'does not care about the described class' do
+      expect_no_offenses(<<-RUBY, 'whatever_spec.rb')
+        describe MyClass do; end
+      RUBY
+    end
+
+    it 'registers an offense when _spec.rb suffix is missing' do
+      expect_offense(<<-RUBY, 'whatever.rb')
+        describe MyClass do; end
+        ^^^^^^^^^^^^^^^^ Spec path should end with `*_spec.rb`.
+      RUBY
+    end
+  end
 end