Merge pull request rubocop#874 from lazycoder9/fix/repeated_example_description

bquorning · web-flow · commit 292f6cb57fba · 2020-02-10T22:14:58.000+01:00
Take metadata into account in `RSpec/RepeatedDescription` cop
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 * Add `RSpec/RepeatedExampleGroupBody` cop. ([@lazycoder9][])
 * Add `RSpec/RepeatedExampleGroupDescription` cop. ([@lazycoder9][])
 * Add block name and other lines to `RSpec/ScatteredSetup` message. ([@elebow][])
+* Fix `RSpec/RepeatedDescription` to take into account example metadata. ([@lazycoder9][])
 
 ## 1.37.1 (2019-12-16)
 
diff --git a/lib/rubocop/cop/rspec/repeated_description.rb b/lib/rubocop/cop/rspec/repeated_description.rb
@@ -29,6 +29,17 @@ module RSpec
       #       end
       #     end
       #
+      #     # good
+      #     RSpec.describe User do
+      #       it 'is valid' do
+      #         # ...
+      #       end
+      #
+      #       it 'is valid', :flag do
+      #         # ...
+      #       end
+      #     end
+      #
       class RepeatedDescription < Cop
         MSG = "Don't repeat descriptions within an example group."
 
@@ -47,14 +58,18 @@ def repeated_descriptions(node)
           grouped_examples =
             RuboCop::RSpec::ExampleGroup.new(node)
               .examples
-              .group_by(&:doc_string)
+              .group_by { |example| example_signature(example) }
 
           grouped_examples
-            .select { |description, group| description && group.size > 1 }
+            .select { |signatures, group| signatures.any? && group.size > 1 }
             .values
             .flatten
             .map(&:definition)
         end
+
+        def example_signature(example)
+          [example.metadata, example.doc_string]
+        end
       end
     end
   end
diff --git a/manual/cops_rspec.md b/manual/cops_rspec.md
@@ -2526,6 +2526,17 @@ RSpec.describe User do
     # ...
   end
 end
+
+# good
+RSpec.describe User do
+  it 'is valid' do
+    # ...
+  end
+
+  it 'is valid', :flag do
+    # ...
+  end
+end
 ```
 
 ### References
diff --git a/spec/rubocop/cop/rspec/repeated_description_spec.rb b/spec/rubocop/cop/rspec/repeated_description_spec.rb
@@ -73,4 +73,48 @@
       end
     RUBY
   end
+
+  it 'does not flag examples if metadata is different' do
+    expect_no_offenses(<<-RUBY)
+      describe 'doing x' do
+        it 'do something' do
+          # ...
+        end
+
+        it 'do something', :flag do
+          # ...
+        end
+      end
+    RUBY
+  end
+
+  it 'does not flag examples with same metadata and different description' do
+    expect_no_offenses(<<-RUBY)
+      describe 'doing x' do
+        it 'do something', :flag do
+          # ...
+        end
+
+        it 'do another thing', :flag do
+          # ...
+        end
+      end
+    RUBY
+  end
+
+  it 'registers offense for repeated description and metadata' do
+    expect_offense(<<-RUBY)
+      describe 'doing x' do
+        it 'do something', :flag do
+        ^^^^^^^^^^^^^^^^^^^^^^^^ Don't repeat descriptions within an example group.
+          # ...
+        end
+
+        it 'do something', :flag do
+        ^^^^^^^^^^^^^^^^^^^^^^^^ Don't repeat descriptions within an example group.
+          # ...
+        end
+      end
+    RUBY
+  end
 end
