rubocop 0.15.0 → 0.16.0

data/spec/isolated_environment_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'isolated environment', :isolated_environment do
+  include FileHelper
+
+  let(:cli) { Rubocop::CLI.new }
+
+  before(:each) { $stdout = StringIO.new }
+  after(:each) { $stdout = STDOUT }
+
+  # Configuration files above the work directory shall not disturb the
+  # tests. This is especially important on Windows where the temporary
+  # directory is under the user's home directory. On any platform we don't want
+  # a .rubocop.yml file in the temporary directory to affect the outcome of
+  # rspec.
+  it 'is not affected by a config file above the work directory' do
+    create_file('../.rubocop.yml', ['inherit_from: missing_file.yml'])
+    create_file('ex.rb', ['# encoding: utf-8'])
+    # A return value of 0 means that the erroneous config file was not read.
+    expect(cli.run([])).to eq(0)
+  end
+end

data/spec/rubocop/cli_spec.rb

@@ -33,6 +33,22 @@ describe Rubocop::CLI, :isolated_environment do
       end
     end
 
+    describe '--auto-correct' do
+      it 'can correct two problems with blocks' do
+        # {} should be do..end and space is missing.
+        create_file('example.rb', ['# encoding: utf-8',
+                                   '(1..10).each{ |i|',
+                                   '  puts i',
+                                   '}'])
+        expect(cli.run(['--auto-correct'])).to eq(1)
+        expect(IO.read('example.rb'))
+          .to eq(['# encoding: utf-8',
+                  '(1..10).each do |i|',
+                  '  puts i',
+                  'end'].join("\n") + "\n")
+      end
+    end
+
     describe '--auto-gen-config' do
       it 'exits with error if asked to re-generate a todo list that is in ' +
         'use' do
@@ -72,6 +88,7 @@ describe Rubocop::CLI, :isolated_environment do
       it 'can generate a todo list' do
         create_file('example1.rb', ['# encoding: utf-8',
                                     'x= 0 ',
+                                    '#' * 90,
                                     '#' * 85,
                                     'y ',
                                     'puts x'])
@@ -95,9 +112,12 @@ describe Rubocop::CLI, :isolated_environment do
                   '# one by one as the offences are removed from the code ' +
                   'base.',
                   '',
-                  'LineLength:',
+                  'IndentationWidth:',
                   '  Enabled: false',
                   '',
+                  'LineLength:',
+                  '  Max: 90',
+                  '',
                   'SpaceAroundOperators:',
                   '  Enabled: false',
                   '',
@@ -154,16 +174,14 @@ describe Rubocop::CLI, :isolated_environment 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, 7].map(&:chomp).join("\n"))
+        expect($stdout.string.lines[2, 5].map(&:chomp).join("\n"))
           .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}/config/default.yml",
-                  "Inheriting configuration from #{home}/config/enabled.yml",
-                  "Inheriting configuration from #{home}/config/disabled.yml"
+                  "Inheriting configuration from #{home}/rubocop-todo.yml"
                  ].join("\n"))
       end
 
@@ -323,6 +341,10 @@ describe Rubocop::CLI, :isolated_environment do
                       'example2.rb:2:1: C: Tab detected.',
                       "\tx",
                       '^',
+                      'example2.rb:3:1: C: Inconsistent indentation ' +
+                      'detected.',
+                      'def a',
+                      '',
                       'example2.rb:4:1: C: Use 2 (not 3) spaces for ' +
                       'indentation.',
                       '   puts',
@@ -340,7 +362,7 @@ describe Rubocop::CLI, :isolated_environment do
                       '    end',
                       '    ^^^',
                       '',
-                      '3 files inspected, 9 offences detected',
+                      '3 files inspected, 10 offences detected',
                       ''].join("\n"))
           end
         end
@@ -362,6 +384,8 @@ describe Rubocop::CLI, :isolated_environment do
                "#{abs('example1.rb')}:2:5: C: Trailing whitespace detected.",
                "#{abs('example1.rb')}:3:2: C: Trailing whitespace detected.",
                "#{abs('example2.rb')}:2:1: C: Tab detected.",
+               "#{abs('example2.rb')}:3:1: C: Inconsistent indentation " +
+               'detected.',
                ''].join("\n")
             expect($stdout.string).to eq(expected_output)
           end
@@ -683,34 +707,36 @@ describe Rubocop::CLI, :isolated_environment do
 
   describe 'enabling/disabling rails cops' do
     it 'by default does not run rails cops' do
-      create_file('example1.rb', ['# encoding: utf-8',
-                                  'read_attribute(:test)'])
-      expect(cli.run(['--format', 'simple', 'example1.rb'])).to eq(0)
+      create_file('app/models/example1.rb', ['# encoding: utf-8',
+                                             'read_attribute(:test)'])
+      expect(cli.run(['--format', 'simple', 'app/models/example1.rb']))
+        .to eq(0)
     end
 
     it 'with -R given runs rails cops' do
-      create_file('example1.rb', ['# encoding: utf-8',
-                                  'read_attribute(:test)'])
-      expect(cli.run(['--format', 'simple', '-R', 'example1.rb'])).to eq(1)
+      create_file('app/models/example1.rb', ['# encoding: utf-8',
+                                             'read_attribute(:test)'])
+      expect(cli.run(['--format', 'simple', '-R', 'app/models/example1.rb']))
+        .to eq(1)
       expect($stdout.string).to include('Prefer self[:attribute]')
     end
 
     it 'with configation option true in one dir runs rails cops there' do
-      create_file('dir1/example1.rb', ['# encoding: utf-8',
-                                       'read_attribute(:test)'])
+      create_file('dir1/app/models/example1.rb', ['# encoding: utf-8',
+                                                 'read_attribute(:test)'])
       create_file('dir1/.rubocop.yml', [
                                         'AllCops:',
                                         '  RunRailsCops: true',
                                        ])
-      create_file('dir2/example2.rb', ['# encoding: utf-8',
-                                       'read_attribute(:test)'])
+      create_file('dir2/app/models/example2.rb', ['# encoding: utf-8',
+                                                  'read_attribute(:test)'])
       create_file('dir2/.rubocop.yml', [
                                         'AllCops:',
                                         '  RunRailsCops: false',
                                        ])
       expect(cli.run(['--format', 'simple', 'dir1', 'dir2'])).to eq(1)
       expect($stdout.string)
-        .to eq(['== dir1/example1.rb ==',
+        .to eq(['== dir1/app/models/example1.rb ==',
                 'C:  2:  1: Prefer self[:attribute] over read_attribute' +
                 '(:attribute).',
                 '',
@@ -719,13 +745,14 @@ describe Rubocop::CLI, :isolated_environment do
     end
 
     it 'with configation option false but -R given runs rails cops' do
-      create_file('example1.rb', ['# encoding: utf-8',
-                                  'read_attribute(:test)'])
+      create_file('app/models/example1.rb', ['# encoding: utf-8',
+                                             'read_attribute(:test)'])
       create_file('.rubocop.yml', [
                                    'AllCops:',
                                    '  RunRailsCops: false',
                                   ])
-      expect(cli.run(['--format', 'simple', '-R', 'example1.rb'])).to eq(1)
+      expect(cli.run(['--format', 'simple', '-R', 'app/models/example1.rb']))
+        .to eq(1)
       expect($stdout.string).to include('Prefer self[:attribute]')
     end
   end
@@ -1111,14 +1138,80 @@ describe Rubocop::CLI, :isolated_environment do
                 abs('example/.rubocop.yml'),
                 ''].join("\n"))
     end
-  end
 
-  describe '#display_error_summary' do
-    it 'displays an error message to stderr when errors are present' do
-      msg = 'An error occurred while Encoding cop was inspecting file.rb.'
-      cli.display_error_summary([msg])
-      expect($stderr.string.lines.to_a[-6..-5])
-        .to eq(["1 error occurred:\n", "#{msg}\n"])
+    it 'works when a configuration file passed by -c specifies Excludes with regexp' do
+      create_file('example/example1.rb', [
+                                          '# encoding: utf-8',
+                                          '#' * 90
+                                         ])
+
+      create_file('rubocop.yml', [
+                                           'AllCops:',
+                                           '  Excludes:',
+                                           '    - !ruby/regexp /example1\.rb$/'
+                                          ])
+
+      cli.run(%w(--format simple -c rubocop.yml))
+      expect($stdout.string)
+        .to eq(['', '0 files inspected, no offences detected',
+                ''].join("\n"))
+    end
+
+    it 'works when a configuration file passed by -c specifies Excludes with strings' do
+      create_file('example/example1.rb', [
+                                          '# encoding: utf-8',
+                                          '#' * 90
+                                         ])
+
+      create_file('rubocop.yml', [
+                                  'AllCops:',
+                                  '  Excludes:',
+                                  '    - example/**'
+                                 ])
+
+      cli.run(%w(--format simple -c rubocop.yml))
+      expect($stdout.string)
+        .to eq(['', '0 files inspected, no offences detected',
+                ''].join("\n"))
+    end
+
+    it 'works when a configuration file specifies a Severity' do
+      create_file('example/example1.rb', [
+                                          '# encoding: utf-8',
+                                          '#' * 90
+                                         ])
+
+      create_file('rubocop.yml', [
+                                  'LineLength:',
+                                  '  Severity: error',
+                                 ])
+
+      cli.run(%w(--format simple -c rubocop.yml))
+      expect($stdout.string)
+        .to eq(['== example/example1.rb ==',
+                'E:  2: 80: Line is too long. [90/79]',
+                '',
+                '1 file inspected, 1 offence detected',
+                ''].join("\n"))
+      expect($stderr.string).to eq('')
+    end
+
+    it 'fails when a configuration file specifies an invalid Severity' do
+      create_file('example/example1.rb', [
+                                          '# encoding: utf-8',
+                                          '#' * 90
+                                         ])
+
+      create_file('rubocop.yml', [
+                                  'LineLength:',
+                                  '  Severity: superbad',
+                                 ])
+
+      cli.run(%w(--format simple -c rubocop.yml))
+      expect($stderr.string)
+        .to eq("Warning: Invalid severity 'superbad'. " +
+               'Valid severities are refactor, convention, ' +
+               "warning, error, fatal.\n")
     end
   end
 end

data/spec/rubocop/config_loader_spec.rb

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-DEFAULT_CONFIG = Rubocop::ConfigLoader.load_file('config/default.yml')
-
 describe Rubocop::ConfigLoader do
   include FileHelper
 
+  let(:default_config) { Rubocop::ConfigLoader.default_configuration }
+
   describe '.configuration_file_for', :isolated_environment do
     subject(:configuration_file_for) do
       described_class.configuration_file_for(dir_path)
@@ -72,10 +72,10 @@ describe Rubocop::ConfigLoader do
                                 '  Enabled: false'])
       end
       it 'returns a configuration inheriting from default.yml' do
-        config = DEFAULT_CONFIG['Encoding'].dup
+        config = default_config['Encoding'].dup
         config['Enabled'] = false
         expect(configuration_from_file)
-          .to eql(DEFAULT_CONFIG.merge('Encoding' => config))
+          .to eql(default_config.merge('Encoding' => config))
       end
     end
 
@@ -121,6 +121,20 @@ describe Rubocop::ConfigLoader do
       end
     end
 
+    context 'when a file inherits from an empty parent file' do
+      let(:file_path) { 'dir/.rubocop.yml' }
+
+      before do
+        create_file('.rubocop.yml', [''])
+
+        create_file(file_path, ['inherit_from: ../.rubocop.yml'])
+      end
+
+      it 'does not fail to load' do
+        expect { configuration_from_file }.not_to raise_error
+      end
+    end
+
     context 'when a file inherits from a sibling file' do
       let(:file_path) { 'dir/.rubocop.yml' }
 
@@ -172,16 +186,16 @@ describe Rubocop::ConfigLoader do
       end
 
       it 'returns the ancestor configuration plus local overrides' do
-        config = DEFAULT_CONFIG
+        config = default_config
                    .merge('LineLength' => {
                           'Description' =>
-                             DEFAULT_CONFIG['LineLength']['Description'],
+                             default_config['LineLength']['Description'],
                           'Enabled' => true,
                           'Max' => 77
                           },
                           'MethodLength' => {
                             'Description' =>
-                               DEFAULT_CONFIG['MethodLength']['Description'],
+                               default_config['MethodLength']['Description'],
                             'Enabled' => true,
                             'CountComments' => false,
                             'Max' => 5
@@ -302,12 +316,12 @@ describe Rubocop::ConfigLoader do
     end
   end
 
-  describe 'configuration for SymbolName' do
-    describe 'AllowCamelCase' do
+  describe 'configuration for AssignmentInCondition' do
+    describe 'AllowSafeAssignment' do
       it 'is enabled by default' do
         default_config = described_class.default_configuration
-        symbol_name_config = default_config.for_cop('SymbolName')
-        expect(symbol_name_config['AllowCamelCase']).to be_true
+        symbol_name_config = default_config.for_cop('AssignmentInCondition')
+        expect(symbol_name_config['AllowSafeAssignment']).to be_true
       end
     end
   end

data/spec/rubocop/config_spec.rb

@@ -32,10 +32,9 @@ describe Rubocop::Config do
       end
 
       it 'raises validation error' do
-        e = described_class::ValidationError
-        expect { configuration.validate }.to raise_error(e) do |error|
-          expect(error.message).to start_with('unrecognized cop LyneLenth')
-        end
+        expect { configuration.validate }
+          .to raise_error(described_class::ValidationError,
+                          /^unrecognized cop LyneLenth/)
       end
     end
 
@@ -49,11 +48,28 @@ describe Rubocop::Config do
       end
 
       it 'raises validation error' do
-        e = described_class::ValidationError
-        expect { configuration.validate }.to raise_error(e) do |error|
-          expect(error.message).to
-            start_with('unrecognized parameter LineLength:Min')
-        end
+        expect { configuration.validate }
+          .to raise_error(described_class::ValidationError,
+                          /^unrecognized parameter LineLength:Min/)
+      end
+    end
+
+    context 'when the configuration includes any common parameter' do
+      # Common parameters are parameters that are not in the default
+      # configuration, but are nonetheless allowed for any cop.
+      before do
+        create_file(configuration_path, [
+          'LineLength:',
+          '  Exclude:',
+          '    - lib/file.rb',
+          '  Include:',
+          '    - lib/file.xyz',
+          '  Severity: warning',
+        ])
+      end
+
+      it 'does not raise validation error' do
+        expect { configuration.validate }.to_not raise_error
       end
     end
   end

data/spec/rubocop/config_store_spec.rb

@@ -23,7 +23,7 @@ describe Rubocop::ConfigStore do
 
   describe '.for' do
     it 'always uses config specified in command line' do
-      config_store.set_options_config(:options_config)
+      config_store.options_config = :options_config
       expect(config_store.for('file1')).to eq('merged options_config loaded')
     end
 

data/spec/rubocop/cop/cop_spec.rb

@@ -15,20 +15,39 @@ describe Rubocop::Cop::Cop do
   end
 
   it 'keeps track of offences' do
-    cop.convention(nil, location, 'message')
+    cop.add_offence(nil, location, 'message')
 
     expect(cop.offences.size).to eq(1)
   end
 
   it 'will report registered offences' do
-    cop.convention(nil, location, 'message')
+    cop.add_offence(nil, location, 'message')
 
     expect(cop.offences).not_to be_empty
   end
 
+  it 'will set default severity' do
+    cop.add_offence(nil, location, 'message')
+
+    expect(cop.offences.first.severity).to eq(:convention)
+  end
+
+  it 'will set custom severity if present' do
+    cop.config[cop.name] = { 'Severity' => 'warning' }
+    cop.add_offence(nil, location, 'message')
+
+    expect(cop.offences.first.severity).to eq(:warning)
+  end
+
+  it 'will warn if custom severity is invalid' do
+    cop.config[cop.name] = { 'Severity' => 'superbad' }
+    cop.should_receive(:warn)
+    cop.add_offence(nil, location, 'message')
+  end
+
   it 'registers offence with its name' do
     cop = Rubocop::Cop::Style::For.new
-    cop.convention(nil, location, 'message')
+    cop.add_offence(nil, location, 'message')
     expect(cop.offences.first.cop_name).to eq('For')
   end