Merge pull request #1279 from koic/clarify_the_default_enforced_styles

pirj · web-flow · commit 54ee97410d3f · 2022-05-30T18:51:16.000+03:00
[Doc] Clarify default enforced styles
diff --git a/docs/modules/ROOT/pages/cops_rspec.adoc b/docs/modules/ROOT/pages/cops_rspec.adoc
@@ -699,7 +699,7 @@ directory.
 
 === Examples
 
-==== `EnforcedStyle: described_class`
+==== `EnforcedStyle: described_class` (default)
 
 [source,ruby]
 ----
@@ -1300,7 +1300,7 @@ This cop can be configured using the `EnforcedStyle` option
 
 === Examples
 
-==== `EnforcedStyle: always_allow`
+==== `EnforcedStyle: always_allow` (default)
 
 [source,ruby]
 ----
@@ -1539,7 +1539,7 @@ expect { run }.to change(Foo, :bar)
 expect { run }.to change { Foo.bar }
 ----
 
-==== `EnforcedStyle: method_call`
+==== `EnforcedStyle: method_call` (default)
 
 [source,ruby]
 ----
@@ -1800,7 +1800,7 @@ the same behavior.
 
 === Examples
 
-==== when configuration is `EnforcedStyle: implicit`
+==== `EnforcedStyle: implicit` (default)
 
 [source,ruby]
 ----
@@ -1820,7 +1820,7 @@ before do
 end
 ----
 
-==== when configuration is `EnforcedStyle: each`
+==== `EnforcedStyle: each`
 
 [source,ruby]
 ----
@@ -1840,7 +1840,7 @@ before(:each) do
 end
 ----
 
-==== when configuration is `EnforcedStyle: example`
+==== `EnforcedStyle: example`
 
 [source,ruby]
 ----
@@ -2000,7 +2000,7 @@ and supports the `--auto-gen-config` flag.
 
 === Examples
 
-==== `EnforcedStyle: is_expected`
+==== `EnforcedStyle: is_expected` (default)
 
 [source,ruby]
 ----
@@ -2244,7 +2244,7 @@ Checks that only one `it_behaves_like` style is used.
 
 === Examples
 
-==== when configuration is `EnforcedStyle: it_behaves_like`
+==== `EnforcedStyle: it_behaves_like` (default)
 
 [source,ruby]
 ----
@@ -2255,7 +2255,7 @@ it_should_behave_like 'a foo'
 it_behaves_like 'a foo'
 ----
 
-==== when configuration is `EnforcedStyle: it_should_behave_like`
+==== `EnforcedStyle: it_should_behave_like`
 
 [source,ruby]
 ----
@@ -2617,7 +2617,7 @@ This cop can be configured in your configuration using the
 
 === Examples
 
-==== `EnforcedStyle: allow`
+==== `EnforcedStyle: allow` (default)
 
 [source,ruby]
 ----
@@ -2672,7 +2672,7 @@ This cop can be configured in your configuration using the
 
 === Examples
 
-==== `EnforcedStyle: have_received`
+==== `EnforcedStyle: have_received` (default)
 
 [source,ruby]
 ----
@@ -3230,6 +3230,8 @@ Checks for consistent method usage for negating expectations.
 
 === Examples
 
+==== `EnforcedStyle: not_to` (default)
+
 [source,ruby]
 ----
 # bad
@@ -3243,6 +3245,21 @@ it '...' do
 end
 ----
 
+==== `EnforcedStyle: to_not`
+
+[source,ruby]
+----
+# bad
+it '...' do
+  expect(false).not_to be_true
+end
+
+# good
+it '...' do
+  expect(false).to_not be_true
+end
+----
+
 === Configurable attributes
 
 |===
@@ -3808,7 +3825,7 @@ expect(Foo).to receive(:bar) { "baz" }
 allow(Foo).to receive(:bar).and_return(bar.baz)
 ----
 
-==== `EnforcedStyle: and_return`
+==== `EnforcedStyle: and_return` (default)
 
 [source,ruby]
 ----
diff --git a/docs/modules/ROOT/pages/cops_rspec_factorybot.adoc b/docs/modules/ROOT/pages/cops_rspec_factorybot.adoc
@@ -69,7 +69,7 @@ This cop can be configured using the `EnforcedStyle` option
 
 === Examples
 
-==== `EnforcedStyle: create_list`
+==== `EnforcedStyle: create_list` (default)
 
 [source,ruby]
 ----
diff --git a/lib/rubocop/cop/rspec/described_class.rb b/lib/rubocop/cop/rspec/described_class.rb
@@ -11,7 +11,7 @@ module RSpec
       # This cop can be configured using the `EnforcedStyle` and `SkipBlocks`
       # options.
       #
-      # @example `EnforcedStyle: described_class`
+      # @example `EnforcedStyle: described_class` (default)
       #   # bad
       #   describe MyClass do
       #     subject { MyClass.do_something }
diff --git a/lib/rubocop/cop/rspec/example_without_description.rb b/lib/rubocop/cop/rspec/example_without_description.rb
@@ -14,7 +14,7 @@ module RSpec
       #
       # This cop can be configured using the `EnforcedStyle` option
       #
-      # @example `EnforcedStyle: always_allow`
+      # @example `EnforcedStyle: always_allow` (default)
       #   # bad
       #   it('') { is_expected.to be_good }
       #   it '' do
diff --git a/lib/rubocop/cop/rspec/expect_change.rb b/lib/rubocop/cop/rspec/expect_change.rb
@@ -17,7 +17,7 @@ module RSpec
       #   # good
       #   expect { run }.to change { Foo.bar }
       #
-      # @example `EnforcedStyle: method_call`
+      # @example `EnforcedStyle: method_call` (default)
       #   # bad
       #   expect { run }.to change { Foo.bar }
       #   expect { run }.to change { foo.baz }
diff --git a/lib/rubocop/cop/rspec/factory_bot/create_list.rb b/lib/rubocop/cop/rspec/factory_bot/create_list.rb
@@ -8,7 +8,7 @@ module FactoryBot
         #
         # This cop can be configured using the `EnforcedStyle` option
         #
-        # @example `EnforcedStyle: create_list`
+        # @example `EnforcedStyle: create_list` (default)
         #   # bad
         #   3.times { create :user }
         #
diff --git a/lib/rubocop/cop/rspec/hook_argument.rb b/lib/rubocop/cop/rspec/hook_argument.rb
@@ -10,7 +10,7 @@ module RSpec
       # styles: "implicit", "each", and "example." All styles have
       # the same behavior.
       #
-      # @example when configuration is `EnforcedStyle: implicit`
+      # @example `EnforcedStyle: implicit` (default)
       #   # bad
       #   before(:each) do
       #     # ...
@@ -26,7 +26,7 @@ module RSpec
       #     # ...
       #   end
       #
-      # @example when configuration is `EnforcedStyle: each`
+      # @example `EnforcedStyle: each`
       #   # bad
       #   before(:example) do
       #     # ...
@@ -42,7 +42,7 @@ module RSpec
       #     # ...
       #   end
       #
-      # @example when configuration is `EnforcedStyle: example`
+      # @example `EnforcedStyle: example`
       #   # bad
       #   before(:each) do
       #     # ...
diff --git a/lib/rubocop/cop/rspec/implicit_expect.rb b/lib/rubocop/cop/rspec/implicit_expect.rb
@@ -8,7 +8,7 @@ module RSpec
       # This cop can be configured using the `EnforcedStyle` option
       # and supports the `--auto-gen-config` flag.
       #
-      # @example `EnforcedStyle: is_expected`
+      # @example `EnforcedStyle: is_expected` (default)
       #
       #   # bad
       #   it { should be_truthy }
diff --git a/lib/rubocop/cop/rspec/it_behaves_like.rb b/lib/rubocop/cop/rspec/it_behaves_like.rb
@@ -5,14 +5,14 @@ module Cop
     module RSpec
       # Checks that only one `it_behaves_like` style is used.
       #
-      # @example when configuration is `EnforcedStyle: it_behaves_like`
+      # @example `EnforcedStyle: it_behaves_like` (default)
       #   # bad
       #   it_should_behave_like 'a foo'
       #
       #   # good
       #   it_behaves_like 'a foo'
       #
-      # @example when configuration is `EnforcedStyle: it_should_behave_like`
+      # @example `EnforcedStyle: it_should_behave_like`
       #   # bad
       #   it_behaves_like 'a foo'
       #
diff --git a/lib/rubocop/cop/rspec/message_expectation.rb b/lib/rubocop/cop/rspec/message_expectation.rb
@@ -8,7 +8,7 @@ module RSpec
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.
       #
-      # @example `EnforcedStyle: allow`
+      # @example `EnforcedStyle: allow` (default)
       #
       #   # bad
       #   expect(foo).to receive(:bar)
diff --git a/lib/rubocop/cop/rspec/message_spies.rb b/lib/rubocop/cop/rspec/message_spies.rb
@@ -8,7 +8,7 @@ module RSpec
       # This cop can be configured in your configuration using the
       # `EnforcedStyle` option and supports `--auto-gen-config`.
       #
-      # @example `EnforcedStyle: have_received`
+      # @example `EnforcedStyle: have_received` (default)
       #
       #   # bad
       #   expect(foo).to receive(:bar)
diff --git a/lib/rubocop/cop/rspec/not_to_not.rb b/lib/rubocop/cop/rspec/not_to_not.rb
@@ -5,7 +5,8 @@ module Cop
     module RSpec
       # Checks for consistent method usage for negating expectations.
       #
-      # @example
+      # @example `EnforcedStyle: not_to` (default)
+      #
       #   # bad
       #   it '...' do
       #     expect(false).to_not be_true
@@ -15,6 +16,18 @@ module RSpec
       #   it '...' do
       #     expect(false).not_to be_true
       #   end
+      #
+      # @example `EnforcedStyle: to_not`
+      #
+      #   # bad
+      #   it '...' do
+      #     expect(false).not_to be_true
+      #   end
+      #
+      #   # good
+      #   it '...' do
+      #     expect(false).to_not be_true
+      #   end
       class NotToNot < Base
         extend AutoCorrector
         include ConfigurableEnforcedStyle
diff --git a/lib/rubocop/cop/rspec/return_from_stub.rb b/lib/rubocop/cop/rspec/return_from_stub.rb
@@ -22,7 +22,7 @@ module RSpec
       #   # also good as the returned value is dynamic
       #   allow(Foo).to receive(:bar).and_return(bar.baz)
       #
-      # @example `EnforcedStyle: and_return`
+      # @example `EnforcedStyle: and_return` (default)
       #   # bad
       #   allow(Foo).to receive(:bar) { "baz" }
       #   expect(Foo).to receive(:bar) { "baz" }

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ module RSpec`
`11`	`11`	# This cop can be configured using the `EnforcedStyle` and `SkipBlocks`
`12`	`12`	`# options.`
`13`	`13`	`#`
`14`		- # @example `EnforcedStyle: described_class`
	`14`	+ # @example `EnforcedStyle: described_class` (default)
`15`	`15`	`# # bad`
`16`	`16`	`# describe MyClass do`
`17`	`17`	`# subject { MyClass.do_something }`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ module RSpec`
`14`	`14`	`#`
`15`	`15`	# This cop can be configured using the `EnforcedStyle` option
`16`	`16`	`#`
`17`		- # @example `EnforcedStyle: always_allow`
	`17`	+ # @example `EnforcedStyle: always_allow` (default)
`18`	`18`	`# # bad`
`19`	`19`	`# it('') { is_expected.to be_good }`
`20`	`20`	`# it '' do`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ module RSpec`
`17`	`17`	`# # good`
`18`	`18`	`# expect { run }.to change { Foo.bar }`
`19`	`19`	`#`
`20`		- # @example `EnforcedStyle: method_call`
	`20`	+ # @example `EnforcedStyle: method_call` (default)
`21`	`21`	`# # bad`
`22`	`22`	`# expect { run }.to change { Foo.bar }`
`23`	`23`	`# expect { run }.to change { foo.baz }`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ module FactoryBot`
`8`	`8`	`#`
`9`	`9`	# This cop can be configured using the `EnforcedStyle` option
`10`	`10`	`#`
`11`		- # @example `EnforcedStyle: create_list`
	`11`	+ # @example `EnforcedStyle: create_list` (default)
`12`	`12`	`# # bad`
`13`	`13`	`# 3.times { create :user }`
`14`	`14`	`#`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ module RSpec`
`8`	`8`	# This cop can be configured using the `EnforcedStyle` option
`9`	`9`	# and supports the `--auto-gen-config` flag.
`10`	`10`	`#`
`11`		- # @example `EnforcedStyle: is_expected`
	`11`	+ # @example `EnforcedStyle: is_expected` (default)
`12`	`12`	`#`
`13`	`13`	`# # bad`
`14`	`14`	`# it { should be_truthy }`
Original file line number	Diff line number	Diff line change
`@@ -5,14 +5,14 @@ module Cop`
`5`	`5`	`module RSpec`
`6`	`6`	# Checks that only one `it_behaves_like` style is used.
`7`	`7`	`#`
`8`		- # @example when configuration is `EnforcedStyle: it_behaves_like`
	`8`	+ # @example `EnforcedStyle: it_behaves_like` (default)
`9`	`9`	`# # bad`
`10`	`10`	`# it_should_behave_like 'a foo'`
`11`	`11`	`#`
`12`	`12`	`# # good`
`13`	`13`	`# it_behaves_like 'a foo'`
`14`	`14`	`#`
`15`		- # @example when configuration is `EnforcedStyle: it_should_behave_like`
	`15`	+ # @example `EnforcedStyle: it_should_behave_like`
`16`	`16`	`# # bad`
`17`	`17`	`# it_behaves_like 'a foo'`
`18`	`18`	`#`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ module RSpec`
`8`	`8`	`# This cop can be configured in your configuration using the`
`9`	`9`	# `EnforcedStyle` option and supports `--auto-gen-config`.
`10`	`10`	`#`
`11`		- # @example `EnforcedStyle: allow`
	`11`	+ # @example `EnforcedStyle: allow` (default)
`12`	`12`	`#`
`13`	`13`	`# # bad`
`14`	`14`	`# expect(foo).to receive(:bar)`