rubocop 0.15.0 → 0.16.0

data/spec/rubocop/cop/lint/block_alignment_spec.rb

@@ -131,12 +131,12 @@ describe Rubocop::Cop::Lint::BlockAlignment do
              'end']
       inspect_source(cop, src)
       expect(cop.messages)
-        .to eq(['end at 10, 8 is not aligned with bar.get_stuffs at 2, 2 or' +
-                ' .select do |stuff| at 8, 6',
+        .to eq(['end at 5, 8 is not aligned with bar.get_stuffs at 2, 2 or' +
+                ' .reject do |stuff| at 3, 6',
                 'end at 7, 4 is not aligned with bar.get_stuffs at 2, 2 or' +
                 ' end.select do |stuff| at 5, 8',
-                'end at 5, 8 is not aligned with bar.get_stuffs at 2, 2 or' +
-                ' .reject do |stuff| at 3, 6'])
+                'end at 10, 8 is not aligned with bar.get_stuffs at 2, 2 or' +
+                ' .select do |stuff| at 8, 6'])
     end
 
     # Example from issue 393 of bbatsov/rubocop on github:

data/spec/rubocop/cop/lint/end_alignment_spec.rb

@@ -1,64 +1,96 @@
 # encoding: utf-8
-# rubocop:disable LineLength
 
 require 'spec_helper'
 
-describe Rubocop::Cop::Lint::EndAlignment do
-  subject(:cop) { described_class.new }
+describe Rubocop::Cop::Lint::EndAlignment, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:cop_config) { {} }
+  let(:cop_config) { { 'AlignWith' => 'keyword' } }
 
-  it 'registers an offence for mismatched class end' do
-    inspect_source(cop,
-                   ['class Test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
+  shared_examples 'misaligned' do |alignment_base, arg, end_kw, name|
+    name ||= alignment_base
+    it "registers an offence for mismatched #{name} ... end" do
+      inspect_source(cop, ["#{alignment_base} #{arg}",
+                           end_kw])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages.first)
+        .to match(/end at 2, \d is not aligned with #{alignment_base} at 1,/)
+      expect(cop.highlights.first).to eq('end')
+    end
   end
 
-  it 'registers an offence for mismatched module end' do
-    inspect_source(cop,
-                   ['module Test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
+  shared_examples 'aligned' do |alignment_base, arg, end_kw, name|
+    name ||= alignment_base
+    it "accepts matching #{name} ... end" do
+      inspect_source(cop, ["#{alignment_base} #{arg}",
+                           end_kw])
+      expect(cop.offences).to be_empty
+    end
   end
 
-  it 'registers an offence for mismatched def end' do
-    inspect_source(cop,
-                   ['def test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
-  end
+  include_examples 'misaligned', 'class',  'Test',      '  end'
+  include_examples 'misaligned', 'module', 'Test',      '  end'
+  include_examples 'misaligned', 'def',    'test',      '  end'
+  include_examples 'misaligned', 'def',    'Test.test', '  end', 'defs'
+  include_examples 'misaligned', 'if',     'test',      '  end'
+  include_examples 'misaligned', 'unless', 'test',      '  end'
+  include_examples 'misaligned', 'while',  'test',      '  end'
+  include_examples 'misaligned', 'until',  'test',      '  end'
 
-  it 'registers an offence for mismatched defs end' do
-    inspect_source(cop,
-                   ['def Test.test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
-  end
+  include_examples 'aligned', 'class',  'Test',      'end'
+  include_examples 'aligned', 'module', 'Test',      'end'
+  include_examples 'aligned', 'def',    'test',      'end'
+  include_examples 'aligned', 'def',    'Test.test', 'end', 'defs'
+  include_examples 'aligned', 'if',     'test',      'end'
+  include_examples 'aligned', 'unless', 'test',      'end'
+  include_examples 'aligned', 'while',  'test',      'end'
+  include_examples 'aligned', 'until',  'test',      'end'
 
-  it 'registers an offence for mismatched if end' do
-    inspect_source(cop,
-                   ['if test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
+  it 'can handle ternary if' do
+    inspect_source(cop, 'a = cond ? x : y')
+    expect(cop.offences).to be_empty
   end
 
-  it 'registers an offence for mismatched while end' do
-    inspect_source(cop,
-                   ['while test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
+  it 'can handle modifier if' do
+    inspect_source(cop, 'a = x if cond')
+    expect(cop.offences).to be_empty
   end
 
-  it 'registers an offence for mismatched until end' do
-    inspect_source(cop,
-                   ['until test',
-                    '  end'
-                   ])
-    expect(cop.offences.size).to eq(1)
+  context 'regarding assignment' do
+    context 'when AlignWith is keyword' do
+      include_examples 'misaligned', 'var = if',     'test', 'end'
+      include_examples 'misaligned', 'var = unless', 'test', 'end'
+      include_examples 'misaligned', 'var = while',  'test', 'end'
+      include_examples 'misaligned', 'var = until',  'test', 'end'
+
+      include_examples 'aligned', 'var = if',     'test', '      end'
+      include_examples 'aligned', 'var = unless', 'test', '      end'
+      include_examples 'aligned', 'var = while',  'test', '      end'
+      include_examples 'aligned', 'var = until',  'test', '      end'
+    end
+
+    context 'when AlignWith is variable' do
+      let(:cop_config) { { 'AlignWith' => 'variable' } }
+
+      include_examples 'aligned', 'var = if',     'test', 'end'
+      include_examples 'aligned', 'var = unless', 'test', 'end'
+      include_examples 'aligned', 'var = while',  'test', 'end'
+      include_examples 'aligned', 'var = until',  'test', 'end'
+      include_examples 'aligned', 'var = until',  'test', 'end.abc.join("")'
+      include_examples 'aligned', 'var = until',  'test', 'end.abc.tap {}'
+
+      include_examples 'misaligned', 'var = if',     'test', '      end'
+      include_examples 'misaligned', 'var = unless', 'test', '      end'
+      include_examples 'misaligned', 'var = while',  'test', '      end'
+      include_examples 'misaligned', 'var = until',  'test', '      end'
+      include_examples 'misaligned', 'var = until',  'test', '      end.join'
+
+      include_examples 'aligned', '@var = if',  'test', 'end'
+      include_examples 'aligned', '$var = if',  'test', 'end'
+      include_examples 'aligned', 'CNST = if',  'test', 'end'
+      include_examples 'aligned', 'var ||= if', 'test', 'end'
+      include_examples 'aligned', 'var &&= if', 'test', 'end'
+      include_examples 'aligned', 'var += if',  'test', 'end'
+    end
   end
 end

data/spec/rubocop/cop/lint/syntax_spec.rb

@@ -5,9 +5,10 @@ require 'spec_helper'
 describe Rubocop::Cop::Lint::Syntax do
   describe '.offences_from_diagnostic' do
     subject(:offence) { described_class.offence_from_diagnostic(diagnostic) }
-    let(:diagnostic) { Parser::Diagnostic.new(level, message, location) }
+    let(:diagnostic) { Parser::Diagnostic.new(level, reason, args, location) }
     let(:level) { :warning }
-    let(:message) { 'This is a message' }
+    let(:reason) { :odd_hash }
+    let(:args) { [] }
     let(:location) { double('location').as_null_object }
 
     it 'returns an offence' do
@@ -19,7 +20,7 @@ describe Rubocop::Cop::Lint::Syntax do
     end
 
     it "sets diagnostic's message to offence's message" do
-      expect(offence.message).to eq(message)
+      expect(offence.message).to eq('odd number of entries for a hash')
     end
 
     it "sets diagnostic's location to offence's location" do

data/spec/rubocop/cop/rails/default_scope_spec.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Rails::DefaultScope do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for default scope with a lambda arg' do
+    inspect_source(cop,
+                   ['default_scope -> { something }'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for default scope with a proc arg' do
+    inspect_source(cop,
+                   ['default_scope proc { something }'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'registers an offence for default scope with a proc(Proc.new) arg' do
+    inspect_source(cop,
+                   ['default_scope Proc.new { something }'])
+    expect(cop.offences.size).to eq(1)
+  end
+
+  it 'accepts a block arg' do
+    inspect_source(cop,
+                   ['default_scope { something }'])
+    expect(cop.offences).to be_empty
+  end
+end

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

@@ -19,19 +19,53 @@ describe Rubocop::Cop::Style::AccessModifierIndentation, :config do
       expect(cop.offences.size).to eq(1)
       expect(cop.messages)
         .to eq(['Indent access modifiers like private.'])
+      expect(cop.config_to_allow_offences).to eq('EnforcedStyle' => 'outdent')
     end
 
     it 'registers an offence for misaligned private in module' do
       inspect_source(cop,
                      ['module Test',
+                      '',
+                      ' private',
+                      '',
+                      '  def test; end',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages).to eq(['Indent access modifiers like private.'])
+      # Not aligned according to `indent` or `outdent` style:
+      expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+    end
+
+    it 'registers an offence for correct + opposite alignment' do
+      inspect_source(cop,
+                     ['module Test',
+                      '',
+                      '  public',
                       '',
                       'private',
                       '',
                       '  def test; end',
                       'end'])
       expect(cop.offences.size).to eq(1)
-      expect(cop.messages)
-        .to eq(['Indent access modifiers like private.'])
+      expect(cop.messages).to eq(['Indent access modifiers like private.'])
+      # No EnforcedStyle can allow both aligments:
+      expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+    end
+
+    it 'registers an offence for opposite + correct alignment' do
+      inspect_source(cop,
+                     ['module Test',
+                      '',
+                      'public',
+                      '',
+                      '  private',
+                      '',
+                      '  def test; end',
+                      'end'])
+      expect(cop.offences.size).to eq(1)
+      expect(cop.messages).to eq(['Indent access modifiers like public.'])
+      # No EnforcedStyle can allow both aligments:
+      expect(cop.config_to_allow_offences).to eq('Enabled' => false)
     end
 
     it 'registers an offence for misaligned private in singleton class' do
@@ -146,6 +180,7 @@ describe Rubocop::Cop::Style::AccessModifierIndentation, :config do
                       'end'])
       expect(cop.offences.size).to eq(1)
       expect(cop.messages).to eq([indent_msg])
+      expect(cop.config_to_allow_offences).to eq('EnforcedStyle' => 'indent')
     end
 
     it 'registers offence for private indented to method depth in a module' do

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

@@ -0,0 +1,81 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Rubocop::Cop::Style::AccessorMethodName do
+  subject(:cop) { described_class.new }
+
+  it 'registers an offence for method get_... with no args' do
+    inspect_source(cop, ['def get_attr',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.highlights).to eq(['get_attr'])
+  end
+
+  it 'registers an offence for singleton method get_... with no args' do
+    inspect_source(cop, ['def self.get_attr',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.highlights).to eq(['get_attr'])
+  end
+
+  it 'accepts method get_something with args' do
+    inspect_source(cop, ['def get_something(arg)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts singleton method get_something with args' do
+    inspect_source(cop, ['def self.get_something(arg)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'registers an offence for method set_something with one arg' do
+    inspect_source(cop, ['def set_attr(arg)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.highlights).to eq(['set_attr'])
+  end
+
+  it 'registers an offence for singleton method set_... with one args' do
+    inspect_source(cop, ['def self.set_attr(arg)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences.size).to eq(1)
+    expect(cop.highlights).to eq(['set_attr'])
+  end
+
+  it 'accepts method set_something with no args' do
+    inspect_source(cop, ['def set_something',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts singleton method set_something with no args' do
+    inspect_source(cop, ['def self.set_something',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts method set_something with two args' do
+    inspect_source(cop, ['def set_something(arg1, arg2)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+
+  it 'accepts singleton method set_something with two args' do
+    inspect_source(cop, ['def self.get_something(arg1, arg2)',
+                         '  # ...',
+                         'end'])
+    expect(cop.offences).to be_empty
+  end
+end

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

@@ -13,6 +13,11 @@ describe Rubocop::Cop::Style::Alias do
       .to eq(['Use alias_method instead of alias.'])
   end
 
+  it 'autocorrects alias with symbol args' do
+    corrected = autocorrect_source(cop, ['alias :ala :bala'])
+    expect(corrected).to eq 'alias_method :ala, :bala'
+  end
+
   it 'registers an offence for alias with bareword args' do
     inspect_source(cop,
                    ['alias ala bala'])
@@ -21,6 +26,11 @@ describe Rubocop::Cop::Style::Alias do
       .to eq(['Use alias_method instead of alias.'])
   end
 
+  it 'autocorrects alias with bareword args' do
+    corrected = autocorrect_source(cop, ['alias ala bala'])
+    expect(corrected).to eq 'alias_method :ala, :bala'
+  end
+
   it 'does not register an offence for alias_method' do
     inspect_source(cop,
                    ['alias_method :ala, :bala'])

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

@@ -38,7 +38,7 @@ describe Rubocop::Cop::Style::AlignParameters do
   end
 
   it "doesn't get confused by a symbol argument" do
-    inspect_source(cop, ['add_offence(:convention, index,',
+    inspect_source(cop, ['add_offence(index,',
                          '            MSG % kind)'])
     expect(cop.offences).to be_empty
   end
@@ -68,13 +68,13 @@ describe Rubocop::Cop::Style::AlignParameters do
   end
 
   it 'can handle a correctly aligned string literal as first argument' do
-    inspect_source(cop, ['add_offence(:convention, x,',
+    inspect_source(cop, ['add_offence(x,',
                          '            a)'])
     expect(cop.offences).to be_empty
   end
 
   it 'can handle a string literal as other argument' do
-    inspect_source(cop, ['add_offence(:convention,',
+    inspect_source(cop, ['add_offence(',
                          '            "", a)'])
     expect(cop.offences).to be_empty
   end

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

@@ -144,10 +144,13 @@ describe Rubocop::Cop::Style::BlockNesting, :config do
     expect_nesting_offences(source, [])
   end
 
-  def expect_nesting_offences(source, lines)
+  def expect_nesting_offences(source, lines, used_nesting_level = 3)
     inspect_source(cop, source)
     expect(cop.offences.map(&:line)).to eq(lines)
     expect(cop.messages).to eq(
       ['Avoid more than 2 levels of block nesting.'] * lines.length)
+    if cop.offences.size > 0
+      expect(cop.config_to_allow_offences['Max']).to eq(used_nesting_level)
+    end
   end
 end

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

@@ -80,6 +80,25 @@ describe Rubocop::Cop::Style::BracesAroundHashParameters, :config do
           'Redundant curly braces around a hash parameter.'
         ])
         expect(cop.highlights).to eq(['{ y: 2 }'])
+        expect(cop.config_to_allow_offences).to eq('EnforcedStyle' => 'braces')
+      end
+
+      it 'correct + opposite style' do
+        inspect_source(cop, ['where(1, y: 2)',
+                             'where(1, { y: 2 })'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'opposite + correct style' do
+        inspect_source(cop, ['where(1, { y: 2 })',
+                             'where(1, y: 2)'])
+        expect(cop.messages).to eq([
+          'Redundant curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
       end
 
       it 'one object method hash parameter with braces' do
@@ -114,6 +133,33 @@ describe Rubocop::Cop::Style::BracesAroundHashParameters, :config do
         expect(cop.highlights).to eq(['{ x: 1, foo: "bar" }'])
       end
     end
+
+    describe 'auto-corrects' do
+      it 'one non-hash parameter followed by a hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['where(1, { y: 2 })'])
+        expect(corrected).to eq 'where(1,  y: 2 )'
+      end
+
+      it 'one object method hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['x.func({ y: "z" })'])
+        expect(corrected).to eq 'x.func( y: "z" )'
+      end
+
+      it 'one hash parameter with braces' do
+        corrected = autocorrect_source(cop, ['where({ x: 1 })'])
+        expect(corrected).to eq 'where( x: 1 )'
+      end
+
+      it 'one hash parameter with braces and separators' do
+        corrected = autocorrect_source(cop, ["where(  \n { x: 1 }   )"])
+        expect(corrected).to eq "where(  \n  x: 1    )"
+      end
+
+      it 'one hash parameter with braces and multiple keys' do
+        corrected = autocorrect_source(cop, ['where({ x: 1, foo: "bar" })'])
+        expect(corrected).to eq 'where( x: 1, foo: "bar" )'
+      end
+    end
   end
 
   context 'braces' do
@@ -174,6 +220,26 @@ describe Rubocop::Cop::Style::BracesAroundHashParameters, :config do
           'Missing curly braces around a hash parameter.'
         ])
         expect(cop.highlights).to eq(['x: "y"'])
+        expect(cop.config_to_allow_offences).to eq('EnforcedStyle' =>
+                                                   'no_braces')
+      end
+
+      it 'opposite + correct style' do
+        inspect_source(cop, ['where(y: 2)',
+                             'where({ y: 2 })'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
+      end
+
+      it 'correct + opposite style' do
+        inspect_source(cop, ['where({ y: 2 })',
+                             'where(y: 2)'])
+        expect(cop.messages).to eq([
+          'Missing curly braces around a hash parameter.'
+        ])
+        expect(cop.config_to_allow_offences).to eq('Enabled' => false)
       end
 
       it 'one hash parameter with multiple keys and without braces' do
@@ -192,5 +258,22 @@ describe Rubocop::Cop::Style::BracesAroundHashParameters, :config do
         expect(cop.highlights).to eq(['x: { "y" => "z" }'])
       end
     end
+
+    describe 'auto-corrects' do
+      it 'one hash parameter without braces' do
+        corrected = autocorrect_source(cop, ['where(x: "y")'])
+        expect(corrected).to eq 'where({x: "y"})'
+      end
+
+      it 'one hash parameter with multiple keys and without braces' do
+        corrected = autocorrect_source(cop, ['where(x: "y", foo: "bar")'])
+        expect(corrected).to eq 'where({x: "y", foo: "bar"})'
+      end
+
+      it 'one hash parameter without braces with one hash value' do
+        corrected = autocorrect_source(cop, ['where(x: { "y" => "z" })'])
+        expect(corrected).to eq 'where({x: { "y" => "z" }})'
+      end
+    end
   end
 end