rubocop 0.23.0 → 0.24.0

data/spec/rubocop/cli_spec.rb

@@ -559,6 +559,7 @@ describe RuboCop::CLI, :isolated_environment do
         expect(cli.run(['--auto-gen-config'])).to eq(1)
         expect(IO.readlines('.rubocop_todo.yml')[7..-1].map(&:chomp))
           .to eq(['# Offense count: 1',
+                  '# Configuration parameters: AllowURI.',
                   'Style/LineLength:',
                   '  Max: 85',
                   '',
@@ -635,6 +636,7 @@ describe RuboCop::CLI, :isolated_environment do
            '  Enabled: false',
            '',
            '# Offense count: 2',
+           '# Configuration parameters: AllowURI.',
            'Style/LineLength:',
            '  Max: 90',
            '',
@@ -977,13 +979,13 @@ describe RuboCop::CLI, :isolated_environment do
             current = types.delete(slice.shift[/Type '(?<c>[^'']+)'/, 'c'])
             # all cops in their type listing
             cops.with_type(current).each do |cop|
-              expect(slice.any? { |l| l.include? cop.cop_name }).to be_true
+              expect(slice.any? { |l| l.include? cop.cop_name }).to be_truthy
             end
 
             # no cop in wrong type listing
             types.each do |type|
               cops.with_type(type).each do |cop|
-                expect(slice.any? { |l| l.include? cop.cop_name }).to be_false
+                expect(slice.any? { |l| l.include? cop.cop_name }).to be_falsey
               end
             end
           end
@@ -1271,22 +1273,19 @@ describe RuboCop::CLI, :isolated_environment do
     end
   end
 
-  describe '#wants_to_quit?' do
-    it 'is initially false' do
-      expect(cli.wants_to_quit?).to be_false
-    end
-
-    context 'when true' do
-      it 'returns 1' do
-        create_file('example.rb', '# encoding: utf-8')
-        cli.wants_to_quit = true
-        expect(cli.run(['example.rb'])).to eq(1)
-      end
+  context 'when interrupted' do
+    it 'returns 1' do
+      allow_any_instance_of(RuboCop::Runner)
+        .to receive(:aborting?).and_return(true)
+      create_file('example.rb', '# encoding: utf-8')
+      expect(cli.run(['example.rb'])).to eq(1)
     end
   end
 
   describe '#trap_interrupt' do
+    let(:runner) { RuboCop::Runner.new({}, RuboCop::ConfigStore.new) }
     let(:interrupt_handlers) { [] }
+
     before do
       allow(Signal).to receive(:trap).with('INT') do |&block|
         interrupt_handlers << block
@@ -1299,30 +1298,29 @@ describe RuboCop::CLI, :isolated_environment do
 
     it 'adds a handler for SIGINT' do
       expect(interrupt_handlers).to be_empty
-      cli.trap_interrupt
+      cli.trap_interrupt(runner)
       expect(interrupt_handlers.size).to eq(1)
     end
 
     context 'with SIGINT once' do
-      it 'sets #wants_to_quit? to true' do
-        cli.trap_interrupt
-        expect(cli.wants_to_quit?).to be_false
+      it 'aborts processing' do
+        cli.trap_interrupt(runner)
+        expect(runner).to receive(:abort)
         interrupt
-        expect(cli.wants_to_quit?).to be_true
       end
 
       it 'does not exit immediately' do
+        cli.trap_interrupt(runner)
         expect_any_instance_of(Object).not_to receive(:exit)
         expect_any_instance_of(Object).not_to receive(:exit!)
-        cli.trap_interrupt
         interrupt
       end
     end
 
     context 'with SIGINT twice' do
       it 'exits immediately' do
+        cli.trap_interrupt(runner)
         expect_any_instance_of(Object).to receive(:exit!).with(1)
-        cli.trap_interrupt
         interrupt
         interrupt
       end
@@ -1387,6 +1385,23 @@ describe RuboCop::CLI, :isolated_environment do
               ''].join("\n"))
   end
 
+  context 'when errors are raised while processing files due to bugs' do
+    let(:errors) do
+      ['An error occurred while Encoding cop was inspecting file.rb.']
+    end
+
+    before do
+      allow_any_instance_of(RuboCop::Runner)
+        .to receive(:errors).and_return(errors)
+    end
+
+    it 'displays an error message to stderr' do
+      cli.run([])
+      expect($stderr.string)
+        .to include('1 error occurred:').and include(errors.first)
+    end
+  end
+
   describe 'rubocop:disable comment' do
     it 'can disable all cops in a code section' do
       create_file('example.rb',
@@ -1796,8 +1811,10 @@ describe RuboCop::CLI, :isolated_environment do
         .to eq(['== example1.rb ==',
                 'C:  2:  6: %w-literals should be delimited by [ and ]',
                 'C:  3:  6: %q-literals should be delimited by ( and )',
+                'C:  3:  6: Use %q only for strings that contain both single ' \
+                'quotes and double quotes.',
                 '',
-                '1 file inspected, 2 offenses detected',
+                '1 file inspected, 3 offenses detected',
                 ''].join("\n"))
     end
 

data/spec/rubocop/config_loader_spec.rb

@@ -192,7 +192,8 @@ describe RuboCop::ConfigLoader do
                    'Description' =>
                    default_config['Style/LineLength']['Description'],
                    'Enabled' => true,
-                   'Max' => 77
+                   'Max' => 77,
+                   'AllowURI' => true
                  },
                  'Style/MethodLength' => {
                    'Description' =>
@@ -292,7 +293,7 @@ describe RuboCop::ConfigLoader do
 
     context 'when no config file exists for the target file' do
       it 'is disabled' do
-        expect(config.cop_enabled?('Style/SymbolArray')).to be_false
+        expect(config.cop_enabled?('Style/SymbolArray')).to be_falsey
       end
     end
 
@@ -302,7 +303,7 @@ describe RuboCop::ConfigLoader do
           'Style/LineLength:',
           '  Max: 80'
         ])
-        expect(config.cop_enabled?('Style/SymbolArray')).to be_false
+        expect(config.cop_enabled?('Style/SymbolArray')).to be_falsey
       end
     end
 
@@ -312,7 +313,7 @@ describe RuboCop::ConfigLoader do
           'Style/SymbolArray:',
           '  Enabled: true'
         ])
-        expect(config.cop_enabled?('Style/SymbolArray')).to be_true
+        expect(config.cop_enabled?('Style/SymbolArray')).to be_truthy
       end
     end
   end
@@ -323,7 +324,7 @@ describe RuboCop::ConfigLoader do
         default_config = described_class.default_configuration
         symbol_name_config =
           default_config.for_cop('Lint/AssignmentInCondition')
-        expect(symbol_name_config['AllowSafeAssignment']).to be_true
+        expect(symbol_name_config['AllowSafeAssignment']).to be_truthy
       end
     end
   end
@@ -339,7 +340,7 @@ describe RuboCop::ConfigLoader do
     it 'requires the passed path' do
       config_path = described_class.configuration_file_for('.')
       described_class.configuration_from_file(config_path)
-      expect(defined?(MyClass)).to be_true
+      expect(defined?(MyClass)).to be_truthy
     end
   end
 end

data/spec/rubocop/config_spec.rb

@@ -88,14 +88,14 @@ describe RuboCop::Config do
     context 'when the passed path matches any of patterns to include' do
       it 'returns true' do
         file_path = '/home/foo/project/Gemfile'
-        expect(configuration.file_to_include?(file_path)).to be_true
+        expect(configuration.file_to_include?(file_path)).to be_truthy
       end
     end
 
     context 'when the passed path does not match any of patterns to include' do
       it 'returns false' do
         file_path = '/home/foo/project/Gemfile.lock'
-        expect(configuration.file_to_include?(file_path)).to be_false
+        expect(configuration.file_to_include?(file_path)).to be_falsey
       end
     end
   end
@@ -120,22 +120,22 @@ describe RuboCop::Config do
     context 'when the passed path matches any of patterns to exclude' do
       it 'returns true' do
         file_path = "#{Dir.pwd}/log/foo.rb"
-        expect(configuration.file_to_exclude?(file_path)).to be_true
+        expect(configuration.file_to_exclude?(file_path)).to be_truthy
 
-        expect(configuration.file_to_exclude?('log/foo.rb')).to be_true
+        expect(configuration.file_to_exclude?('log/foo.rb')).to be_truthy
 
-        expect(configuration.file_to_exclude?('bar.rb')).to be_true
+        expect(configuration.file_to_exclude?('bar.rb')).to be_truthy
       end
     end
 
     context 'when the passed path does not match any of patterns to exclude' do
       it 'returns false' do
         file_path = "#{Dir.pwd}/log_file.rb"
-        expect(configuration.file_to_exclude?(file_path)).to be_false
+        expect(configuration.file_to_exclude?(file_path)).to be_falsey
 
-        expect(configuration.file_to_exclude?('app/controller.rb')).to be_false
+        expect(configuration.file_to_exclude?('app/controller.rb')).to be_falsey
 
-        expect(configuration.file_to_exclude?('baz.rb')).to be_false
+        expect(configuration.file_to_exclude?('baz.rb')).to be_falsey
       end
     end
   end

data/spec/rubocop/cop/cop_spec.rb

@@ -31,7 +31,7 @@ describe RuboCop::Cop::Cop do
     end
 
     it 'raises an error if the cop name is in more than one namespace' do
-      pending 'Example needs a cop with same name in two namespaces'
+      skip 'Example needs a cop with same name in two namespaces'
       expect { described_class.qualified_cop_name('ExampleCop', '--only') }
         .to raise_error(RuboCop::Cop::AmbiguousCopName)
     end

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

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Lint::DefEndAlignment, :config do
+  subject(:cop) { described_class.new(config) }
+  let(:opposite) do
+    cop_config['AlignWith'] == 'def' ? 'start_of_line' : 'def'
+  end
+
+  context 'when AlignWith is start_of_line' do
+    let(:cop_config) { { 'AlignWith' => 'start_of_line' } }
+
+    include_examples 'misaligned', '', 'def', 'test',      '  end'
+    include_examples 'misaligned', '', 'def', 'Test.test', '  end', 'defs'
+
+    include_examples 'aligned', 'def', 'test',      'end'
+    include_examples 'aligned', 'def', 'Test.test', 'end', 'defs'
+
+    context 'in ruby 2.1 or later' do
+      include_examples 'aligned', 'public def',          'test', 'end'
+      include_examples 'aligned', 'protected def',       'test', 'end'
+      include_examples 'aligned', 'private def',         'test', 'end'
+      include_examples 'aligned', 'module_function def', 'test', 'end'
+
+      include_examples('misaligned', '',
+                       'public def', 'test',
+                       '       end')
+      include_examples('misaligned', '',
+                       'protected def', 'test',
+                       '          end')
+      include_examples('misaligned', '',
+                       'private def', 'test',
+                       '        end')
+      include_examples('misaligned', '',
+                       'module_function def', 'test',
+                       '                end')
+    end
+
+    it 'registers an offense for correct + opposite' do
+      inspect_source(cop, ['private def a',
+                           '  a1',
+                           'end',
+                           '',
+                           'private def b',
+                           '          b1',
+                           '        end'])
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.messages.first)
+        .to eq('`end` at 7, 8 is not aligned with `private def` at 5, 8')
+      expect(cop.highlights.first).to eq('end')
+      expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+    end
+  end
+
+  context 'when AlignWith is def' do
+    let(:cop_config) { { 'AlignWith' => 'def' } }
+
+    include_examples 'misaligned', '', 'def', 'test',      '  end'
+    include_examples 'misaligned', '', 'def', 'Test.test', '  end', 'defs'
+
+    include_examples 'aligned', 'def', 'test',      'end'
+    include_examples 'aligned', 'def', 'Test.test', 'end', 'defs'
+
+    context 'in ruby 2.1 or later' do
+      include_examples('aligned',
+                       'public def',          'test',
+                       '       end')
+      include_examples('aligned',
+                       'protected def',       'test',
+                       '          end')
+      include_examples('aligned',
+                       'private def', 'test',
+                       '        end')
+      include_examples('aligned',
+                       'module_function def', 'test',
+                       '                end')
+
+      include_examples('misaligned',
+                       'public ', 'def', 'test',
+                       'end')
+      include_examples('misaligned',
+                       'protected ', 'def', 'test',
+                       'end')
+      include_examples('misaligned',
+                       'private ', 'def', 'test',
+                       'end')
+      include_examples('misaligned',
+                       'module_function ', 'def', 'test',
+                       'end')
+
+      it 'registers an offense for correct + opposite' do
+        inspect_source(cop, ['private def a',
+                             '  a1',
+                             'end',
+                             '',
+                             'private def b',
+                             '          b1',
+                             '        end'])
+        expect(cop.offenses.size).to eq(1)
+        expect(cop.messages.first)
+          .to eq('`end` at 3, 0 is not aligned with `def` at 1, 8')
+        expect(cop.highlights.first).to eq('end')
+        expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
+      end
+    end
+  end
+end

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

@@ -9,33 +9,8 @@ describe RuboCop::Cop::Lint::EndAlignment, :config do
     cop_config['AlignWith'] == 'keyword' ? 'variable' : 'keyword'
   end
 
-  shared_examples 'misaligned' do |prefix, alignment_base, arg, end_kw, name|
-    name ||= alignment_base
-    it "registers an offense for mismatched #{name} ... end" do
-      inspect_source(cop, ["#{prefix}#{alignment_base} #{arg}",
-                           end_kw])
-      expect(cop.offenses.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')
-      expect(cop.config_to_allow_offenses).to eq('AlignWith' => opposite)
-    end
-  end
-
-  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.offenses).to be_empty
-    end
-  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'
@@ -43,33 +18,11 @@ describe RuboCop::Cop::Lint::EndAlignment, :config do
 
   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'
 
-  context 'in ruby 2.1 or later' do
-    include_examples 'aligned', 'public def',          'test', 'end'
-    include_examples 'aligned', 'protected def',       'test', 'end'
-    include_examples 'aligned', 'private def',         'test', 'end'
-    include_examples 'aligned', 'module_function def', 'test', 'end'
-
-    include_examples('misaligned', '',
-                     'public def', 'test',
-                     '       end')
-    include_examples('misaligned', '',
-                     'protected def', 'test',
-                     '          end')
-    include_examples('misaligned', '',
-                     'private def', 'test',
-                     '        end')
-    include_examples('misaligned', '',
-                     'module_function def', 'test',
-                     '                end')
-  end
-
   it 'can handle ternary if' do
     inspect_source(cop, 'a = cond ? x : y')
     expect(cop.offenses).to be_empty

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

@@ -20,15 +20,14 @@ describe RuboCop::Cop::Lint::InvalidCharacterLiteral do
     let(:source) { 'p(? )' }
 
     it 'registers an offense' do
-      pending 'Is there a way to emit this warning without syntax errors?' do
+      pending 'Is there a way to emit this warning without syntax errors?'
 
-        inspect_source(cop, source)
+      inspect_source(cop, source)
 
-        expect(cop.offenses.size).to eq(1)
-        expect(cop.offenses.first.message)
-        .to eq('Invalid character literal; use ?\s')
-        expect(cop.highlights).to eq([' '])
-      end
+      expect(cop.offenses.size).to eq(1)
+      expect(cop.offenses.first.message)
+      .to eq('Invalid character literal; use ?\s')
+      expect(cop.highlights).to eq([' '])
     end
   end
 end

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

@@ -72,6 +72,25 @@ describe RuboCop::Cop::Lint::UnusedBlockArgument do
       end
     end
 
+    context 'when a block have a block local variable' do
+      context 'and the variable is unused' do
+        let(:source) { <<-END }
+          1.times do |index; block_local_variable|
+            puts index
+          end
+        END
+
+        it 'registers an offense' do
+          expect(cop.offenses.size).to eq(1)
+          expect(cop.offenses.first.message).to eq(
+            'Unused block local variable - `block_local_variable`.'
+          )
+          expect(cop.offenses.first.line).to eq(1)
+          expect(cop.highlights).to eq(['block_local_variable'])
+        end
+      end
+    end
+
     context 'when a lambda block takes arguments' do
       context 'and all the arguments are unused' do
         let(:source) { <<-END }