rubocop 0.70.0 → 0.75.0

data/lib/rubocop/cop/variable_force/variable.rb

@@ -37,7 +37,7 @@ module RuboCop
           !@references.empty?
         end
 
-        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
         def reference!(node)
           reference = Reference.new(node, @scope)
           @references << reference
@@ -50,6 +50,13 @@ module RuboCop
               assignment.reference!(node)
             end
 
+            # Modifier if/unless conditions are special. Assignments made in
+            # them do not put the assigned variable in scope to the left of the
+            # if/unless keyword. A preceding assignment is needed to put the
+            # variable in scope. For this reason we skip to the next assignment
+            # here.
+            next if in_modifier_if?(assignment)
+
             break if !assignment.branch || assignment.branch == reference.branch
 
             unless assignment.branch.may_run_incompletely?
@@ -57,7 +64,13 @@ module RuboCop
             end
           end
         end
-        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+        def in_modifier_if?(assignment)
+          parent = assignment.node.parent
+          parent = parent.parent if parent&.begin_type?
+          parent&.if_type? && parent&.modifier_form?
+        end
 
         def capture_with_block!
           @captured_by_block = true

data/lib/rubocop/core_ext/string.rb

@@ -20,28 +20,4 @@ class String
       empty? || strip.empty?
     end
   end
-
-  unless method_defined? :strip_indent
-    # The method strips the whitespace preceding the base indentation.
-    # Useful for HEREDOCs and other multi-line strings.
-    #
-    # @example
-    #
-    #   code = <<~END
-    #     def test
-    #       some_method
-    #       other_method
-    #     end
-    #   END
-    #
-    #   #=> "def\n  some_method\n  \nother_method\nend"
-    #
-    # @todo Replace call sites with squiggly heredocs when required Ruby
-    #   version is >= 2.3.0
-    def strip_indent
-      leading_space = scan(/^[ \t]*(?=\S)/).min
-      indent = leading_space ? leading_space.size : 0
-      gsub(/^[ \t]{#{indent}}/, '')
-    end
-  end
 end

data/lib/rubocop/error.rb

@@ -8,4 +8,27 @@ module RuboCop
   class Error < StandardError; end
 
   class ValidationError < Error; end
+
+  # A wrapper to display errored location of analyzed file.
+  class ErrorWithAnalyzedFileLocation < Error
+    def initialize(cause:, node:, cop:)
+      @cause = cause
+      @cop = cop
+      @location = node.is_a?(RuboCop::AST::Node) ? node.loc : node
+    end
+
+    attr_reader :cause, :cop
+
+    def line
+      @location&.line
+    end
+
+    def column
+      @location&.column
+    end
+
+    def message
+      "cause: #{cause.inspect}"
+    end
+  end
 end

data/lib/rubocop/formatter/emacs_style_formatter.rb

@@ -8,11 +8,14 @@ module RuboCop
     class EmacsStyleFormatter < BaseFormatter
       def file_finished(file, offenses)
         offenses.each do |o|
-          message = if o.corrected?
-                      "[Corrected] #{o.message}"
-                    else
-                      o.message
-                    end
+          message =
+            if o.corrected_with_todo?
+              "[Todo] #{o.message}"
+            elsif o.corrected?
+              "[Corrected] #{o.message}"
+            else
+              o.message
+            end
 
           output.printf("%s:%d:%d: %s: %s\n",
                         file, o.line, o.real_column, o.severity.code,

data/lib/rubocop/formatter/formatter_set.rb

@@ -22,7 +22,8 @@ module RuboCop
         'worst'       => WorstOffendersFormatter,
         'tap'         => TapFormatter,
         'quiet'       => QuietFormatter,
-        'autogenconf' => AutoGenConfigFormatter
+        'autogenconf' => AutoGenConfigFormatter,
+        'pacman'      => PacmanFormatter
       }.freeze
 
       FORMATTER_APIS = %i[started finished].freeze

data/lib/rubocop/formatter/pacman_formatter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Formatter
+    # This formatter prints a PACDOT per every file to be analized.
+    # Pacman will "eat" one PACDOT per file when no offense is detected.
+    # Otherwise it will print a Ghost.
+    # This is inspired by the Pacman formatter for RSpec by Carlos Rojas.
+    # https://github.com/go-labs/rspec_pacman_formatter
+    class PacmanFormatter < ClangStyleFormatter
+      include TextUtil
+      attr_accessor :progress_line
+
+      FALLBACK_TERMINAL_WIDTH = 80
+      GHOST = 'ᗣ'
+      PACMAN = Rainbow('ᗧ').yellow.bright
+      PACDOT = Rainbow('•').yellow.bright
+
+      def initialize(output, options = {})
+        super
+        @progress_line = ''
+        @total_files   = 0
+        @repetitions   = 0
+      end
+
+      def started(target_files)
+        super
+        @total_files = target_files.size
+        output.puts "Eating #{pluralize(target_files.size, 'file')}"
+        update_progress_line
+      end
+
+      def file_started(_file, _options)
+        step(PACMAN)
+      end
+
+      def file_finished(file, offenses)
+        count_stats(offenses) unless offenses.empty?
+        next_step(offenses)
+        report_file(file, offenses)
+      end
+
+      def next_step(offenses)
+        return step('.') if offenses.empty?
+
+        ghost_color = COLOR_FOR_SEVERITY[offenses.last.severity.name]
+        step(colorize(GHOST, ghost_color))
+      end
+
+      def cols
+        @cols ||= begin
+          width = `tput cols`.chomp.to_i
+          width.nil? || width.zero? ? FALLBACK_TERMINAL_WIDTH : width
+        end
+      end
+
+      def update_progress_line
+        return pacdots(@total_files) unless @total_files > cols
+        return pacdots(cols) unless (@total_files / cols).eql?(@repetitions)
+
+        pacdots((@total_files - (cols * @repetitions)))
+      end
+
+      def pacdots(number)
+        @progress_line = PACDOT * number
+      end
+
+      def step(character)
+        regex = /#{Regexp.quote(PACMAN)}|#{Regexp.quote(PACDOT)}/
+        @progress_line = @progress_line.sub(regex, character)
+        output.printf("%s\r", @progress_line)
+        return unless @progress_line[-1] =~ /ᗣ|\./
+
+        @repetitions += 1
+        output.puts
+        update_progress_line
+      end
+    end
+  end
+end

data/lib/rubocop/formatter/simple_text_formatter.rb

@@ -75,7 +75,15 @@ module RuboCop
       end
 
       def message(offense)
-        message = offense.corrected? ? green('[Corrected] ') : ''
+        message =
+          if offense.corrected_with_todo?
+            green('[Todo] ')
+          elsif offense.corrected?
+            green('[Corrected] ')
+          else
+            ''
+          end
+
         "#{message}#{annotate_message(offense.message)}"
       end
 

data/lib/rubocop/formatter/tap_formatter.rb

@@ -63,7 +63,15 @@ module RuboCop
       end
 
       def message(offense)
-        message = offense.corrected? ? '[Corrected] ' : ''
+        message =
+          if offense.corrected_with_todo?
+            '[Todo] '
+          elsif offense.corrected?
+            '[Corrected] '
+          else
+            ''
+          end
+
         "#{message}#{annotate_message(offense.message)}"
       end
     end

data/lib/rubocop/magic_comment.rb

@@ -42,6 +42,10 @@ module RuboCop
       frozen_string_literal == true
     end
 
+    def valid_literal_value?
+      [true, false].include?(frozen_string_literal)
+    end
+
     # Was a magic comment for the frozen string literal found?
     #
     # @return [Boolean]

data/lib/rubocop/node_pattern.rb

@@ -47,6 +47,11 @@ module RuboCop
   #                         # a `sym` node, but can have more.
   #     '(array <$str $_>)' # captures are in the order of the pattern,
   #                         # irrespective of the actual order of the children
+  #     '(array int*)'      # will match an array of 0 or more integers
+  #     '(array int ?)'     # will match 0 or 1 integer.
+  #                         # Note: Space needed to distinguish from int?
+  #     '(array int+)'      # will match an array of 1 or more integers
+  #     '(array (int $_)+)' # as above and will capture the numbers in an array
   #     '(send $...)'       # capture all the children as an array
   #     '(send $... int)'   # capture all children but the last as an array
   #     '(send _x :+ _x)'   # unification is performed on named wildcards
@@ -106,7 +111,9 @@ module RuboCop
     class Compiler
       SYMBOL       = %r{:(?:[\w+@*/?!<>=~|%^-]+|\[\]=?)}.freeze
       IDENTIFIER   = /[a-zA-Z_][a-zA-Z0-9_-]*/.freeze
-      META         = Regexp.union(%w"( ) { } [ ] $< < > $... $ ! ^ ...").freeze
+      META         = Regexp.union(
+        %w"( ) { } [ ] $< < > $... $ ! ^ ... + * ?"
+      ).freeze
       NUMBER       = /-?\d+(?:\.\d+)?/.freeze
       STRING       = /".+?"/.freeze
       METHOD_NAME  = /\#?#{IDENTIFIER}[\!\?]?\(?/.freeze
@@ -160,6 +167,21 @@ module RuboCop
       RUBY
       ANY_ORDER_TEMPLATE.location = [__FILE__, line + 1]
 
+      line = __LINE__
+      REPEATED_TEMPLATE = ERB.new <<~RUBY.gsub("-%>\n", '%>')
+        <% if captured %>(<%= accumulate %> = Array.new) && <% end %>
+        <%= CUR_NODE %>.children[<%= range %>].all? do |<%= child %>|
+          <%= with_context(expr, child, use_temp_node: false) %><% if captured %>&&
+          <%= accumulate %>.push(<%= captured %>)<% end %>
+        end <% if captured %>&&
+        (<%= captured %> = if <%= accumulate %>.empty?
+          <%= captured %>.map{[]} # Transpose hack won't work for empty case
+        else
+          <%= accumulate %>.transpose
+        end) <% end -%>
+      RUBY
+      REPEATED_TEMPLATE.location = [__FILE__, line + 1]
+
       def initialize(str, node_var = 'node0')
         @string   = str
         @root     = node_var
@@ -238,10 +260,48 @@ module RuboCop
         when REST          then compile_ellipsis
         when '$<'          then compile_any_order(next_capture)
         when '<'           then compile_any_order
-        else                    [1, compile_expr(token)]
+        else                    compile_repeated_expr(token)
+        end
+      end
+
+      def compile_repeated_expr(token)
+        before = @captures
+        expr = compile_expr(token)
+        min, max = parse_repetition_token
+        return [1, expr] if min.nil?
+
+        if @captures != before
+          captured = "captures[#{before}...#{@captures}]"
+          accumulate = next_temp_variable(:accumulate)
+        end
+        arity = min..max || Float::INFINITY
+
+        [arity, repeated_generator(expr, captured, accumulate)]
+      end
+
+      def repeated_generator(expr, captured, accumulate)
+        with_temp_variables do |child|
+          lambda do |range|
+            if range.begin == SEQ_HEAD_INDEX
+              fail_due_to 'repeated pattern at beginning of sequence'
+            end
+            REPEATED_TEMPLATE.result(binding)
+          end
         end
       end
 
+      def parse_repetition_token
+        case tokens.first
+        when '*' then min = 0
+        when '+' then min = 1
+        when '?' then min = 0
+                      max = 1
+        else          return
+        end
+        tokens.shift
+        [min, max]
+      end
+
       # @private
       # Builds Ruby code for a sequence
       # (head *first_terms variadic_term *last_terms)
@@ -276,6 +336,10 @@ module RuboCop
           last_terms_range { |r| @arities[r].inject(0, :+) } || 0
         end
 
+        def variadic_term_min_arity
+          @variadic_index ? @arities[@variadic_index].begin : 0
+        end
+
         def first_terms_range
           yield 1..(@variadic_index || @terms.size) - 1 if seq_head?
         end
@@ -289,8 +353,19 @@ module RuboCop
         end
 
         def compile_child_nb_guard
-          min = first_terms_arity + last_terms_arity
-          "#{CUR_NODE}.children.size #{@variadic_index ? '>' : '='}= #{min}"
+          fixed = first_terms_arity + last_terms_arity
+          min = fixed + variadic_term_min_arity
+          op = if @variadic_index
+                 max_variadic = @arities[@variadic_index].end
+                 if max_variadic != Float::INFINITY
+                   range = min..fixed + max_variadic
+                   return "(#{range}).cover?(#{CUR_NODE}.children.size)"
+                 end
+                 '>='
+               else
+                 '=='
+               end
+          "#{CUR_NODE}.children.size #{op} #{min}"
         end
 
         def term(index, range)
@@ -537,7 +612,7 @@ module RuboCop
       end
 
       def emit_method_code
-        <<-RUBY
+        <<~RUBY
           return unless #{@match_code}
           block_given? ? #{emit_yield_capture} : (return #{emit_retval})
         RUBY
@@ -555,10 +630,14 @@ module RuboCop
       end
 
       def with_temp_variables(&block)
-        names = block.parameters.map { |_, name| "#{name}#{next_temp_value}" }
+        names = block.parameters.map { |_, name| next_temp_variable(name) }
         yield(*names)
       end
 
+      def next_temp_variable(name)
+        "#{name}#{next_temp_value}"
+      end
+
       def next_temp_value
         @temps += 1
       end
@@ -667,7 +746,7 @@ module RuboCop
 
       def node_search_body(method_name, trailing_params, prelude, match_code,
                            on_match)
-        <<-RUBY
+        <<~RUBY
           def #{method_name}(node0#{trailing_params})
             #{prelude}
             node0.each_node do |node|

data/lib/rubocop/options.rb

@@ -109,6 +109,8 @@ module RuboCop
         @validator.validate_exclude_limit_option
       end
 
+      option(opts, '--disable-uncorrectable')
+
       option(opts, '--no-offense-counts') do
         @options[:no_offense_counts] = true
       end
@@ -159,7 +161,6 @@ module RuboCop
       option(opts, '-D', '--[no-]display-cop-names')
       option(opts, '-E', '--extra-details')
       option(opts, '-S', '--display-style-guide')
-      option(opts, '-R', '--rails')
       option(opts, '-a', '--auto-correct')
       option(opts, '--ignore-disable-comments')
 
@@ -254,6 +255,7 @@ module RuboCop
       @options = options
     end
 
+    # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_unneeded_disable?
         raise OptionArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
@@ -271,6 +273,7 @@ module RuboCop
           '--display-only-fail-level-offenses'
       end
       validate_auto_gen_config
+      validate_auto_correct
       validate_parallel
 
       return if incompatible_options.size <= 1
@@ -278,6 +281,7 @@ module RuboCop
       raise OptionArgumentError, 'Incompatible cli options: ' \
                                  "#{incompatible_options.inspect}"
     end
+    # rubocop:enable Metrics/AbcSize
 
     def validate_auto_gen_config
       return if @options.key?(:auto_gen_config)
@@ -293,6 +297,15 @@ module RuboCop
       end
     end
 
+    def validate_auto_correct
+      return if @options.key?(:auto_correct)
+      return unless @options.key?(:disable_uncorrectable)
+
+      raise OptionArgumentError,
+            format('--%<flag>s can only be used together with --auto-correct.',
+                   flag: '--disable-uncorrectable')
+    end
+
     def validate_parallel
       return unless @options.key?(:parallel)
 
@@ -379,6 +392,9 @@ module RuboCop
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],
+      disable_uncorrectable:            ['Used with --auto-correct to annotate any',
+                                         'offenses that do not support autocorrect',
+                                         'with `rubocop:todo` comments.'],
       force_exclusion:                  ['Force excluding files specified in the',
                                          'configuration `Exclude` even if they are',
                                          'explicitly passed as arguments.'],
@@ -396,6 +412,7 @@ module RuboCop
                                          '  [c]lang',
                                          '  [d]isabled cops via inline comments',
                                          '  [fu]ubar',
+                                         '  [pa]cman',
                                          '  [e]macs',
                                          '  [j]son',
                                          '  [h]tml',
@@ -429,7 +446,6 @@ module RuboCop
                                          'Default is true.'],
       display_style_guide:              'Display style guide URLs in offense messages.',
       extra_details:                    'Display extra details in offense messages.',
-      rails:                            'Run extra Rails cops.',
       lint:                             'Run only lint cops.',
       safe:                             'Run only safe cops.',
       list_target_files:                'List all files RuboCop will inspect.',