rubocop 1.35.1 → 1.37.0

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

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Checks for redundant escapes in string literals.
+      #
+      # @example
+      #   # bad - no need to escape # without following {/$/@
+      #   "\#foo"
+      #
+      #   # bad - no need to escape single quotes inside double quoted string
+      #   "\'foo\'"
+      #
+      #   # bad - heredocs are also checked for unnecessary escapes
+      #   <<~STR
+      #     \#foo \"foo\"
+      #   STR
+      #
+      #   # good
+      #   "#foo"
+      #
+      #   # good
+      #   "\#{no_interpolation}"
+      #
+      #   # good
+      #   "'foo'"
+      #
+      #   # good
+      #   "foo\
+      #   bar"
+      #
+      #   # good
+      #   <<~STR
+      #     #foo "foo"
+      #   STR
+      class RedundantStringEscape < Base
+        include MatchRange
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Redundant escape of %<char>s inside string literal.'
+
+        def on_str(node)
+          return if node.parent&.regexp_type? || node.parent&.xstr_type?
+
+          str_contents_range = str_contents_range(node)
+          return unless str_contents_range.source.include?('\\')
+
+          each_match_range(str_contents_range, /(\\.)/) do |range|
+            next if allowed_escape?(node, range.resize(3))
+
+            add_offense(range) do |corrector|
+              corrector.remove_leading(range, 1)
+            end
+          end
+        end
+
+        private
+
+        def message(range)
+          format(MSG, char: range.source.chars.last)
+        end
+
+        def str_contents_range(node)
+          if heredoc?(node)
+            node.loc.heredoc_body
+          elsif begin_loc_present?(node)
+            contents_range(node)
+          else
+            node.loc.expression
+          end
+        end
+
+        def begin_loc_present?(node)
+          # e.g. a __FILE__ literal has no begin loc so we can't query if it's nil
+          node.loc.to_hash.key?(:begin) && !node.loc.begin.nil?
+        end
+
+        def allowed_escape?(node, range)
+          escaped = range.source[(1..-1)]
+
+          # Inside a single-quoted string, escapes (except \\ and \') do not have special meaning,
+          # and so are not redundant, as they are a literal backslash.
+          return true if interpolation_not_enabled?(node)
+
+          # Strictly speaking a few single-letter chars are currently unnecessary to "escape", e.g.
+          # d, but enumerating them is rather difficult, and their behavior could change over time
+          # with different versions of Ruby so that e.g. /\d/ != /d/
+          return true if /[\n\\[[:alnum:]]]/.match?(escaped[0])
+
+          return true if escaped[0] == ' ' && percent_array_literal?(node)
+
+          # Allow #{foo}, #$foo, #@foo, and #@@foo for escaping local, global, instance and class
+          # variable interpolations inside
+          return true if /\A#[{$@]/.match?(escaped)
+          return true if delimiter?(node, escaped[0])
+
+          false
+        end
+
+        def interpolation_not_enabled?(node)
+          single_quoted?(node) ||
+            percent_w_literal?(node) ||
+            percent_q_literal?(node) ||
+            heredoc_with_disabled_interpolation?(node)
+        end
+
+        def single_quoted?(node)
+          delimiter?(node, "'")
+        end
+
+        def percent_q_literal?(node)
+          if literal_in_interpolated_or_multiline_string?(node)
+            percent_q_literal?(node.parent)
+          else
+            node.source.start_with?('%q')
+          end
+        end
+
+        def array_literal?(node, prefix)
+          if literal_in_interpolated_or_multiline_string?(node)
+            array_literal?(node.parent, prefix)
+          else
+            node.parent&.array_type? && node.parent.source.start_with?(prefix)
+          end
+        end
+
+        def percent_w_literal?(node)
+          array_literal?(node, '%w')
+        end
+
+        def percent_w_upper_literal?(node)
+          array_literal?(node, '%W')
+        end
+
+        def percent_array_literal?(node)
+          (percent_w_literal?(node) || percent_w_upper_literal?(node))
+        end
+
+        def heredoc_with_disabled_interpolation?(node)
+          if heredoc?(node)
+            node.loc.expression.source.end_with?("'")
+          elsif node.parent&.dstr_type?
+            heredoc_with_disabled_interpolation?(node.parent)
+          else
+            false
+          end
+        end
+
+        def heredoc?(node)
+          (node.str_type? || node.dstr_type?) && node.heredoc?
+        end
+
+        def delimiter?(node, char)
+          return false if heredoc?(node)
+
+          if literal_in_interpolated_or_multiline_string?(node) || percent_array_literal?(node)
+            return delimiter?(node.parent, char)
+          end
+
+          delimiters = [node.loc.begin.source[-1], node.loc.end.source[0]]
+
+          delimiters.include?(char)
+        end
+
+        def literal_in_interpolated_or_multiline_string?(node)
+          node.str_type? && !begin_loc_present?(node) && node.parent&.dstr_type?
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module RuboCop
       # reasons:
       #
       # * The syntax of modifier form `rescue` can be misleading because it
-      #   might led us to believe that `rescue` handles the given exception
+      #   might lead us to believe that `rescue` handles the given exception
       #   but it actually rescue all exceptions to return the given rescue
       #   block. In this case, value returned by handle_error or
       #   SomeException.

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

@@ -44,18 +44,49 @@ module RuboCop
       #   end
       #
       class StaticClass < Base
+        include RangeHelp
         include VisibilityHelp
+        extend AutoCorrector
 
         MSG = 'Prefer modules to classes with only class methods.'
 
         def on_class(class_node)
           return if class_node.parent_class
+          return unless class_convertible_to_module?(class_node)
 
-          add_offense(class_node) if class_convertible_to_module?(class_node)
+          add_offense(class_node) do |corrector|
+            autocorrect(corrector, class_node)
+          end
         end
 
         private
 
+        def autocorrect(corrector, class_node)
+          corrector.replace(class_node.loc.keyword, 'module')
+          corrector.insert_after(class_node.loc.name, "\nmodule_function\n")
+
+          class_elements(class_node).each do |node|
+            if node.defs_type?
+              autocorrect_def(corrector, node)
+            elsif node.sclass_type?
+              autocorrect_sclass(corrector, node)
+            end
+          end
+        end
+
+        def autocorrect_def(corrector, node)
+          corrector.remove(
+            range_between(node.receiver.source_range.begin_pos, node.loc.name.begin_pos)
+          )
+        end
+
+        def autocorrect_sclass(corrector, node)
+          corrector.remove(
+            range_between(node.loc.keyword.begin_pos, node.identifier.source_range.end_pos)
+          )
+          corrector.remove(node.loc.end)
+        end
+
         def class_convertible_to_module?(class_node)
           nodes = class_elements(class_node)
           return false if nodes.empty?

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

@@ -65,6 +65,8 @@ module RuboCop
         end
 
         def build_bracketed_array(node)
+          return '[]' if node.children.empty?
+
           syms = node.children.map do |c|
             if c.dsym_type?
               string_literal = to_string_literal(c.source)

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

@@ -11,10 +11,11 @@ module RuboCop
       # These are customizable with `AllowedMethods` option.
       #
       # @safety
-      #   This cop is unsafe because `proc`s and blocks work differently
-      #   when additional arguments are passed in. A block will silently
-      #   allow additional arguments, but a `proc` will raise
-      #   an `ArgumentError`.
+      #   This cop is unsafe because there is a difference that a `Proc`
+      #   generated from `Symbol#to_proc` behaves as a lambda, while
+      #   a `Proc` generated from a block does not.
+      #   For example, a lambda will raise an `ArgumentError` if the
+      #   number of arguments is wrong, but a non-lambda `Proc` will not.
       #
       #   For example:
       #
@@ -81,7 +82,7 @@ module RuboCop
       #   # bad
       #   something.map { |s| s.upcase }
       #
-      # @example AllowedPatterns: [/map/] (default)
+      # @example AllowedPatterns: ['map'] (default)
       #   # good
       #   something.map { |s| s.upcase }
       #

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

@@ -83,6 +83,8 @@ module RuboCop
         end
 
         def build_bracketed_array(node)
+          return '[]' if node.children.empty?
+
           words = node.children.map do |word|
             if word.dstr_type?
               string_literal = to_string_literal(word.source)

data/lib/rubocop/formatter/disabled_config_formatter.rb

@@ -70,7 +70,9 @@ module RuboCop
 
         command += ' --auto-gen-only-exclude' if @options[:auto_gen_only_exclude]
 
-        if @exclude_limit_option
+        if no_exclude_limit?
+          command += ' --no-exclude-limit'
+        elsif @exclude_limit_option
           command += format(' --exclude-limit %<limit>d', limit: Integer(@exclude_limit_option))
         end
         command += ' --no-offense-counts' unless show_offense_counts?
@@ -187,7 +189,7 @@ module RuboCop
         return unless cfg.empty?
 
         offending_files = @files_with_offenses[cop_name].sort
-        if offending_files.count > @exclude_limit
+        if !no_exclude_limit? && offending_files.count > @exclude_limit
           output_buffer.puts '  Enabled: false'
         else
           output_exclude_list(output_buffer, offending_files, cop_name)
@@ -245,6 +247,10 @@ module RuboCop
       def safe_autocorrect?(config)
         config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true)
       end
+
+      def no_exclude_limit?
+        @options[:no_exclude_limit] == false
+      end
     end
   end
 end

data/lib/rubocop/options.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'optparse'
-require 'shellwords'
+require_relative 'arguments_env'
+require_relative 'arguments_file'
 
 module RuboCop
   class IncorrectCopNameError < StandardError; end
@@ -24,7 +25,10 @@ module RuboCop
     end
 
     def parse(command_line_args)
+      args_from_file = ArgumentsFile.read_as_arguments
+      args_from_env = ArgumentsEnv.read_as_arguments
       args = args_from_file.concat(args_from_env).concat(command_line_args)
+
       define_options.parse!(args)
 
       @validator.validate_compatibility
@@ -45,18 +49,6 @@ module RuboCop
 
     private
 
-    def args_from_file
-      if File.exist?('.rubocop') && !File.directory?('.rubocop')
-        File.read('.rubocop').shellsplit
-      else
-        []
-      end
-    end
-
-    def args_from_env
-      Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
-    end
-
     def define_options
       OptionParser.new do |opts|
         opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
@@ -169,6 +161,7 @@ module RuboCop
         end
 
         option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
+        option(opts, '--no-exclude-limit')
 
         option(opts, '--[no-]offense-counts')
         option(opts, '--[no-]auto-gen-only-exclude')
@@ -400,6 +393,12 @@ module RuboCop
     end
 
     def validate_autocorrect
+      if @options.key?(:safe_autocorrect) && @options.key?(:autocorrect_all)
+        message = Rainbow(<<~MESSAGE).red
+          Error: Both safe and unsafe autocorrect options are specified, use only one.
+        MESSAGE
+        raise OptionArgumentError, message
+      end
       return if @options.key?(:autocorrect)
       return unless @options.key?(:disable_uncorrectable)
 
@@ -497,6 +496,7 @@ module RuboCop
       disable_uncorrectable:            ['Used with --autocorrect to annotate any',
                                          'offenses that do not support autocorrect',
                                          'with `rubocop:todo` comments.'],
+      no_exclude_limit:                 ['Do not set the limit for how many files to exclude.'],
       force_exclusion:                  ['Any files excluded by `Exclude` in configuration',
                                          'files will be excluded, even if given explicitly',
                                          'as arguments.'],

data/lib/rubocop/rspec/shared_contexts.rb

@@ -2,7 +2,15 @@
 
 require 'tmpdir'
 
-RSpec.shared_context 'isolated environment' do
+RSpec.shared_context 'isolated environment' do # rubocop:disable Metrics/BlockLength
+  before do
+    if RuboCop.const_defined?(:Server)
+      # Bust server cache to behave as an isolated environment
+      RuboCop::Server::Cache.cache_root_path = nil
+      RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+    end
+  end
+
   around do |example|
     Dir.mktmpdir do |tmpdir|
       original_home = Dir.home
@@ -32,6 +40,10 @@ RSpec.shared_context 'isolated environment' do
         ENV['HOME'] = original_home
         ENV['XDG_CONFIG_HOME'] = original_xdg_config_home
 
+        if RuboCop.const_defined?(:Server)
+          RuboCop::Server::Cache.cache_root_path = nil
+          RuboCop::Server::Cache.instance_variable_set(:@project_dir_cache_key, nil)
+        end
         RuboCop::FileFinder.root_level = nil
       end
     end

data/lib/rubocop/runner.rb

@@ -64,6 +64,10 @@ module RuboCop
     # instances that each inspects its allotted group of files.
     def warm_cache(target_files)
       saved_options = @options.dup
+      if target_files.length <= 1
+        puts 'Skipping parallel inspection: only a single file needs inspection' if @options[:debug]
+        return
+      end
       puts 'Running parallel inspection' if @options[:debug]
       %i[autocorrect safe_autocorrect].each { |opt| @options[opt] = false }
       Parallel.each(target_files) { |target_file| file_offenses(target_file) }

data/lib/rubocop/server/cache.rb

@@ -103,9 +103,13 @@ module RuboCop
           dir.join('version')
         end
 
+        def stderr_path
+          dir.join('stderr')
+        end
+
         def pid_running?
           Process.kill(0, pid_path.read.to_i) == 1
-        rescue Errno::ESRCH
+        rescue Errno::ESRCH, Errno::ENOENT
           false
         end
 

data/lib/rubocop/server/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'rainbow'
+require_relative '../arguments_env'
+require_relative '../arguments_file'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -29,7 +31,7 @@ module RuboCop
         @exit = false
       end
 
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
       def run(argv = ARGV)
         unless Server.support_server?
           return error('RuboCop server is not supported by this Ruby.') if use_server_option?(argv)
@@ -50,11 +52,16 @@ module RuboCop
           return error("#{server_command} cannot be combined with other options.")
         end
 
+        if server_command.nil?
+          server_command = ArgumentsEnv.read_as_arguments.delete('--server') ||
+                           ArgumentsFile.read_as_arguments.delete('--server')
+        end
+
         run_command(server_command)
 
         STATUS_SUCCESS
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
       def exit?
         @exit

data/lib/rubocop/server/client_command/exec.rb

@@ -23,6 +23,7 @@ module RuboCop
             args: ARGV.dup,
             body: $stdin.tty? ? '' : $stdin.read
           )
+          warn stderr unless stderr.empty?
           status
         end
 
@@ -43,6 +44,10 @@ module RuboCop
           RuboCop::Version::STRING != Cache.version_path.read
         end
 
+        def stderr
+          Cache.stderr_path.read
+        end
+
         def status
           unless Cache.status_path.file?
             raise "RuboCop server: Could not find status file at: #{Cache.status_path}"

data/lib/rubocop/server/core.rb

@@ -56,7 +56,8 @@ module RuboCop
       def start_server(host, port)
         @server = TCPServer.open(host, port)
 
-        puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
+        output_stream = ARGV.include?('--stderr') ? $stderr : $stdout
+        output_stream.puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
       end
 
       def read_socket(socket)

data/lib/rubocop/server/socket_reader.rb

@@ -24,13 +24,17 @@ module RuboCop
       def read!
         request = parse_request(@socket.read)
 
+        stderr = StringIO.new
         Helper.redirect(
           stdin: StringIO.new(request.body),
           stdout: @socket,
-          stderr: @socket
+          stderr: stderr
         ) do
           create_command_instance(request).run
         end
+      ensure
+        Cache.stderr_path.write(stderr.string)
+        @socket.close
       end
 
       private

data/lib/rubocop/server.rb

@@ -33,7 +33,7 @@ module RuboCop
       def running?
         return false unless support_server? # Never running.
 
-        Cache.dir.exist? && Cache.pid_path.file? && Cache.pid_running?
+        Cache.pid_running?
       end
 
       def wait_for_running_status!(expected)

data/lib/rubocop/version.rb

@@ -3,11 +3,11 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.35.1'
+    STRING = '1.37.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \
-          'running on %<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'
+          'running on %<ruby_engine>s %<ruby_version>s)%<server_mode>s [%<ruby_platform>s]'
 
     CANONICAL_FEATURE_NAMES = { 'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown',
                                 'Thread_safety' => 'ThreadSafety' }.freeze
@@ -19,6 +19,7 @@ module RuboCop
         verbose_version = format(MSG, version: STRING, parser_version: Parser::VERSION,
                                       rubocop_ast_version: RuboCop::AST::Version::STRING,
                                       ruby_engine: RUBY_ENGINE, ruby_version: RUBY_VERSION,
+                                      server_mode: server_mode,
                                       ruby_platform: RUBY_PLATFORM)
         return verbose_version unless env
 
@@ -88,5 +89,10 @@ module RuboCop
     def self.document_version
       STRING.match('\d+\.\d+').to_s
     end
+
+    # @api private
+    def self.server_mode
+      RuboCop.const_defined?(:Server) && Server.running? ? ' +server' : ''
+    end
   end
 end

data/lib/rubocop.rb

@@ -292,6 +292,7 @@ require_relative 'rubocop/cop/lint/duplicate_branch'
 require_relative 'rubocop/cop/lint/duplicate_case_condition'
 require_relative 'rubocop/cop/lint/duplicate_elsif_condition'
 require_relative 'rubocop/cop/lint/duplicate_hash_key'
+require_relative 'rubocop/cop/lint/duplicate_magic_comment'
 require_relative 'rubocop/cop/lint/duplicate_methods'
 require_relative 'rubocop/cop/lint/duplicate_regexp_character_class_element'
 require_relative 'rubocop/cop/lint/duplicate_require'
@@ -537,6 +538,7 @@ require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
 require_relative 'rubocop/cop/style/multiline_in_pattern_then'
 require_relative 'rubocop/cop/style/numbered_parameters'
 require_relative 'rubocop/cop/style/open_struct_use'
+require_relative 'rubocop/cop/style/operator_method_call'
 require_relative 'rubocop/cop/style/redundant_assignment'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
@@ -612,6 +614,7 @@ require_relative 'rubocop/cop/style/redundant_return'
 require_relative 'rubocop/cop/style/redundant_self'
 require_relative 'rubocop/cop/style/redundant_sort'
 require_relative 'rubocop/cop/style/redundant_sort_by'
+require_relative 'rubocop/cop/style/redundant_string_escape'
 require_relative 'rubocop/cop/style/regexp_literal'
 require_relative 'rubocop/cop/style/rescue_modifier'
 require_relative 'rubocop/cop/style/rescue_standard_error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.35.1
+  version: 1.37.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,7 +120,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: 1.22.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.20.1
+        version: 1.22.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -207,6 +207,8 @@ files:
 - config/obsoletion.yml
 - exe/rubocop
 - lib/rubocop.rb
+- lib/rubocop/arguments_env.rb
+- lib/rubocop/arguments_file.rb
 - lib/rubocop/ast_aliases.rb
 - lib/rubocop/cache_config.rb
 - lib/rubocop/cached_data.rb
@@ -430,6 +432,7 @@ files:
 - lib/rubocop/cop/lint/duplicate_case_condition.rb
 - lib/rubocop/cop/lint/duplicate_elsif_condition.rb
 - lib/rubocop/cop/lint/duplicate_hash_key.rb
+- lib/rubocop/cop/lint/duplicate_magic_comment.rb
 - lib/rubocop/cop/lint/duplicate_methods.rb
 - lib/rubocop/cop/lint/duplicate_regexp_character_class_element.rb
 - lib/rubocop/cop/lint/duplicate_require.rb
@@ -795,6 +798,7 @@ files:
 - lib/rubocop/cop/style/object_then.rb
 - lib/rubocop/cop/style/one_line_conditional.rb
 - lib/rubocop/cop/style/open_struct_use.rb
+- lib/rubocop/cop/style/operator_method_call.rb
 - lib/rubocop/cop/style/option_hash.rb
 - lib/rubocop/cop/style/optional_arguments.rb
 - lib/rubocop/cop/style/optional_boolean_parameter.rb
@@ -831,6 +835,7 @@ files:
 - lib/rubocop/cop/style/redundant_self_assignment_branch.rb
 - lib/rubocop/cop/style/redundant_sort.rb
 - lib/rubocop/cop/style/redundant_sort_by.rb
+- lib/rubocop/cop/style/redundant_string_escape.rb
 - lib/rubocop/cop/style/regexp_literal.rb
 - lib/rubocop/cop/style/rescue_modifier.rb
 - lib/rubocop/cop/style/rescue_standard_error.rb
@@ -977,7 +982,7 @@ metadata:
   homepage_uri: https://rubocop.org/
   changelog_uri: https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.35/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.37/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: