rubocop 0.16.0 → 0.17.0

data/spec/rubocop/cop/style/{favor_modifier_spec.rb → if_unless_modifier_spec.rb}

@@ -3,6 +3,8 @@
 require 'spec_helper'
 
 describe Rubocop::Cop::Style::IfUnlessModifier do
+  include StatementModifierHelper
+
   subject(:cop) { described_class.new(config) }
   let(:config) do
     hash = { 'LineLength' => { 'Max' => 79 } }
@@ -21,7 +23,7 @@ describe Rubocop::Cop::Style::IfUnlessModifier do
                     "    #{body}",
                     '  end'])
     expect(cop.messages).to eq(
-      ['Favor modifier if/unless usage when you have a single-line' +
+      ['Favor modifier if usage when you have a single-line' +
        ' body. Another good alternative is the usage of control flow' +
        ' &&/||.'])
   end
@@ -57,7 +59,7 @@ describe Rubocop::Cop::Style::IfUnlessModifier do
                          '  b',
                          'end'])
     expect(cop.messages).to eq(
-      ['Favor modifier if/unless usage when you have a single-line' +
+      ['Favor modifier unless usage when you have a single-line' +
        ' body. Another good alternative is the usage of control flow' +
        ' &&/||.'])
   end
@@ -124,112 +126,3 @@ describe Rubocop::Cop::Style::IfUnlessModifier do
     end
   end
 end
-
-describe Rubocop::Cop::Style::WhileUntilModifier do
-  subject(:cop) { described_class.new(config) }
-  let(:config) do
-    hash = { 'LineLength' => { 'Max' => 79 } }
-    Rubocop::Config.new(hash)
-  end
-
-  it "accepts multiline unless that doesn't fit on one line" do
-    check_too_long(cop, 'unless')
-  end
-
-  it 'accepts multiline unless whose body is more than one line' do
-    check_short_multiline(cop, 'unless')
-  end
-
-  it 'registers an offence for multiline while that fits on one line' do
-    check_really_short(cop, 'while')
-  end
-
-  it "accepts multiline while that doesn't fit on one line" do
-    check_too_long(cop, 'while')
-  end
-
-  it 'accepts multiline while whose body is more than one line' do
-    check_short_multiline(cop, 'while')
-  end
-
-  it 'accepts oneline while when condition has local variable assignment' do
-    inspect_source(cop, ['lines = %w{first second third}',
-                         'while (line = lines.shift)',
-                         '  puts line',
-                         'end'])
-    expect(cop.offences).to be_empty
-  end
-
-  it 'registers an offence for oneline while when assignment is in body' do
-    inspect_source(cop, ['while true',
-                         '  x = 0',
-                         'end'])
-    expect(cop.offences.size).to eq(1)
-  end
-
-  it 'registers an offence for multiline until that fits on one line' do
-    check_really_short(cop, 'until')
-  end
-
-  it "accepts multiline until that doesn't fit on one line" do
-    check_too_long(cop, 'until')
-  end
-
-  it 'accepts multiline until whose body is more than one line' do
-    check_short_multiline(cop, 'until')
-  end
-
-  it 'accepts an empty condition' do
-    check_empty(cop, 'while')
-    check_empty(cop, 'until')
-  end
-
-  it 'accepts modifier while' do
-    inspect_source(cop, ['ala while bala'])
-    expect(cop.offences).to be_empty
-  end
-
-  it 'accepts modifier until' do
-    inspect_source(cop, ['ala until bala'])
-    expect(cop.offences).to be_empty
-  end
-end
-
-def check_empty(cop, keyword)
-  inspect_source(cop, ["#{keyword} cond",
-                       'end'])
-  expect(cop.offences).to be_empty
-end
-
-def check_really_short(cop, keyword)
-  inspect_source(cop, ["#{keyword} a",
-                       '  b',
-                       'end'])
-  expect(cop.messages).to eq(
-    ['Favor modifier while/until usage when you have a single-line ' +
-     'body.'])
-  expect(cop.offences.map { |o| o.location.source }).to eq([keyword])
-end
-
-def check_too_long(cop, keyword)
-  # This statement is one character too long to fit.
-  condition = 'a' * (40 - keyword.length)
-  body = 'b' * 36
-  expect("  #{body} #{keyword} #{condition}".length).to eq(80)
-
-  inspect_source(cop,
-                 ["  #{keyword} #{condition}",
-                  "    #{body}",
-                  '  end'])
-
-  expect(cop.offences).to be_empty
-end
-
-def check_short_multiline(cop, keyword)
-  inspect_source(cop,
-                 ["#{keyword} ENV['COVERAGE']",
-                  "  require 'simplecov'",
-                  '  SimpleCov.start',
-                  'end'])
-  expect(cop.messages).to be_empty
-end

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

@@ -0,0 +1,490 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+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
+      inspect_source(cop,
+                     ['if cond',
+                      ' func',
+                      '  func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in an else body' do
+      inspect_source(cop,
+                     ['if cond',
+                      '  func1',
+                      'else',
+                      ' func2',
+                      '  func2',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in an elsif body' do
+      inspect_source(cop,
+                     ['if a1',
+                      '  b1',
+                      'elsif a2',
+                      ' b2',
+                      'b3',
+                      'else',
+                      '  c',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    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
+    end
+
+    it 'accepts a correctly aligned if/elsif/else/end' do
+      inspect_source(cop,
+                     ['if a1',
+                      '  b1',
+                      'elsif a2',
+                      '  b2',
+                      'else',
+                      '  c',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts if/elsif/else/end laid out as a table' do
+      inspect_source(cop,
+                     ['if    @io == $stdout then str << "$stdout"',
+                      'elsif @io == $stdin  then str << "$stdin"',
+                      'elsif @io == $stderr then str << "$stderr"',
+                      'else                      str << @io.class.to_s',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts if/then/else/end laid out as another table' do
+      inspect_source(cop,
+                     ["if File.exist?('config.save')",
+                      'then ConfigTable.load',
+                      'else ConfigTable.new',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts an empty if' do
+      inspect_source(cop,
+                     ['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
+    end
+
+    it 'accepts an if/else branches with rescue clauses' do
+      # Because of how the rescue clauses come out of Parser, these are
+      # special and need to be tested.
+      inspect_source(cop,
+                     ['if a',
+                      '  a rescue nil',
+                      'else',
+                      '  a rescue nil',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with unless' do
+    it 'registers an offence for bad indentation in an unless body' do
+      inspect_source(cop,
+                     ['unless cond',
+                      ' func',
+                      '  func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty unless' do
+      inspect_source(cop,
+                     ['unless a',
+                      'else',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with case' do
+    it 'registers an offence for bad indentation in a case/when body' do
+      inspect_source(cop,
+                     ['case a',
+                      'when b',
+                      ' c',
+                      '    d',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in a case/else body' do
+      inspect_source(cop,
+                     ['case a',
+                      'when b',
+                      '  c',
+                      'when d',
+                      '  e',
+                      'else',
+                      '   f',
+                      '  g',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts correctly indented case/when/else' do
+      inspect_source(cop,
+                     ['case a',
+                      'when b',
+                      '  c',
+                      '  c',
+                      'when d',
+                      'else',
+                      '  f',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts case/when/else laid out as a table' do
+      inspect_source(cop,
+                     ['case sexp.loc.keyword.source',
+                      "when 'if'     then cond, body, _else = *sexp",
+                      "when 'unless' then cond, _else, body = *sexp",
+                      'else               cond, body = *sexp',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts case/when/else with then beginning a line' do
+      inspect_source(cop,
+                     ['case sexp.loc.keyword.source',
+                      "when 'if'",
+                      'then cond, body, _else = *sexp',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts indented when/else plus indented body' do
+      # "Indent when as deep as case" is the job of another cop.
+      inspect_source(cop,
+                     ['case code_type',
+                      "  when 'ruby', 'sql', 'plain'",
+                      '    code_type',
+                      "  when 'erb'",
+                      "    'ruby; html-script: true'",
+                      '  when "html"',
+                      "    'xml'",
+                      '  else',
+                      "    'plain'",
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with while/until' do
+    it 'registers an offence for bad indentation in a while body' do
+      inspect_source(cop,
+                     ['while cond',
+                      ' func',
+                      '  func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in begin/end/while' do
+      inspect_source(cop,
+                     ['something = begin',
+                      ' func1',
+                      '   func2',
+                      'end while cond'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in an until body' do
+      inspect_source(cop,
+                     ['until cond',
+                      ' func',
+                      '  func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty while' do
+      inspect_source(cop,
+                     ['while a',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with for' do
+    it 'registers an offence for bad indentation in a for body' do
+      inspect_source(cop,
+                     ['for var in 1..10',
+                      ' func',
+                      'func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty for' do
+      inspect_source(cop,
+                     ['for var in 1..10',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with def/defs' do
+    it 'registers an offence for bad indentation in a def body' do
+      inspect_source(cop,
+                     ['def test',
+                      '    func1',
+                      '     func2',
+                      'end'])
+      expect(cop.messages)
+        .to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in a defs body' do
+      inspect_source(cop,
+                     ['def self.test',
+                      '   func',
+                      '    func',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty def body' do
+      inspect_source(cop,
+                     ['def test',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts an empty defs body' do
+      inspect_source(cop,
+                     ['def self.test',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with class' do
+    it 'registers an offence for bad indentation in a class body' do
+      inspect_source(cop,
+                     ['class Test',
+                      '    def func1',
+                      '    end',
+                      '  def func2',
+                      '  end',
+                      'end'])
+      expect(cop.messages)
+        .to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty class body' do
+      inspect_source(cop,
+                     ['class Test',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts indented public, protected, and private' do
+      inspect_source(cop,
+                     ['class Test',
+                      '  public',
+                      '',
+                      '  def e',
+                      '  end',
+                      '',
+                      '  protected',
+                      '',
+                      '  def f',
+                      '  end',
+                      '',
+                      '  private',
+                      '',
+                      '  def g',
+                      '  end',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'registers an offence for bad indentation in def but not for ' +
+      'outdented public, protected, and private' do
+      inspect_source(cop,
+                     ['class Test',
+                      'public',
+                      '',
+                      '  def e',
+                      '  end',
+                      '',
+                      'protected',
+                      '',
+                      '  def f',
+                      '  end',
+                      '',
+                      'private',
+                      '',
+                      ' def g',
+                      ' end',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+      expect(cop.highlights).to eq([' '])
+    end
+  end
+
+  context 'with module' do
+    it 'registers an offence for bad indentation in a module body' do
+      inspect_source(cop,
+                     ['module Test',
+                      '    def func1',
+                      '    end',
+                      '     def func2',
+                      '     end',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts an empty module body' do
+      inspect_source(cop,
+                     ['module Test',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+
+  context 'with block' do
+    it 'registers an offence for bad indentation in a do/end body' do
+      inspect_source(cop,
+                     ['a = func do',
+                      ' b',
+                      '  c',
+                      'end'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'registers an offence for bad indentation in a {} body' do
+      inspect_source(cop,
+                     ['func {',
+                      '   b',
+                      '  c',
+                      '}'])
+      expect(cop.messages).to eq(['Inconsistent indentation detected.'])
+    end
+
+    it 'accepts a correctly indented block body' do
+      inspect_source(cop,
+                     ['a = func do',
+                      '  b',
+                      '  c',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+
+    it 'accepts an empty block body' do
+      inspect_source(cop,
+                     ['a = func do',
+                      'end'])
+      expect(cop.offences).to be_empty
+    end
+  end
+end