Merge pull request #7657 from rrosenblum/empty_line_between_defs_context

Add the method name to the highlight area of Layout/EmptyLineBetweenDefs
rubocop · Jan 22, 2020 · d7a6d1b · d7a6d1b
2 parents c3bc810 + 3b6bd3e
commit d7a6d1b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@
 
 * [#7636](https://github.com/rubocop-hq/rubocop/issues/7636): Remove `console` from `Lint/Debugger` to prevent false positives. ([@gsamokovarov][])
 * [#7641](https://github.com/rubocop-hq/rubocop/issues/7641): **(Breaking)** Remove `Style/BracesAroundHashParameters` cop. ([@pocke][])
+* Add the method name to highlight area of `Layout/EmptyLineBetweenDefs` to help provide more context. ([@rrosenblum][])
 
 ## 0.79.0 (2020-01-06)
 

diff --git a/lib/rubocop/cop/layout/empty_line_between_defs.rb b/lib/rubocop/cop/layout/empty_line_between_defs.rb
@@ -56,7 +56,8 @@ def check_defs(nodes)
           return if nodes.all?(&:single_line?) &&
                     cop_config['AllowAdjacentOneLineDefs']
 
-          add_offense(nodes.last, location: :keyword)
+          location = nodes.last.loc.keyword.join(nodes.last.loc.name)
+          add_offense(nodes.last, location: location)
         end
 
         def autocorrect(node)

diff --git a/spec/rubocop/cop/layout/empty_line_between_defs_spec.rb b/spec/rubocop/cop/layout/empty_line_between_defs_spec.rb
@@ -14,7 +14,7 @@ class J
           def n
           end
           def o
-          ^^^ Use empty lines between method definitions.
+          ^^^^^ Use empty lines between method definitions.
           end
         end
         # checks something
@@ -33,7 +33,7 @@ def n
           # checks something o-related
           # and more
           def o
-          ^^^ Use empty lines between method definitions.
+          ^^^^^ Use empty lines between method definitions.
           end
         end
       RUBY
@@ -74,7 +74,7 @@ def foo
             true
           end
           def bar
-          ^^^ Use empty lines between method definitions.
+          ^^^^^^^ Use empty lines between method definitions.
             true
           end
         else
@@ -95,7 +95,7 @@ def self.foo
               true
             end
             def self.bar
-            ^^^ Use empty lines between method definitions.
+            ^^^^^^^^^^^^ Use empty lines between method definitions.
               true
             end
           end
@@ -123,7 +123,7 @@ def foo
               true
             end
             def self.bar
-            ^^^ Use empty lines between method definitions.
+            ^^^^^^^^^^^^ Use empty lines between method definitions.
               true
             end
           end
@@ -215,7 +215,7 @@ def initialize(attrs)
     expect_offense(<<~RUBY)
       def a; end
       def b; end
-      ^^^ Use empty lines between method definitions.
+      ^^^^^ Use empty lines between method definitions.
     RUBY
 
     expect_correction(<<~RUBY)
@@ -232,7 +232,7 @@ def a; end
 
 
       def b; end
-      ^^^ Use empty lines between method definitions.
+      ^^^^^ Use empty lines between method definitions.
     RUBY
 
     expect_correction(<<~RUBY)
@@ -262,7 +262,7 @@ def n
 
 
         def o
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
         end
       end
     RUBY
@@ -293,10 +293,10 @@ def b; end
         def a; end
         def b; end
         def c # Not a one-liner, so this is an offense.
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
         end
         def d; end # Also an offense since previous was multi-line:
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
       RUBY
 
       expect_correction(<<~RUBY)
@@ -340,7 +340,7 @@ def n
 
 
         def o
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
         end
       RUBY
 
@@ -363,7 +363,7 @@ def n
         end
 
         def o
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
         end
       RUBY
 
@@ -386,7 +386,7 @@ def n
 
 
         def o
-        ^^^ Use empty lines between method definitions.
+        ^^^^^ Use empty lines between method definitions.
         end
       RUBY