rubocop 0.42.0 → 0.52.1

data/lib/rubocop/cop/variable_force.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -36,7 +35,7 @@ module RuboCop
         :shadowarg # This means block local variable (obj.each { |arg; this| }).
       ].freeze
 
-      LOGICAL_OPERATOR_ASSIGNMENT_TYPES = [:or_asgn, :and_asgn].freeze
+      LOGICAL_OPERATOR_ASSIGNMENT_TYPES = %i[or_asgn and_asgn].freeze
       OPERATOR_ASSIGNMENT_TYPES =
         (LOGICAL_OPERATOR_ASSIGNMENT_TYPES + [:op_asgn]).freeze
 
@@ -44,18 +43,30 @@ module RuboCop
 
       VARIABLE_REFERENCE_TYPE = :lvar
 
-      POST_CONDITION_LOOP_TYPES = [:while_post, :until_post].freeze
-      LOOP_TYPES = (POST_CONDITION_LOOP_TYPES + [:while, :until, :for]).freeze
+      POST_CONDITION_LOOP_TYPES = %i[while_post until_post].freeze
+      LOOP_TYPES = (POST_CONDITION_LOOP_TYPES + %i[while until for]).freeze
 
       RESCUE_TYPE = :rescue
 
       ZERO_ARITY_SUPER_TYPE = :zsuper
 
-      TWISTED_SCOPE_TYPES = [:block, :class, :sclass, :defs].freeze
-      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + [:module, :def]).freeze
+      TWISTED_SCOPE_TYPES = %i[block class sclass defs].freeze
+      SCOPE_TYPES = (TWISTED_SCOPE_TYPES + %i[module def]).freeze
 
       SEND_TYPE = :send
 
+      VariableReference = Struct.new(:name) do
+        def assignment?
+          false
+        end
+      end
+
+      AssignmentReference = Struct.new(:node) do
+        def assignment?
+          true
+        end
+      end
+
       def variable_table
         @variable_table ||= VariableTable.new(self)
       end
@@ -70,6 +81,15 @@ module RuboCop
         variable_table.pop_scope
       end
 
+      def process_node(node)
+        catch(:skip_children) do
+          dispatch_node(node)
+          process_children(node)
+        end
+      end
+
+      private
+
       # This is called for each scope recursively.
       def inspect_variables_in_scope(scope_node)
         variable_table.push_scope(scope_node)
@@ -84,13 +104,6 @@ module RuboCop
         end
       end
 
-      def process_node(node)
-        catch(:skip_children) do
-          dispatch_node(node)
-          process_children(node)
-        end
-      end
-
       def skip_children!
         throw :skip_children
       end
@@ -158,10 +171,7 @@ module RuboCop
 
       def process_regexp_named_captures(node)
         regexp_node, rhs_node = *node
-
-        regexp_string = regexp_node.children[0].children[0]
-        regexp = Regexp.new(regexp_string)
-        variable_names = regexp.named_captures.keys
+        variable_names = regexp_captured_names(regexp_node)
 
         variable_names.each do |name|
           next if variable_table.variable_exist?(name)
@@ -178,6 +188,13 @@ module RuboCop
         skip_children!
       end
 
+      def regexp_captured_names(node)
+        regexp_string = node.children[0].children[0] || ''
+        regexp = Regexp.new(regexp_string)
+
+        regexp.named_captures.keys
+      end
+
       def process_variable_operator_assignment(node)
         if LOGICAL_OPERATOR_ASSIGNMENT_TYPES.include?(node.type)
           asgn_node, rhs_node = *node
@@ -185,7 +202,7 @@ module RuboCop
           asgn_node, _operator, rhs_node = *node
         end
 
-        return unless asgn_node.type == :lvasgn
+        return unless asgn_node.lvasgn_type?
 
         name = asgn_node.children.first
 
@@ -264,7 +281,7 @@ module RuboCop
         if TWISTED_SCOPE_TYPES.include?(node.type)
           # See the comment at the end of file for this behavior.
           twisted_nodes = [node.children[0]]
-          twisted_nodes << node.children[1] if node.type == :class
+          twisted_nodes << node.children[1] if node.class_type?
           twisted_nodes.compact!
 
           twisted_nodes.each do |twisted_node|
@@ -303,7 +320,7 @@ module RuboCop
             next if assignment_nodes_in_loop.none? do |assignment_node|
                       assignment_node.equal?(assignment.node)
                     end
-            assignment.reference!
+            assignment.reference!(node)
           end
         end
       end
@@ -312,23 +329,39 @@ module RuboCop
         referenced_variable_names_in_loop = []
         assignment_nodes_in_loop = []
 
+        each_descendant_reference(loop_node) do |reference|
+          if reference.assignment?
+            assignment_nodes_in_loop << reference.node
+          else
+            referenced_variable_names_in_loop << reference.name
+          end
+        end
+
+        [referenced_variable_names_in_loop, assignment_nodes_in_loop]
+      end
+
+      def each_descendant_reference(loop_node)
         # #each_descendant does not consider scope,
         # but we don't need to care about it here.
         loop_node.each_descendant do |node|
-          case node.type
-          when :lvar
-            referenced_variable_names_in_loop << node.children.first
-          when :lvasgn
-            assignment_nodes_in_loop << node
-          when *OPERATOR_ASSIGNMENT_TYPES
-            asgn_node = node.children.first
-            if asgn_node.type == :lvasgn
-              referenced_variable_names_in_loop << asgn_node.children.first
-            end
-          end
+          reference = descendant_reference(node)
+
+          yield reference if reference
         end
+      end
 
-        [referenced_variable_names_in_loop, assignment_nodes_in_loop]
+      def descendant_reference(node)
+        case node.type
+        when :lvar
+          VariableReference.new(node.children.first)
+        when :lvasgn
+          AssignmentReference.new(node)
+        when *OPERATOR_ASSIGNMENT_TYPES
+          asgn_node = node.children.first
+          if asgn_node.lvasgn_type?
+            VariableReference.new(asgn_node.children.first)
+          end
+        end
       end
 
       # Use Node#equal? for accurate check.
@@ -343,13 +376,13 @@ module RuboCop
       end
 
       # Hooks invoked by VariableTable.
-      [
-        :before_entering_scope,
-        :after_entering_scope,
-        :before_leaving_scope,
-        :after_leaving_scope,
-        :before_declaring_variable,
-        :after_declaring_variable
+      %i[
+        before_entering_scope
+        after_entering_scope
+        before_leaving_scope
+        after_leaving_scope
+        before_declaring_variable
+        after_declaring_variable
       ].each do |hook|
         define_method(hook) do |arg|
           # Invoke hook in cops.

data/lib/rubocop/error.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/formatter/base_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/LineLength
@@ -78,8 +77,7 @@ module RuboCop
       #   all target file paths to be inspected
       #
       # @return [void]
-      def started(target_files)
-      end
+      def started(target_files); end
 
       # @api public
       #
@@ -92,8 +90,7 @@ module RuboCop
       #   file specific information, currently this is always empty.
       #
       # @return [void]
-      def file_started(file, options)
-      end
+      def file_started(file, options); end
 
       # @api public
       #
@@ -108,8 +105,7 @@ module RuboCop
       # @return [void]
       #
       # @see RuboCop::Cop::Offense
-      def file_finished(file, offenses)
-      end
+      def file_finished(file, offenses); end
 
       # @api public
       #
@@ -121,8 +117,7 @@ module RuboCop
       #   unless RuboCop is interrupted by user.
       #
       # @return [void]
-      def finished(inspected_files)
-      end
+      def finished(inspected_files); end
     end
   end
 end

data/lib/rubocop/formatter/clang_style_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -7,7 +6,7 @@ module RuboCop
     # The precise location of the problem is shown together with the
     # relevant source code.
     class ClangStyleFormatter < SimpleTextFormatter
-      ELLIPSES = Rainbow('...').yellow.freeze
+      ELLIPSES = '...'.freeze
 
       def report_file(file, offenses)
         offenses.each { |offense| report_offense(file, offense) }
@@ -42,7 +41,7 @@ module RuboCop
         if location.first_line == location.last_line
           output.puts(source_line)
         else
-          output.puts("#{source_line} #{ELLIPSES}")
+          output.puts("#{source_line} #{yellow(ELLIPSES)}")
         end
       end
 

data/lib/rubocop/formatter/colorizable.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -23,15 +22,15 @@ module RuboCop
         rainbow.wrap(string).color(*args)
       end
 
-      [
-        :black,
-        :red,
-        :green,
-        :yellow,
-        :blue,
-        :magenta,
-        :cyan,
-        :white
+      %i[
+        black
+        red
+        green
+        yellow
+        blue
+        magenta
+        cyan
+        white
       ].each do |color|
         define_method(color) do |string|
           colorize(string, color)

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -19,7 +18,7 @@ module RuboCop
       @config_to_allow_offenses = {}
       @detected_styles = {}
 
-      COPS = Cop::Cop.all.group_by(&:cop_name)
+      COPS = Cop::Cop.registry.to_h
 
       class << self
         attr_accessor :config_to_allow_offenses, :detected_styles
@@ -51,13 +50,11 @@ module RuboCop
         output.puts HEADING % command
 
         # Syntax isn't a real cop and it can't be disabled.
-        @cops_with_offenses.delete('Syntax')
+        @cops_with_offenses.delete('Lint/Syntax')
 
         output_offenses
 
         puts "Created #{output.path}."
-        puts "Run `rubocop --config #{output.path}`, or add `inherit_from: " \
-             "#{output.path}` in a .rubocop.yml file."
       end
 
       private
@@ -67,6 +64,7 @@ module RuboCop
         if @exclude_limit_option
           command += format(' --exclude-limit %d', @exclude_limit_option.to_i)
         end
+        command += ' --no-offense-counts' if @options[:no_offense_counts]
 
         command
       end
@@ -81,14 +79,21 @@ module RuboCop
         output.puts
         cfg = self.class.config_to_allow_offenses[cop_name] || {}
 
-        output_cop_comments(output, cfg, cop_name, offense_count)
-        output_cop_config(output, cfg, cop_name)
+        # To avoid malformed YAML when potentially reading the config in
+        # #excludes, we use an output buffer and append it to the actual output
+        # only when it results in valid YAML.
+        output_buffer = StringIO.new
+        output_cop_comments(output_buffer, cfg, cop_name, offense_count)
+        output_cop_config(output_buffer, cfg, cop_name)
+        output.puts(output_buffer.string)
       end
 
-      def output_cop_comments(output, cfg, cop_name, offense_count)
-        output.puts "# Offense count: #{offense_count}" if @show_offense_counts
+      def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
+        if @show_offense_counts
+          output_buffer.puts "# Offense count: #{offense_count}"
+        end
         if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
-          output.puts '# Cop supports --auto-correct.'
+          output_buffer.puts '# Cop supports --auto-correct.'
         end
 
         default_cfg = default_config(cop_name)
@@ -97,23 +102,26 @@ module RuboCop
         params = cop_config_params(default_cfg, cfg)
         return if params.empty?
 
-        output_cop_param_comments(params, default_cfg)
+        output_cop_param_comments(output_buffer, params, default_cfg)
       end
 
       def cop_config_params(default_cfg, cfg)
         default_cfg.keys -
-          %w(Description StyleGuide Reference Enabled Exclude) -
+          %w[Description StyleGuide Reference Enabled Exclude] -
           cfg.keys
       end
 
-      def output_cop_param_comments(params, default_cfg)
-        output.puts "# Configuration parameters: #{params.join(', ')}."
+      def output_cop_param_comments(output_buffer, params, default_cfg)
+        config_params = params.reject { |p| p.start_with?('Supported') }
+        output_buffer.puts(
+          "# Configuration parameters: #{config_params.join(', ')}."
+        )
 
         params.each do |param|
           value = default_cfg[param]
           if value.is_a?(Array)
             next if value.empty?
-            output.puts "# #{param}: #{value.join(', ')}"
+            output_buffer.puts "# #{param}: #{value.join(', ')}"
           end
         end
       end
@@ -122,35 +130,42 @@ module RuboCop
         RuboCop::ConfigLoader.default_configuration[cop_name]
       end
 
-      def output_cop_config(output, cfg, cop_name)
+      def output_cop_config(output_buffer, cfg, cop_name)
         # 'Enabled' option will be put into file only if exclude
         # limit is exceeded.
         cfg_without_enabled = cfg.reject { |key| key == 'Enabled' }
 
-        output.puts "#{cop_name}:"
+        output_buffer.puts "#{cop_name}:"
         cfg_without_enabled.each do |key, value|
           value = value[0] if value.is_a?(Array)
-          output.puts "  #{key}: #{value}"
+          output_buffer.puts "  #{key}: #{value}"
         end
 
-        output_offending_files(output, cfg_without_enabled, cop_name)
+        output_offending_files(output_buffer, cfg_without_enabled, cop_name)
       end
 
-      def output_offending_files(output, cfg, cop_name)
+      def output_offending_files(output_buffer, cfg, cop_name)
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].uniq.sort
         if offending_files.count > @exclude_limit
-          output.puts '  Enabled: false'
+          output_buffer.puts '  Enabled: false'
         else
-          output_exclude_list(output, offending_files, cop_name)
+          output_exclude_list(output_buffer, offending_files, cop_name)
         end
       end
 
-      def output_exclude_list(output, offending_files, cop_name)
+      def output_exclude_list(output_buffer, offending_files, cop_name)
         require 'pathname'
         parent = Pathname.new(Dir.pwd)
 
+        output_buffer.puts '  Exclude:'
+        excludes(offending_files, cop_name, parent).each do |file|
+          output_exclude_path(output_buffer, file, parent)
+        end
+      end
+
+      def excludes(offending_files, cop_name, parent)
         # Exclude properties in .rubocop_todo.yml override default ones, as well
         # as any custom excludes in .rubocop.yml, so in order to retain those
         # excludes we must copy them.
@@ -158,18 +173,16 @@ module RuboCop
         # just look at the current working directory
         config = ConfigStore.new.for(parent)
         cfg = config[cop_name] || {}
-        excludes = ((cfg['Exclude'] || []) + offending_files).uniq
-
-        output.puts '  Exclude:'
-        excludes.each do |file|
-          file_path = Pathname.new(file)
-          begin
-            relative = file_path.relative_path_from(parent)
-            output.puts "    - '#{relative}'"
-          rescue ArgumentError
-            output.puts "    - '#{file}'"
-          end
-        end
+
+        ((cfg['Exclude'] || []) + offending_files).uniq
+      end
+
+      def output_exclude_path(output_buffer, file, parent)
+        file_path = Pathname.new(file)
+        relative = file_path.relative_path_from(parent)
+        output_buffer.puts "    - '#{relative}'"
+      rescue ArgumentError
+        output_buffer.puts "    - '#{file}'"
       end
     end
   end

data/lib/rubocop/formatter/disabled_lines_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/formatter/file_list_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/formatter/formatter_set.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'fileutils'
@@ -20,10 +19,12 @@ module RuboCop
         'files'    => FileListFormatter,
         'offenses' => OffenseCountFormatter,
         'disabled' => DisabledLinesFormatter,
-        'worst'    => WorstOffendersFormatter
+        'worst'    => WorstOffendersFormatter,
+        'tap'      => TapFormatter,
+        'quiet'    => QuietFormatter
       }.freeze
 
-      FORMATTER_APIS = [:started, :finished].freeze
+      FORMATTER_APIS = %i[started finished].freeze
 
       FORMATTER_APIS.each do |method_name|
         define_method(method_name) do |*args|
@@ -47,15 +48,6 @@ module RuboCop
       end
 
       def add_formatter(formatter_type, output_path = nil)
-        formatter_class = case formatter_type
-                          when Class
-                            formatter_type
-                          when /\A[A-Z]/
-                            custom_formatter_class(formatter_type)
-                          else
-                            builtin_formatter_class(formatter_type)
-                          end
-
         if output_path
           dir_path = File.dirname(output_path)
           FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
@@ -64,7 +56,7 @@ module RuboCop
           output = $stdout
         end
 
-        self << formatter_class.new(output, @options)
+        self << formatter_class(formatter_type).new(output, @options)
       end
 
       def close_output_files
@@ -75,6 +67,17 @@ module RuboCop
 
       private
 
+      def formatter_class(formatter_type)
+        case formatter_type
+        when Class
+          formatter_type
+        when /\A[A-Z]/
+          custom_formatter_class(formatter_type)
+        else
+          builtin_formatter_class(formatter_type)
+        end
+      end
+
       def builtin_formatter_class(specified_key)
         matching_keys = BUILTIN_FORMATTERS_FOR_KEYS.keys.select do |key|
           key.start_with?(specified_key)

data/lib/rubocop/formatter/fuubar_style_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'ruby-progressbar'
@@ -12,6 +11,12 @@ module RuboCop
     class FuubarStyleFormatter < ClangStyleFormatter
       RESET_SEQUENCE = "\e[0m".freeze
 
+      def initialize(*)
+        @severest_offense = nil
+
+        super
+      end
+
       def started(target_files)
         super
 

data/lib/rubocop/formatter/html_formatter.rb

@@ -1,19 +1,18 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'cgi'
 require 'erb'
 require 'ostruct'
 require 'base64'
-require 'rubocop/formatter/text_util'
+require_relative 'text_util'
 
 module RuboCop
   module Formatter
     # This formatter saves the output as an html file.
     class HTMLFormatter < BaseFormatter
       ELLIPSES = '<span class="extra-code">...</span>'.freeze
-      TEMPLATE_PATH = File.expand_path('../../../../assets/output.html.erb',
-                                       __FILE__).encode('utf-8')
+      TEMPLATE_PATH =
+        File.expand_path('../../../../assets/output.html.erb', __FILE__)
 
       Color = Struct.new(:red, :green, :blue, :alpha) do
         def to_s
@@ -62,7 +61,8 @@ module RuboCop
 
       # This class provides helper methods used in the ERB template.
       class ERBContext
-        include PathUtil, TextUtil
+        include PathUtil
+        include TextUtil
 
         SEVERITY_COLORS = {
           refactor:   Color.new(0xED, 0x9C, 0x28, 1.0),

data/lib/rubocop/formatter/json_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'json'
@@ -65,9 +64,15 @@ module RuboCop
       # TODO: Consider better solution for Offense#real_column.
       def hash_for_location(offense)
         {
-          line:   offense.line,
-          column: offense.real_column,
-          length: offense.location.length
+          start_line:        offense.line,
+          start_column:      offense.real_column,
+          last_line:   offense.last_line,
+          last_column: offense.last_column,
+          length:      offense.location.length,
+          # `line` and `column` exist for compatibility.
+          # Use `start_line` and `start_column` instead.
+          line:        offense.line,
+          column:      offense.real_column
         }
       end
     end

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop
@@ -28,6 +27,7 @@ module RuboCop
         report_summary(@offense_counts)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def report_summary(offense_counts)
         per_cop_counts = ordered_offense_counts(offense_counts)
         total_count = total_offense_count(offense_counts)
@@ -43,6 +43,7 @@ module RuboCop
 
         output.puts
       end
+      # rubocop:enable Metrics/AbcSize
 
       def ordered_offense_counts(offense_counts)
         Hash[offense_counts.sort_by { |k, v| [-v, k] }]

data/lib/rubocop/formatter/progress_formatter.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module RuboCop

data/lib/rubocop/formatter/quiet_formatter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # If no offenses are found, no output is displayed.
+    # Otherwise, SimpleTextFormatter's output is displayed.
+    class QuietFormatter < SimpleTextFormatter
+      def report_summary(file_count, offense_count, correction_count)
+        super unless offense_count.zero?
+      end
+    end
+  end
+end