rubocop 0.16.0 → 0.17.0

data/rubocop.gemspec

@@ -26,9 +26,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.8.23'
   s.summary = 'Automatic Ruby code style checking tool.'
 
-  s.add_runtime_dependency('rainbow', '>= 1.1.4')
-  s.add_runtime_dependency('parser', '~> 2.1')
+  s.add_runtime_dependency('rainbow', '~> 1.99.1')
+  s.add_runtime_dependency('parser', '~> 2.1.3')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
+  s.add_runtime_dependency('json', '~> 1.8')
   s.add_development_dependency('rake', '~> 10.1')
   s.add_development_dependency('rspec', '~> 2.14')
   s.add_development_dependency('yard', '~> 0.8')

data/spec/project_spec.rb

@@ -4,16 +4,21 @@ require 'spec_helper'
 
 describe 'RuboCop Project' do
   describe 'default configuration file' do
+    let(:cop_names) { Rubocop::Cop::Cop.all.map(&:cop_name) }
+
+    subject(:default_config) do
+      Rubocop::ConfigLoader.load_file('config/default.yml')
+    end
+
     it 'has configuration for all cops' do
-      cop_names = Rubocop::Cop::Cop.all.map(&:cop_name)
-      expect(Rubocop::ConfigLoader.load_file('config/default.yml').keys.sort)
-        .to eq((['AllCops'] + cop_names).sort)
+      expect(default_config.keys.sort).to eq((['AllCops'] + cop_names).sort)
     end
-    it 'has a description for all cops' do
-      cop_names = Rubocop::Cop::Cop.all.map(&:cop_name)
-      conf = Rubocop::ConfigLoader.load_file('config/default.yml')
+
+    it 'has a nicely formatted description for all cops' do
       cop_names.each do |name|
-        expect(conf[name]['Description']).not_to be_nil
+        description = default_config[name]['Description']
+        expect(description).not_to be_nil
+        expect(description).not_to include("\n")
       end
     end
   end

data/spec/rubocop/cli_spec.rb

@@ -47,6 +47,76 @@ describe Rubocop::CLI, :isolated_environment do
                   '  puts i',
                   'end'].join("\n") + "\n")
       end
+
+      # In this example, the auto-correction (changing "raise" to "fail")
+      # creates a new problem (alignment of parameters), which is also
+      # corrected automatically.
+      it 'can correct a problems and the problem it creates' do
+        create_file('example.rb',
+                    ['# encoding: utf-8',
+                     'raise NotImplementedError,',
+                     "      'Method should be overridden in child classes'"])
+        expect(cli.run(['--auto-correct'])).to eq(1)
+        expect(IO.read('example.rb'))
+          .to eq(['# encoding: utf-8',
+                  'fail NotImplementedError,',
+                  "     'Method should be overridden in child classes'"]
+                   .join("\n") + "\n")
+        expect($stdout.string)
+          .to eq(['Inspecting 1 file',
+                  'C',
+                  '',
+                  'Offences:',
+                  '',
+                  'example.rb:2:1: C: [Corrected] Use `fail` instead of ' +
+                  '`raise` to signal exceptions.',
+                  'raise NotImplementedError,',
+                  '^^^^^',
+                  'example.rb:3:7: C: [Corrected] Align the parameters of a ' +
+                  'method call if they span more than one line.',
+                  "      'Method should be overridden in child classes'",
+                  '      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^',
+                  '',
+                  '1 file inspected, 2 offences detected, 2 offences ' +
+                  'corrected',
+                  ''].join("\n"))
+      end
+
+      # Thanks to repeated auto-correction, we can get rid of the trailing
+      # spaces, and then the extra empty line.
+      it 'can correct two problems in the same place' do
+        create_file('example.rb',
+                    ['# encoding: utf-8',
+                     '# Example class.',
+                     'class Klass',
+                     '  ',
+                     '  def f',
+                     '  end',
+                     'end'])
+        expect(cli.run(['--auto-correct'])).to eq(1)
+        expect(IO.read('example.rb'))
+          .to eq(['# encoding: utf-8',
+                  '# Example class.',
+                  'class Klass',
+                  '  def f',
+                  '  end',
+                  'end'].join("\n") + "\n")
+        expect($stderr.string).to eq('')
+        expect($stdout.string)
+          .to eq(['Inspecting 1 file',
+                  'C',
+                  '',
+                  'Offences:',
+                  '',
+                  'example.rb:4:1: C: [Corrected] Trailing whitespace ' +
+                  'detected.',
+                  'example.rb:4:1: C: [Corrected] Extra empty line detected ' +
+                  'at body beginning.',
+                  '',
+                  '1 file inspected, 2 offences detected, 2 offences ' +
+                  'corrected',
+                  ''].join("\n"))
+      end
     end
 
     describe '--auto-gen-config' do
@@ -87,7 +157,7 @@ describe Rubocop::CLI, :isolated_environment do
 
       it 'can generate a todo list' do
         create_file('example1.rb', ['# encoding: utf-8',
-                                    'x= 0 ',
+                                    '$x= 0 ',
                                     '#' * 90,
                                     '#' * 85,
                                     'y ',
@@ -104,29 +174,49 @@ describe Rubocop::CLI, :isolated_environment do
                        'add inherit_from: rubocop-todo.yml in a ' +
                        '.rubocop.yml file.',
                        ''].join("\n"))
-        expect(IO.read('rubocop-todo.yml'))
-          .to eq(['# This configuration was generated by `rubocop' +
-                  ' --auto-gen-config`.',
-                  '# The point is for the user to remove these' +
-                  ' configuration records',
-                  '# one by one as the offences are removed from the code ' +
-                  'base.',
-                  '',
-                  'IndentationWidth:',
-                  '  Enabled: false',
-                  '',
-                  'LineLength:',
-                  '  Max: 90',
-                  '',
-                  'SpaceAroundOperators:',
-                  '  Enabled: false',
-                  '',
-                  'Tab:',
-                  '  Enabled: false',
-                  '',
-                  'TrailingWhitespace:',
-                  '  Enabled: false',
-                  ''].join("\n"))
+        expected =
+          ['# This configuration was generated by `rubocop --auto-gen-config`',
+           /# on .* using RuboCop version .*/,
+           '# The point is for the user to remove these configuration records',
+           '# one by one as the offences are removed from the code base.',
+           '# Note that changes in the inspected code, or installation of new',
+           '# versions of RuboCop, may require this file to be generated ' +
+           'again.',
+           '',
+           '# Offence count: 1',
+           '# Configuration parameters: AllowedVariables.',
+           'GlobalVars:',
+           '  Enabled: false',
+           '',
+           '# Offence count: 1',
+           'IndentationConsistency:',
+           '  Enabled: false',
+           '',
+           '# Offence count: 2',
+           'LineLength:',
+           '  Max: 90',
+           '',
+           '# Offence count: 1',
+           '# Cop supports --auto-correct.',
+           'SpaceAroundOperators:',
+           '  Enabled: false',
+           '',
+           '# Offence count: 1',
+           'Tab:',
+           '  Enabled: false',
+           '',
+           '# Offence count: 2',
+           '# Cop supports --auto-correct.',
+           'TrailingWhitespace:',
+           '  Enabled: false']
+        actual = IO.read('rubocop-todo.yml').split($RS)
+        expected.each_with_index do |line, ix|
+          if line.is_a?(String)
+            expect(actual[ix]).to eq(line)
+          else
+            expect(actual[ix]).to match(line)
+          end
+        end
       end
     end
 
@@ -142,7 +232,7 @@ describe Rubocop::CLI, :isolated_environment do
                         'example.rb'])).to eq(1)
         expect($stdout.string)
           .to eq(['== example.rb ==',
-                  'C:  1:  1: Favor modifier if/unless usage when you ' +
+                  'C:  1:  1: Favor modifier if usage when you ' +
                   'have a single-line body. Another good alternative is ' +
                   'the usage of control flow &&/||.',
                   '',
@@ -170,34 +260,58 @@ describe Rubocop::CLI, :isolated_environment do
     end
 
     describe '-d/--debug' do
-      it 'shows config files', ruby: 2.0 do
+      it 'shows config files' do
         create_file('example1.rb', "\tputs 0")
         expect(cli.run(['--debug', 'example1.rb'])).to eq(1)
         home = File.dirname(File.dirname(File.dirname(__FILE__)))
-        expect($stdout.string.lines[2, 5].map(&:chomp).join("\n"))
+        expect($stdout.string.lines.grep(/configuration/).map(&:chomp))
           .to eq(["For #{abs('')}:" +
                   " configuration from #{home}/config/default.yml",
                   "Inheriting configuration from #{home}/config/enabled.yml",
-                  "Inheriting configuration from #{home}/config/" +
-                  'disabled.yml',
-                  "AllCops/Excludes configuration from #{home}/.rubocop.yml",
-                  "Inheriting configuration from #{home}/rubocop-todo.yml"
-                 ].join("\n"))
+                  "Inheriting configuration from #{home}/config/disabled.yml"
+                 ])
       end
 
-      it 'shows cop names', ruby: 2.0 do
+      it 'shows cop names' do
         create_file('example1.rb', "\tputs 0")
         expect(cli.run(['--format',
                         'emacs',
                         '--debug',
                         'example1.rb'])).to eq(1)
-        expect($stdout.string.lines[-1])
+        expect($stdout.string.lines.to_a[-1])
+          .to eq(["#{abs('example1.rb')}:1:1: C: Tab: Tab detected.",
+                  ''].join("\n"))
+      end
+    end
+
+    describe '-D/--display-cop-names' do
+      it 'shows cop names' do
+        create_file('example1.rb', "\tputs 0")
+        expect(cli.run(['--format',
+                        'emacs',
+                        '--debug',
+                        'example1.rb'])).to eq(1)
+        expect($stdout.string.lines.to_a[-1])
           .to eq(["#{abs('example1.rb')}:1:1: C: Tab: Tab detected.",
                   ''].join("\n"))
       end
     end
 
     describe '--show-cops' do
+      shared_examples(:prints_config) do
+        it 'prints the current configuration' do
+          out = stdout.lines.to_a
+          printed_config = YAML.load(out.join)
+          cop_names = (cop_list[0] || '').split(',')
+          cop_names.each do |cop_name|
+            global_conf[cop_name].each do |key, value|
+              printed_value = printed_config[cop_name][key]
+              expect(printed_value).to eq(value)
+            end
+          end
+        end
+      end
+
       let(:cops) { Rubocop::Cop::Cop.all }
 
       let(:global_conf) do
@@ -209,72 +323,90 @@ describe Rubocop::CLI, :isolated_environment do
       let(:stdout) { $stdout.string }
 
       before do
-        expect { cli.run ['--show-cops'] }.to exit_with_code(0)
+        expect { cli.run ['--show-cops'] + cop_list }.to exit_with_code(0)
       end
 
-      # Extracts the first line out of the description
-      def short_description_of_cop(cop)
-        desc = full_description_of_cop(cop)
-        desc ? desc.lines.first.strip : ''
-      end
-
-      # Gets the full description of the cop or nil if no description is set.
-      def full_description_of_cop(cop)
-        cop_config = global_conf.for_cop(cop)
-        cop_config['Description']
-      end
+      context 'with no args' do
+        let(:cop_list) { [] }
 
-      it 'prints all available cops and their description' do
-        cops.each do |cop|
-          expect(stdout).to include cop.cop_name
-          expect(stdout).to include short_description_of_cop(cop)
+        # Extracts the first line out of the description
+        def short_description_of_cop(cop)
+          desc = full_description_of_cop(cop)
+          desc ? desc.lines.first.strip : ''
         end
-      end
 
-      it 'prints all types' do
-        cops
-          .types
-          .map(&:to_s)
-          .map(&:capitalize)
-          .each { |type| expect(stdout).to include(type) }
-      end
+        # Gets the full description of the cop or nil if no description is set.
+        def full_description_of_cop(cop)
+          cop_config = global_conf.for_cop(cop)
+          cop_config['Description']
+        end
 
-      it 'prints all cops in their right type listing' do
-        lines = stdout.lines
-        lines.slice_before(/Type /).each do |slice|
-          types = cops.types.map(&:to_s).map(&:capitalize)
-          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
+        it 'prints all available cops and their description' do
+          cops.each do |cop|
+            expect(stdout).to include cop.cop_name
+            # Because of line breaks, we will only find the beginning.
+            expect(stdout).to include short_description_of_cop(cop)[0..60]
           end
+        end
+
+        it 'prints all types' do
+          cops
+            .types
+            .map(&:to_s)
+            .map(&:capitalize)
+            .each { |type| expect(stdout).to include(type) }
+        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
+        it 'prints all cops in their right type listing' do
+          lines = stdout.lines
+          lines.slice_before(/Type /).each do |slice|
+            types = cops.types.map(&:to_s).map(&:capitalize)
+            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
+            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
+              end
             end
           end
         end
+
+        include_examples :prints_config
       end
 
-      it 'prints the current configuration' do
-        out = stdout.lines.to_a
-        cops.each do |cop|
-          conf = global_conf[cop.cop_name].dup
-          confstrt =
-            out.find_index { |i| i.include?("- #{cop.cop_name}") } + 1
-          c = out[confstrt, conf.keys.size].to_s
-          conf.delete('Description')
-          expect(c).to include(short_description_of_cop(cop))
-          conf.each do |k, v|
-            # ugly hack to get hash/array content tested
-            if v.kind_of?(Hash) || v.kind_of?(Array)
-              expect(c).to include "#{k}: #{v.to_s.dump[2, -2]}"
-            else
-              expect(c).to include "#{k}: #{v}"
-            end
-          end
+      context 'with one cop given' do
+        let(:cop_list) { ['Tab'] }
+
+        it 'prints that cop and nothing else' do
+          expect(stdout).to eq(['Tab:',
+                                '  Description: No hard tabs.',
+                                '  Enabled: true',
+                                '',
+                                ''].join("\n"))
+        end
+
+        include_examples :prints_config
+      end
+
+      context 'with two cops given' do
+        let(:cop_list) { ['Tab,LineLength'] }
+        include_examples :prints_config
+      end
+
+      context 'with one of the cops misspelled' do
+        let(:cop_list) { ['Tab,X123'] }
+
+        it 'skips the unknown cop' do
+          expect(stdout).to eq(['Tab:',
+                                '  Description: No hard tabs.',
+                                '  Enabled: true',
+                                '',
+                                ''].join("\n"))
         end
       end
     end
@@ -352,7 +484,7 @@ describe Rubocop::CLI, :isolated_environment do
                       'example3.rb:2:5: C: Use snake_case for methods.',
                       'def badName',
                       '    ^^^^^^^',
-                      'example3.rb:3:3: C: Favor modifier if/unless usage ' +
+                      'example3.rb:3:3: C: Favor modifier if usage ' +
                       'when you have a single-line body. Another good ' +
                       'alternative is the usage of control flow &&/||.',
                       '  if something',
@@ -511,7 +643,7 @@ describe Rubocop::CLI, :isolated_environment do
   describe '#trap_interrupt' do
     before do
       @interrupt_handlers = []
-      Signal.stub(:trap).with('INT') do |&block|
+      allow(Signal).to receive(:trap).with('INT') do |&block|
         @interrupt_handlers << block
       end
     end
@@ -535,8 +667,8 @@ describe Rubocop::CLI, :isolated_environment do
       end
 
       it 'does not exit immediately' do
-        Object.any_instance.should_not_receive(:exit)
-        Object.any_instance.should_not_receive(:exit!)
+        expect_any_instance_of(Object).not_to receive(:exit)
+        expect_any_instance_of(Object).not_to receive(:exit!)
         cli.trap_interrupt
         interrupt
       end
@@ -544,7 +676,7 @@ describe Rubocop::CLI, :isolated_environment do
 
     context 'with SIGINT twice' do
       it 'exits immediately' do
-        Object.any_instance.should_receive(:exit!).with(1)
+        expect_any_instance_of(Object).to receive(:exit!).with(1)
         cli.trap_interrupt
         interrupt
         interrupt
@@ -600,7 +732,9 @@ describe Rubocop::CLI, :isolated_environment do
     expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
     expect($stdout.string)
       .to eq(["#{abs('example.rb')}:2:6: W: " +
-              "`*' interpreted as argument prefix",
+              'Ambiguous splat operator. Parenthesize the method arguments ' +
+              "if it's surely a splat operator, or add a whitespace to the " +
+              'right of the * if it should be a multiplication.',
               "#{abs('example.rb')}:3:1: C: " +
               'Favor the ternary operator (?:) over if/then/else/end ' +
               'constructs.',
@@ -757,6 +891,36 @@ describe Rubocop::CLI, :isolated_environment do
     end
   end
 
+  describe 'cops can exclude files based on config' do
+    it 'ignores excluded files' do
+      create_file('example.rb', [
+                                 '# encoding: utf-8',
+                                 'x = 0'
+                                ])
+      create_file('regexp.rb', [
+                                '# encoding: utf-8',
+                                'x = 0'
+                               ])
+      create_file('exclude_glob.rb', [
+                                      '#!/usr/bin/env ruby',
+                                      '# encoding: utf-8',
+                                      'x = 0'
+                                     ])
+      create_file('.rubocop.yml', [
+                                   'UselessAssignment:',
+                                   '  Exclude:',
+                                   '    - example.rb',
+                                   '    - !ruby/regexp /regexp.rb\z/',
+                                   '    - "exclude_*"'
+                                  ])
+      expect(cli.run(%w(--format simple))).to eq(0)
+      expect($stdout.string)
+        .to eq(['', '3 files inspected, no offences detected',
+                ''].join("\n"))
+    end
+
+  end
+
   describe 'configuration from file' do
     it 'finds included files' do
       create_file('example', [
@@ -826,8 +990,8 @@ describe Rubocop::CLI, :isolated_environment do
                                            '  Excludes:',
                                            '    - ignored/**',
                                           ])
-      File.should_not_receive(:open).with(%r(/ignored/))
-      File.stub(:open).and_call_original
+      expect(File).not_to receive(:open).with(%r(/ignored/))
+      allow(File).to receive(:open).and_call_original
       expect(cli.run(%w(--format simple example))).to eq(0)
       expect($stdout.string)
         .to eq(['', '0 files inspected, no offences detected',
@@ -853,15 +1017,14 @@ describe Rubocop::CLI, :isolated_environment do
                 ''].join("\n"))
     end
 
-    it 'can disable Syntax offences with warning severity' do
-      pending
+    it 'can disable parser-derived offences with warning severity' do
       # `-' interpreted as argument prefix
       create_file('example.rb', 'puts -1')
       create_file('.rubocop.yml', [
                                    'Encoding:',
                                    '  Enabled: false',
                                    '',
-                                   'Syntax:',
+                                   'AmbiguousOperator:',
                                    '  Enabled: false'
                                   ])
       expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(0)
@@ -915,7 +1078,7 @@ describe Rubocop::CLI, :isolated_environment do
                         '-c', 'rubocop.yml', 'example1.rb'])
       expect($stdout.string)
         .to eq(['== example1.rb ==',
-                'C:  1:  1: Favor modifier if/unless usage when you have ' +
+                'C:  1:  1: Favor modifier if usage when you have ' +
                 'a single-line body. Another good alternative is the ' +
                 'usage of control flow &&/||.',
                 '',