rubocop 0.89.1 → 0.93.0

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

@@ -27,11 +27,12 @@ module RuboCop
       #
       #   # bad
       #   %w[foo bar baz]
-      class WordArray < Cop
+      class WordArray < Base
         include ArrayMinSize
         include ArraySyntax
         include ConfigurableEnforcedStyle
         include PercentArray
+        extend AutoCorrector
 
         PERCENT_MSG = 'Use `%w` or `%W` for an array of words.'
         ARRAY_MSG = 'Use `[]` for an array of words.'
@@ -44,31 +45,14 @@ module RuboCop
           if bracketed_array_of?(:str, node)
             return if complex_content?(node.values)
 
-            check_bracketed_array(node)
+            check_bracketed_array(node, 'w')
           elsif node.percent_literal?(:string)
             check_percent_array(node)
           end
         end
 
-        def autocorrect(node)
-          if style == :percent
-            PercentLiteralCorrector
-              .new(@config, @preferred_delimiters)
-              .correct(node, 'w')
-          else
-            correct_bracketed(node)
-          end
-        end
-
         private
 
-        def check_bracketed_array(node)
-          return if allowed_bracket_array?(node)
-
-          array_style_detected(:brackets, node.values.size)
-          add_offense(node) if style == :percent
-        end
-
         def complex_content?(strings)
           strings.any? do |s|
             string = s.str_content.dup.force_encoding(::Encoding::UTF_8)
@@ -81,7 +65,7 @@ module RuboCop
           Regexp.new(cop_config['WordRegex'])
         end
 
-        def correct_bracketed(node)
+        def correct_bracketed(corrector, node)
           words = node.children.map do |word|
             if word.dstr_type?
               string_literal = to_string_literal(word.source)
@@ -92,9 +76,7 @@ module RuboCop
             end
           end
 
-          lambda do |corrector|
-            corrector.replace(node, "[#{words.join(', ')}]")
-          end
+          corrector.replace(node, "[#{words.join(', ')}]")
         end
       end
     end

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

@@ -52,9 +52,10 @@ module RuboCop
       #   # good
       #   99 == foo
       #   "bar" != foo
-      class YodaCondition < Cop
+      class YodaCondition < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Reverse the order of the operands `%<source>s`.'
 
@@ -80,11 +81,7 @@ module RuboCop
           return if equality_only? && non_equality_operator?(node) ||
                     file_constant_equal_program_name?(node)
 
-          valid_yoda?(node) || add_offense(node)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
+          valid_yoda?(node) || add_offense(node) do |corrector|
             corrector.replace(actual_code_range(node), corrected_code(node))
           end
         end
@@ -157,15 +154,7 @@ module RuboCop
         def interpolation?(node)
           return true if node.dstr_type?
 
-          # TODO: Use `RegexpNode#interpolation?` when the following is released.
-          # https://github.com/rubocop-hq/rubocop-ast/pull/18
-          if node.regexp_type?
-            return true if node.children.any? do |child|
-              child.respond_to?(:begin_type?) && child.begin_type?
-            end
-          end
-
-          false
+          node.regexp_type? && node.interpolation?
         end
       end
     end

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

@@ -25,29 +25,23 @@ module RuboCop
       #   !{a: 1, b: 2}.empty?
       #   !string.empty?
       #   !hash.empty?
-      class ZeroLengthPredicate < Cop
+      class ZeroLengthPredicate < Base
+        extend AutoCorrector
+
         ZERO_MSG = 'Use `empty?` instead of `%<lhs>s %<opr>s %<rhs>s`.'
         NONZERO_MSG = 'Use `!empty?` instead of ' \
                       '`%<lhs>s %<opr>s %<rhs>s`.'
 
-        LENGTH_METHODS = %i[size length].freeze
+        RESTRICT_ON_SEND = %i[size length].freeze
 
         def on_send(node)
           check_zero_length_predicate(node)
           check_nonzero_length_predicate(node)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node, replacement(node))
-          end
-        end
-
         private
 
         def check_zero_length_predicate(node)
-          return unless LENGTH_METHODS.include?(node.method_name)
-
           zero_length_predicate = zero_length_predicate(node.parent)
           return unless zero_length_predicate
 
@@ -56,14 +50,13 @@ module RuboCop
           return if non_polymorphic_collection?(node.parent)
 
           add_offense(
-            node.parent,
-            message: format(ZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
-          )
+            node.parent, message: format(ZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          ) do |corrector|
+            corrector.replace(node.parent, replacement(node.parent))
+          end
         end
 
         def check_nonzero_length_predicate(node)
-          return unless LENGTH_METHODS.include?(node.method_name)
-
           nonzero_length_predicate = nonzero_length_predicate(node.parent)
           return unless nonzero_length_predicate
 
@@ -72,9 +65,10 @@ module RuboCop
           return if non_polymorphic_collection?(node.parent)
 
           add_offense(
-            node.parent,
-            message: format(NONZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
-          )
+            node.parent, message: format(NONZERO_MSG, lhs: lhs, opr: opr, rhs: rhs)
+          ) do |corrector|
+            corrector.replace(node.parent, replacement(node.parent))
+          end
         end
 
         def_node_matcher :zero_length_predicate, <<~PATTERN

data/lib/rubocop/cop/team.rb

@@ -117,6 +117,7 @@ module RuboCop
       def autocorrect(processed_source, report)
         @updated_source_file = false
         return unless autocorrect?
+        return if report.processed_source.parser_error
 
         new_source = autocorrect_report(report)
 

data/lib/rubocop/cop/util.rb

@@ -5,7 +5,6 @@ module RuboCop
     # This module contains a collection of useful utility methods.
     module Util
       include PathUtil
-      include TokensUtil
 
       # Match literal regex characters, not including anchors, character
       # classes, alternatives, groups, repetitions, references, etc
@@ -19,7 +18,7 @@ module RuboCop
         /^\s*#/.match?(line_source)
       end
 
-      # @deprecated Use `ProcessedSource#line_with_comment?`, `contains_comment` or similar
+      # @deprecated Use `ProcessedSource#line_with_comment?`, `contains_comment?` or similar
       def comment_lines?(node)
         processed_source[line_range(node)].any? { |line| comment_line?(line) }
       end

data/lib/rubocop/cop/utils/format_string.rb

@@ -111,11 +111,9 @@ module RuboCop
         private
 
         def parse
-          @source.to_enum(:scan, SEQUENCE).map do
-            FormatSequence.new(
-              Regexp.last_match
-            )
-          end
+          matches = []
+          @source.scan(SEQUENCE) { matches << FormatSequence.new(Regexp.last_match) }
+          matches
         end
 
         def mixed_formats?

data/lib/rubocop/cop/variable_force.rb

@@ -22,6 +22,8 @@ module RuboCop
     #
     #     def after_declaring_variable(variable, variable_table)
     #     end
+    #
+    # @api private
     class VariableForce < Force # rubocop:disable Metrics/ClassLength
       VARIABLE_ASSIGNMENT_TYPE = :lvasgn
       REGEXP_NAMED_CAPTURE_TYPE = :match_with_lvasgn

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

@@ -20,8 +20,6 @@ module RuboCop
           nil
         end
 
-        # rubocop:disable Metrics/BlockLength
-
         # Abstract base class for branch classes.
         # A branch represents a conditional branch in a scope.
         #
@@ -42,8 +40,6 @@ module RuboCop
         #     do_something     # no branch
         #   end
         Base = Struct.new(:child_node, :scope) do
-          # rubocop:enable Metrics/BlockLength
-
           def self.classes
             @classes ||= []
           end

data/lib/rubocop/cops_documentation_generator.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 # Class for generating documentation of all cops departments
+# @api private
 class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
+  include ::RuboCop::Cop::Documentation
   # This class will only generate documentation for cops that belong to one of
   # the departments given in the `departments` array. E.g. if we only wanted
   # documentation for Lint cops:
@@ -210,7 +212,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
     selected_cops.each do |cop|
       content << print_cop_with_doc(cop)
     end
-    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/cops_#{department.downcase}.adoc"
+    file_name = "#{Dir.pwd}/docs/modules/ROOT/pages/#{department_to_basename(department)}.adoc"
     File.open(file_name, 'w') do |file|
       puts "* generated #{file_name}"
       file.write("#{content.strip}\n")
@@ -243,7 +245,7 @@ class CopsDocumentationGenerator # rubocop:disable Metrics/ClassLength
 
   def table_of_content_for_department(department)
     type_title = department[0].upcase + department[1..-1]
-    filename = "cops_#{department.downcase}.adoc"
+    filename = "#{department_to_basename(department)}.adoc"
     content = +"=== Department xref:#{filename}[#{type_title}]\n\n"
     cops_of_department(department).each do |cop|
       anchor = cop.cop_name.sub('/', '').downcase

data/lib/rubocop/core_ext/string.rb

@@ -2,7 +2,7 @@
 
 # Extensions to the core String class
 class String
-  unless method_defined? :blank?
+  unless method_defined?(:blank?) && ' '.blank?
     # Checks whether a string is blank. A string is considered blank if it
     # is either empty or contains only whitespace characters.
     #
@@ -17,7 +17,7 @@ class String
     # @example
     #   '  test'.blank? #=> false
     def blank?
-      empty? || strip.empty?
+      empty? || lstrip.empty?
     end
   end
 end

data/lib/rubocop/directive_comment.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class wraps the `Parser::Source::Comment` object that represents a
+  # special `rubocop:disable` and `rubocop:enable` comment and exposes what
+  # cops it contains.
+  class DirectiveComment
+    attr_reader :comment
+
+    def initialize(comment)
+      @comment = comment
+    end
+
+    # Return all the cops specified in the directive
+    def cops
+      match = comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP)
+      return unless match
+
+      cops_string = match.captures[1]
+      cops_string.split(/,\s*/).uniq.sort
+    end
+
+    # Checks if this directive contains all the given cop names
+    def match?(cop_names)
+      cops == cop_names.uniq.sort
+    end
+
+    def range
+      comment.location.expression
+    end
+  end
+end

data/lib/rubocop/ext/regexp_node.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Ext
+    # Extensions to AST::RegexpNode for our cached parsed regexp info
+    module RegexpNode
+      ANY = Object.new
+      def ANY.==(_)
+        true
+      end
+      private_constant :ANY
+
+      class << self
+        attr_reader :parsed_cache
+      end
+      @parsed_cache = {}
+
+      # @return [Regexp::Expression::Root, nil]
+      def parsed_tree
+        str = with_interpolations_blanked
+        Ext::RegexpNode.parsed_cache[str] ||= begin
+          Regexp::Parser.parse(str, options: options)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def each_capture(named: ANY)
+        return enum_for(__method__, named: named) unless block_given?
+
+        parsed_tree&.traverse do |event, exp, _index|
+          yield(exp) if event == :enter &&
+                        named == exp.respond_to?(:name) &&
+                        exp.respond_to?(:capturing?) &&
+                        exp.capturing?
+        end
+
+        self
+      end
+
+      private
+
+      def with_interpolations_blanked
+        # Ignore the trailing regopt node
+        children[0...-1].map do |child|
+          source = child.source
+
+          # We don't want to consider the contents of interpolations as part of the pattern source,
+          # but need to preserve their width, to allow offsets to correctly line up with the
+          # original source: spaces have no effect, and preserve width.
+          if child.begin_type?
+            ' ' * source.length
+          else
+            source
+          end
+        end.join
+      end
+
+      AST::RegexpNode.include self
+    end
+  end
+end

data/lib/rubocop/file_finder.rb

@@ -4,6 +4,7 @@ require 'pathname'
 
 module RuboCop
   # Common methods for finding files.
+  # @api private
   module FileFinder
     def self.root_level=(level)
       @root_level = level

data/lib/rubocop/formatter/auto_gen_config_formatter.rb

@@ -9,7 +9,8 @@ module RuboCop
 
         report_summary(inspected_files.size,
                        @total_offense_count,
-                       @total_correction_count)
+                       @total_correction_count,
+                       @total_correctable_count)
       end
     end
   end

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -32,7 +32,6 @@ module RuboCop
         @exclude_limit_option = @options[:exclude_limit]
         @exclude_limit = Integer(@exclude_limit_option ||
           RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS)
-        @show_offense_counts = !@options[:no_offense_counts]
       end
 
       def file_finished(file, offenses)
@@ -56,6 +55,14 @@ module RuboCop
 
       private
 
+      def show_timestamp?
+        @options.fetch(:auto_gen_timestamp, true)
+      end
+
+      def show_offense_counts?
+        @options.fetch(:offense_counts, true)
+      end
+
       def command
         command = 'rubocop --auto-gen-config'
 
@@ -66,15 +73,15 @@ module RuboCop
             format(' --exclude-limit %<limit>d',
                    limit: Integer(@exclude_limit_option))
         end
-        command += ' --no-offense-counts' if @options[:no_offense_counts]
+        command += ' --no-offense-counts' unless show_offense_counts?
 
-        command += ' --no-auto-gen-timestamp' if @options[:no_auto_gen_timestamp]
+        command += ' --no-auto-gen-timestamp' unless show_timestamp?
 
         command
       end
 
       def timestamp
-        @options[:no_auto_gen_timestamp] ? '' : "on #{Time.now.utc} "
+        show_timestamp? ? "on #{Time.now.utc} " : ''
       end
 
       def output_offenses
@@ -112,7 +119,7 @@ module RuboCop
       end
 
       def output_cop_comments(output_buffer, cfg, cop_name, offense_count)
-        output_buffer.puts "# Offense count: #{offense_count}" if @show_offense_counts
+        output_buffer.puts "# Offense count: #{offense_count}" if show_offense_counts?
 
         cop_class = Cop::Registry.global.find_by_cop_name(cop_name)
         output_buffer.puts '# Cop supports --auto-correct.' if cop_class&.support_autocorrect?