[Fix rubocop#4704] Move Lint/EndAlignment to Layout

Oftentimes, a misaligned `end` on module/class definition is just a whitespace/indentation error. Having it fixed together with the other `Layout` cops by e.g. `rubocop --auto-correct --only Layout` is very convenient. But since it *may* be something more serious than just a style issue, cop violations are still of severity `warning`.
bquorning · Jan 6, 2018 · 89c43bf · 89c43bf
1 parent 8c545d1
commit 89c43bf
Show file tree

Hide file tree

Showing 19 changed files with 121 additions and 109 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,7 @@
 * [#5240](https://github.com/bbatsov/rubocop/pull/5240): Make `Style/StringHashKeys` to accepts environment variables. ([@pocke][])
 * [#5395](https://github.com/bbatsov/rubocop/pull/5395): Always exit 2 when specified configuration file does not exist. ([@pocke][])
 * [#5402](https://github.com/bbatsov/rubocop/pull/5402): Remove undefined `ActiveSupport::TimeZone#strftime` method from defined dangerous methods of `Rails/TimeZone` cop. ([@koic][])
+* [#4704](https://github.com/bbatsov/rubocop/issues/4704): Move `Lint/EndAlignment` to the `Layout` namespace. ([@bquorning][])
 
 ## 0.52.1 (2017-12-27)
 

diff --git a/config/default.yml b/config/default.yml
@@ -273,6 +273,23 @@ Layout/EmptyLinesAroundModuleBody:
     - empty_lines_special
     - no_empty_lines
 
+# Align ends correctly.
+Layout/EndAlignment:
+  # The value `keyword` means that `end` should be aligned with the matching
+  # keyword (`if`, `while`, etc.).
+  # The value `variable` means that in assignments, `end` should be aligned
+  # with the start of the variable on the left hand side of `=`. In all other
+  # situations, `end` should still be aligned with the keyword.
+  # The value `start_of_line` means that `end` should be aligned with the start
+  # of the line which the matching keyword appears on.
+  EnforcedStyleAlignWith: keyword
+  SupportedStylesAlignWith:
+    - keyword
+    - variable
+    - start_of_line
+  AutoCorrect: false
+  Severity: warning
+
 Layout/EndOfLine:
   # The `native` style means that CR+LF (Carriage Return + Line Feed) is
   # enforced on Windows, and LF is enforced on other platforms. The other styles
@@ -1510,22 +1527,6 @@ Lint/DefEndAlignment:
     - def
   AutoCorrect: false
 
-# Align ends correctly.
-Lint/EndAlignment:
-  # The value `keyword` means that `end` should be aligned with the matching
-  # keyword (`if`, `while`, etc.).
-  # The value `variable` means that in assignments, `end` should be aligned
-  # with the start of the variable on the left hand side of `=`. In all other
-  # situations, `end` should still be aligned with the keyword.
-  # The value `start_of_line` means that `end` should be aligned with the start
-  # of the line which the matching keyword appears on.
-  EnforcedStyleAlignWith: keyword
-  SupportedStylesAlignWith:
-    - keyword
-    - variable
-    - start_of_line
-  AutoCorrect: false
-
 Lint/InheritException:
   # The default base class in favour of `Exception`.
   EnforcedStyle: runtime_error

diff --git a/config/enabled.yml b/config/enabled.yml
@@ -158,6 +158,10 @@ Layout/EmptyLinesAroundModuleBody:
   StyleGuide: '#empty-lines-around-bodies'
   Enabled: true
 
+Layout/EndAlignment:
+  Description: 'Align ends correctly.'
+  Enabled: true
+
 Layout/EndOfLine:
   Description: 'Use Unix-style line endings.'
   StyleGuide: '#crlf'
@@ -496,10 +500,6 @@ Lint/EmptyWhen:
   Description: 'Checks for `when` branches with empty bodies.'
   Enabled: true
 
-Lint/EndAlignment:
-  Description: 'Align ends correctly.'
-  Enabled: true
-
 Lint/EndInMethod:
   Description: 'END blocks should not be placed inside method definitions.'
   Enabled: true

diff --git a/lib/rubocop.rb b/lib/rubocop.rb
@@ -184,6 +184,7 @@
 require_relative 'rubocop/cop/layout/empty_lines_around_method_body'
 require_relative 'rubocop/cop/layout/empty_lines_around_module_body'
 require_relative 'rubocop/cop/layout/empty_lines'
+require_relative 'rubocop/cop/layout/end_alignment'
 require_relative 'rubocop/cop/layout/end_of_line'
 require_relative 'rubocop/cop/layout/extra_spacing'
 require_relative 'rubocop/cop/layout/first_array_element_line_break'
@@ -257,7 +258,6 @@
 require_relative 'rubocop/cop/lint/empty_expression'
 require_relative 'rubocop/cop/lint/empty_interpolation'
 require_relative 'rubocop/cop/lint/empty_when'
-require_relative 'rubocop/cop/lint/end_alignment'
 require_relative 'rubocop/cop/lint/end_in_method'
 require_relative 'rubocop/cop/lint/ensure_return'
 require_relative 'rubocop/cop/lint/float_out_of_range'

diff --git a/lib/rubocop/config.rb b/lib/rubocop/config.rb
@@ -95,7 +95,10 @@ class Config
           '`Naming/VariableName`.',
       'Style/VariableNumber' =>
         'The `Style/VariableNumber` cop has been renamed to ' \
-          '`Naming/VariableNumber`.'
+          '`Naming/VariableNumber`.',
+      'Lint/EndAlignment' =>
+        'The `Lint/EndAlignment` cop has been renamed to ' \
+          '`Layout/EndAlignment`.'
     }.freeze
 
     OBSOLETE_PARAMETERS = [
@@ -169,6 +172,12 @@ class Config
         alternative: '`AlignWith` has been renamed to ' \
                      '`EnforcedStyleAlignWith`'
       },
+      {
+        cop: 'Layout/EndAlignment',
+        parameter: 'AlignWith',
+        alternative: '`AlignWith` has been renamed to ' \
+                     '`EnforcedStyleAlignWith`'
+      },
       {
         cop: 'Lint/DefEndAlignment',
         parameter: 'AlignWith',

diff --git a/lib/rubocop/cop/layout/else_alignment.rb b/lib/rubocop/cop/layout/else_alignment.rb
@@ -102,7 +102,7 @@ def check_assignment(node, rhs)
           rhs = first_part_of_call_chain(rhs)
           return unless rhs
 
-          end_config = config.for_cop('Lint/EndAlignment')
+          end_config = config.for_cop('Layout/EndAlignment')
           style = end_config['EnforcedStyleAlignWith'] || 'keyword'
           base = variable_alignment?(node.loc, rhs, style.to_sym) ? node : rhs
 

diff --git a/lib/rubocop/cop/lint/end_alignment.rb → lib/rubocop/cop/layout/end_alignment.rb b/lib/rubocop/cop/lint/end_alignment.rb → lib/rubocop/cop/layout/end_alignment.rb
@@ -2,7 +2,7 @@
 
 module RuboCop
   module Cop
-    module Lint
+    module Layout
       # This cop checks whether the end keywords are aligned properly.
       #
       # Three modes are supported through the `EnforcedStyleAlignWith`

diff --git a/lib/rubocop/cop/layout/indentation_width.rb b/lib/rubocop/cop/layout/indentation_width.rb
@@ -187,7 +187,7 @@ def check_assignment(node, rhs)
           rhs = first_part_of_call_chain(rhs)
           return unless rhs
 
-          end_config = config.for_cop('Lint/EndAlignment')
+          end_config = config.for_cop('Layout/EndAlignment')
           style = end_config['EnforcedStyleAlignWith'] || 'keyword'
           base = variable_alignment?(node.loc, rhs, style.to_sym) ? node : rhs
 

diff --git a/lib/rubocop/cop/style/conditional_assignment.rb b/lib/rubocop/cop/style/conditional_assignment.rb
@@ -9,7 +9,7 @@ module ConditionalAssignmentHelper
         extend NodePattern::Macros
 
         EQUAL = '='.freeze
-        END_ALIGNMENT = 'Lint/EndAlignment'.freeze
+        END_ALIGNMENT = 'Layout/EndAlignment'.freeze
         ALIGN_WITH = 'EnforcedStyleAlignWith'.freeze
         KEYWORD = 'keyword'.freeze
 

diff --git a/manual/basic_usage.md b/manual/basic_usage.md
@@ -43,7 +43,7 @@ test.rb:2:3: C: Style/GuardClause: Use a guard clause instead of wrapping the co
 test.rb:2:3: C: Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
   if something
   ^^
-test.rb:4:5: W: Lint/EndAlignment: end at 4, 4 is not aligned with if at 2, 2.
+test.rb:4:5: W: Layout/EndAlignment: end at 4, 4 is not aligned with if at 2, 2.
     end
     ^^^
 

diff --git a/manual/cops.md b/manual/cops.md
@@ -126,6 +126,7 @@ In the following section you find all available cops:
 * [Layout/EmptyLinesAroundExceptionHandlingKeywords](cops_layout.md#layoutemptylinesaroundexceptionhandlingkeywords)
 * [Layout/EmptyLinesAroundMethodBody](cops_layout.md#layoutemptylinesaroundmethodbody)
 * [Layout/EmptyLinesAroundModuleBody](cops_layout.md#layoutemptylinesaroundmodulebody)
+* [Layout/EndAlignment](cops_layout.md#layoutendalignment)
 * [Layout/EndOfLine](cops_layout.md#layoutendofline)
 * [Layout/ExtraSpacing](cops_layout.md#layoutextraspacing)
 * [Layout/FirstArrayElementLineBreak](cops_layout.md#layoutfirstarrayelementlinebreak)
@@ -201,7 +202,6 @@ In the following section you find all available cops:
 * [Lint/EmptyExpression](cops_lint.md#lintemptyexpression)
 * [Lint/EmptyInterpolation](cops_lint.md#lintemptyinterpolation)
 * [Lint/EmptyWhen](cops_lint.md#lintemptywhen)
-* [Lint/EndAlignment](cops_lint.md#lintendalignment)
 * [Lint/EndInMethod](cops_lint.md#lintendinmethod)
 * [Lint/EnsureReturn](cops_lint.md#lintensurereturn)
 * [Lint/FloatOutOfRange](cops_lint.md#lintfloatoutofrange)

diff --git a/manual/cops_layout.md b/manual/cops_layout.md
@@ -1120,6 +1120,76 @@ EnforcedStyle | `no_empty_lines` | `empty_lines`, `empty_lines_except_namespace`
 
 * [https://github.com/bbatsov/ruby-style-guide#empty-lines-around-bodies](https://github.com/bbatsov/ruby-style-guide#empty-lines-around-bodies)
 
+## Layout/EndAlignment
+
+Enabled by default | Supports autocorrection
+--- | ---
+Enabled | Yes
+
+This cop checks whether the end keywords are aligned properly.
+
+Three modes are supported through the `EnforcedStyleAlignWith`
+configuration parameter:
+
+If it's set to `keyword` (which is the default), the `end`
+shall be aligned with the start of the keyword (if, class, etc.).
+
+If it's set to `variable` the `end` shall be aligned with the
+left-hand-side of the variable assignment, if there is one.
+
+If it's set to `start_of_line`, the `end` shall be aligned with the
+start of the line where the matching keyword appears.
+
+### Examples
+
+#### EnforcedStyleAlignWith: keyword (default)
+
+```ruby
+# bad
+
+variable = if true
+    end
+
+# good
+
+variable = if true
+           end
+```
+#### EnforcedStyleAlignWith: variable
+
+```ruby
+# bad
+
+variable = if true
+    end
+
+# good
+
+variable = if true
+end
+```
+#### EnforcedStyleAlignWith: start_of_line
+
+```ruby
+# bad
+
+variable = if true
+    end
+
+# good
+
+puts(if true
+end)
+```
+
+### Configurable attributes
+
+Name | Default value | Configurable values
+--- | --- | ---
+EnforcedStyleAlignWith | `keyword` | `keyword`, `variable`, `start_of_line`
+AutoCorrect | `false` | Boolean
+Severity | `warning` | String
+
 ## Layout/EndOfLine
 
 Enabled by default | Supports autocorrection

diff --git a/manual/cops_lint.md b/manual/cops_lint.md
@@ -720,75 +720,6 @@ when baz then 2
 end
 ```
 
-## Lint/EndAlignment
-
-Enabled by default | Supports autocorrection
---- | ---
-Enabled | Yes
-
-This cop checks whether the end keywords are aligned properly.
-
-Three modes are supported through the `EnforcedStyleAlignWith`
-configuration parameter:
-
-If it's set to `keyword` (which is the default), the `end`
-shall be aligned with the start of the keyword (if, class, etc.).
-
-If it's set to `variable` the `end` shall be aligned with the
-left-hand-side of the variable assignment, if there is one.
-
-If it's set to `start_of_line`, the `end` shall be aligned with the
-start of the line where the matching keyword appears.
-
-### Examples
-
-#### EnforcedStyleAlignWith: keyword (default)
-
-```ruby
-# bad
-
-variable = if true
-    end
-
-# good
-
-variable = if true
-           end
-```
-#### EnforcedStyleAlignWith: variable
-
-```ruby
-# bad
-
-variable = if true
-    end
-
-# good
-
-variable = if true
-end
-```
-#### EnforcedStyleAlignWith: start_of_line
-
-```ruby
-# bad
-
-variable = if true
-    end
-
-# good
-
-puts(if true
-end)
-```
-
-### Configurable attributes
-
-Name | Default value | Configurable values
---- | --- | ---
-EnforcedStyleAlignWith | `keyword` | `keyword`, `variable`, `start_of_line`
-AutoCorrect | `false` | Boolean
-
 ## Lint/EndInMethod
 
 Enabled by default | Supports autocorrection

diff --git a/spec/rubocop/cli/cli_options_spec.rb b/spec/rubocop/cli/cli_options_spec.rb
@@ -288,7 +288,7 @@ class SomeCop < Cop
                                      "\ty = 3",
                                      '  end'])
           create_file('.rubocop.yml', <<-YAML.strip_indent)
-            Lint/EndAlignment:
+            Layout/EndAlignment:
               Enabled: false
           YAML
           expect(cli.run(['--format', 'simple',
@@ -921,7 +921,7 @@ def badName
             'Another good alternative is the usage of control flow &&/||.',
             '  if something',
             '  ^^',
-            'example3.rb:4:5: W: Lint/EndAlignment: ' \
+            'example3.rb:4:5: W: Layout/EndAlignment: ' \
             'end at 4, 4 is not aligned with if at 2, 2.',
             '    end',
             '    ^^^',

diff --git a/spec/rubocop/cop/layout/else_alignment_spec.rb b/spec/rubocop/cop/layout/else_alignment_spec.rb
@@ -4,7 +4,7 @@
   subject(:cop) { described_class.new(config) }
 
   let(:config) do
-    RuboCop::Config.new('Lint/EndAlignment' => end_alignment_config)
+    RuboCop::Config.new('Layout/EndAlignment' => end_alignment_config)
   end
   let(:end_alignment_config) do
     { 'Enabled' => true, 'EnforcedStyleAlignWith' => 'variable' }

diff --git a/spec/rubocop/cop/lint/end_alignment_spec.rb → .../rubocop/cop/layout/end_alignment_spec.rb b/spec/rubocop/cop/lint/end_alignment_spec.rb → .../rubocop/cop/layout/end_alignment_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.describe RuboCop::Cop::Lint::EndAlignment, :config do
+RSpec.describe RuboCop::Cop::Layout::EndAlignment, :config do
   subject(:cop) { described_class.new(config) }
 
   let(:cop_config) do

diff --git a/spec/rubocop/cop/layout/indentation_width_spec.rb b/spec/rubocop/cop/layout/indentation_width_spec.rb
@@ -6,7 +6,7 @@
   let(:config) do
     RuboCop::Config.new('Layout/IndentationWidth' => cop_config,
                         'Layout/IndentationConsistency' => consistency_config,
-                        'Lint/EndAlignment' => end_alignment_config,
+                        'Layout/EndAlignment' => end_alignment_config,
                         'Lint/DefEndAlignment' => def_end_alignment_config)
   end
   let(:consistency_config) { { 'EnforcedStyle' => 'normal' } }