rubocop 0.9.1 → 0.10.0

data/lib/rubocop/token.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module Rubocop
+  # A basic wrapper around Parser's tokens.
+  class Token
+    attr_reader :pos, :type, :text
+
+    def self.from_parser_token(parser_token)
+      type, details = *parser_token
+      text, range = *details
+      new(range, type, text)
+    end
+
+    def initialize(pos, type, text)
+      @pos, @type, @text = pos, type, text
+    end
+
+    def to_s
+      "[[#{@pos.line}, #{@pos.column}], #{@type}, #{@text.inspect}]"
+    end
+  end
+end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module Rubocop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '0.9.1'
+    STRING = '0.10.0'
 
     MSG = '%s (using Parser %s, running on %s %s %s)'
 

data/rubocop.gemspec

@@ -27,9 +27,11 @@ Gem::Specification.new do |s|
   s.summary = 'Automatic Ruby code style checking tool.'
 
   s.add_runtime_dependency('rainbow', '>= 1.1.4')
-  s.add_runtime_dependency('parser', '2.0.0.pre1')
-  s.add_development_dependency('rake', '~> 10.0')
-  s.add_development_dependency('rspec', '~> 2.13')
+  s.add_runtime_dependency('parser', '2.0.0.pre2')
+  s.add_runtime_dependency('backports', '~> 3.3.3')
+  s.add_runtime_dependency('powerpack', '0.0.1')
+  s.add_development_dependency('rake', '~> 10.1')
+  s.add_development_dependency('rspec', '~> 2.14')
   s.add_development_dependency('yard', '~> 0.8')
   s.add_development_dependency('bundler', '~> 1.3')
   s.add_development_dependency('simplecov', '~> 0.7')

data/spec/project_spec.rb

@@ -10,15 +10,4 @@ describe 'RuboCop Project' do
         .to eq((['AllCops'] + cop_names).sort)
     end
   end
-
-  describe 'source codes' do
-    before { $stdout = StringIO.new }
-    after  { $stdout = STDOUT }
-
-    it 'has no violations' do
-      # Need to pass an empty array explicitly
-      # so that the CLI does not refer arguments of `rspec`
-      expect(Rubocop::CLI.new.run([])).to eq(0)
-    end
-  end
 end

data/spec/rubocop/cli_spec.rb

@@ -24,10 +24,19 @@ module Rubocop
       File.expand_path(path)
     end
 
-    it 'exits cleanly when -h is used' do
-      expect { cli.run ['-h'] }.to exit_with_code(0)
-      expect { cli.run ['--help'] }.to exit_with_code(0)
-      message = <<-END
+    describe '-h/--help option' do
+      it 'exits cleanly' do
+        expect { cli.run ['-h'] }.to exit_with_code(0)
+        expect { cli.run ['--help'] }.to exit_with_code(0)
+      end
+
+      it 'shows help text' do
+        begin
+          cli.run(['--help'])
+        rescue SystemExit # rubocop:disable HandleExceptions
+        end
+
+        expected_help = <<-END
 Usage: rubocop [options] [file1, file2, ...]
     -d, --debug                      Display debug info.
     -c, --config FILE                Specify configuration file.
@@ -40,6 +49,7 @@ Usage: rubocop [options] [file1, file2, ...]
                                        [c]lang
                                        [e]macs
                                        [j]son
+                                       [f]iles
                                        custom formatter class name
     -o, --out FILE                   Write output to a file instead of STDOUT.
                                      This option applies to the previously
@@ -53,8 +63,34 @@ Usage: rubocop [options] [file1, file2, ...]
     -n, --no-color                   Disable color output.
     -v, --version                    Display version.
     -V, --verbose-version            Display verbose version.
-      END
-      expect($stdout.string).to eq(message * 2)
+        END
+
+        expect($stdout.string).to eq(expected_help)
+      end
+
+      it 'lists all builtin formatters' do
+        begin
+          cli.run(['--help'])
+        rescue SystemExit # rubocop:disable HandleExceptions
+        end
+
+        option_sections = $stdout.string.lines.slice_before(/^\s*-/)
+
+        format_section = option_sections.find do |lines|
+          lines.first =~ /^\s*-f/
+        end
+
+        formatter_keys = format_section.reduce([]) do |keys, line|
+          match = line.match(/^[ ]{39}(\[[a-z\]]+)/)
+          next keys unless match
+          keys << match.captures.first.gsub(/\[|\]/, '')
+        end.sort
+
+        expected_formatter_keys =
+          Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys.sort
+
+        expect(formatter_keys).to eq(expected_formatter_keys)
+      end
     end
 
     it 'exits cleanly when -v is used' do
@@ -339,6 +375,26 @@ Usage: rubocop [options] [file1, file2, ...]
          ''].join("\n"))
     end
 
+    it 'can be configured to override a parameter that is a hash' do
+      create_file('example1.rb',
+                  ['# encoding: utf-8',
+                   'arr.find_all { |e| e > 0 }.collect { |e| -e }'])
+      # We only care about select over find_all. All other preferred methods
+      # appearing in the default config are gone when we override
+      # PreferredMethods. We get no report about collect.
+      create_file('rubocop.yml',
+                  ['CollectionMethods:',
+                   '  PreferredMethods:',
+                   '    find_all: select'])
+      cli.run(['--format', 'simple', '-c', 'rubocop.yml', 'example1.rb'])
+      expect($stdout.string).to eq(
+        ['== example1.rb ==',
+         'C:  2:  5: Prefer select over find_all.',
+         '',
+         '1 file inspected, 1 offence detected',
+         ''].join("\n"))
+    end
+
     it 'works when a cop that others depend on is disabled' do
       create_file('example1.rb', ['if a',
                                   '  b',
@@ -467,6 +523,56 @@ Usage: rubocop [options] [file1, file2, ...]
          ''].join("\n"))
     end
 
+    it 'can exclude a typical vendor directory' do
+      create_file('vendor/bundle/ruby/1.9.1/gems/parser-2.0.0/.rubocop.yml',
+                  ['AllCops:',
+                   '  Excludes:',
+                   '    - lib/parser/lexer.rb'])
+
+      create_file('vendor/bundle/ruby/1.9.1/gems/parser-2.0.0/lib/ex.rb',
+                  ['# encoding: utf-8',
+                   '#' * 90])
+
+      create_file('.rubocop.yml',
+                  ['AllCops:',
+                   '  Excludes:',
+                   '    - vendor/**'])
+
+      cli.run(%w(--format simple))
+      expect($stdout.string).to eq(
+        ['',
+         '0 files inspected, no offences detected',
+         ''].join("\n"))
+    end
+
+    # Relative exclude paths in .rubocop.yml files are relative to that file,
+    # but in configuration files with other names they will be relative to
+    # whatever file inherits from them.
+    it 'can exclude a vendor directory indirectly' do
+      create_file('vendor/bundle/ruby/1.9.1/gems/parser-2.0.0/.rubocop.yml',
+                  ['AllCops:',
+                   '  Excludes:',
+                   '    - lib/parser/lexer.rb'])
+
+      create_file('vendor/bundle/ruby/1.9.1/gems/parser-2.0.0/lib/ex.rb',
+                  ['# encoding: utf-8',
+                   '#' * 90])
+
+      create_file('.rubocop.yml',
+                  ['inherit_from: config/default.yml'])
+
+      create_file('config/default.yml',
+                  ['AllCops:',
+                   '  Excludes:',
+                   '    - vendor/**'])
+
+      cli.run(%w(--format simple))
+      expect($stdout.string).to eq(
+        ['',
+         '0 files inspected, no offences detected',
+         ''].join("\n"))
+    end
+
     it 'prints a warning for an unrecognized cop name in .rubocop.yml' do
       create_file('example/example1.rb', [
         '# encoding: utf-8',

data/spec/rubocop/config_spec.rb

@@ -11,8 +11,6 @@ describe Rubocop::Config do
   let(:hash) { {} }
   let(:loaded_path) { 'example/.rubocop.yml' }
 
-  before { Rubocop::ConfigStore.prepare }
-
   describe '.configuration_file_for', :isolated_environment do
     subject(:configuration_file_for) do
       Rubocop::Config.configuration_file_for(dir_path)
@@ -100,9 +98,9 @@ describe Rubocop::Config do
                     ])
       end
 
-      it 'gets AllCops/Exclude from the highest directory level' do
+      it 'gets AllCops/Excludes from the highest directory level' do
         excludes = configuration_from_file['AllCops']['Excludes']
-        expect(excludes).to eq(['../vendor/**'])
+        expect(excludes).to eq([File.expand_path('vendor/**')])
       end
     end
 
@@ -120,9 +118,9 @@ describe Rubocop::Config do
         create_file(file_path, ['inherit_from: ../.rubocop.yml'])
       end
 
-      it 'gets AllCops/Exclude relative to its own directory' do
+      it 'gets an absolute AllCops/Excludes' do
         excludes = configuration_from_file['AllCops']['Excludes']
-        expect(excludes).to eq(['../vendor/**', /[A-Z]/])
+        expect(excludes).to eq([File.expand_path('vendor/**'), /[A-Z]/])
       end
     end
 
@@ -139,9 +137,9 @@ describe Rubocop::Config do
         create_file(file_path, ['inherit_from: ../src/.rubocop.yml'])
       end
 
-      it 'gets AllCops/Exclude relative to its own directory' do
+      it 'gets an absolute AllCops/Exclude' do
         excludes = configuration_from_file['AllCops']['Excludes']
-        expect(excludes).to eq(['../src/vendor/**'])
+        expect(excludes).to eq([File.expand_path('src/vendor/**')])
       end
     end
 
@@ -350,7 +348,7 @@ describe Rubocop::Config do
     let(:hash) do
       {
         'AllCops' => {
-          'Excludes' => ['log/*']
+          'Excludes' => ['/home/foo/project/log/*']
         }
       }
     end
@@ -424,14 +422,14 @@ describe Rubocop::Config do
   end
 
   describe 'configuration for SymbolArray', :isolated_environment do
-    before do
-      create_file('example.rb', '# encoding: utf-8')
+    let(:config) do
+      config_path = Rubocop::Config.configuration_file_for('.')
+      Rubocop::Config.configuration_from_file(config_path)
     end
 
     context 'when no config file exists for the target file' do
       it 'is disabled' do
-        configuration = Rubocop::ConfigStore.for('example.rb')
-        expect(configuration.cop_enabled?('SymbolArray')).to be_false
+        expect(config.cop_enabled?('SymbolArray')).to be_false
       end
     end
 
@@ -441,8 +439,7 @@ describe Rubocop::Config do
           'LineLength:',
           '  Max: 79'
         ])
-        configuration = Rubocop::ConfigStore.for('example.rb')
-        expect(configuration.cop_enabled?('SymbolArray')).to be_false
+        expect(config.cop_enabled?('SymbolArray')).to be_false
       end
     end
 
@@ -452,8 +449,7 @@ describe Rubocop::Config do
           'SymbolArray:',
           '  Enabled: true'
         ])
-        configuration = Rubocop::ConfigStore.for('example.rb')
-        expect(configuration.cop_enabled?('SymbolArray')).to be_true
+        expect(config.cop_enabled?('SymbolArray')).to be_true
       end
     end
   end

data/spec/rubocop/config_store_spec.rb

@@ -4,7 +4,8 @@ require 'spec_helper'
 
 module Rubocop
   describe ConfigStore do
-    before(:each) { ConfigStore.prepare }
+    subject(:config_store) { ConfigStore.new }
+
     before do
       Config.stub(:configuration_file_for) do |arg|
         # File tree:
@@ -19,26 +20,10 @@ module Rubocop
       Config.stub(:merge_with_default) { |config, file| "merged #{config}" }
     end
 
-    describe '.prepare' do
-      it 'resets @options_config' do
-        ConfigStore.set_options_config(:options_config)
-        ConfigStore.prepare
-        Config.should_receive(:configuration_file_for)
-        ConfigStore.for('file1')
-      end
-
-      it 'resets @config_cache' do
-        ConfigStore.for('file1')
-        ConfigStore.prepare
-        Config.should_receive(:configuration_file_for)
-        ConfigStore.for('file1')
-      end
-    end
-
     describe '.for' do
       it 'always uses config specified in command line' do
-        ConfigStore.set_options_config(:options_config)
-        expect(ConfigStore.for('file1')).to eq('merged options_config loaded')
+        config_store.set_options_config(:options_config)
+        expect(config_store.for('file1')).to eq('merged options_config loaded')
       end
 
       context 'when no config specified in command line' do
@@ -50,15 +35,15 @@ module Rubocop
           Config.should_receive(:configuration_from_file).once
             .with('dir/.rubocop.yml')
 
-          ConfigStore.for('dir/file2')
-          ConfigStore.for('dir/file2')
-          ConfigStore.for('dir/subdir/file3')
+          config_store.for('dir/file2')
+          config_store.for('dir/file2')
+          config_store.for('dir/subdir/file3')
         end
 
         it 'searches for config path if not available in cache' do
           Config.should_receive(:configuration_file_for).once
           Config.should_receive(:configuration_from_file).once
-          ConfigStore.for('file1')
+          config_store.for('file1')
         end
       end
     end

data/spec/rubocop/cops/commissioner_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# rubocop:disable LineLength
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe Commissioner do
+      describe '#investigate' do
+        it 'returns all offences found by the cops' do
+          cop = double(Cop, offences: [1])
+          commissioner = Commissioner.new([cop])
+          source = []
+          processed_source = parse_source(source)
+
+          expect(commissioner.investigate(processed_source)).to eq [1]
+        end
+
+        it 'traverses the AST and invoke cops specific callbacks' do
+          cop = double(Cop, offences: [])
+          cop.should_receive(:on_def)
+
+          commissioner = Commissioner.new([cop])
+          source = ['def method', '1', 'end']
+          processed_source = parse_source(source)
+
+          commissioner.investigate(processed_source)
+        end
+
+        it 'passes the input params to all cops that implement their own #investigate method' do
+          source = []
+          processed_source = parse_source(source)
+          cop = double(Cop, offences: [])
+          cop.should_receive(:investigate).with(processed_source)
+
+          commissioner = Commissioner.new([cop])
+
+          commissioner.investigate(processed_source)
+        end
+
+        it 'stores all errors raised by the cops' do
+          cop = double(Cop, offences: [])
+          cop.stub(:on_def) { raise RuntimeError }
+
+          commissioner = Commissioner.new([cop])
+          source = ['def method', '1', 'end']
+          processed_source = parse_source(source)
+
+          commissioner.investigate(processed_source)
+
+          expect(commissioner.errors[cop]).to have(1).item
+          expect(commissioner.errors[cop][0]).to be_instance_of(RuntimeError)
+        end
+
+        context 'when passed :raise_error option' do
+          it 're-raises the exception received while processing' do
+          cop = double(Cop, offences: [])
+          cop.stub(:on_def) { raise RuntimeError }
+
+          commissioner = Commissioner.new([cop], raise_error: true)
+          source = ['def method', '1', 'end']
+          processed_source = parse_source(source)
+
+          expect do
+            commissioner.investigate(processed_source)
+          end.to raise_error(RuntimeError)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rubocop/cops/corrector_spec.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+module Rubocop
+  module Cop
+    describe Corrector do
+      describe '#rewrite' do
+        it 'allows removal of a range' do
+          source = 'true and false'
+          processed_source = parse_source(source)
+
+          correction = lambda do |corrector|
+            node = processed_source.ast
+            corrector.remove(node.loc.operator)
+          end
+
+          corrector = Corrector.new(processed_source.buffer, [correction])
+          expect(corrector.rewrite).to eq 'true  false'
+        end
+
+        it 'allows insertion before a source range' do
+          source = 'true and false'
+          processed_source = parse_source(source)
+
+          correction = lambda do |corrector|
+            node = processed_source.ast
+            corrector.insert_before(node.loc.operator, ';nil ')
+          end
+
+          corrector = Corrector.new(processed_source.buffer, [correction])
+          expect(corrector.rewrite).to eq 'true ;nil and false'
+        end
+
+        it 'allows insertion after a source range' do
+          source = 'true and false'
+          processed_source = parse_source(source)
+
+          correction = lambda do |corrector|
+            node = processed_source.ast
+            corrector.insert_after(node.loc.operator, ' nil;')
+          end
+
+          corrector = Corrector.new(processed_source.buffer, [correction])
+          expect(corrector.rewrite).to eq 'true and nil; false'
+        end
+
+        it 'allows replacement of a range' do
+          source = 'true and false'
+          processed_source = parse_source(source)
+
+          correction = lambda do |corrector|
+            node = processed_source.ast
+            corrector.replace(node.loc.operator, 'or')
+          end
+
+          corrector = Corrector.new(processed_source.buffer, [correction])
+          expect(corrector.rewrite).to eq 'true or false'
+        end
+      end
+    end
+  end
+end