rubocop 0.24.1 → 0.25.0

data/rubocop.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.name = 'rubocop'
   s.version = RuboCop::Version::STRING
   s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 1.9.3'
   s.authors = ['Bozhidar Batsov', 'Jonas Arvidsson', 'Yuji Nakayama']
   s.description = <<-EOF
     Automatic Ruby code style checking tool.
@@ -27,9 +27,8 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.99.1', '< 3.0')
-  s.add_runtime_dependency('parser', '>= 2.2.0.pre.3', '< 3.0')
+  s.add_runtime_dependency('parser', '>= 2.2.0.pre.4', '< 3.0')
   s.add_runtime_dependency('powerpack', '~> 0.0.6')
-  s.add_runtime_dependency('json', '>= 1.7.7', '< 2')
   s.add_runtime_dependency('ruby-progressbar', '~> 1.4')
   s.add_development_dependency('rake', '~> 10.1')
   s.add_development_dependency('rspec', '~> 3.0')

data/spec/project_spec.rb

@@ -76,7 +76,7 @@ describe 'RuboCop Project' do
         it 'has a valid URL' do
           issues.each do |issue|
             number = issue[:number].gsub(/\D/, '')
-            pattern = %r{^https://github\.com/bbatsov/rubocop/(?:issues|pull)/#{number}$} # rubocop:disable Style/LineLength
+            pattern = %r{^https://github\.com/bbatsov/rubocop/(?:issues|pull)/#{number}$} # rubocop:disable Metrics/LineLength
             expect(issue[:url]).to match(pattern)
           end
         end

data/spec/rubocop/cli_spec.rb

@@ -95,12 +95,12 @@ describe RuboCop::CLI, :isolated_environment do
                   '  class Bar',
                   '    stuff = [',
                   '      {',
-                  "        some: 'hash',",
+                  "        some: 'hash'",
                   '      },',
                   '      {',
                   "        another: 'hash',",
                   "        with: 'more'",
-                  '      },',
+                  '      }',
                   '    ]',
                   '  end',
                   'end'].join("\n") + "\n")
@@ -197,12 +197,13 @@ describe RuboCop::CLI, :isolated_environment do
         create_file('example.rb', ['# encoding: utf-8',
                                    'class Dsl',
                                    'private',
-                                   '  A = ["git", "path"]',
+                                   '  A = ["git", "path",]',
                                    'end'])
         expect(cli.run(%w(--auto-correct --format emacs))).to eq(1)
         expect(IO.read('example.rb')).to eq(['# encoding: utf-8',
                                              'class Dsl',
                                              '  private',
+                                             '',
                                              '  A = %w(git path)',
                                              'end'].join("\n") + "\n")
         e = abs('example.rb')
@@ -211,8 +212,11 @@ describe RuboCop::CLI, :isolated_environment do
                   'comment.',
                   "#{e}:3:1: C: [Corrected] Indent access modifiers like " \
                   '`private`.',
+                  "#{e}:3:1: C: [Corrected] Keep a blank line before and " \
+                  'after `private`.',
                   "#{e}:3:3: W: Useless `private` access modifier.",
-                  "#{e}:3:3: C: Keep a blank line before and after `private`.",
+                  "#{e}:3:3: C: [Corrected] Keep a blank line before and " \
+                  'after `private`.',
                   "#{e}:4:7: C: [Corrected] Use `%w` or `%W` " \
                   'for array of words.',
                   "#{e}:4:8: C: [Corrected] Prefer single-quoted strings " \
@@ -221,6 +225,18 @@ describe RuboCop::CLI, :isolated_environment do
                   "#{e}:4:15: C: [Corrected] Prefer single-quoted strings " \
                   "when you don't need string interpolation or special " \
                   'symbols.',
+                  "#{e}:4:21: C: [Corrected] Avoid comma after the last item " \
+                  'of an array.',
+                  "#{e}:5:7: C: [Corrected] Use `%w` or `%W` " \
+                  'for array of words.',
+                  "#{e}:5:8: C: [Corrected] Prefer single-quoted strings " \
+                  "when you don't need string interpolation or special " \
+                  'symbols.',
+                  "#{e}:5:15: C: [Corrected] Prefer single-quoted strings " \
+                  "when you don't need string interpolation or special " \
+                  'symbols.',
+                  "#{e}:5:21: C: [Corrected] Avoid comma after the last item " \
+                  'of an array.',
                   ''].join("\n"))
       end
 
@@ -498,19 +514,19 @@ describe RuboCop::CLI, :isolated_environment do
 
       it 'does not say [Corrected] if correction was avoided' do
         create_file('example.rb', ['# encoding: utf-8',
-                                   'func a and b',
+                                   'a = c and b',
                                    'not a && b',
                                    'func a do b end'])
         expect(cli.run(%w(-a -f simple))).to eq(1)
         expect($stderr.string).to eq('')
         expect(IO.read('example.rb')).to eq(['# encoding: utf-8',
-                                             'func a and b',
+                                             'a = c and b',
                                              'not a && b',
                                              'func a do b end',
                                              ''].join("\n"))
         expect($stdout.string)
           .to eq(['== example.rb ==',
-                  'C:  2:  8: Use && instead of and.',
+                  'C:  2:  7: Use && instead of and.',
                   'C:  3:  1: Use ! instead of not.',
                   'C:  4:  8: Prefer {...} over do...end for single-line ' \
                   'blocks.',
@@ -528,7 +544,7 @@ describe RuboCop::CLI, :isolated_environment do
         end
         expect($stderr.string).to eq('')
         expect(IO.read('example.rb')).to eq(['# encoding: utf-8',
-                                             'some_method(a,)',
+                                             'some_method(a)',
                                              ''].join("\n"))
       end
 
@@ -541,26 +557,31 @@ describe RuboCop::CLI, :isolated_environment do
         end
         expect($stderr.string).to eq('')
         expect(IO.read('example.rb')).to eq(['# encoding: utf-8',
-                                             'puts [1,]',
+                                             'puts [1]',
                                              ''].join("\n"))
       end
     end
 
     describe '--auto-gen-config' do
+      before(:each) do
+        RuboCop::Formatter::DisabledConfigFormatter
+          .config_to_allow_offenses = {}
+      end
+
       it 'overwrites an existing todo file' do
         create_file('example1.rb', ['# encoding: utf-8',
                                     'x= 0 ',
                                     '#' * 85,
                                     'y ',
                                     'puts x'])
-        create_file('.rubocop_todo.yml', ['Style/LineLength:',
+        create_file('.rubocop_todo.yml', ['Metrics/LineLength:',
                                           '  Enabled: false'])
         create_file('.rubocop.yml', ['inherit_from: .rubocop_todo.yml'])
         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:',
+                  'Metrics/LineLength:',
                   '  Max: 85',
                   '',
                   '# Offense count: 1',
@@ -620,6 +641,11 @@ describe RuboCop::CLI, :isolated_environment do
            '# versions of RuboCop, may require this file to be generated ' \
            'again.',
            '',
+           '# Offense count: 2',
+           '# Configuration parameters: AllowURI.',
+           'Metrics/LineLength:',
+           '  Max: 90',
+           '',
            '# Offense count: 1',
            '# Cop supports --auto-correct.',
            'Style/CommentIndentation:',
@@ -635,11 +661,6 @@ describe RuboCop::CLI, :isolated_environment do
            'Style/IndentationConsistency:',
            '  Enabled: false',
            '',
-           '# Offense count: 2',
-           '# Configuration parameters: AllowURI.',
-           'Style/LineLength:',
-           '  Max: 90',
-           '',
            '# Offense count: 1',
            '# Cop supports --auto-correct.',
            'Style/SpaceAroundOperators:',
@@ -706,6 +727,7 @@ describe RuboCop::CLI, :isolated_environment do
       end
 
       it 'generates a todo list that removes the reports' do
+        RuboCop::Cop::Style::RegexpLiteral.slash_count = 0
         create_file('example.rb', ['# encoding: utf-8',
                                    'y.gsub!(%r{abc/xyz}, "#{x}")'])
         expect(cli.run(%w(--format emacs))).to eq(1)
@@ -724,8 +746,9 @@ describe RuboCop::CLI, :isolated_environment do
            'again.',
            '',
            '# Offense count: 1',
+           '# Configuration parameters: MaxSlashes.',
            'Style/RegexpLiteral:',
-           '  MaxSlashes: 0']
+           '  Enabled: false']
         actual = IO.read('.rubocop_todo.yml').split($RS)
         expected.each_with_index do |line, ix|
           if line.is_a?(String)
@@ -978,7 +1001,7 @@ describe RuboCop::CLI, :isolated_environment do
       let(:stdout) { $stdout.string }
 
       before do
-        create_file('.rubocop.yml', ['Style/LineLength:',
+        create_file('.rubocop.yml', ['Metrics/LineLength:',
                                      '  Max: 110'])
         expect { cli.run ['--show-cops'] + cop_list }.to exit_with_code(0)
       end
@@ -1051,7 +1074,7 @@ describe RuboCop::CLI, :isolated_environment do
       end
 
       context 'with two cops given' do
-        let(:cop_list) { ['Style/Tab,Style/LineLength'] }
+        let(:cop_list) { ['Style/Tab,Metrics/LineLength'] }
         include_examples :prints_config
       end
 
@@ -1446,18 +1469,18 @@ describe RuboCop::CLI, :isolated_environment do
 
   describe 'rubocop:disable comment' do
     it 'can disable all cops in a code section' do
-      create_file('example.rb',
-                  ['# encoding: utf-8',
-                   '# rubocop:disable all',
-                   '#' * 90,
-                   'x(123456)',
-                   'y("123")',
-                   'def func',
-                   '  # rubocop: enable Style/LineLength,Style/StringLiterals',
-                   '  ' + '#' * 93,
-                   '  x(123456)',
-                   '  y("123")',
-                   'end'])
+      src = ['# encoding: utf-8',
+             '# rubocop:disable all',
+             '#' * 90,
+             'x(123456)',
+             'y("123")',
+             'def func',
+             '  # rubocop: enable Metrics/LineLength,Style/StringLiterals',
+             '  ' + '#' * 93,
+             '  x(123456)',
+             '  y("123")',
+             'end']
+      create_file('example.rb', src)
       expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
       # all cops were disabled, then 2 were enabled again, so we
       # should get 2 offenses reported.
@@ -1478,13 +1501,16 @@ describe RuboCop::CLI, :isolated_environment do
                    'x(123456)',
                    'y("123")',
                    'def func',
-                   '  # rubocop: enable Style/LineLength, ' \
+                   '  # rubocop: enable Metrics/LineLength, ' \
                    'Style/StringLiterals',
                    '  ' + '#' * 93,
                    '  x(123456)',
                    '  y("123")',
                    'end'])
       expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
+      expect($stderr.string)
+        .to eq("#{abs('example.rb')}: Style/LineLength has the wrong " \
+               "namespace - should be Metrics\n")
       # 3 cops were disabled, then 2 were enabled again, so we
       # should get 2 offenses reported.
       expect($stdout.string)
@@ -1506,9 +1532,9 @@ describe RuboCop::CLI, :isolated_environment do
     it 'can disable selected cops on a single line' do
       create_file('example.rb',
                   ['# encoding: utf-8',
-                   'a' * 90 + ' # rubocop:disable Style/LineLength',
+                   'a' * 90 + ' # rubocop:disable Metrics/LineLength',
                    '#' * 95,
-                   'y("123") # rubocop:disable Style/LineLength,' \
+                   'y("123") # rubocop:disable Metrics/LineLength,' \
                    'Style/StringLiterals'
                   ])
       expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
@@ -1890,7 +1916,7 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('rubocop.yml', ['Style/Encoding:',
                                   '  Enabled: false',
                                   '',
-                                  'Style/LineLength:',
+                                  'Metrics/LineLength:',
                                   '  Enabled: false'
                                  ])
       result = cli.run(['--format', 'simple',
@@ -1928,7 +1954,7 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('example_src/example1.rb', ['# encoding: utf-8',
                                               '#' * 90
                                              ])
-      create_file('example_src/.rubocop.yml', ['Style/LineLength:',
+      create_file('example_src/.rubocop.yml', ['Metrics/LineLength:',
                                                '  Enabled: true',
                                                '  Max: 100'
                                               ])
@@ -1944,7 +1970,7 @@ describe RuboCop::CLI, :isolated_environment do
                                                    '#' * 90
                                                   ])
       end
-      create_file('example/src/.rubocop.yml', ['Style/LineLength:',
+      create_file('example/src/.rubocop.yml', ['Metrics/LineLength:',
                                                '  Enabled: true',
                                                '  Max: 100'
                                               ])
@@ -1961,11 +1987,11 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('example_src/example1.rb', ['# encoding: utf-8',
                                               '#' * 90
                                              ])
-      create_file('example_src/.rubocop.yml', ['Style/LineLength:',
+      create_file('example_src/.rubocop.yml', ['Metrics/LineLength:',
                                                '  Enabled: true',
                                                '  Max: 100'
                                               ])
-      create_file("#{Dir.home}/.rubocop.yml", ['Style/LineLength:',
+      create_file("#{Dir.home}/.rubocop.yml", ['Metrics/LineLength:',
                                                '  Enabled: true',
                                                '  Max: 80'
                                               ])
@@ -2100,14 +2126,14 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('example/example1.rb', ['# encoding: utf-8',
                                           '#' * 90])
 
-      create_file('example/.rubocop.yml', ['Style/LineLength:',
+      create_file('example/.rubocop.yml', ['Metrics/LineLength:',
                                            '  Enabled: true',
                                            '  Min: 10'])
 
       expect(cli.run(%w(--format simple example))).to eq(1)
       expect($stderr.string)
-        .to eq(['Warning: unrecognized parameter Style/LineLength:Min found ' \
-                'in ' + abs('example/.rubocop.yml'),
+        .to eq(['Warning: unrecognized parameter Metrics/LineLength:Min ' \
+                'found in ' + abs('example/.rubocop.yml'),
                 ''].join("\n"))
     end
 
@@ -2145,7 +2171,7 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('example/example1.rb', ['# encoding: utf-8',
                                           '#' * 90])
 
-      create_file('rubocop.yml', ['Style/LineLength:',
+      create_file('rubocop.yml', ['Metrics/LineLength:',
                                   '  Severity: error'])
 
       cli.run(%w(--format simple -c rubocop.yml))
@@ -2162,7 +2188,7 @@ describe RuboCop::CLI, :isolated_environment do
       create_file('example/example1.rb', ['# encoding: utf-8',
                                           '#' * 90])
 
-      create_file('rubocop.yml', ['Style/LineLength:',
+      create_file('rubocop.yml', ['Metrics/LineLength:',
                                   '  Severity: superbad'])
 
       cli.run(%w(--format simple -c rubocop.yml))

data/spec/rubocop/comment_config_spec.rb

@@ -10,11 +10,11 @@ describe RuboCop::CommentConfig do
       [
         '# encoding: utf-8',
         '',
-        '# rubocop:disable Style/MethodLength',
+        '# rubocop:disable Metrics/MethodLength',
         'def some_method',
         "  puts 'foo'",
         'end',
-        '# rubocop:enable Style/MethodLength',
+        '# rubocop:enable Metrics/MethodLength',
         '',
         '# rubocop:disable all',
         'some_method',
@@ -26,7 +26,7 @@ describe RuboCop::CommentConfig do
         '',
         'def some_method',
         "  puts 'Disabling indented single line' # rubocop:disable " \
-        'Style/LineLength',
+        'Metrics/LineLength',
         'end',
         '',
         'string = <<END',
@@ -35,7 +35,7 @@ describe RuboCop::CommentConfig do
         '',
         'foo # rubocop:disable Style/MethodCallParentheses',
         '',
-        '# rubocop:enable Style/Void',
+        '# rubocop:enable Lint/Void',
         '',
         '# rubocop:disable Style/For',
         'foo'
@@ -51,7 +51,7 @@ describe RuboCop::CommentConfig do
 
     it 'supports disabling multiple lines with a pair of directive' do
       method_length_disabled_lines =
-        disabled_lines_of_cop('Style/MethodLength')
+        disabled_lines_of_cop('Metrics/MethodLength')
       expected_part = (3..6).to_a
       expect(method_length_disabled_lines & expected_part)
         .to eq(expected_part)
@@ -77,7 +77,7 @@ describe RuboCop::CommentConfig do
     end
 
     it 'handles indented single line' do
-      line_length_disabled_lines = disabled_lines_of_cop('Style/LineLength')
+      line_length_disabled_lines = disabled_lines_of_cop('Metrics/LineLength')
       expect(line_length_disabled_lines).to include(18)
       expect(line_length_disabled_lines).not_to include(19)
     end

data/spec/rubocop/config_loader_spec.rb

@@ -161,14 +161,14 @@ describe RuboCop::ConfigLoader do
         create_file('dir/subdir/example.rb', '')
 
         create_file('.rubocop.yml',
-                    ['Style/LineLength:',
+                    ['Metrics/LineLength:',
                      '  Enabled: false',
                      '  Max: 77'])
 
         create_file('dir/.rubocop.yml',
                     ['inherit_from: ../.rubocop.yml',
                      '',
-                     'Style/MethodLength:',
+                     'Metrics/MethodLength:',
                      '  Enabled: true',
                      '  CountComments: false',
                      '  Max: 10'
@@ -177,10 +177,10 @@ describe RuboCop::ConfigLoader do
         create_file(file_path,
                     ['inherit_from: ../.rubocop.yml',
                      '',
-                     'Style/LineLength:',
+                     'Metrics/LineLength:',
                      '  Enabled: true',
                      '',
-                     'Style/MethodLength:',
+                     'Metrics/MethodLength:',
                      '  Max: 5'
                     ])
       end
@@ -188,16 +188,16 @@ describe RuboCop::ConfigLoader do
       it 'returns the ancestor configuration plus local overrides' do
         config =
           default_config
-          .merge('Style/LineLength' => {
+          .merge('Metrics/LineLength' => {
                    'Description' =>
-                   default_config['Style/LineLength']['Description'],
+                   default_config['Metrics/LineLength']['Description'],
                    'Enabled' => true,
                    'Max' => 77,
                    'AllowURI' => true
                  },
-                 'Style/MethodLength' => {
+                 'Metrics/MethodLength' => {
                    'Description' =>
-                   default_config['Style/MethodLength']['Description'],
+                   default_config['Metrics/MethodLength']['Description'],
                    'Enabled' => true,
                    'CountComments' => false,
                    'Max' => 5
@@ -213,13 +213,13 @@ describe RuboCop::ConfigLoader do
         create_file('example.rb', '')
 
         create_file('normal.yml',
-                    ['Style/MethodLength:',
+                    ['Metrics/MethodLength:',
                      '  Enabled: false',
                      '  CountComments: true',
                      '  Max: 80'])
 
         create_file('special.yml',
-                    ['Style/MethodLength:',
+                    ['Metrics/MethodLength:',
                      '  Enabled: false',
                      '  Max: 200'])
 
@@ -228,7 +228,7 @@ describe RuboCop::ConfigLoader do
                      '  - normal.yml',
                      '  - special.yml',
                      '',
-                     'Style/MethodLength:',
+                     'Metrics/MethodLength:',
                      '  Enabled: true'
                     ])
       end
@@ -237,7 +237,7 @@ describe RuboCop::ConfigLoader do
         expected = { 'Enabled' => true,        # overridden in .rubocop.yml
                      'CountComments' => true,  # only defined in normal.yml
                      'Max' => 200 }            # special.yml takes precedence
-        expect(configuration_from_file['Style/MethodLength'].to_set)
+        expect(configuration_from_file['Metrics/MethodLength'].to_set)
           .to be_superset(expected.to_set)
       end
     end
@@ -260,6 +260,12 @@ describe RuboCop::ConfigLoader do
         'Enabled' => true
       )
     end
+
+    it 'returns an empty configuration loaded from an empty file' do
+      create_file(configuration_path, '')
+      configuration = load_file
+      expect(configuration).to eq({})
+    end
   end
 
   describe '.merge' do
@@ -300,7 +306,7 @@ describe RuboCop::ConfigLoader do
     context 'when a config file which does not mention SymbolArray exists' do
       it 'is disabled' do
         create_file('.rubocop.yml', [
-          'Style/LineLength:',
+          'Metrics/LineLength:',
           '  Max: 80'
         ])
         expect(config.cop_enabled?('Style/SymbolArray')).to be_falsey