Merge pull request #1170 from dswij/subject-declaration-cop

Add SubjectDeclaration cop
rubocop · Jul 28, 2021 · d833041 · d833041
2 parents 1a8c891 + 45e89ad
commit d833041
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 * Fix each example for `RSpec/HookArgument`. ([@lokhi][])
 * Exclude unrelated Rails directories from `RSpec/DescribeClass`. ([@MothOnMars][])
 * Add `RSpec/ExcessiveDocstringSpacing` cop. ([@G-Rath][])
+* Add `RSpec/SubjectDeclaration` cop. ([@dswij][])
 
 ## 2.4.0 (2021-06-09)
 
@@ -632,3 +633,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@lokhi]: https://github.com/lokhi
 [@MothOnMars]: https://github.com/MothOnMars
 [@G-Rath]: https://github.com/G-Rath
+[@dswij]: https://github.com/dswij
diff --git a/config/default.yml b/config/default.yml
@@ -655,6 +655,12 @@ RSpec/StubbedMock:
   VersionAdded: '1.44'
   StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/StubbedMock
 
+RSpec/SubjectDeclaration:
+  Description: Ensure that subject is defined using subject helper.
+  Enabled: pending
+  VersionAdded: '2.5'
+  StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/SubjectDeclaration
+
 RSpec/SubjectStub:
   Description: Checks for stubbed test subjects.
   Enabled: true

diff --git a/docs/modules/ROOT/pages/cops.adoc b/docs/modules/ROOT/pages/cops.adoc
@@ -76,6 +76,7 @@
 * xref:cops_rspec.adoc#rspecsharedexamples[RSpec/SharedExamples]
 * xref:cops_rspec.adoc#rspecsingleargumentmessagechain[RSpec/SingleArgumentMessageChain]
 * xref:cops_rspec.adoc#rspecstubbedmock[RSpec/StubbedMock]
+* xref:cops_rspec.adoc#rspecsubjectdeclaration[RSpec/SubjectDeclaration]
 * xref:cops_rspec.adoc#rspecsubjectstub[RSpec/SubjectStub]
 * xref:cops_rspec.adoc#rspecunspecifiedexception[RSpec/UnspecifiedException]
 * xref:cops_rspec.adoc#rspecvariabledefinition[RSpec/VariableDefinition]

diff --git a/lib/rubocop/cop/rspec_rails_cops.rb b/lib/rubocop/cop/rspec_rails_cops.rb
@@ -89,6 +89,7 @@
 require_relative 'rspec/shared_examples'
 require_relative 'rspec/single_argument_message_chain'
 require_relative 'rspec/stubbed_mock'
+require_relative 'rspec/subject_declaration'
 require_relative 'rspec/subject_stub'
 require_relative 'rspec/unspecified_exception'
 require_relative 'rspec/variable_definition'