rubocop 0.18.1 → 0.19.0

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

@@ -0,0 +1,238 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::IndentHash, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { { 'EnforcedStyle' => 'special_inside_parentheses' } }
+
+  context 'when hash is operand' do
+    it 'accepts correctly indented first pair' do
+      inspect_source(cop,
+                     ['a << {',
+                      '  a: 1',
+                      '}'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'registers an offense for incorrectly indented first pair' do
+      inspect_source(cop,
+                     ['a << {',
+                      ' a: 1',
+                      '}'])
+      expect(cop.highlights).to eq(['a: 1'])
+      expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+    end
+
+    it 'auto-corrects incorrectly indented first pair' do
+      corrected = autocorrect_source(cop, ['a << {',
+                                           ' a: 1',
+                                           '}'])
+      expect(corrected).to eq ['a << {',
+                               '  a: 1',
+                               '}'].join("\n")
+    end
+  end
+
+  context 'when hash is argument to setter' do
+    it 'accepts correctly indented first pair' do
+      inspect_source(cop,
+                     ['   config.rack_cache = {',
+                      '     :metastore => "rails:/",',
+                      '     :entitystore => "rails:/",',
+                      '     :verbose => false',
+                      '   }'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'registers an offense for incorrectly indented first pair' do
+      inspect_source(cop,
+                     ['   config.rack_cache = {',
+                      '   :metastore => "rails:/",',
+                      '   :entitystore => "rails:/",',
+                      '   :verbose => false',
+                      '   }'])
+      expect(cop.highlights).to eq([':metastore => "rails:/"'])
+      expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+    end
+  end
+
+  context 'when hash is right hand side in assignment' do
+    it 'registers an offense for incorrectly indented first pair' do
+      inspect_source(cop, ['a = {',
+                           '    a: 1,',
+                           '  b: 2,',
+                           ' c: 3',
+                           '}'])
+      expect(cop.messages)
+        .to eq(['Use 2 spaces for indentation in a hash, relative to the ' \
+                'start of the line where the left curly brace is.'])
+      expect(cop.highlights).to eq(['a: 1'])
+      expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+    end
+
+    it 'auto-corrects incorrectly indented first pair' do
+      corrected = autocorrect_source(cop, ['a = {',
+                                           '    a: 1,',
+                                           '  b: 2,',
+                                           ' c: 3',
+                                           '}'])
+      expect(corrected).to eq ['a = {',
+                               '  a: 1,',
+                               '  b: 2,',
+                               ' c: 3',
+                               '}'].join("\n")
+    end
+
+    it 'accepts correctly indented first pair' do
+      inspect_source(cop,
+                     ['a = {',
+                      '  a: 1',
+                      '}'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'accepts several pairs per line' do
+      inspect_source(cop,
+                     ['a = {',
+                      '  a: 1, b: 2',
+                      '}'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'accepts a first pair on the same line as the left brace' do
+      inspect_source(cop,
+                     ['a = { "a" => 1,',
+                      '      "b" => 2 }'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'accepts single line hash' do
+      inspect_source(cop,
+                     ['a = { a: 1, b: 2 }'])
+      expect(cop.offenses).to be_empty
+    end
+
+    it 'accepts an empty hash' do
+      inspect_source(cop,
+                     ['a = {}'])
+      expect(cop.offenses).to be_empty
+    end
+  end
+
+  context 'when hash is method argument' do
+    context 'and arguments are surrounded by parentheses' do
+      context 'and EnforcedStyle is special_inside_parentheses' do
+        it 'accepts special indentation for first argument' do
+          inspect_source(cop,
+                         ['func({',
+                          '       a: 1',
+                          '     })'])
+          expect(cop.offenses).to be_empty
+        end
+
+        it 'registers an offense for incorrect indentation' do
+          inspect_source(cop,
+                         ['func({',
+                          '  a: 1',
+                          '})'])
+          expect(cop.messages)
+            .to eq(['Use 2 spaces for indentation in a hash, relative to the' \
+                    ' first position after the preceding left parenthesis.'])
+          expect(cop.config_to_allow_offenses)
+            .to eq('EnforcedStyle' => 'consistent')
+        end
+
+        it 'auto-corrects incorrectly indented first pair' do
+          corrected = autocorrect_source(cop, ['func({',
+                                               '  a: 1',
+                                               '})'])
+          expect(corrected).to eq ['func({',
+                                   '       a: 1',
+                                   '})'].join("\n")
+        end
+
+        it 'accepts special indentation for second argument' do
+          inspect_source(cop,
+                         ['body.should have_tag("input", :attributes => {',
+                          '                       :name => /q\[(id_eq)\]/ })'])
+          expect(cop.offenses).to be_empty
+        end
+
+        it 'accepts normal indentation for hash within hash' do
+          inspect_source(cop,
+                         ['scope = scope.where(',
+                          '  klass.table_name => {',
+                          '    reflection.type => model.base_class.sti_name',
+                          '  }',
+                          ')'])
+          expect(cop.offenses).to be_empty
+        end
+      end
+
+      context 'and EnforcedStyle is consistent' do
+        let(:cop_config) { { 'EnforcedStyle' => 'consistent' } }
+
+        it 'accepts normal indentation for first argument' do
+          inspect_source(cop,
+                         ['func({',
+                          '  a: 1',
+                          '})'])
+          expect(cop.offenses).to be_empty
+        end
+
+        it 'registers an offense for incorrect indentation' do
+          inspect_source(cop,
+                         ['func({',
+                          '       a: 1',
+                          '     })'])
+          expect(cop.messages)
+            .to eq(['Use 2 spaces for indentation in a hash, relative to the' \
+                    ' start of the line where the left curly brace is.'])
+          expect(cop.config_to_allow_offenses)
+            .to eq('EnforcedStyle' => 'special_inside_parentheses')
+        end
+
+        it 'accepts normal indentation for second argument' do
+          inspect_source(cop,
+                         ['body.should have_tag("input", :attributes => {',
+                          '  :name => /q\[(id_eq)\]/ })'])
+          expect(cop.offenses).to be_empty
+        end
+      end
+    end
+
+    context 'and argument are not surrounded by parentheses' do
+      it 'accepts braceless hash' do
+        inspect_source(cop,
+                       ['func a: 1, b: 2'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'accepts single line hash with braces' do
+        inspect_source(cop,
+                       ['func x, { a: 1, b: 2 }'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'accepts a correctly indented multi-line hash with braces' do
+        inspect_source(cop,
+                       ['func x, {',
+                        '  a: 1, b: 2 }'])
+        expect(cop.offenses).to be_empty
+      end
+
+      it 'registers an offense for incorrectly indented multi-line hash ' \
+         'with braces' do
+        inspect_source(cop,
+                       ['func x, {',
+                        '       a: 1, b: 2 }'])
+        expect(cop.messages)
+          .to eq(['Use 2 spaces for indentation in a hash, relative to the ' \
+                  'start of the line where the left curly brace is.'])
+        expect(cop.highlights).to eq(['a: 1'])
+        expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
   subject(:cop) { described_class.new }
 
   context 'with if statement' do
-    it 'registers an offence for bad indentation in an if body' do
+    it 'registers an offense for bad indentation in an if body' do
       inspect_source(cop,
                      ['if cond',
                       ' func',
@@ -15,7 +15,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in an else body' do
+    it 'registers an offense for bad indentation in an else body' do
       inspect_source(cop,
                      ['if cond',
                       '  func1',
@@ -26,7 +26,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in an elsif body' do
+    it 'registers an offense for bad indentation in an elsif body' do
       inspect_source(cop,
                      ['if a1',
                       '  b1',
@@ -39,10 +39,30 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
+    it 'autocorrects bad indentation' do
+      corrected = autocorrect_source(cop,
+                                     ['if a1',
+                                      '   b1',
+                                      'elsif a2',
+                                      ' b2',
+                                      '  b3',
+                                      'else',
+                                      '    c',
+                                      'end'])
+      expect(corrected).to eq ['if a1',
+                               '   b1',
+                               'elsif a2',
+                               ' b2',
+                               ' b3',
+                               '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
@@ -54,7 +74,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -64,7 +84,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -73,7 +93,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -81,7 +101,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                      ['if a',
                       'else',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if in assignment with end aligned with variable' do
@@ -107,7 +127,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       'VAR = if a',
                       '  0',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if/else in assignment with end aligned with variable' do
@@ -117,29 +137,29 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       'else',
                       '  1',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if/else in assignment with end aligned with variable ' \
-      'and chaining after the end' do
+       'and chaining after the end' do
       inspect_source(cop,
                      ['var = if a',
                       '  0',
                       'else',
                       '  1',
                       'end.abc.join("")'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).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
+       '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
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if in assignment with end aligned with if' do
@@ -147,7 +167,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                      ['var = if a',
                       '        0',
                       '      end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if/else in assignment with end aligned with if' do
@@ -157,11 +177,11 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       '      else',
                       '        1',
                       '      end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if/else in assignment on next line with end aligned ' \
-      'with if' do
+       'with if' do
       inspect_source(cop,
                      ['var =',
                       '  if a',
@@ -169,7 +189,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       '  else',
                       '    1',
                       '  end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
     it 'accepts an if/else branches with rescue clauses' do
@@ -181,12 +201,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in an unless body' do
+    it 'registers an offense for bad indentation in an unless body' do
       inspect_source(cop,
                      ['unless cond',
                       ' func',
@@ -200,12 +220,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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',
@@ -215,7 +235,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     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',
@@ -239,7 +259,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -249,7 +269,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -258,7 +278,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -274,12 +294,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in a while body' do
+    it 'registers an offense for bad indentation in a while body' do
       inspect_source(cop,
                      ['while cond',
                       ' func',
@@ -288,7 +308,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in begin/end/while' do
+    it 'registers an offense for bad indentation in begin/end/while' do
       inspect_source(cop,
                      ['something = begin',
                       ' func1',
@@ -297,7 +317,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in an until body' do
+    it 'registers an offense for bad indentation in an until body' do
       inspect_source(cop,
                      ['until cond',
                       ' func',
@@ -310,12 +330,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in a for body' do
+    it 'registers an offense for bad indentation in a for body' do
       inspect_source(cop,
                      ['for var in 1..10',
                       ' func',
@@ -328,12 +348,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in a def body' do
+    it 'registers an offense for bad indentation in a def body' do
       inspect_source(cop,
                      ['def test',
                       '    func1',
@@ -343,7 +363,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
         .to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in a defs body' do
+    it 'registers an offense for bad indentation in a defs body' do
       inspect_source(cop,
                      ['def self.test',
                       '   func',
@@ -356,19 +376,19 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in a class body' do
+    it 'registers an offense for bad indentation in a class body' do
       inspect_source(cop,
                      ['class Test',
                       '    def func1',
@@ -384,7 +404,7 @@ describe Rubocop::Cop::Style::IndentationConsistency 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
@@ -405,11 +425,11 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       '  def g',
                       '  end',
                       'end'])
-      expect(cop.offences).to be_empty
+      expect(cop.offenses).to be_empty
     end
 
-    it 'registers an offence for bad indentation in def but not for ' \
-      'outdented public, protected, and private' do
+    it 'registers an offense for bad indentation in def but not for ' \
+       'outdented public, protected, and private' do
       inspect_source(cop,
                      ['class Test',
                       'public',
@@ -428,12 +448,12 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       ' end',
                       'end'])
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
-      expect(cop.highlights).to eq([' '])
+      expect(cop.highlights).to eq(["def g\n end"])
     end
   end
 
   context 'with module' do
-    it 'registers an offence for bad indentation in a module body' do
+    it 'registers an offense for bad indentation in a module body' do
       inspect_source(cop,
                      ['module Test',
                       '    def func1',
@@ -448,12 +468,12 @@ describe Rubocop::Cop::Style::IndentationConsistency 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 in a do/end body' do
+    it 'registers an offense for bad indentation in a do/end body' do
       inspect_source(cop,
                      ['a = func do',
                       ' b',
@@ -462,7 +482,7 @@ describe Rubocop::Cop::Style::IndentationConsistency do
       expect(cop.messages).to eq(['Inconsistent indentation detected.'])
     end
 
-    it 'registers an offence for bad indentation in a {} body' do
+    it 'registers an offense for bad indentation in a {} body' do
       inspect_source(cop,
                      ['func {',
                       '   b',
@@ -477,14 +497,14 @@ describe Rubocop::Cop::Style::IndentationConsistency do
                       '  b',
                       '  c',
                       '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