rubocop 0.91.0 → 1.0.0

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

@@ -142,10 +142,22 @@ module RuboCop
         end
 
         def comments(node)
-          processed_source.each_comment_in_lines(
-            node.loc.first_line...
-            node.loc.last_line
-          ).to_a
+          relevant_comment_ranges(node).each.with_object([]) do |range, comments|
+            comments.concat(processed_source.each_comment_in_lines(range).to_a)
+          end
+        end
+
+        def relevant_comment_ranges(node)
+          # Get source lines ranges inside the if node that aren't inside an inner node
+          # Comments inside an inner node should remain attached to that node, and not
+          # moved.
+          begin_pos = node.loc.first_line
+          end_pos = node.loc.last_line
+
+          node.child_nodes.each.with_object([]) do |child, ranges|
+            ranges << (begin_pos...child.loc.first_line)
+            begin_pos = child.loc.last_line
+          end << (begin_pos...end_pos)
         end
 
         def allowed_if_condition?(node)

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

@@ -33,6 +33,10 @@ module RuboCop
           }
         PATTERN
 
+        def on_new_investigation
+          @corrected_nodes = nil
+        end
+
         def on_send(node)
           return unless string_concatenation?(node)
 
@@ -42,8 +46,12 @@ module RuboCop
           collect_parts(topmost_plus_node, parts)
 
           add_offense(topmost_plus_node) do |corrector|
-            if parts.none? { |part| uncorrectable?(part) }
+            correctable_parts = parts.none? { |part| uncorrectable?(part) }
+            if correctable_parts && !corrected_ancestor?(topmost_plus_node)
               corrector.replace(topmost_plus_node, replacement(parts))
+
+              @corrected_nodes ||= Set.new.compare_by_identity
+              @corrected_nodes.add(topmost_plus_node)
             end
           end
         end
@@ -80,6 +88,10 @@ module RuboCop
             part.each_descendant(:block).any?
         end
 
+        def corrected_ancestor?(node)
+          node.each_ancestor(:send).any? { |ancestor| @corrected_nodes&.include?(ancestor) }
+        end
+
         def replacement(parts)
           interpolated_parts =
             parts.map do |part|
@@ -87,7 +99,7 @@ module RuboCop
                 if single_quoted?(part)
                   part.value.gsub('\\') { '\\\\' }
                 else
-                  escape_string(part.value)
+                  part.value.inspect[1..-2]
                 end
               else
                 "\#{#{part.source}}"

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

@@ -192,7 +192,7 @@ module RuboCop
         end
 
         def_node_matcher :method_name, <<~PATTERN
-          {($:defined? (send nil? _) ...)
+          {($:defined? _ ...)
            (send {_ nil?} $_ _ ...)}
         PATTERN
 
@@ -211,8 +211,7 @@ module RuboCop
         end
 
         def whitespace_after?(node)
-          index = index_of_last_token(node)
-          last_token = processed_source.tokens[index]
+          last_token = processed_source.last_token_of(node)
           last_token.space_after?
         end
       end

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

@@ -76,12 +76,13 @@ module RuboCop
         end
 
         def argument_tokens(node)
-          pipes = tokens(node).select { |token| token.type == :tPIPE }
+          tokens = processed_source.tokens_within(node)
+          pipes = tokens.select { |token| token.type == :tPIPE }
           begin_pos, end_pos = pipes.map do |pipe|
-            tokens(node).index(pipe)
+            tokens.index(pipe)
           end
 
-          tokens(node)[begin_pos + 1..end_pos - 1]
+          tokens[begin_pos + 1..end_pos - 1]
         end
       end
     end

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

@@ -36,6 +36,8 @@ module RuboCop
         MSG = 'Do not use trailing `_`s in parallel assignment. ' \
               'Prefer `%<code>s`.'
         UNDERSCORE = '_'
+        DISALLOW = %i[lvasgn splat].freeze
+        private_constant :DISALLOW
 
         def on_masgn(node)
           ranges = unneeded_ranges(node)
@@ -64,7 +66,7 @@ module RuboCop
 
         def find_first_possible_offense(variables)
           variables.reduce(nil) do |offense, variable|
-            break offense unless %i[lvasgn splat].include?(variable.type)
+            break offense unless DISALLOW.include?(variable.type)
 
             var, = *variable
             var, = *var

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

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/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

@@ -17,11 +17,9 @@ module RuboCop
 
       # @return [Regexp::Expression::Root, nil]
       def parsed_tree
-        return if interpolation?
-
-        str = content
+        str = with_interpolations_blanked
         Ext::RegexpNode.parsed_cache[str] ||= begin
-          Regexp::Parser.parse(str)
+          Regexp::Parser.parse(str, options: options)
         rescue StandardError
           nil
         end
@@ -40,6 +38,24 @@ module RuboCop
         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

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?

data/lib/rubocop/formatter/offense_count_formatter.rb

@@ -67,7 +67,7 @@ module RuboCop
       end
 
       def total_offense_count(offense_counts)
-        offense_counts.values.inject(0, :+)
+        offense_counts.values.sum
       end
     end
   end

data/lib/rubocop/formatter/worst_offenders_formatter.rb

@@ -55,7 +55,7 @@ module RuboCop
       end
 
       def total_offense_count(offense_counts)
-        offense_counts.values.inject(0, :+)
+        offense_counts.values.sum
       end
     end
   end

data/lib/rubocop/options.rb

@@ -114,20 +114,19 @@ module RuboCop
     def add_auto_gen_options(opts)
       option(opts, '--auto-gen-config')
 
+      option(opts, '--regenerate-todo') do
+        @options.replace(ConfigRegeneration.new.options.merge(@options))
+      end
+
       option(opts, '--exclude-limit COUNT') do
         @validator.validate_exclude_limit_option
       end
 
       option(opts, '--disable-uncorrectable')
 
-      option(opts, '--no-offense-counts') do
-        @options[:no_offense_counts] = true
-      end
-
-      option(opts, '--auto-gen-only-exclude')
-      option(opts, '--no-auto-gen-timestamp') do
-        @options[:no_auto_gen_timestamp] = true
-      end
+      option(opts, '--[no-]offense-counts')
+      option(opts, '--[no-]auto-gen-only-exclude')
+      option(opts, '--[no-]auto-gen-timestamp')
 
       option(opts, '--init')
     end
@@ -243,6 +242,9 @@ module RuboCop
   # @api private
   class OptionsValidator
     class << self
+      SYNTAX_DEPARTMENTS = %w[Syntax Lint/Syntax].freeze
+      private_constant :SYNTAX_DEPARTMENTS
+
       # Cop name validation must be done later than option parsing, so it's not
       # called from within Options.
       def validate_cop_list(names)
@@ -254,7 +256,7 @@ module RuboCop
         names.each do |name|
           next if cop_names.include?(name)
           next if departments.include?(name)
-          next if %w[Syntax Lint/Syntax].include?(name)
+          next if SYNTAX_DEPARTMENTS.include?(name)
 
           raise IncorrectCopNameError, format_message_from(name, cop_names)
         end
@@ -318,7 +320,7 @@ module RuboCop
 
       message = '--%<flag>s can only be used together with --auto-gen-config.'
 
-      %i[exclude_limit no_offense_counts no_auto_gen_timestamp
+      %i[exclude_limit offense_counts auto_gen_timestamp
          auto_gen_only_exclude].each do |option|
         if @options.key?(option)
           raise OptionArgumentError,
@@ -423,17 +425,20 @@ module RuboCop
       config:                           'Specify configuration file.',
       auto_gen_config:                  ['Generate a configuration file acting as a',
                                          'TODO list.'],
-      no_offense_counts:                ['Do not include offense counts in configuration',
-                                         'file generated by --auto-gen-config.'],
-      no_auto_gen_timestamp:
-                                        ['Do not include the date and time when',
-                                         'the --auto-gen-config was run in the file it',
-                                         'generates.'],
+      regenerate_todo:                  ['Regenerate the TODO configuration file using',
+                                         'the last configuration. If there is no existing',
+                                         'TODO file, acts like --auto-gen-config.'],
+      offense_counts:                   ['Include offense counts in configuration',
+                                         'file generated by --auto-gen-config.',
+                                         'Default is true.'],
+      auto_gen_timestamp:
+                                        ['Include the date and time when the --auto-gen-config',
+                                         'was run in the file it generates. Default is true.'],
       auto_gen_only_exclude:
                                         ['Generate only Exclude parameters and not Max',
                                          'when running --auto-gen-config, except if the',
                                          'number of files with offenses is bigger than',
-                                         'exclude-limit.'],
+                                         'exclude-limit. Default is false.'],
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],

data/lib/rubocop/result_cache.rb

@@ -95,6 +95,11 @@ module RuboCop
                         context_checksum(team, options),
                         file_checksum(file, config_store))
       @cached_data = CachedData.new(file)
+      @debug = options[:debug]
+    end
+
+    def debug?
+      @debug
     end
 
     def valid?
@@ -102,6 +107,7 @@ module RuboCop
     end
 
     def load
+      puts "Loading cache from #{@path}" if debug?
       @cached_data.from_json(IO.read(@path, encoding: Encoding::UTF_8))
     end
 
@@ -209,8 +215,8 @@ module RuboCop
     # The external dependency checksums are cached per RuboCop team so that
     # the checksums don't need to be recomputed for each file.
     def team_checksum(team)
-      @checksum_by_team ||= {}
-      @checksum_by_team[team.object_id] ||= team.external_dependency_checksum
+      @checksum_by_team ||= {}.compare_by_identity
+      @checksum_by_team[team] ||= team.external_dependency_checksum
     end
 
     # We combine team and options into a single "context" checksum to avoid

data/lib/rubocop/rspec/cop_helper.rb

@@ -26,7 +26,7 @@ module CopHelper
   end
 
   def parse_source(source, file = nil)
-    if file&.respond_to?(:write)
+    if file.respond_to?(:write)
       file.write(source)
       file.rewind
       file = file.path

data/lib/rubocop/rspec/expect_offense.rb

@@ -133,14 +133,14 @@ module RuboCop
             "#{@processed_source.diagnostics.map(&:render).join("\n")}"
         end
 
-        offenses = _investigate(cop, @processed_source)
+        @offenses = _investigate(cop, @processed_source)
         actual_annotations =
-          expected_annotations.with_offense_annotations(offenses)
+          expected_annotations.with_offense_annotations(@offenses)
 
         expect(actual_annotations).to eq(expected_annotations), ''
-        expect(offenses.map(&:severity).uniq).to eq([severity]) if severity
+        expect(@offenses.map(&:severity).uniq).to eq([severity]) if severity
 
-        offenses
+        @offenses
       end
 
       def expect_correction(correction, loop: true)
@@ -157,7 +157,7 @@ module RuboCop
           break corrected_source if corrected_source == @processed_source.buffer.source
 
           if iteration > RuboCop::Runner::MAX_ITERATIONS
-            raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [])
+            raise RuboCop::Runner::InfiniteCorrectionLoop.new(@processed_source.path, [@offenses])
           end
 
           # Prepare for next loop