rubocop 0.20.1 → 0.21.0

data/lib/rubocop/cop/{variable_inspector → variable_force}/variable.rb

@@ -2,7 +2,7 @@
 
 module Rubocop
   module Cop
-    module VariableInspector
+    class VariableForce
       # A Variable represents existance of a local variable.
       # This holds a variable declaration node,
       # and some states of the variable.
@@ -11,7 +11,7 @@ module Rubocop
           (VARIABLE_ASSIGNMENT_TYPES + DECLARATION_TYPES).freeze
 
         attr_reader :name, :declaration_node, :scope,
-                    :assignments, :captured_by_block
+                    :assignments, :references, :captured_by_block
         alias_method :captured_by_block?, :captured_by_block
 
         def initialize(name, declaration_node, scope)
@@ -26,6 +26,7 @@ module Rubocop
           @scope = scope
 
           @assignments = []
+          @references = []
           @captured_by_block = false
         end
 
@@ -34,11 +35,12 @@ module Rubocop
         end
 
         def referenced?
-          @assignments.any?(&:referenced?)
+          !@references.empty?
         end
 
         def reference!(node)
           reference = Reference.new(node, @scope)
+          @references << reference
           consumed_branch_ids = Set.new
 
           @assignments.reverse_each do |assignment|
@@ -74,8 +76,16 @@ module Rubocop
           @captured_by_block || referenced?
         end
 
+        def argument?
+          ARGUMENT_DECLARATION_TYPES.include?(@declaration_node.type)
+        end
+
         def method_argument?
-          METHOD_ARGUMENT_DECLARATION_TYPES.include?(@declaration_node.type)
+          argument? && [:def, :defs].include?(@scope.node.type)
+        end
+
+        def block_argument?
+          argument? && @scope.node.type == :block
         end
 
         def block_local_variable?

data/lib/rubocop/cop/{variable_inspector → variable_force}/variable_table.rb

@@ -2,7 +2,7 @@
 
 module Rubocop
   module Cop
-    module VariableInspector
+    class VariableForce
       # A VariableTable manages the lifetime of all scopes and local variables
       # in a program.
       # This holds scopes as stack structure, and provides a way to add local

data/lib/rubocop/file_inspector.rb

@@ -109,7 +109,9 @@ module Rubocop
         cop_classes = Cop::Cop.all
 
         if @options[:only]
-          cop_classes.select! { |c| c.cop_name == @options[:only] }
+          cop_classes.select! do |c|
+            @options[:only].include?(c.cop_name) || @options[:lint] && c.lint?
+          end
         else
           # filter out Rails cops unless requested
           cop_classes.reject!(&:rails?) unless run_rails_cops?(config)

data/lib/rubocop/formatter/base_formatter.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# rubocop:disable LineLength
+# rubocop:disable LineLength, UnusedMethodArgument
 
 module Rubocop
   module Formatter

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -22,12 +22,12 @@ module Rubocop
         attr_accessor :config_to_allow_offenses
       end
 
-      def file_finished(file, offenses)
+      def file_finished(_file, offenses)
         @cops_with_offenses ||= Hash.new(0)
         offenses.each { |o| @cops_with_offenses[o.cop_name] += 1 }
       end
 
-      def finished(inspected_files)
+      def finished(_inspected_files)
         output.puts HEADING
 
         # Syntax isn't a real cop and it can't be disabled.

data/lib/rubocop/formatter/disabled_lines_formatter.rb

@@ -9,7 +9,7 @@ module Rubocop
 
       attr_reader :cop_disabled_line_ranges
 
-      def started(target_files)
+      def started(_target_files)
         @cop_disabled_line_ranges = {}
       end
 
@@ -20,7 +20,7 @@ module Rubocop
           options[:cop_disabled_line_ranges]
       end
 
-      def finished(inspected_files)
+      def finished(_inspected_files)
         cops_disabled_in_comments_summary
       end
 

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -19,25 +19,26 @@ module Rubocop
         @offense_counts = Hash.new(0)
       end
 
-      def file_finished(file, offenses)
+      def file_finished(_file, offenses)
         offenses.each { |o| @offense_counts[o.cop_name] += 1 }
       end
 
-      def finished(inspected_files)
-        report_summary(inspected_files.count,
-                       ordered_offense_counts(@offense_counts))
+      def finished(_inspected_files)
+        report_summary(@offense_counts)
       end
 
-      def report_summary(file_count, offense_counts)
+      def report_summary(offense_counts)
+        per_cop_counts = ordered_offense_counts(offense_counts)
+        total_count = total_offense_count(offense_counts)
+
         output.puts
 
-        offense_count = total_offense_count(offense_counts)
-        offense_counts.each do |cop_name, count|
-          output.puts "#{count.to_s.ljust(offense_count.to_s.length + 2)}" \
+        per_cop_counts.each do |cop_name, count|
+          output.puts "#{count.to_s.ljust(total_count.to_s.length + 2)}" \
                       "#{cop_name}\n"
         end
         output.puts '--'
-        output.puts "#{offense_count}  Total"
+        output.puts "#{total_count}  Total"
 
         output.puts
       end
@@ -46,7 +47,7 @@ module Rubocop
         Hash[offense_counts.sort_by { |k, v| [-v, k] }]
       end
 
-      def total_offense_count(offense_counts = {})
+      def total_offense_count(offense_counts)
         offense_counts.values.inject(0, :+)
       end
     end

data/lib/rubocop/formatter/progress_formatter.rb

@@ -19,7 +19,7 @@ module Rubocop
           @offenses_for_files[file] = offenses
         end
 
-        report_file_as_mark(file, offenses)
+        report_file_as_mark(offenses)
       end
 
       def finished(inspected_files)
@@ -40,7 +40,7 @@ module Rubocop
                        @total_correction_count)
       end
 
-      def report_file_as_mark(file, offenses)
+      def report_file_as_mark(offenses)
         mark = if offenses.empty?
                  green('.')
                else

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -19,7 +19,7 @@ module Rubocop
         fatal:      :red
       }.freeze
 
-      def started(target_files)
+      def started(_target_files)
         @total_offense_count = 0
         @total_correction_count = 0
       end

data/lib/rubocop/options.rb

@@ -3,6 +3,49 @@
 require 'optparse'
 
 module Rubocop
+  # This module contains help texts for command line options.
+  module OptionsHelp
+    TEXT = {
+      only:              'Run only the given cop(s).',
+      require:           'Require Ruby file.',
+      config:            'Specify configuration file.',
+      auto_gen_config:  ['Generate a configuration file acting as a',
+                         'TODO list.'],
+      force_exclusion:  ['Force excluding files specified in the',
+                         'configuration `Exclude` even if they are',
+                         'explicitly passed as arguments.'],
+      format:           ['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',
+                         '  [d]isabled cops via inline comments',
+                         '  [fu]ubar',
+                         '  [e]macs',
+                         '  [j]son',
+                         '  [fi]les',
+                         '  [o]ffenses',
+                         '  custom formatter class name'],
+      out:              ['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.'],
+      fail_level:        'Minimum severity for exit with error code.',
+      show_cops:        ['Shows the given cops, or all cops by',
+                         'default, and their configurations for the',
+                         'current directory.'],
+      debug:             'Display debug info.',
+      display_cop_names: 'Display cop names in offense messages.',
+      rails:             'Run extra Rails cops.',
+      lint:              'Run only lint cops.',
+      auto_correct:      'Auto-correct offenses.',
+      no_color:          'Disable color output.',
+      version:           'Display version.',
+      verbose_version:   'Display verbose version.'
+    }
+  end
+
   # This class handles command line options.
   class Options
     DEFAULT_FORMATTER = 'progress'
@@ -19,16 +62,15 @@ module Rubocop
       OptionParser.new do |opts|
         opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
 
-        option(opts, '--only COP', 'Run just one cop.') do
+        option(opts, '--only [COP1,COP2,...]') do |list|
+          @options[:only] = list.split(',')
           validate_only_option
         end
 
         add_configuration_options(opts, args)
-        add_formatting_options(opts, args)
+        add_formatting_options(opts)
 
-        option(opts, '-r', '--require FILE', 'Require Ruby file.') do |f|
-          require f
-        end
+        option(opts, '-r', '--require FILE') { |f| require f }
 
         add_severity_option(opts)
         add_flags_with_optional_args(opts)
@@ -45,93 +87,65 @@ module Rubocop
     private
 
     def add_configuration_options(opts, args)
-      option(opts, '-c', '--config FILE', 'Specify configuration file.')
+      option(opts, '-c', '--config FILE')
 
-      option(opts, '--auto-gen-config',
-             'Generate a configuration file acting as a', 'TODO list.') do
+      option(opts, '--auto-gen-config') do
         validate_auto_gen_config_option(args)
         @options[:formatters] = [[DEFAULT_FORMATTER],
                                  [Formatter::DisabledConfigFormatter,
                                   ConfigLoader::AUTO_GENERATED_FILE]]
       end
 
-      option(opts, '--force-exclusion',
-             'Force excluding files specified in the',
-             'configuration `Exclude` even if they are',
-             'explicitly passed as arguments.')
+      option(opts, '--force-exclusion')
     end
 
-    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',
-                   '  [d]isabled cops via inline comments',
-                   '  [fu]ubar',
-                   '  [e]macs',
-                   '  [j]son',
-                   '  [fi]les',
-                   '  [o]ffenses',
-                   '  custom formatter class name']
-
-    def add_formatting_options(opts, args)
-      option(opts, '-f', '--format FORMATTER', *FORMAT_HELP) do |key|
+    def add_formatting_options(opts)
+      option(opts, '-f', '--format FORMATTER') 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|
+      option(opts, '-o', '--out FILE') do |path|
         @options[:formatters] ||= [[DEFAULT_FORMATTER]]
         @options[:formatters].last << path
       end
     end
 
     def add_severity_option(opts)
-      opts.on('--fail-level SEVERITY',
-              Rubocop::Cop::Severity::NAMES,
-              Rubocop::Cop::Severity::CODE_TABLE,
-              'Minimum severity for exit with error code.') do |severity|
-                @options[:fail_level] = severity
-              end
+      option(opts, '--fail-level SEVERITY',
+             Rubocop::Cop::Severity::NAMES,
+             Rubocop::Cop::Severity::CODE_TABLE) do |severity|
+        @options[:fail_level] = severity
+      end
     end
 
     def add_flags_with_optional_args(opts)
-      option(opts, '--show-cops [cop1,cop2,...]',
-             'Shows the given cops, or all cops by',
-             'default, and their configurations for the',
-             'current directory.') do |list|
+      option(opts, '--show-cops [COP1,COP2,...]') do |list|
         @options[:show_cops] = list.nil? ? [] : list.split(',')
       end
     end
 
     def add_boolean_flags(opts)
-      option(opts, '-d', '--debug', 'Display debug info.')
-      option(opts,
-             '-D', '--display-cop-names',
-             'Display cop names in offense messages.')
-      option(opts, '-R', '--rails', 'Run extra Rails cops.')
-      option(opts, '-l', '--lint', 'Run only lint cops.')
-      option(opts, '-a', '--auto-correct', 'Auto-correct offenses.')
+      option(opts, '-d', '--debug')
+      option(opts, '-D', '--display-cop-names')
+      option(opts, '-R', '--rails')
+      option(opts, '-l', '--lint')
+      option(opts, '-a', '--auto-correct')
 
       @options[:color] = true
-      opts.on('-n', '--no-color', 'Disable color output.') do
-        @options[:color] = false
-      end
+      option(opts, '-n', '--no-color') { @options[:color] = false }
 
-      option(opts, '-v', '--version', 'Display version.')
-      option(opts, '-V', '--verbose-version', 'Display verbose version.')
+      option(opts, '-v', '--version')
+      option(opts, '-V', '--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)
+      long_opt_symbol = long_opt_symbol(args)
+      args += Array(OptionsHelp::TEXT[long_opt_symbol])
       opts.on(*args) do |arg|
-        @options[long_opt_symbol(args)] = arg
+        @options[long_opt_symbol] = arg
         yield arg if block_given?
       end
     end
@@ -174,8 +188,10 @@ module Rubocop
     end
 
     def validate_only_option
-      if Cop::Cop.all.none? { |c| c.cop_name == @options[:only] }
-        fail ArgumentError, "Unrecognized cop name: #{@options[:only]}."
+      @options[:only].each do |cop_to_run|
+        if Cop::Cop.all.none? { |c| c.cop_name == cop_to_run }
+          fail ArgumentError, "Unrecognized cop name: #{cop_to_run}."
+        end
       end
     end
 

data/lib/rubocop/path_util.rb

@@ -10,11 +10,26 @@ module Rubocop
       path_name.relative_path_from(Pathname.new(base_dir)).to_s
     end
 
-    def match_path?(pattern, path)
+    # TODO: The old way of matching patterns is flawed, so a new one has been
+    # introduced. We keep supporting the old way for a while and issue
+    # deprecation warnings when a pattern is used that produced a match with
+    # the old way but doesn't match with the new.
+    def match_path?(pattern, path, config_path)
       case pattern
       when String
         basename = File.basename(path)
-        path == pattern || basename == pattern || File.fnmatch(pattern, path)
+        old_match = basename == pattern || File.fnmatch?(pattern, path)
+        new_match = File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+        if old_match && !new_match
+          instruction = if basename == pattern
+                          ". Change to '**/#{pattern}'."
+                        elsif pattern.end_with?('**')
+                          ". Change to '#{pattern}/*'."
+                        end
+          warn("Warning: Deprecated pattern style '#{pattern}' in " \
+               "#{config_path}#{instruction}")
+        end
+        old_match || new_match
       when Regexp
         path =~ pattern
       end

data/lib/rubocop/rake_task.rb

@@ -27,24 +27,30 @@ module Rubocop
           if task_block
             task_block.call(*[self, task_args].slice(0, task_block.arity))
           end
-          run_task(verbose)
+          run_main_task(verbose)
         end
       end
+
+      setup_subtasks(name)
+    end
+
+    def run_main_task(verbose)
+      run_cli(verbose, full_options)
     end
 
-    def run_task(verbose)
+    private
+
+    def run_cli(verbose, options)
       # 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(full_options)
+      result = cli.run(options)
       abort('RuboCop failed!') if fail_on_error unless result == 0
     end
 
-    private
-
     def full_options
       [].tap do |result|
         result.concat(formatters.map { |f| ['--format', f] }.flatten)
@@ -66,5 +72,17 @@ module Rubocop
       @options = []
       @formatters = [Rubocop::Options::DEFAULT_FORMATTER]
     end
+
+    def setup_subtasks(name)
+      namespace name do
+
+        desc 'Auto-correct RuboCop offenses'
+
+        task :auto_correct do
+          options = full_options.unshift('--auto-correct')
+          run_cli(verbose, options)
+        end
+      end
+    end
   end
 end