rubocop 1.44.1 → 1.45.0

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

@@ -45,9 +45,9 @@ module RuboCop
             node
           else
             child_index = case node.type
-                          when :module, :sclass     then 1
-                          when :def, :class, :block then 2
-                          when :defs                then 3
+                          when :module, :sclass then 1
+                          when :def, :class, :block, :numblock then 2
+                          when :defs then 3
                           end
 
             node.children[child_index]

data/lib/rubocop/options.rb

@@ -61,6 +61,9 @@ module RuboCop
         add_config_generation_options(opts)
         add_additional_modes(opts)
         add_general_options(opts)
+
+        # `stackprof` is not supported on JRuby and Windows.
+        add_profile_options(opts) if RUBY_ENGINE == 'ruby' && !Platform.windows?
       end
     end
 
@@ -206,6 +209,7 @@ module RuboCop
         option(opts, '--start-server')
         option(opts, '--stop-server')
         option(opts, '--server-status')
+        option(opts, '--no-detach')
       end
     end
 
@@ -233,6 +237,16 @@ module RuboCop
       end
     end
 
+    def add_profile_options(opts)
+      section(opts, 'Profiling Options') do
+        option(opts, '--profile') do
+          @options[:profile] = true
+          @options[:cache] = 'false' unless @options.key?(:cache)
+        end
+        option(opts, '--memory')
+      end
+    end
+
     def handle_deprecated_option(old_option, new_option)
       warn rainbow.wrap("#{old_option} is deprecated; use #{new_option} instead.").yellow
       @options[long_opt_symbol([new_option])] = @options.delete(long_opt_symbol([old_option]))
@@ -424,6 +438,8 @@ module RuboCop
     def invalid_arguments_for_parallel
       [('--auto-gen-config' if @options.key?(:auto_gen_config)),
        ('-F/--fail-fast'    if @options.key?(:fail_fast)),
+       ('--profile'         if @options[:profile]),
+       ('--memory'          if @options[:memory]),
        ('--cache false'     if @options > { cache: 'false' })].compact
     end
 
@@ -465,6 +481,7 @@ module RuboCop
 
   # This module contains help texts for command line options.
   # @api private
+  # rubocop:disable Metrics/ModuleLength
   module OptionsHelp
     MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
     FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
@@ -599,9 +616,13 @@ module RuboCop
       start_server:                     'Start server process.',
       stop_server:                      'Stop server process.',
       server_status:                    'Show server status.',
+      no_detach:                        'Run the server process in the foreground.',
       raise_cop_error:                  ['Raise cop-related errors with cause and location.',
                                          'This is used to prevent cops from failing silently.',
-                                         'Default is false.']
+                                         'Default is false.'],
+      profile:                          'Profile rubocop',
+      memory:                           'Profile rubocop memory usage'
     }.freeze
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/rubocop/runner.rb

@@ -24,6 +24,27 @@ module RuboCop
       end
     end
 
+    class << self
+      # @return [Array<#call>]
+      def ruby_extractors
+        @ruby_extractors ||= [default_ruby_extractor]
+      end
+
+      private
+
+      # @return [#call]
+      def default_ruby_extractor
+        lambda do |processed_source|
+          [
+            {
+              offset: 0,
+              processed_source: processed_source
+            }
+          ]
+        end
+      end
+    end
+
     # @api private
     MAX_ITERATIONS = 200
 
@@ -319,10 +340,25 @@ module RuboCop
     end
 
     def inspect_file(processed_source, team = mobilize_team(processed_source))
-      report = team.investigate(processed_source)
-      @errors.concat(team.errors)
-      @warnings.concat(team.warnings)
-      [report.offenses, team.updated_source_file?]
+      extracted_ruby_sources = extract_ruby_sources(processed_source)
+      offenses = extracted_ruby_sources.flat_map do |extracted_ruby_source|
+        report = team.investigate(
+          extracted_ruby_source[:processed_source],
+          offset: extracted_ruby_source[:offset],
+          original: processed_source
+        )
+        @errors.concat(team.errors)
+        @warnings.concat(team.warnings)
+        report.offenses
+      end
+      [offenses, team.updated_source_file?]
+    end
+
+    def extract_ruby_sources(processed_source)
+      self.class.ruby_extractors.find do |ruby_extractor|
+        result = ruby_extractor.call(processed_source)
+        break result if result
+      end
     end
 
     def mobilize_team(processed_source)

data/lib/rubocop/server/cache.rb

@@ -57,17 +57,21 @@ module RuboCop
           File.expand_path(File.join(cache_root_dir, 'server'))
         end
 
+        # rubocop:disable Metrics/MethodLength
         def cache_root_dir_from_config
           CacheConfig.root_dir do
             # `RuboCop::ConfigStore` has heavy dependencies, this is a lightweight implementation
             # so that only the necessary `CacheRootDirectory` can be obtained.
-            require 'yaml'
             config_path = ConfigFinder.find_config_path(Dir.pwd)
+            file_contents = File.read(config_path)
+
+            # Returns early if `CacheRootDirectory` is not used before requiring `erb` or `yaml`.
+            next unless file_contents.include?('CacheRootDirectory')
 
             require 'erb'
-            file_contents = File.read(config_path)
             yaml_code = ERB.new(file_contents).result
 
+            require 'yaml'
             config_yaml = YAML.safe_load(
               yaml_code, permitted_classes: [Regexp, Symbol], aliases: true
             )
@@ -80,6 +84,7 @@ module RuboCop
             config_yaml&.dig('AllCops', 'CacheRootDirectory')
           end
         end
+        # rubocop:enable Metrics/MethodLength
 
         def port_path
           dir.join('port')

data/lib/rubocop/server/cli.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rainbow'
 require_relative '../arguments_env'
 require_relative '../arguments_file'
 
@@ -23,15 +22,21 @@ module RuboCop
       STATUS_ERROR = 2
 
       SERVER_OPTIONS = %w[
-        --server --no-server --server-status --restart-server --start-server --stop-server
+        --server
+        --no-server
+        --server-status
+        --restart-server
+        --start-server
+        --stop-server
+        --no-detach
       ].freeze
       EXCLUSIVE_OPTIONS = (SERVER_OPTIONS - %w[--server --no-server]).freeze
+      NO_DETACH_OPTIONS = %w[--server --start-server --restart-server].freeze
 
       def initialize
         @exit = false
       end
 
-      # 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)
@@ -40,16 +45,34 @@ module RuboCop
         end
 
         Cache.cache_root_path = fetch_cache_root_path_from(argv)
-        deleted_server_arguments = delete_server_argument_from(argv)
 
-        if deleted_server_arguments.size >= 2
-          return error("#{deleted_server_arguments.join(', ')} cannot be specified together.")
+        process_arguments(argv)
+      end
+
+      def exit?
+        @exit
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def process_arguments(argv)
+        server_arguments = delete_server_argument_from(argv)
+
+        detach = !server_arguments.delete('--no-detach')
+
+        if server_arguments.size >= 2
+          return error("#{server_arguments.join(', ')} cannot be specified together.")
         end
 
-        server_command = deleted_server_arguments.first
+        server_command = server_arguments.first
+
+        unless detach || NO_DETACH_OPTIONS.include?(server_command)
+          return error("#{server_command} cannot be combined with --no-detach.")
+        end
 
         if EXCLUSIVE_OPTIONS.include?(server_command) && argv.count > allowed_option_count
-          return error("#{server_command} cannot be combined with other options.")
+          return error("#{server_command} cannot be combined with #{argv[0]}.")
         end
 
         if server_command.nil?
@@ -57,23 +80,17 @@ module RuboCop
                            ArgumentsFile.read_as_arguments.delete('--server')
         end
 
-        run_command(server_command)
+        run_command(server_command, detach: detach)
 
         STATUS_SUCCESS
       end
       # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
 
-      def exit?
-        @exit
-      end
-
-      private
-
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
-      def run_command(server_command)
+      def run_command(server_command, detach:)
         case server_command
         when '--server'
-          Server::ClientCommand::Start.new.run unless Server.running?
+          Server::ClientCommand::Start.new(detach: detach).run unless Server.running?
         when '--no-server'
           Server::ClientCommand::Stop.new.run if Server.running?
         when '--restart-server'
@@ -81,7 +98,7 @@ module RuboCop
           Server::ClientCommand::Restart.new.run
         when '--start-server'
           @exit = true
-          Server::ClientCommand::Start.new.run
+          Server::ClientCommand::Start.new(detach: detach).run
         when '--stop-server'
           @exit = true
           Server::ClientCommand::Stop.new.run
@@ -118,6 +135,8 @@ module RuboCop
       end
 
       def error(message)
+        require 'rainbow'
+
         @exit = true
         warn Rainbow(message).red
 

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

@@ -41,7 +41,7 @@ module RuboCop
         end
 
         def incompatible_version?
-          RuboCop::Version::STRING != Cache.version_path.read
+          Cache.version_path.read != RuboCop::Version::STRING
         end
 
         def stderr

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

@@ -15,6 +15,11 @@ module RuboCop
       # This class is a client command to start server process.
       # @api private
       class Start < Base
+        def initialize(detach: true)
+          @detach = detach
+          super()
+        end
+
         def run
           if Server.running?
             warn "RuboCop server (#{Cache.pid_path.read}) is already running."
@@ -34,7 +39,7 @@ module RuboCop
             host = ENV.fetch('RUBOCOP_SERVER_HOST', '127.0.0.1')
             port = ENV.fetch('RUBOCOP_SERVER_PORT', 0)
 
-            Server::Core.new.start(host, port)
+            Server::Core.new.start(host, port, detach: @detach)
           end
         end
       end

data/lib/rubocop/server/core.rb

@@ -27,31 +27,46 @@ module RuboCop
         self.class.token
       end
 
-      def start(host, port)
+      def start(host, port, detach: true)
         $PROGRAM_NAME = "rubocop --server #{Cache.project_dir}"
 
-        require 'rubocop'
+        require_relative '../../rubocop'
         start_server(host, port)
 
-        demonize if server_mode?
+        return unless server_mode?
+
+        detach ? detach_server : run_server
       end
 
       private
 
-      def demonize
-        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
+      def detach_server
+        write_port_and_token_files
 
         pid = fork do
           Process.daemon(true)
           $stderr.reopen(Cache.stderr_path, 'w')
-          Cache.write_pid_file do
-            read_socket(@server.accept) until @server.closed?
-          end
+          process_input
         end
 
         Process.waitpid(pid)
       end
 
+      def write_port_and_token_files
+        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
+      end
+
+      def process_input
+        Cache.write_pid_file do
+          read_socket(@server.accept) until @server.closed?
+        end
+      end
+
+      def run_server
+        write_port_and_token_files
+        process_input
+      end
+
       def server_mode?
         true
       end

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.44.1'
+    STRING = '1.45.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, ' \
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -556,6 +556,7 @@ require_relative 'rubocop/cop/style/redundant_double_splat_hash_braces'
 require_relative 'rubocop/cop/style/redundant_each'
 require_relative 'rubocop/cop/style/redundant_fetch_block'
 require_relative 'rubocop/cop/style/redundant_file_extension_in_require'
+require_relative 'rubocop/cop/style/redundant_heredoc_delimiter_quotes'
 require_relative 'rubocop/cop/style/redundant_initialize'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.44.1
+  version: 1.45.0
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-25 00:00:00.000000000 Z
+date: 2023-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -168,26 +168,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 description: |2
       RuboCop is a Ruby code style checking and code formatting tool.
       It aims to enforce the community-driven Ruby Style Guide.
@@ -837,6 +817,7 @@ files:
 - lib/rubocop/cop/style/redundant_fetch_block.rb
 - lib/rubocop/cop/style/redundant_file_extension_in_require.rb
 - lib/rubocop/cop/style/redundant_freeze.rb
+- lib/rubocop/cop/style/redundant_heredoc_delimiter_quotes.rb
 - lib/rubocop/cop/style/redundant_initialize.rb
 - lib/rubocop/cop/style/redundant_interpolation.rb
 - lib/rubocop/cop/style/redundant_parentheses.rb
@@ -999,10 +980,10 @@ 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.44/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.45/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1017,8 +998,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Automatic Ruby code style checking tool.
 test_files: []