rubocop 0.6.1 → 0.7.0

data/Rakefile

@@ -7,7 +7,7 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -23,7 +23,7 @@ task :coverage do
   Rake::Task['spec'].execute
 end
 
-task :default => :spec
+task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/bin/rubocop

@@ -1,17 +1,22 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+if RUBY_ENGINE == 'ruby' && RUBY_VERSION >= '1.9.2'
+  $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
-require 'rubocop'
-require 'benchmark'
+  require 'rubocop'
+  require 'benchmark'
 
-cli = Rubocop::CLI.new
-result = 0
+  cli = Rubocop::CLI.new
+  result = 0
 
-time = Benchmark.realtime do
-  result = cli.run
-end
+  time = Benchmark.realtime do
+    result = cli.run
+  end
 
-puts "Finished in #{time} seconds" if $options[:debug]
-exit result
+  puts "Finished in #{time} seconds" if cli.options[:debug]
+  exit result
+else
+  puts 'RuboCop supports only MRI 1.9.2+'
+  exit(-1)
+end

data/lib/rubocop.rb

@@ -2,18 +2,22 @@
 
 require 'ripper'
 require 'rainbow'
+require 'English'
 
 require 'rubocop/cop/offence'
 require 'rubocop/cop/cop'
 require 'rubocop/cop/encoding'
 require 'rubocop/cop/line_length'
+require 'rubocop/cop/line_continuation'
 require 'rubocop/cop/syntax'
 require 'rubocop/cop/tab'
 require 'rubocop/cop/trailing_whitespace'
-require 'rubocop/cop/indentation'
+require 'rubocop/cop/case_indentation'
+require 'rubocop/cop/empty_line_between_defs'
 require 'rubocop/cop/empty_lines'
 require 'rubocop/cop/surrounding_space'
 require 'rubocop/cop/space_after_comma_etc'
+require 'rubocop/cop/space_after_control_keyword'
 require 'rubocop/cop/hash_syntax'
 require 'rubocop/cop/end_of_line'
 require 'rubocop/cop/numeric_literals'
@@ -37,11 +41,13 @@ require 'rubocop/cop/collection_methods'
 require 'rubocop/cop/avoid_for'
 require 'rubocop/cop/avoid_perlisms'
 require 'rubocop/cop/avoid_perl_backrefs'
+require 'rubocop/cop/avoid_global_vars'
 require 'rubocop/cop/avoid_class_vars'
 require 'rubocop/cop/symbol_snake_case'
 require 'rubocop/cop/variable_interpolation'
 require 'rubocop/cop/semicolon'
 require 'rubocop/cop/favor_sprintf'
+require 'rubocop/cop/favor_join'
 require 'rubocop/cop/alias'
 require 'rubocop/cop/rescue_modifier'
 require 'rubocop/cop/percent_literals'
@@ -51,6 +57,7 @@ require 'rubocop/cop/handle_exceptions'
 require 'rubocop/cop/rescue_exception'
 require 'rubocop/cop/ascii_identifiers'
 require 'rubocop/cop/ascii_comments'
+require 'rubocop/cop/block_comments'
 require 'rubocop/cop/hash_literal'
 require 'rubocop/cop/array_literal'
 require 'rubocop/cop/method_length'
@@ -58,10 +65,21 @@ require 'rubocop/cop/op_method'
 require 'rubocop/cop/reduce_arguments'
 require 'rubocop/cop/percent_r'
 require 'rubocop/cop/favor_percent_r'
+require 'rubocop/cop/class_methods'
+require 'rubocop/cop/single_line_methods'
+require 'rubocop/cop/word_array'
+require 'rubocop/cop/symbol_array'
+require 'rubocop/cop/trivial_accessors'
+require 'rubocop/cop/leading_comment_space'
+require 'rubocop/cop/colon_method_call'
+require 'rubocop/cop/not'
+require 'rubocop/cop/eval'
 
 require 'rubocop/report/report'
 require 'rubocop/report/plain_text'
 require 'rubocop/report/emacs_style'
 
+require 'rubocop/config'
+require 'rubocop/config_store'
 require 'rubocop/cli'
 require 'rubocop/version'

data/lib/rubocop/cli.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
-
+require 'pathname'
 require 'optparse'
-require 'yaml'
 require_relative 'cop/grammar'
 
 module Rubocop
@@ -11,8 +10,19 @@ module Rubocop
     # If set true while running,
     # RuboCop will abort processing and exit gracefully.
     attr_accessor :wants_to_quit
+    attr_accessor :options
+
     alias_method :wants_to_quit?, :wants_to_quit
 
+    def initialize
+      @cops = Cop::Cop.all
+      @processed_file_count = 0
+      @total_offences = 0
+      @errors = []
+      @options = { mode: :default }
+      ConfigStore.prepare
+    end
+
     # Entry point for the application logic. Here we
     # do the command line arguments processing and inspect
     # the target files
@@ -20,73 +30,89 @@ module Rubocop
     def run(args = ARGV)
       trap_interrupt
 
-      $options = { mode: :default }
-
       parse_options(args)
 
-      cops = Cop::Cop.all
-      show_cops_on_duty(cops) if $options[:debug]
-      processed_file_count = 0
-      total_offences = 0
-      errors_count = 0
-      @configs = {}
+      begin
+        handle_only_option if @options[:only]
+      rescue ArgumentError => e
+        puts e.message
+        return 1
+      end
 
       target_files(args).each do |file|
         break if wants_to_quit?
 
-        puts "Scanning #{file}" if $options[:debug]
+        config = ConfigStore.for(file)
+        report = Report.create(file, @options[:mode])
+        source = read_source(file)
 
-        report = Report.create(file, $options[:mode])
-        source = File.readlines(file).map do |line|
-          get_rid_of_invalid_byte_sequences(line)
-          line.chomp
-        end
+        puts "Scanning #{file}" if @options[:debug]
 
         syntax_cop = Rubocop::Cop::Syntax.new
+        syntax_cop.debug = @options[:debug]
         syntax_cop.inspect(file, source, nil, nil)
 
         if syntax_cop.offences.map(&:severity).include?(:error)
           # In case of a syntax error we just report that error and do
           # no more checking in the file.
           report << syntax_cop
-          total_offences += syntax_cop.offences.count
+          @total_offences += syntax_cop.offences.count
         else
-          tokens, sexp, correlations = CLI.rip_source(source)
-          config = $options[:config] || config_from_dotfile(File.dirname(file))
-          disabled_lines = disabled_lines_in(source)
-
-          cops.each do |cop_klass|
-            cop_name = cop_klass.name.split('::').last
-            cop_config = config[cop_name] if config
-            if cop_config.nil? || cop_config['Enabled']
-              cop_klass.config = cop_config
-              cop = cop_klass.new
-              cop.correlations = correlations
-              cop.disabled_lines = disabled_lines[cop_name]
-              begin
-                cop.inspect(file, source, tokens, sexp)
-              rescue => e
-                errors_count += 1
-                warn "An error occurred while #{cop.name} cop" +
-                  " was inspecting #{file}."
-                warn 'To see the complete backtrace run rubocop -d.'
-                puts e.backtrace if $options[:debug]
-              end
-              total_offences += cop.offences.count
-              report << cop if cop.has_report?
-            end
-          end
+          inspect_file(file, source, config, report)
         end
 
-        processed_file_count += 1
+        @processed_file_count += 1
         report.display unless report.empty?
       end
 
-      unless $options[:silent]
-        display_summary(processed_file_count, total_offences, errors_count)
+      unless @options[:silent]
+        display_summary(@processed_file_count, @total_offences, @errors)
       end
 
-      (total_offences == 0) && !wants_to_quit ? 0 : 1
+      (@total_offences == 0) && !wants_to_quit ? 0 : 1
+    end
+
+    def handle_only_option
+      @cops = @cops.select { |c| c.cop_name == @options[:only] }
+      if @cops.empty?
+        fail ArgumentError, "Unrecognized cop name: #{@options[:only]}."
+      end
+    end
+
+    def read_source(file)
+      get_rid_of_invalid_byte_sequences(File.read(file)).split($RS)
+    end
+
+    def inspect_file(file, source, config, report)
+      tokens, sexp, correlations = CLI.rip_source(source)
+      disabled_lines = disabled_lines_in(source)
+
+      @cops.each do |cop_klass|
+        cop_name = cop_klass.cop_name
+        cop_config = config.for_cop(cop_name)
+        if config.cop_enabled?(cop_name)
+          cop_klass.config = cop_config
+          cop = cop_klass.new
+          cop.debug = @options[:debug]
+          cop.correlations = correlations
+          cop.disabled_lines = disabled_lines[cop_name]
+          begin
+            cop.inspect(file, source, tokens, sexp)
+          rescue => e
+            message = "An error occurred while #{cop.name} cop".color(:red) +
+              " was inspecting #{file}.".color(:red)
+            @errors << message
+            warn message
+            if @options[:debug]
+              puts e.message, e.backtrace
+            else
+              warn 'To see the complete backtrace run rubocop -d.'
+            end
+          end
+          @total_offences += cop.offences.count
+          report << cop if cop.has_report?
+        end
+      end
     end
 
     def parse_options(args)
@@ -94,16 +120,20 @@ module Rubocop
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
 
         opts.on('-d', '--debug', 'Display debug info') do |d|
-          $options[:debug] = d
+          @options[:debug] = d
         end
         opts.on('-e', '--emacs', 'Emacs style output') do
-          $options[:mode] = :emacs_style
+          @options[:mode] = :emacs_style
         end
         opts.on('-c FILE', '--config FILE', 'Configuration file') do |f|
-          $options[:config] = YAML.load_file(f)
+          @options[:config] = f
+          ConfigStore.set_options_config(@options[:config])
+        end
+        opts.on('--only COP', 'Run just one cop') do |s|
+          @options[:only] = s
         end
         opts.on('-s', '--silent', 'Silence summary') do |s|
-          $options[:silent] = s
+          @options[:silent] = s
         end
         opts.on('-n', '--no-color', 'Disable color output') do |s|
           Sickill::Rainbow.enabled = false
@@ -119,13 +149,14 @@ module Rubocop
       Signal.trap('INT') do
         exit!(1) if wants_to_quit?
         self.wants_to_quit = true
-        STDERR.puts
-        STDERR.puts 'Exiting... Interrupt again to exit immediately.'
+        $stderr.puts
+        $stderr.puts 'Exiting... Interrupt again to exit immediately.'
       end
     end
 
-    def display_summary(num_files, total_offences, errors_count)
-      print "\n#{num_files} file#{num_files > 1 ? 's' : ''} inspected, "
+    def display_summary(num_files, total_offences, errors)
+      plural = num_files == 0 || num_files > 1 ? 's' : ''
+      print "\n#{num_files} file#{plural} inspected, "
       offences_string = if total_offences.zero?
                           'no offences'
                         elsif total_offences == 1
@@ -136,9 +167,10 @@ module Rubocop
       puts "#{offences_string} detected"
         .color(total_offences.zero? ? :green : :red)
 
-      if errors_count > 0
-        plural = errors_count > 1 ? 's' : ''
-        puts "\n#{errors_count} error#{plural} occurred.".color(:red)
+      if errors.count > 0
+        plural = errors.count > 1 ? 's' : ''
+        puts "\n#{errors.count} error#{plural} occurred:".color(:red)
+        errors.each { |error| puts error }
         puts 'Errors are usually caused by RuboCop bugs.'
         puts 'Please, report your problems to RuboCop\'s issue tracker.'
       end
@@ -170,19 +202,18 @@ module Rubocop
       match = line.match(regexp)
       if match
         kind, cops = match.captures
-        if cops.include?('all')
-          cops = Cop::Cop.all.map { |c| c.name.split('::').last }.join(',')
-        end
+        cops = Cop::Cop.all.map(&:cop_name).join(',') if cops.include?('all')
         cops.split(/,\s*/).each { |cop_name| yield cop_name, kind }
       end
     end
 
-    def get_rid_of_invalid_byte_sequences(line)
-      enc = line.encoding.name
+    def get_rid_of_invalid_byte_sequences(source)
+      source_encoding = source.encoding.name
       # UTF-16 works better in this algorithm but is not supported in 1.9.2.
       temporary_encoding = (RUBY_VERSION == '1.9.2') ? 'UTF-8' : 'UTF-16'
-      line.encode!(temporary_encoding, enc, invalid: :replace, replace: '')
-      line.encode!(enc, temporary_encoding)
+      source.encode!(temporary_encoding, source_encoding,
+                     invalid: :replace, replace: '')
+      source.encode!(source_encoding, temporary_encoding)
     end
 
     def self.rip_source(source)
@@ -193,50 +224,6 @@ module Rubocop
       [tokens, sexp, correlations]
     end
 
-    # Returns the configuration hash from .rubocop.yml searching
-    # upwards in the directory structure starting at the given
-    # directory where the inspected file is. If no .rubocop.yml is
-    # found there, the user's home directory is checked.
-    def config_from_dotfile(target_file_dir)
-      return unless target_file_dir
-      # @configs is a cache that maps directories to
-      # configurations. We search for .rubocop.yml only if we haven't
-      # already found it for the given directory.
-      unless @configs[target_file_dir]
-        dir = target_file_dir
-        while dir != '/'
-          path = File.join(dir, '.rubocop.yml')
-          if File.exist?(path)
-            @configs[target_file_dir] = YAML.load_file(path)
-            return @configs[target_file_dir]
-          end
-          dir = File.expand_path('..', dir)
-        end
-        path = File.join(Dir.home, '.rubocop.yml')
-        @configs[target_file_dir] = YAML.load_file(path) if File.exist?(path)
-      end
-      @configs[target_file_dir]
-    end
-
-    def cops_on_duty(config)
-      cops_on_duty = []
-
-      Cop::Cop.all.each do |cop_klass|
-        cop_config = config[cop_klass.name.split('::').last] if config
-        cops_on_duty << cop_klass if cop_config.nil? || cop_config['Enabled']
-      end
-
-      cops_on_duty
-    end
-
-    def show_cops_on_duty(cops)
-      puts '== Reporting for duty =='
-      cops.each do |c|
-        puts ' * '.color(:yellow) + c.to_s.color(:green)
-      end
-      puts '========================'
-    end
-
     # Generate a list of target files by expanding globing patterns
     # (if any). If args is empty recursively finds all Ruby source
     # files under the current directory
@@ -248,21 +235,23 @@ module Rubocop
 
       args.each do |target|
         if File.directory?(target)
-          files << ruby_files(target)
+          files += ruby_files(target.chomp(File::SEPARATOR))
         elsif target =~ /\*/
-          files << Dir[target]
+          files += Dir[target]
         else
           files << target
         end
       end
 
-      files.flatten
+      files.uniq
     end
 
     # Finds all Ruby source files under the current or other supplied
     # directory.  A Ruby source file is defined as a file with the `.rb`
     # extension or a file with no extension that has a ruby shebang line
     # as its first line.
+    # It is possible to specify includes and excludes using the config file,
+    # so you can include other Ruby files like Rakefiles and gemspecs.
     # @param root Root directory under which to search for ruby source files
     # @return [Array] Array of filenames
     def ruby_files(root = Dir.pwd)
@@ -270,8 +259,8 @@ module Rubocop
 
       rb = []
 
-      rb << files.select { |file| File.extname(file) == '.rb' }
-      rb << files.select do |file|
+      rb += files.select { |file| File.extname(file) == '.rb' }
+      rb += files.select do |file|
         File.extname(file) == '' &&
         begin
           File.open(file) { |f| f.readline } =~ /#!.*ruby/
@@ -281,13 +270,21 @@ module Rubocop
         end
       end
 
-      rb.flatten
+      rb += files.select do |file|
+        config = ConfigStore.for(file)
+        config.file_to_include?(file)
+      end
+
+      rb.reject do |file|
+        config = ConfigStore.for(file)
+        config.file_to_exclude?(file)
+      end.uniq
     end
 
     private
 
-    def log_error(e, msg='')
-      if $options[:debug]
+    def log_error(e, msg = '')
+      if @options[:debug]
         error_message = "#{e.class}, #{e.message}"
         STDERR.puts "#{msg}\t#{error_message}"
       end