rubocop 0.12.0 → 0.13.0

data/spec/rubocop/cop/cop_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 module Rubocop
   module Cop
     describe Cop do
-      let(:cop) { Cop.new }
+      subject(:cop) { Cop.new }
       let(:location) do
         source_buffer = Parser::Source::Buffer.new('test', 1)
         source_buffer.source = "a\n"
@@ -17,39 +17,21 @@ module Rubocop
       end
 
       it 'keeps track of offences' do
-        cop.add_offence(:convention, location, 'message')
+        cop.convention(nil, location, 'message')
 
         expect(cop.offences.size).to eq(1)
       end
 
       it 'will report registered offences' do
-        cop.add_offence(:convention, location, 'message')
+        cop.convention(nil, location, 'message')
 
         expect(cop.offences).not_to be_empty
       end
 
       it 'registers offence with its name' do
-        cop = Style::AvoidFor.new
-        cop.add_offence(:convention, location, 'message')
-        expect(cop.offences.first.cop_name).to eq('AvoidFor')
-      end
-
-      describe 'description' do
-        let(:short_desc) { 'abc' }
-        let(:long_desc) { short_desc + "\n" + short_desc + 'def' }
-        before { Cop.config['Description'] = long_desc }
-        context '#full_description' do
-          it 'contains whole text' do
-            expect(Cop.full_description).to eq(long_desc)
-            expect(Cop.full_description.lines.to_a.size).to be > 1
-          end
-        end
-        context '#short_description' do
-          it 'contains first line' do
-            expect(Cop.short_description).to eq(short_desc)
-            expect(Cop.short_description.lines.to_a.size).to eq(1)
-          end
-        end
+        cop = Style::For.new
+        cop.convention(nil, location, 'message')
+        expect(cop.offences.first.cop_name).to eq('For')
       end
 
       context 'with no submodule' do
@@ -59,8 +41,8 @@ module Rubocop
       end
 
       context 'with style cops' do
-        subject(:cop) { Style::AvoidFor }
-        it('has right name') { expect(cop.cop_name).to eq('AvoidFor') }
+        subject(:cop) { Style::For }
+        it('has right name') { expect(cop.cop_name).to eq('For') }
         it('has right type') { expect(cop.cop_type).to eq(:style) }
       end
 

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

@@ -5,11 +5,9 @@ require 'spec_helper'
 module Rubocop
   module Cop
     module Lint
-      describe AssignmentInCondition do
-        let(:cop) { AssignmentInCondition.new }
-        before do
-          AssignmentInCondition.config = { 'AllowSafeAssignment' => true }
-        end
+      describe AssignmentInCondition, :config do
+        subject(:cop) { AssignmentInCondition.new(config) }
+        let(:cop_config) { { 'AllowSafeAssignment' => true } }
 
         it 'registers an offence for lvar assignment in condition' do
           inspect_source(cop,
@@ -99,14 +97,12 @@ module Rubocop
         end
 
         context 'safe assignment is not allowed' do
-          before do
-            AssignmentInCondition.config['AllowSafeAssignment'] = false
-          end
+          let(:cop_config) { { 'AllowSafeAssignment' => false } }
 
           it 'does not accepts = in condition surrounded with braces' do
             inspect_source(cop,
                            ['if (test = 10)',
-                           'end'
+                            'end'
                            ])
             expect(cop.offences.size).to eq(1)
           end

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

@@ -7,14 +7,15 @@ module Rubocop
   module Cop
     module Lint
       describe BlockAlignment do
-        let(:cop) { BlockAlignment.new }
+        subject(:cop) { BlockAlignment.new }
 
         it 'registers an offence for mismatched block end' do
           inspect_source(cop,
                          ['test do |ala|',
                           '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with test do |ala| at 1, 0'])
         end
 
         context 'when the block is a logical operand' do
@@ -33,7 +34,7 @@ module Rubocop
         it 'accepts end aligned with a variable' do
           inspect_source(cop,
                          ['variable = test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -44,7 +45,8 @@ module Rubocop
                            ['a = b = c = test do |ala|',
                             '    end'
                            ])
-            expect(cop.offences.size).to eq(1)
+            expect(cop.messages)
+              .to eq(['end at 2, 4 is not aligned with a = b = c = test do |ala| at 1, 0'])
           end
 
           it 'accepts end aligned with the first variable' do
@@ -60,8 +62,8 @@ module Rubocop
           it 'accepts end aligned with a variable' do
             inspect_source(cop,
                            ['b = 1 + preceding_line.reduce(0) do |a, e|',
-                           '  a + e.length + newline_length',
-                           'end + 1'
+                            '  a + e.length + newline_length',
+                            'end + 1'
                            ])
             expect(cop.offences).to be_empty
           end
@@ -70,9 +72,10 @@ module Rubocop
         it 'registers an offence for mismatched block end with a variable' do
           inspect_source(cop,
                          ['variable = test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with variable = test do |ala| at 1, 0'])
         end
 
         context 'when the block is defined on the next line' do
@@ -93,12 +96,15 @@ module Rubocop
                             '    v.foo',
                             'end'
                            ])
-            expect(cop.offences.size).to eq(1)
+            expect(cop.messages)
+              .to eq(['end at 4, 0 is not aligned with a_long_method_that_dont_fit_on_the_line ' +
+                      'do |v| at 2, 2'])
           end
         end
 
         context 'when the method part is a call chain that spans several lines' do
-          it 'registers offences for pretty multiline chaining' do
+          # Example from issue 346 of bbatsov/rubocop on github:
+          it 'accepts pretty alignment style' do
             src = ['def foo(bar)',
                    '  bar.get_stuffs',
                    '      .reject do |stuff| ',
@@ -111,16 +117,13 @@ module Rubocop
                    '      end',
                    'end']
             inspect_source(cop, src)
-            expect(cop.offences.map(&:message))
-              .to eq(['end at 10, 6 is not aligned with bar.get_stuffs at 2, 2',
-                      'end at 7, 6 is not aligned with bar.get_stuffs at 2, 2',
-                      'end at 5, 6 is not aligned with bar.get_stuffs at 2, 2'])
+            expect(cop.offences).to be_empty
           end
 
           it 'registers offences for misaligned ends' do
             src = ['def foo(bar)',
                    '  bar.get_stuffs',
-                   '      .reject do |stuff| ',
+                   '      .reject do |stuff|',
                    '        stuff.with_a_very_long_expression_that_doesnt_fit_the_line',
                    '        end.select do |stuff|',
                    '        stuff.another_very_long_expression_that_doesnt_fit_the_line',
@@ -130,17 +133,49 @@ module Rubocop
                    '        end',
                    'end']
             inspect_source(cop, src)
-            expect(cop.offences.size).to eq(3)
+            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',
+                      '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
 
+          # Example from issue 393 of bbatsov/rubocop on github:
           it 'accepts end indented as the start of the block' do
             src = ['my_object.chaining_this_very_long_method(with_a_parameter)',
                    '    .and_one_with_a_block do',
                    '  do_something',
+                   'end',
+                   '', # Other variant:
+                   'my_object.chaining_this_very_long_method(',
+                   '    with_a_parameter).and_one_with_a_block do',
+                   '  do_something',
                    'end']
             inspect_source(cop, src)
             expect(cop.offences).to be_empty
           end
+
+          # Example from issue 447 of bbatsov/rubocop on github:
+          it 'accepts two kinds of end alignment' do
+            src = [
+                   # Aligned with start of line where do is:
+                   'params = default_options.merge(options)',
+                   '          .delete_if { |k, v| v.nil? }',
+                   '          .each_with_object({}) do |(k, v), new_hash|',
+                   '            new_hash[k.to_s] = v.to_s',
+                   '          end',
+                   # Aligned with start of the whole expression:
+                   'params = default_options.merge(options)',
+                   '          .delete_if { |k, v| v.nil? }',
+                   '          .each_with_object({}) do |(k, v), new_hash|',
+                   '            new_hash[k.to_s] = v.to_s',
+                   'end'
+                  ]
+            inspect_source(cop, src)
+            expect(cop.offences).to be_empty
+          end
         end
 
         context 'when variables of a mass assignment spans several lines' do
@@ -150,7 +185,7 @@ module Rubocop
                    '  i - 5',
                    'end']
             inspect_source(cop, src)
-            expect(cop.offences.map(&:message)).to eq([])
+            expect(cop.offences).to be_empty
           end
 
           it 'registers an offence for end aligned with the block' do
@@ -159,14 +194,15 @@ module Rubocop
                    '  i - 5',
                    '    end']
             inspect_source(cop, src)
-            expect(cop.offences.size).to eq(1)
+            expect(cop.messages)
+              .to eq(['end at 4, 4 is not aligned with e, at 1, 0 or f = [5, 6].map do |i| at 2, 0'])
           end
         end
 
         it 'accepts end aligned with an instance variable' do
           inspect_source(cop,
                          ['@variable = test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -174,15 +210,16 @@ module Rubocop
         it 'registers an offence for mismatched block end with an instance variable' do
           inspect_source(cop,
                          ['@variable = test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with @variable = test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with a class variable' do
           inspect_source(cop,
                          ['@@variable = test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -190,15 +227,16 @@ module Rubocop
         it 'registers an offence for mismatched block end with a class variable' do
           inspect_source(cop,
                          ['@@variable = test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with @@variable = test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with a global variable' do
           inspect_source(cop,
                          ['$variable = test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -206,15 +244,16 @@ module Rubocop
         it 'registers an offence for mismatched block end with a global variable' do
           inspect_source(cop,
                          ['$variable = test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with $variable = test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with a constant' do
           inspect_source(cop,
                          ['CONSTANT = test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -222,16 +261,17 @@ module Rubocop
         it 'registers an offence for mismatched block end with a constant' do
           inspect_source(cop,
                          ['Module::CONSTANT = test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with Module::CONSTANT = test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with a method call' do
           inspect_source(cop,
                          ['parser.childs << lambda do |token|',
-                         '  token << 1',
-                         'end'
+                          '  token << 1',
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -239,17 +279,18 @@ module Rubocop
         it 'registers an offence for mismatched block end with a method call' do
           inspect_source(cop,
                          ['parser.childs << lambda do |token|',
-                         '  token << 1',
-                         '  end'
+                          '  token << 1',
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 3, 2 is not aligned with parser.childs << lambda do |token| at 1, 0'])
         end
 
         it 'accepts end aligned with a method call with arguments' do
           inspect_source(cop,
                          ['@h[:f] = f.each_pair.map do |f, v|',
-                         '  v = 1',
-                         'end'
+                          '  v = 1',
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -257,10 +298,11 @@ module Rubocop
         it 'registers an offence for mismatched end with a method call with arguments' do
           inspect_source(cop,
                          ['@h[:f] = f.each_pair.map do |f, v|',
-                         '  v = 1',
-                         '  end'
+                          '  v = 1',
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 3, 2 is not aligned with @h[:f] = f.each_pair.map do |f, v| at 1, 0'])
         end
 
         it 'does not raise an error for nested block in a method call' do
@@ -285,14 +327,16 @@ module Rubocop
                           '  o.valid?',
                           '  end)'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 3, 2 is not aligned with arr.all? do |o| at 1, 7 or ' +
+                    'expect(arr.all? do |o| at 1, 0'])
         end
 
         it 'accepts end aligned with an op-asgn (+=, -=)' do
           inspect_source(cop,
                          ['rb += files.select do |file|',
-                         '  file << something',
-                         'end'
+                          '  file << something',
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -300,16 +344,17 @@ module Rubocop
         it 'registers an offence for mismatched block end with an op-asgn (+=, -=)' do
           inspect_source(cop,
                          ['rb += files.select do |file|',
-                         '  file << something',
-                         '  end'
+                          '  file << something',
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 3, 2 is not aligned with rb at 1, 0'])
         end
 
         it 'accepts end aligned with an and-asgn (&&=)' do
           inspect_source(cop,
                          ['variable &&= test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -317,15 +362,16 @@ module Rubocop
         it 'registers an offence for mismatched block end with an and-asgn (&&=)' do
           inspect_source(cop,
                          ['variable &&= test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with variable &&= test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with an or-asgn (||=)' do
           inspect_source(cop,
                          ['variable ||= test do |ala|',
-                         'end'
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -333,16 +379,17 @@ module Rubocop
         it 'registers an offence for mismatched block end with an or-asgn (||=)' do
           inspect_source(cop,
                          ['variable ||= test do |ala|',
-                         '  end'
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 2, 2 is not aligned with variable ||= test do |ala| at 1, 0'])
         end
 
         it 'accepts end aligned with a mass assignment' do
           inspect_source(cop,
                          ['var1, var2 = lambda do |test|',
-                         '  [1, 2]',
-                         'end'
+                          '  [1, 2]',
+                          'end'
                          ])
           expect(cop.offences).to be_empty
         end
@@ -358,10 +405,11 @@ module Rubocop
         it 'registers an offence for mismatched block end with a mass assignment' do
           inspect_source(cop,
                          ['var1, var2 = lambda do |test|',
-                         '  [1, 2]',
-                         '  end'
+                          '  [1, 2]',
+                          '  end'
                          ])
-          expect(cop.offences.size).to eq(1)
+          expect(cop.messages)
+            .to eq(['end at 3, 2 is not aligned with var1, var2 at 1, 0'])
         end
       end
     end