Merge pull request #1155 from tejasbubane/implicit-subject-missing-doc

Add missing documentation for `single_statement_only` style of `RSpec/ImplicitSubject` cop
rubocop · May 21, 2021 · a01cc07 · a01cc07
2 parents 78d1ae4 + 35fe00b
commit a01cc07
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Master (Unreleased)
 
+* Add missing documentation for `single_statement_only` style of `RSpec/ImplicitSubject` cop. ([@tejasbubane][])
+
 ## 2.3.0 (2021-04-28)
 
 * Allow `RSpec/ContextWording` to accept multi-word prefixes. ([@hosamaly][])

diff --git a/docs/modules/ROOT/pages/cops_rspec.adoc b/docs/modules/ROOT/pages/cops_rspec.adoc
@@ -1827,7 +1827,7 @@ This cop can be configured using the `EnforcedStyle` option
 
 === Examples
 
-==== `EnforcedStyle: single_line_only`
+==== `EnforcedStyle: single_line_only` (default)
 
 [source,ruby]
 ----
@@ -1843,6 +1843,26 @@ it do
 end
 ----
 
+==== `EnforcedStyle: single_statement_only`
+
+[source,ruby]
+----
+# bad
+it do
+  foo = 1
+  is_expected.to be_truthy
+end
+
+# good
+it do
+  foo = 1
+  expect(subject).to be_truthy
+end
+it do
+  is_expected.to be_truthy
+end
+----
+
 ==== `EnforcedStyle: disallow`
 
 [source,ruby]

diff --git a/lib/rubocop/cop/rspec/implicit_subject.rb b/lib/rubocop/cop/rspec/implicit_subject.rb
@@ -7,7 +7,7 @@ module RSpec
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
-      # @example `EnforcedStyle: single_line_only`
+      # @example `EnforcedStyle: single_line_only` (default)
       #   # bad
       #   it do
       #     is_expected.to be_truthy
@@ -19,6 +19,22 @@ module RSpec
       #     expect(subject).to be_truthy
       #   end
       #
+      # @example `EnforcedStyle: single_statement_only`
+      #   # bad
+      #   it do
+      #     foo = 1
+      #     is_expected.to be_truthy
+      #   end
+      #
+      #   # good
+      #   it do
+      #     foo = 1
+      #     expect(subject).to be_truthy
+      #   end
+      #   it do
+      #     is_expected.to be_truthy
+      #   end
+      #
       # @example `EnforcedStyle: disallow`
       #   # bad
       #   it { is_expected.to be_truthy }