Merge pull request #845 from ybiquitous/improve-message-and-description-of-FactoryBot/FactoryClassName

Improve message and description of `FactoryBot/FactoryClassName`

Author: Darhazer

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Master (Unreleased)
 
+* Improve message and description of `FactoryBot/FactoryClassName`. ([@ybiquitous][])
+
 ## 1.37.0 (2019-11-25)
 
 * Implement `RSpec/DescribedClassModuleWrapping` to disallow RSpec statements within a module. ([@kellysutton][])
@@ -466,3 +468,4 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features.
 [@kellysutton]: https://github.com/kellysutton
 [@mkrawc]: https://github.com/mkrawc
 [@jfragoulis]: https://github.com/jfragoulis
+[@ybiquitous]: https://github.com/ybiquitous

lib/rubocop/cop/rspec/factory_bot/factory_class_name.rb

@@ -6,6 +6,11 @@ module RSpec
       module FactoryBot
         # Use string value when setting the class attribute explicitly.
         #
+        # This cop would promote faster tests by lazy-loading of
+        # application files. Also, this could help you suppress potential bugs
+        # in combination with external libraries by avoiding a preload of
+        # application files from the factory files.
+        #
         # @example
         #   # bad
         #   factory :foo, class: Foo do
@@ -15,7 +20,8 @@ module FactoryBot
         #   factory :foo, class: 'Foo' do
         #   end
         class FactoryClassName < Cop
-          MSG = "Pass '%<class_name>s' instead of %<class_name>s."
+          MSG = "Pass '%<class_name>s' string instead of `%<class_name>s` " \
+                'constant.'
 
           def_node_matcher :class_name, <<~PATTERN
             (send _ :factory _ (hash <(pair (sym :class) $(const ...)) ...>))

manual/cops_factorybot.md

@@ -86,6 +86,11 @@ Enabled | Yes
 
 Use string value when setting the class attribute explicitly.
 
+This cop would promote faster tests by lazy-loading of
+application files. Also, this could help you suppress potential bugs
+in combination with external libraries by avoiding a preload of
+application files from the factory files.
+
 ### Examples
 
 ```ruby

spec/rubocop/cop/rspec/factory_bot/factory_class_name_spec.rb

@@ -7,7 +7,7 @@
     it 'flags passing a class' do
       expect_offense(<<~RUBY)
         factory :foo, class: Foo do
-                             ^^^ Pass 'Foo' instead of Foo.
+                             ^^^ Pass 'Foo' string instead of `Foo` constant.
         end
       RUBY
 
@@ -20,7 +20,7 @@
     it 'flags passing a class from global namespace' do
       expect_offense(<<~RUBY)
         factory :foo, class: ::Foo do
-                             ^^^^^ Pass 'Foo' instead of Foo.
+                             ^^^^^ Pass 'Foo' string instead of `Foo` constant.
         end
       RUBY
 
@@ -33,7 +33,7 @@
     it 'flags passing a subclass' do
       expect_offense(<<~RUBY)
         factory :foo, class: Foo::Bar do
-                             ^^^^^^^^ Pass 'Foo::Bar' instead of Foo::Bar.
+                             ^^^^^^^^ Pass 'Foo::Bar' string instead of `Foo::Bar` constant.
         end
       RUBY
 
@@ -55,7 +55,7 @@
     it 'flags passing a class' do
       expect_offense(<<~RUBY)
         factory :foo, class: Foo
-                             ^^^ Pass 'Foo' instead of Foo.
+                             ^^^ Pass 'Foo' string instead of `Foo` constant.
       RUBY
 
       expect_correction(<<~RUBY)