rubocop 0.14.1 → 0.15.0

data/lib/rubocop/cop/style/trailing_blank_lines.rb

@@ -19,13 +19,25 @@ module Rubocop
           end
 
           if blank_lines > 0
-            convention(nil,
-                       source_range(processed_source.buffer,
-                                    processed_source[0...-blank_lines],
-                                    0, 1),
-                       format(MSG, blank_lines))
+            range_size =
+              processed_source.raw_lines.to_a[-blank_lines..-1].join.length
+            range = source_range(processed_source.buffer,
+                                 processed_source[0...-blank_lines],
+                                 0, range_size)
+            convention(range, range, format(MSG, blank_lines))
           end
         end
+
+        def autocorrect(range)
+          # Bail out if there's also trailing whitespace, because
+          # auto-correction in the two cops would result in clobbering.
+          if range.source =~ / / &&
+              config.for_cop('TrailingWhitespace')['Enabled']
+            fail CorrectionNotPossible
+          end
+
+          @corrections << ->(corrector) { corrector.remove(range) }
+        end
       end
     end
   end

data/lib/rubocop/cop/style/trailing_whitespace.rb

@@ -10,14 +10,18 @@ module Rubocop
         def investigate(processed_source)
           processed_source.lines.each_with_index do |line, index|
             if line =~ /.*[ \t]+$/
-              convention(nil,
-                         source_range(processed_source.buffer,
-                                      processed_source[0...index],
-                                      line.rstrip.length,
-                                      line.length - line.rstrip.length))
+              range = source_range(processed_source.buffer,
+                                   processed_source[0...index],
+                                   line.rstrip.length,
+                                   line.length - line.rstrip.length)
+              convention(range, range)
             end
           end
         end
+
+        def autocorrect(range)
+          @corrections << ->(corrector) { corrector.remove(range) }
+        end
       end
     end
   end

data/lib/rubocop/cop/style/trivial_accessors.rb

@@ -32,7 +32,6 @@ module Rubocop
             convention(node, :keyword,
                        sprintf(MSG, kind, kind))
           end
-
         end
 
         def exact_name_match?
@@ -67,7 +66,7 @@ module Rubocop
         end
 
         def looks_like_trivial_writer?(args, body)
-          args.children.size == 1 &&
+          args.children.size == 1 && args.children[0].type != :restarg &&
             body && body.type == :ivasgn &&
             body.children[1] && body.children[1].type == :lvar
         end

data/lib/rubocop/cop/style/word_array.rb

@@ -18,13 +18,24 @@ module Rubocop
 
           string_array = array_elems.all? { |e| e.type == :str }
 
-          if string_array && !complex_content?(array_elems)
+          if string_array && !complex_content?(array_elems) &&
+            array_elems.size > min_size && !comments_in_array?(node)
             convention(node, :expression)
           end
         end
 
         private
 
+        def comments_in_array?(node)
+          comments = processed_source.comments
+
+          array_range = node.loc.expression.to_a
+
+          comments.any? do |comment|
+            !(comment.loc.expression.to_a & array_range).empty?
+          end
+        end
+
         def complex_content?(arr_sexp)
           arr_sexp.each do |s|
             source = s.loc.expression.source
@@ -36,6 +47,10 @@ module Rubocop
 
           false
         end
+
+        def min_size
+          cop_config['MinSize']
+        end
       end
     end
   end

data/lib/rubocop/cop/team.rb

@@ -9,12 +9,12 @@ module Rubocop
       def initialize(cop_classes, config, options = nil)
         @cop_classes = cop_classes
         @config = config
-        @options = options || { autocorrect: false, debug: false }
+        @options = options || { auto_correct: false, debug: false }
         @errors = []
       end
 
       def autocorrect?
-        @options[:autocorrect]
+        @options[:auto_correct]
       end
 
       def debug?
@@ -25,9 +25,9 @@ module Rubocop
         begin
           processed_source = SourceParser.parse_file(file)
         rescue Encoding::UndefinedConversionError, ArgumentError => e
-          handle_error(e,
-                       "An error occurred while parsing #{file}.".color(:red))
-          return []
+          range = Struct.new(:line, :column, :source_line).new(1, 0, '')
+          return [Offence.new(:fatal, range, e.message.capitalize + '.',
+                              'Parser')]
         end
 
         # If we got any syntax errors, return only the syntax offences.

data/lib/rubocop/cop/util.rb

@@ -62,6 +62,7 @@ module Rubocop
           namespace_node, name = *const_node
           const_names << name
           break unless namespace_node
+          break unless namespace_node.is_a?(Parser::AST::Node)
           break if namespace_node.type == :cbase
           const_node = namespace_node
         end

data/lib/rubocop/formatter/offence_count_formatter.rb

@@ -10,7 +10,6 @@ module Rubocop
     # (26)  LineLength
     # (3)   OneLineConditional
     class OffenceCountFormatter < BaseFormatter
-
       attr_reader :offence_counts
 
       def started(target_files)

data/lib/rubocop/options.rb

@@ -7,12 +7,10 @@ module Rubocop
   class Options
     DEFAULT_FORMATTER = 'progress'
 
-    def initialize(config_store)
-      @config_store = config_store
+    def initialize
       @options = {}
     end
 
-    # rubocop:disable MethodLength
     def parse(args)
       ignore_dropped_options(args)
       convert_deprecated_options(args)
@@ -20,89 +18,91 @@ module Rubocop
       OptionParser.new do |opts|
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
 
-        opts.on('-d', '--debug', 'Display debug info.') do |d|
-          @options[:debug] = d
-        end
-        opts.on('-c', '--config FILE', 'Specify configuration file.') do |f|
-          @options[:config] = f
-          @config_store.set_options_config(@options[:config])
-        end
-        opts.on('--only COP', 'Run just one cop.') do |s|
-          @options[:only] = s
+        option(opts, '--only COP', 'Run just one cop.') do
           validate_only_option
         end
-        opts.on('--auto-gen-config',
-                'Generate a configuration file acting as a',
-                'TODO list.') do
-          @options[:auto_gen_config] = true
-          @options[:formatters] = [
-                                   [DEFAULT_FORMATTER],
-                                   [Formatter::DisabledConfigFormatter,
-                                    ConfigLoader::AUTO_GENERATED_FILE]
-                                  ]
-          validate_auto_gen_config_option(args)
-        end
-        opts.on('--show-cops',
-                'Shows cops and their config for the',
-                'current directory.') do
-          print_available_cops
-          exit(0)
-        end
-        opts.on('-f', '--format FORMATTER',
-                'Choose an output formatter. This option',
-                'can be specified multiple times to enable',
-                'multiple formatters at the same time.',
-                '  [p]rogress (default)',
-                '  [s]imple',
-                '  [c]lang',
-                '  [e]macs',
-                '  [j]son',
-                '  [f]iles',
-                '  [o]ffences',
-                '  custom formatter class name') do |key|
-          @options[:formatters] ||= []
-          @options[:formatters] << [key]
-        end
-        opts.on('-o', '--out FILE',
-                'Write output to a file instead of STDOUT.',
-                'This option applies to the previously',
-                'specified --format, or the default format',
-                'if no format is specified.') do |path|
-          @options[:formatters] ||= [[DEFAULT_FORMATTER]]
-          @options[:formatters].last << path
-        end
-        opts.on('-r', '--require FILE', 'Require Ruby file.') do |f|
+
+        option(opts, '-c', '--config FILE', 'Specify configuration file.')
+
+        add_formatting_options(opts, args)
+
+        option(opts, '-r', '--require FILE', 'Require Ruby file.') do |f|
           require f
         end
-        opts.on('-R', '--rails', 'Run extra Rails cops.') do |r|
-          @options[:rails] = r
-        end
-        opts.on('-l', '--lint', 'Run only lint cops.') do |l|
-          @options[:lint] = l
-        end
-        opts.on('-a', '--auto-correct', 'Auto-correct offences.') do |a|
-          @options[:autocorrect] = a
-        end
-        opts.on('-n', '--no-color', 'Disable color output.') do |s|
-          Sickill::Rainbow.enabled = false
-        end
-        opts.on('-v', '--version', 'Display version.') do
-          puts Rubocop::Version.version(false)
-          exit(0)
-        end
-        opts.on('-V', '--verbose-version', 'Display verbose version.') do
-          puts Rubocop::Version.version(true)
-          exit(0)
-        end
+
+        add_boolean_flags(opts)
       end.parse!(args)
 
-      target_files = target_finder.find(args)
-      [@options, target_files]
+      [@options, args]
     end
-    # rubocop:enable MethodLength
 
     private
 
+    FORMAT_HELP = ['Choose an output formatter. This option',
+                   'can be specified multiple times to enable',
+                   'multiple formatters at the same time.',
+                   '  [p]rogress (default)',
+                   '  [s]imple',
+                   '  [c]lang',
+                   '  [e]macs',
+                   '  [j]son',
+                   '  [f]iles',
+                   '  [o]ffences',
+                   '  custom formatter class name']
+
+    def add_formatting_options(opts, args)
+      option(opts, '--auto-gen-config',
+             'Generate a configuration file acting as a', 'TODO list.') do
+        validate_auto_gen_config_option(args)
+        @options[:formatters] = [[DEFAULT_FORMATTER],
+                                 [Formatter::DisabledConfigFormatter,
+                                  ConfigLoader::AUTO_GENERATED_FILE]]
+      end
+
+      option(opts, '-f', '--format FORMATTER', *FORMAT_HELP) do |key|
+        @options[:formatters] ||= []
+        @options[:formatters] << [key]
+      end
+
+      option(opts, '-o', '--out FILE',
+             'Write output to a file instead of STDOUT.',
+             'This option applies to the previously',
+             'specified --format, or the default format',
+             'if no format is specified.') do |path|
+        @options[:formatters] ||= [[DEFAULT_FORMATTER]]
+        @options[:formatters].last << path
+      end
+    end
+
+    def add_boolean_flags(opts)
+      option(opts, '--show-cops',
+             'Shows cops and their config for the',
+             'current directory.')
+      option(opts, '-d', '--debug', 'Display debug info.')
+      option(opts, '-R', '--rails', 'Run extra Rails cops.')
+      option(opts, '-l', '--lint', 'Run only lint cops.')
+      option(opts, '-a', '--auto-correct', 'Auto-correct offences.')
+      option(opts, '-n', '--no-color', 'Disable color output.')
+      option(opts, '-v', '--version', 'Display version.')
+      option(opts, '-V', '--verbose-version', 'Display verbose version.')
+    end
+
+    # Sets a value in the @options hash, based on the given long option and its
+    # value, in addition to calling the block if a block is given.
+    def option(opts, *args)
+      opts.on(*args) do |arg|
+        @options[long_opt_symbol(args)] = arg
+        yield arg if block_given?
+      end
+    end
+
+    # Finds the option in `args` starting with -- and converts it to a symbol,
+    # e.g. [..., '--auto-correct', ...] to :auto_correct.
+    def long_opt_symbol(args)
+      long_opt = args.find { |arg| arg.start_with?('--') }
+      long_opt[2..-1].sub(/ .*/, '').gsub(/-/, '_').to_sym
+    end
+
     def ignore_dropped_options(args)
       # Currently we don't make -s/--silent option raise error
       # since those are mostly used by external tools.
@@ -144,41 +144,6 @@ module Rubocop
         fail ArgumentError,
              '--auto-gen-config can not be combined with any other arguments.'
       end
-
-      target_finder.find(args).each do |file|
-        config = @config_store.for(file)
-        if @options[:auto_gen_config] && config.contains_auto_generated_config
-          fail "Remove #{ConfigLoader::AUTO_GENERATED_FILE} from the " +
-            'current configuration before generating it again.'
-        end
-      end
-    end
-
-    def target_finder
-      @target_finder ||= TargetFinder.new(@config_store, @options[:debug])
-    end
-
-    def print_available_cops
-      cops = Cop::Cop.all
-      puts "Available cops (#{cops.length}) + config for #{Dir.pwd.to_s}: "
-      dirconf = @config_store.for(Dir.pwd.to_s)
-      cops.types.sort!.each do |type|
-        coptypes = cops.with_type(type).sort_by!(&:cop_name)
-        puts "Type '#{type.to_s.capitalize}' (#{coptypes.size}):"
-        coptypes.each do |cop|
-          puts " - #{cop.cop_name}"
-          cnf = dirconf.for_cop(cop).dup
-          print_conf_option('Description',
-                            cnf.delete('Description') { 'None' })
-          cnf.each { |k, v| print_conf_option(k, v) }
-          print_conf_option('SupportsAutoCorrection',
-                            cop.new.support_autocorrect?.to_s)
-        end
-      end
-    end
-
-    def print_conf_option(option, value)
-      puts  "    - #{option}: #{value}"
     end
   end
 end

data/lib/rubocop/rake_task.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 
-require 'rubocop'
 require 'rake'
 require 'rake/tasklib'
 
@@ -10,7 +9,6 @@ module Rubocop
   # require 'rubocop/rake_task'
   # Rubocop::RakeTask.new
   class RakeTask < Rake::TaskLib
-
     attr_accessor :name
     attr_accessor :verbose
     attr_accessor :fail_on_error
@@ -32,6 +30,10 @@ module Rubocop
     end
 
     def run_task(verbose)
+      # We lazy-load rubocop so that the task doesn't dramatically impact the
+      # load time of your Rakefile.
+      require 'rubocop'
+
       cli = CLI.new
       puts 'Running RuboCop...' if verbose
       result = cli.run(patterns)

data/lib/rubocop/target_finder.rb

@@ -42,13 +42,13 @@ module Rubocop
     # @return [Array] Array of filenames
     def target_files_in_dir(base_dir = Dir.pwd)
       files = Dir["#{base_dir}/**/*"].select { |path| FileTest.file?(path) }
+      base_dir_config = @config_store.for("#{base_dir}/foobar.rb")
 
       target_files = files.select do |file|
-        config = @config_store.for(file)
-        next false if config.file_to_exclude?(file)
+        next false if base_dir_config.file_to_exclude?(file)
         next true if File.extname(file) == '.rb'
         next true if ruby_executable?(file)
-        config.file_to_include?(file)
+        @config_store.for(file).file_to_include?(file)
       end
 
       target_files.uniq

data/lib/rubocop/version.rb

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

data/spec/rubocop/cli_spec.rb

@@ -25,6 +25,14 @@ describe Rubocop::CLI, :isolated_environment do
   end
 
   describe 'option' do
+    describe '--version' do
+      it 'exits cleanly' do
+        expect { cli.run ['-v'] }.to exit_with_code(0)
+        expect { cli.run ['--version'] }.to exit_with_code(0)
+        expect($stdout.string).to eq((Rubocop::Version::STRING + "\n") * 2)
+      end
+    end
+
     describe '--auto-gen-config' do
       it 'exits with error if asked to re-generate a todo list that is in ' +
         'use' do
@@ -171,6 +179,88 @@ describe Rubocop::CLI, :isolated_environment do
       end
     end
 
+    describe '--show-cops' do
+      let(:cops) { Rubocop::Cop::Cop.all }
+
+      let(:global_conf) do
+        config_path =
+          Rubocop::ConfigLoader.configuration_file_for(Dir.pwd.to_s)
+        Rubocop::ConfigLoader.configuration_from_file(config_path)
+      end
+
+      let(:stdout) { $stdout.string }
+
+      before do
+        expect { cli.run ['--show-cops'] }.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
+
+      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)
+        end
+      end
+
+      it 'prints all types' do
+        cops
+          .types
+          .map(&:to_s)
+          .map(&:capitalize)
+          .each { |type| expect(stdout).to include(type) }
+      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
+          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
+
+      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
+        end
+      end
+    end
+
     describe '-f/--format' do
       let(:target_file) { 'example.rb' }
 
@@ -498,7 +588,10 @@ describe Rubocop::CLI, :isolated_environment do
                                '# encoding: utf-8',
                                "# #{'f9'.hex.chr}#{'29'.hex.chr}"
                               ])
-    expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(0)
+    expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
+    expect($stdout.string)
+      .to eq(["#{abs('example.rb')}:1:1: F: Invalid byte sequence in utf-8.",
+              ''].join("\n"))
   end
 
   describe 'rubocop:disable comment' do
@@ -927,6 +1020,31 @@ describe Rubocop::CLI, :isolated_environment do
                 ''].join("\n"))
     end
 
+    # Being immune to bad configuration files in excluded directories has
+    # become important due to a bug in rubygems
+    # (https://github.com/rubygems/rubygems/issues/680) that makes
+    # installations of, for example, rubocop lack their .rubocop.yml in the
+    # root directory.
+    it 'can exclude a vendor directory with an erroneous config file' do
+      create_file('vendor/bundle/ruby/1.9.1/gems/parser-2.0.0/.rubocop.yml',
+                  ['inherit_from: non_existent.yml'])
+
+      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($stderr.string).to eq('')
+      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.
@@ -967,14 +1085,10 @@ describe Rubocop::CLI, :isolated_environment do
                                           ])
 
       expect(cli.run(%w(--format simple example))).to eq(1)
-      expect($stdout.string)
+      expect($stderr.string)
         .to eq(
                ['Warning: unrecognized cop LyneLenth found in ' +
-                File.expand_path('example/.rubocop.yml'),
-                '== example/example1.rb ==',
-                'C:  2: 80: Line is too long. [90/79]',
-                '',
-                '1 file inspected, 1 offence detected',
+                abs('example/.rubocop.yml'),
                 ''].join("\n"))
     end
 
@@ -991,14 +1105,10 @@ describe Rubocop::CLI, :isolated_environment do
                                           ])
 
       expect(cli.run(%w(--format simple example))).to eq(1)
-      expect($stdout.string)
+      expect($stderr.string)
         .to eq(
                ['Warning: unrecognized parameter LineLength:Min found in ' +
-                File.expand_path('example/.rubocop.yml'),
-                '== example/example1.rb ==',
-                'C:  2: 80: Line is too long. [90/79]',
-                '',
-                '1 file inspected, 1 offence detected',
+                abs('example/.rubocop.yml'),
                 ''].join("\n"))
     end
   end