rubocop 0.18.1 → 0.19.0

data/spec/rubocop/cop/style/indentation_width_spec.rb

@@ -3,18 +3,25 @@
 require 'spec_helper'
 
 describe Rubocop::Cop::Style::IndentationWidth do
-  subject(:cop) { described_class.new }
+  subject(:cop) { described_class.new(config) }
+  let(:config) do
+    Rubocop::Config.new('EndAlignment' => end_alignment_config)
+  end
+  let(:end_alignment_config) do
+    { 'Enabled' => true, 'AlignWith' => 'variable' }
+  end
 
   context 'with if statement' do
-    it 'registers an offence for bad indentation of an if body' do
+    it 'registers an offense for bad indentation of an if body' do
       inspect_source(cop,
                      ['if cond',
                       ' func',
                       'end'])
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
+      expect(cop.highlights).to eq([' '])
     end
 
-    it 'registers an offence for bad indentation of an else body' do
+    it 'registers an offense for bad indentation of an else body' do
       inspect_source(cop,
                      ['if cond',
                       '  func1',
@@ -22,9 +29,10 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       ' func2',
                       'end'])
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
+      expect(cop.highlights).to eq([' '])
     end
 
-    it 'registers an offence for bad indentation of an elsif body' do
+    it 'registers an offense for bad indentation of an elsif body' do
       inspect_source(cop,
                      ['if a1',
                       '  b1',
@@ -36,7 +44,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
     end
 
-    it 'registers offence for bad indentation of ternary inside else' do
+    it 'registers offense for bad indentation of ternary inside else' do
       inspect_source(cop,
                      ['if a',
                       '  b',
@@ -45,9 +53,10 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'end'])
       expect(cop.messages)
         .to eq(['Use 2 (not 5) spaces for indentation.'])
+      expect(cop.highlights).to eq(['     '])
     end
 
-    it 'registers offence for bad indentation of modifier if in else' do
+    it 'registers offense for bad indentation of modifier if in else' do
       inspect_source(cop,
                      ['if a',
                       '  b',
@@ -58,10 +67,31 @@ describe Rubocop::Cop::Style::IndentationWidth do
         .to eq(['Use 2 (not 3) spaces for indentation.'])
     end
 
+    it 'autocorrects bad indentation' do
+      corrected = autocorrect_source(cop,
+                                     ['if a1',
+                                      '   b1',
+                                      '   b1',
+                                      'elsif a2',
+                                      ' b2',
+                                      'else',
+                                      '    c',
+                                      'end'])
+      expect(corrected)
+        .to eq ['if a1',
+                '  b1',
+                '   b1', # Will be corrected by IndentationConsistency.
+                'elsif a2',
+                '  b2',
+                'else',
+                '  c',
+                'end'].join("\n")
+    end
+
     it 'accepts a one line if statement' do
       inspect_source(cop,
                      ['if cond then func1 else func2 end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts a correctly aligned if/elsif/else/end' do
@@ -73,7 +103,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'else',
                       '  c',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts if/elsif/else/end laid out as a table' do
@@ -83,7 +113,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'elsif @io == $stderr then str << "$stderr"',
                       'else                      str << @io.class.to_s',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts if/then/else/end laid out as another table' do
@@ -92,7 +122,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'then ConfigTable.load',
                       'else ConfigTable.new',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an empty if' do
@@ -100,95 +130,201 @@ describe Rubocop::Cop::Style::IndentationWidth do
                      ['if a',
                       'else',
                       'end'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if in assignment with end aligned with variable' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '  0',
-                      'end',
-                      '@var = if a',
-                      '  0',
-                      'end',
-                      '$var = if a',
-                      '  0',
-                      'end',
-                      'var ||= if a',
-                      '  0',
-                      'end',
-                      'var &&= if a',
-                      '  0',
-                      'end',
-                      'var -= if a',
-                      '  0',
-                      'end',
-                      'VAR = if a',
-                      '  0',
-                      'end'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if/else in assignment with end aligned with variable' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '  0',
-                      'else',
-                      '  1',
-                      'end'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if/else in assignment with end aligned with variable ' \
-      'and chaining after the end' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '  0',
-                      'else',
-                      '  1',
-                      'end.abc.join("")'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if/else in assignment with end aligned with variable ' \
-      'and chaining with a block after the end' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '  0',
-                      'else',
-                      '  1',
-                      'end.abc.tap {}'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if in assignment with end aligned with if' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '        0',
-                      '      end'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if/else in assignment with end aligned with if' do
-      inspect_source(cop,
-                     ['var = if a',
-                      '        0',
-                      '      else',
-                      '        1',
-                      '      end'])
-      expect(cop.offences).to be_empty
-    end
-
-    it 'accepts an if/else in assignment on next line with end aligned ' \
-      'with if' do
-      inspect_source(cop,
-                     ['var =',
-                      '  if a',
-                      '    0',
-                      '  else',
-                      '    1',
-                      '  end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
+    end
+
+    context 'with assignment' do
+      context 'when alignment style is variable' do
+        context 'and end is aligned with variable' do
+          it 'accepts an if with end aligned with variable' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '  0',
+                            'end',
+                            '@var = if a',
+                            '  0',
+                            'end',
+                            '$var = if a',
+                            '  0',
+                            'end',
+                            'var ||= if a',
+                            '  0',
+                            'end',
+                            'var &&= if a',
+                            '  0',
+                            'end',
+                            'var -= if a',
+                            '  0',
+                            'end',
+                            'VAR = if a',
+                            '  0',
+                            'end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an if/else' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '  0',
+                            'else',
+                            '  1',
+                            'end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an if/else with chaining after the end' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '  0',
+                            'else',
+                            '  1',
+                            'end.abc.join("")'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an if/else with chaining with a block after the end' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '  0',
+                            'else',
+                            '  1',
+                            'end.abc.tap {}'])
+            expect(cop.offenses).to be_empty
+          end
+        end
+
+        context 'and end is aligned with keyword' do
+          it 'registers an offense for an if' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '        0',
+                            '      end'])
+            expect(cop.messages)
+              .to eq(['Use 2 (not 8) spaces for indentation.'])
+          end
+
+          it 'registers an offense for a while' do
+            inspect_source(cop,
+                           ['var = while a',
+                            '        b',
+                            '      end'])
+            expect(cop.messages)
+              .to eq(['Use 2 (not 8) spaces for indentation.'])
+          end
+
+          it 'registers an offense for an until' do
+            inspect_source(cop,
+                           ['var = until a',
+                            '        b',
+                            '      end'])
+            expect(cop.messages)
+              .to eq(['Use 2 (not 8) spaces for indentation.'])
+          end
+        end
+      end
+
+      shared_examples 'assignment and if with keyword alignment' do
+        context 'and end is aligned with variable' do
+          it 'registers an offense for an if' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '  0',
+                            'end'])
+            expect(cop.messages)
+              .to eq(['Use 2 (not -4) spaces for indentation.'])
+          end
+
+          it 'registers an offense for a while' do
+            inspect_source(cop,
+                           ['var = while a',
+                            '  b',
+                            'end'])
+            expect(cop.messages)
+              .to eq(['Use 2 (not -4) spaces for indentation.'])
+          end
+
+          it 'autocorrects bad indentation' do
+            corrected = autocorrect_source(cop,
+                                           ['var = if a',
+                                            '  b',
+                                            'end',
+                                            '',
+                                            'var = while a',
+                                            '  b',
+                                            'end'])
+            expect(corrected).to eq ['var = if a',
+                                     '        b',
+                                     'end', # Not this cop's job to fix end.
+                                     '',
+                                     'var = while a',
+                                     '        b',
+                                     'end'].join("\n")
+          end
+        end
+
+        context 'and end is aligned with keyword' do
+          it 'accepts an if in assignment' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '        0',
+                            '      end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an if/else in assignment' do
+            inspect_source(cop,
+                           ['var = if a',
+                            '        0',
+                            '      else',
+                            '        1',
+                            '      end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an if/else in assignment on next line' do
+            inspect_source(cop,
+                           ['var =',
+                            '  if a',
+                            '    0',
+                            '  else',
+                            '    1',
+                            '  end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts a while in assignment' do
+            inspect_source(cop,
+                           ['var = while a',
+                            '        b',
+                            '      end'])
+            expect(cop.offenses).to be_empty
+          end
+
+          it 'accepts an until in assignment' do
+            inspect_source(cop,
+                           ['var = until a',
+                            '        b',
+                            '      end'])
+            expect(cop.offenses).to be_empty
+          end
+        end
+      end
+
+      context 'when alignment style is keyword by choice' do
+        let(:end_alignment_config) do
+          { 'Enabled' => true, 'AlignWith' => 'keyword' }
+        end
+
+        include_examples 'assignment and if with keyword alignment'
+      end
+
+      context 'when alignment style is keyword by default' do
+        let(:end_alignment_config) do
+          { 'Enabled' => false, 'AlignWith' => 'variable' }
+        end
+
+        include_examples 'assignment and if with keyword alignment'
+      end
     end
 
     it 'accepts an if/else branches with rescue clauses' do
@@ -200,12 +336,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'else',
                       '  a rescue nil',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with unless' do
-    it 'registers an offence for bad indentation of an unless body' do
+    it 'registers an offense for bad indentation of an unless body' do
       inspect_source(cop,
                      ['unless cond',
                       ' func',
@@ -218,12 +354,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
                      ['unless a',
                       'else',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with case' do
-    it 'registers an offence for bad indentation in a case/when body' do
+    it 'registers an offense for bad indentation in a case/when body' do
       inspect_source(cop,
                      ['case a',
                       'when b',
@@ -232,7 +368,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
     end
 
-    it 'registers an offence for bad indentation in a case/else body' do
+    it 'registers an offense for bad indentation in a case/else body' do
       inspect_source(cop,
                      ['case a',
                       'when b',
@@ -255,7 +391,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       'else',
                       '  f',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts case/when/else laid out as a table' do
@@ -265,7 +401,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       "when 'unless' then cond, _else, body = *sexp",
                       'else               cond, body = *sexp',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts case/when/else with then beginning a line' do
@@ -274,7 +410,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       "when 'if'",
                       'then cond, body, _else = *sexp',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts indented when/else plus indented body' do
@@ -290,12 +426,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       '  else',
                       "    'plain'",
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with while/until' do
-    it 'registers an offence for bad indentation of a while body' do
+    it 'registers an offense for bad indentation of a while body' do
       inspect_source(cop,
                      ['while cond',
                       ' func',
@@ -303,7 +439,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
     end
 
-    it 'registers an offence for bad indentation of begin/end/while' do
+    it 'registers an offense for bad indentation of begin/end/while' do
       inspect_source(cop,
                      ['something = begin',
                       ' func1',
@@ -312,7 +448,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
     end
 
-    it 'registers an offence for bad indentation of an until body' do
+    it 'registers an offense for bad indentation of an until body' do
       inspect_source(cop,
                      ['until cond',
                       ' func',
@@ -324,12 +460,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
       inspect_source(cop,
                      ['while a',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with for' do
-    it 'registers an offence for bad indentation of a for body' do
+    it 'registers an offense for bad indentation of a for body' do
       inspect_source(cop,
                      ['for var in 1..10',
                       ' func',
@@ -341,21 +477,21 @@ describe Rubocop::Cop::Style::IndentationWidth do
       inspect_source(cop,
                      ['for var in 1..10',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with def/defs' do
-    it 'registers an offence for bad indentation of a def body' do
+    it 'registers an offense for bad indentation of a def body' do
       inspect_source(cop,
                      ['def test',
                       '    func1',
-                      '     func2', # No offence registered for this.
+                      '     func2', # No offense registered for this.
                       'end'])
       expect(cop.messages).to eq(['Use 2 (not 4) spaces for indentation.'])
     end
 
-    it 'registers an offence for bad indentation of a defs body' do
+    it 'registers an offense for bad indentation of a defs body' do
       inspect_source(cop,
                      ['def self.test',
                       '   func',
@@ -367,19 +503,19 @@ describe Rubocop::Cop::Style::IndentationWidth do
       inspect_source(cop,
                      ['def test',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an empty defs body' do
       inspect_source(cop,
                      ['def self.test',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with class' do
-    it 'registers an offence for bad indentation of a class body' do
+    it 'registers an offense for bad indentation of a class body' do
       inspect_source(cop,
                      ['class Test',
                       '    def func',
@@ -392,7 +528,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       inspect_source(cop,
                      ['class Test',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts indented public, protected, and private' do
@@ -413,12 +549,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
                       '  def g',
                       '  end',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with module' do
-    it 'registers an offence for bad indentation of a module body' do
+    it 'registers an offense for bad indentation of a module body' do
       inspect_source(cop,
                      ['module Test',
                       '    def func',
@@ -431,12 +567,12 @@ describe Rubocop::Cop::Style::IndentationWidth do
       inspect_source(cop,
                      ['module Test',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 
   context 'with block' do
-    it 'registers an offence for bad indentation of a do/end body' do
+    it 'registers an offense for bad indentation of a do/end body' do
       inspect_source(cop,
                      ['a = func do',
                       ' b',
@@ -444,7 +580,7 @@ describe Rubocop::Cop::Style::IndentationWidth do
       expect(cop.messages).to eq(['Use 2 (not 1) spaces for indentation.'])
     end
 
-    it 'registers an offence for bad indentation of a {} body' do
+    it 'registers an offense for bad indentation of a {} body' do
       inspect_source(cop,
                      ['func {',
                       '   b',
@@ -457,14 +593,14 @@ describe Rubocop::Cop::Style::IndentationWidth do
                      ['a = func do',
                       '  b',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an empty block body' do
       inspect_source(cop,
                      ['a = func do',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
   end
 end