Merge pull request #621 from nvasilevski/improve-read-write-attribute-message

[ReadWriteAttribute] Improve cop message to be more dynamic

Author: koic

lib/rubocop/cop/rails/read_write_attribute.rb

@@ -37,7 +37,7 @@ module Rails
       class ReadWriteAttribute < Base
         extend AutoCorrector
 
-        MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
+        MSG = 'Prefer `%<prefer>s`.'
         RESTRICT_ON_SEND = %i[read_attribute write_attribute].freeze
 
         def_node_matcher :read_write_attribute?, <<~PATTERN
@@ -51,15 +51,8 @@ def on_send(node)
           return unless read_write_attribute?(node)
           return if within_shadowing_method?(node)
 
-          add_offense(node.loc.selector, message: message(node)) do |corrector|
-            case node.method_name
-            when :read_attribute
-              replacement = read_attribute_replacement(node)
-            when :write_attribute
-              replacement = write_attribute_replacement(node)
-            end
-
-            corrector.replace(node.source_range, replacement)
+          add_offense(node, message: build_message(node)) do |corrector|
+            corrector.replace(node.source_range, node_replacement(node))
           end
         end
 
@@ -74,12 +67,32 @@ def within_shadowing_method?(node)
           end
         end
 
-        def message(node)
+        def build_message(node)
+          if node.single_line?
+            single_line_message(node)
+          else
+            multi_line_message(node)
+          end
+        end
+
+        def single_line_message(node)
+          format(MSG, prefer: node_replacement(node))
+        end
+
+        def multi_line_message(node)
           if node.method?(:read_attribute)
-            format(MSG, prefer: 'self[:attr]', current: 'read_attribute(:attr)')
+            format(MSG, prefer: 'self[:attr]')
           else
-            format(MSG, prefer: 'self[:attr] = val',
-                        current: 'write_attribute(:attr, val)')
+            format(MSG, prefer: 'self[:attr] = val')
+          end
+        end
+
+        def node_replacement(node)
+          case node.method_name
+          when :read_attribute
+            read_attribute_replacement(node)
+          when :write_attribute
+            write_attribute_replacement(node)
           end
         end
 

spec/rubocop/cop/rails/read_write_attribute_spec.rb

@@ -5,7 +5,7 @@
     it 'registers an offense and corrects a symbol' do
       expect_offense(<<~RUBY)
         res = read_attribute(:test)
-              ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+              ^^^^^^^^^^^^^^^^^^^^^ Prefer `self[:test]`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -16,7 +16,7 @@
     it 'register an offense and corrects a string' do
       expect_offense(<<~RUBY)
         res = read_attribute('test')
-              ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+              ^^^^^^^^^^^^^^^^^^^^^^ Prefer `self['test']`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -36,7 +36,7 @@ def foo
       expect_offense(<<~RUBY)
         def foo
           bar || read_attribute(:baz)
-                 ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+                 ^^^^^^^^^^^^^^^^^^^^ Prefer `self[:baz]`.
         end
       RUBY
 
@@ -50,7 +50,7 @@ def foo
     it 'autocorrects without parentheses' do
       expect_offense(<<~RUBY)
         res = read_attribute 'test'
-              ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+              ^^^^^^^^^^^^^^^^^^^^^ Prefer `self['test']`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -61,7 +61,7 @@ def foo
     it 'corrects an expression' do
       expect_offense(<<~RUBY)
         res = read_attribute('test_' + postfix)
-              ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self['test_' + postfix]`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -72,7 +72,7 @@ def foo
     it 'corrects multiline' do
       expect_offense(<<~RUBY)
         res = read_attribute(
-              ^^^^^^^^^^^^^^ Prefer `self[:attr]` over `read_attribute(:attr)`.
+              ^^^^^^^^^^^^^^^ Prefer `self[:attr]`.
         (
         'test_' + postfix
         ).to_sym
@@ -96,7 +96,7 @@ def foo
       it 'registers an offense and corrects' do
         expect_offense(<<~RUBY)
           write_attribute(:test, val)
-          ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self[:test] = val`.
         RUBY
 
         expect_correction(<<~RUBY)
@@ -109,7 +109,7 @@ def foo
       it 'registers an offense and corrects' do
         expect_offense(<<~RUBY)
           write_attribute('attr', 'test')
-          ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self['attr'] = 'test'`.
         RUBY
 
         expect_correction(<<~RUBY)
@@ -121,7 +121,7 @@ def foo
     it 'registers an offense and corrects without parentheses' do
       expect_offense(<<~RUBY)
         write_attribute 'attr', 'test'
-        ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self['attr'] = 'test'`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -141,7 +141,7 @@ def foo=(value)
       expect_offense(<<~RUBY)
         def foo=(value)
           bar(value) || write_attribute(:baz, "baz")
-                        ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self[:baz] = "baz"`.
         end
       RUBY
 
@@ -155,7 +155,7 @@ def foo=(value)
     it 'corrects assignment with chained methods' do
       expect_offense(<<~RUBY)
         write_attribute(:attr, 'test_' + postfix)
-        ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Prefer `self[:attr] = 'test_' + postfix`.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -166,7 +166,7 @@ def foo=(value)
     it 'autocorrects multiline' do
       expect_offense(<<~RUBY)
         write_attribute(
-        ^^^^^^^^^^^^^^^ Prefer `self[:attr] = val` over `write_attribute(:attr, val)`.
+        ^^^^^^^^^^^^^^^^ Prefer `self[:attr] = val`.
         :attr,
         (
         'test_' + postfix