rubocop 1.34.1 → 1.54.0

data/lib/rubocop/server/core.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'socket'
 require 'securerandom'
+require 'socket'
 
 #
 # This code is based on https://github.com/fohte/rubocop-daemon.
@@ -17,6 +17,8 @@ module RuboCop
     # The core of server process. It starts TCP server and perform socket communication.
     # @api private
     class Core
+      JSON_FORMATS = %w[json j].freeze
+
       def self.token
         @token ||= SecureRandom.hex(4)
       end
@@ -25,30 +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)
-          Cache.write_pid_file do
-            read_socket(@server.accept) until @server.closed?
-          end
+          $stderr.reopen(Cache.stderr_path, 'w')
+          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
@@ -56,7 +74,12 @@ module RuboCop
       def start_server(host, port)
         @server = TCPServer.open(host, port)
 
-        puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
+        # JSON format does not expected output message when IDE integration with server mode.
+        # See: https://github.com/rubocop/rubocop/issues/11164
+        return if use_json_format?
+
+        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)
@@ -74,6 +97,15 @@ module RuboCop
       ensure
         socket.close
       end
+
+      def use_json_format?
+        return true if ARGV.include?('--format=json') || ARGV.include?('--format=j')
+        return false unless (index = ARGV.index('--format') || ARGV.index('-f'))
+
+        format = ARGV[index + 1]
+
+        JSON_FORMATS.include?(format)
+      end
     end
   end
 end

data/lib/rubocop/server/helper.rb

@@ -11,7 +11,7 @@
 #
 module RuboCop
   module Server
-    # This module has a helper memthod for `RuboCop::Server::SocketReader`.
+    # This module has a helper method for `RuboCop::Server::SocketReader`.
     # @api private
     module Helper
       def self.redirect(stdin: $stdin, stdout: $stdout, stderr: $stderr, &_block)

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

@@ -21,7 +21,7 @@ module RuboCop
           # We must pass the --color option to preserve this behavior.
           @args.unshift('--color') unless %w[--color --no-color].any? { |f| @args.include?(f) }
           status = RuboCop::CLI.new.run(@args)
-          # This status file is read by `rubocop --server` (`RuboCop::Server::Clientcommand::Exec`).
+          # This status file is read by `rubocop --server` (`RuboCop::Server::ClientCommand::Exec`).
           # so that they use the correct exit code.
           # Status is 1 when there are any issues, and 0 otherwise.
           Cache.write_status_file(status)

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/target_finder.rb

@@ -88,7 +88,7 @@ module RuboCop
       patterns.map! { |dir| File.join(dir, '*') }
       # We need this special case to avoid creating the pattern
       # /**/* which searches the entire file system.
-      patterns = [File.join(dir, '**/*')] if patterns.empty?
+      patterns = [File.join(base_dir, '**/*')] if patterns.empty?
 
       Dir.glob(patterns, flags).select { |path| FileTest.file?(path) }
     end

data/lib/rubocop/target_ruby.rb

@@ -4,8 +4,8 @@ module RuboCop
   # The kind of Ruby that code inspected by RuboCop is written in.
   # @api private
   class TargetRuby
-    KNOWN_RUBIES = [2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2].freeze
-    DEFAULT_VERSION = 2.6
+    KNOWN_RUBIES = [2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3].freeze
+    DEFAULT_VERSION = 2.7
 
     OBSOLETE_RUBIES = {
       1.9 => '0.41',
@@ -14,7 +14,8 @@ module RuboCop
       2.2 => '0.68',
       2.3 => '0.81',
       2.4 => '1.12',
-      2.5 => '1.28'
+      2.5 => '1.28',
+      2.6 => '1.50'
     }.freeze
     private_constant :KNOWN_RUBIES, :OBSOLETE_RUBIES
 
@@ -84,7 +85,7 @@ module RuboCop
     # @api private
     class ToolVersionsFile < RubyVersionFile
       TOOL_VERSIONS_FILENAME = '.tool-versions'
-      TOOL_VERSIONS_PATTERN = /\Aruby (?:ruby-)?(?<version>\d+\.\d+)/.freeze
+      TOOL_VERSIONS_PATTERN = /^(?:ruby )(?<version>\d+\.\d+)/.freeze
 
       def name
         "`#{TOOL_VERSIONS_FILENAME}`"
@@ -244,7 +245,6 @@ module RuboCop
     ].freeze
 
     private_constant :SOURCES
-
     def initialize(config)
       @config = config
     end

data/lib/rubocop/version.rb

@@ -3,15 +3,19 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.34.1'
+    STRING = '1.54.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
-    EXTENSION_PATH_NAMES = { 'rubocop-md' => 'markdown' }.freeze
+    CANONICAL_FEATURE_NAMES = {
+      'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown', 'Factory_bot' => 'FactoryBot',
+      'Thread_safety' => 'ThreadSafety'
+    }.freeze
+    EXTENSION_PATH_NAMES = {
+      'rubocop-md' => 'markdown', 'rubocop-factory_bot' => 'factory_bot'
+    }.freeze
 
     # @api private
     def self.version(debug: false, env: nil)
@@ -19,6 +23,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
 
@@ -42,7 +47,7 @@ module RuboCop
         env.config_store.unvalidated.for_pwd.loaded_features.sort
       end
 
-      features.map do |loaded_feature|
+      features.filter_map do |loaded_feature|
         next unless (match = loaded_feature.match(/rubocop-(?<feature>.*)/))
 
         # Get the expected name of the folder containing the extension code.
@@ -60,7 +65,7 @@ module RuboCop
         next unless (feature_version = feature_version(feature))
 
         "  - #{loaded_feature} #{feature_version}"
-      end.compact
+      end
     end
 
     # Returns feature version in one of two ways:
@@ -88,5 +93,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

@@ -4,9 +4,9 @@ require 'English'
 before_us = $LOADED_FEATURES.dup
 require 'rainbow'
 
-require 'set'
 require 'forwardable'
 require 'regexp_parser'
+require 'set'
 require 'unicode/display_width'
 
 # we have to require RuboCop's version, before rubocop-ast's
@@ -14,21 +14,25 @@ require_relative 'rubocop/version'
 require 'rubocop-ast'
 
 require_relative 'rubocop/ast_aliases'
+require_relative 'rubocop/ext/comment'
+require_relative 'rubocop/ext/range'
 require_relative 'rubocop/ext/regexp_node'
 require_relative 'rubocop/ext/regexp_parser'
-require_relative 'rubocop/ext/range'
 
 require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/ext/processed_source'
 
-require_relative 'rubocop/path_util'
+require_relative 'rubocop/error'
 require_relative 'rubocop/file_finder'
-require_relative 'rubocop/platform'
+require_relative 'rubocop/file_patterns'
 require_relative 'rubocop/name_similarity'
+require_relative 'rubocop/path_util'
+require_relative 'rubocop/platform'
 require_relative 'rubocop/string_interpreter'
-require_relative 'rubocop/error'
-require_relative 'rubocop/warning'
 require_relative 'rubocop/util'
+require_relative 'rubocop/warning'
+
+# rubocop:disable Style/RequireOrder
 
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
@@ -48,6 +52,7 @@ require_relative 'rubocop/cop/severity'
 require_relative 'rubocop/cop/generator'
 require_relative 'rubocop/cop/generator/configuration_injector'
 require_relative 'rubocop/cop/generator/require_file_injector'
+require_relative 'rubocop/magic_comment'
 
 require_relative 'rubocop/cop/variable_force'
 require_relative 'rubocop/cop/variable_force/branch'
@@ -64,6 +69,7 @@ require_relative 'rubocop/cop/mixin/alignment'
 require_relative 'rubocop/cop/mixin/allowed_identifiers'
 require_relative 'rubocop/cop/mixin/allowed_methods'
 require_relative 'rubocop/cop/mixin/allowed_pattern'
+require_relative 'rubocop/cop/mixin/allowed_receivers'
 require_relative 'rubocop/cop/mixin/auto_corrector' # rubocop:todo Naming/InclusiveLanguage
 require_relative 'rubocop/cop/mixin/check_assignment'
 require_relative 'rubocop/cop/mixin/check_line_breakable'
@@ -97,6 +103,7 @@ require_relative 'rubocop/cop/mixin/hash_shorthand_syntax'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
+require_relative 'rubocop/cop/mixin/min_branches_count'
 require_relative 'rubocop/cop/mixin/multiline_element_indentation'
 require_relative 'rubocop/cop/mixin/multiline_element_line_breaks'
 require_relative 'rubocop/cop/mixin/multiline_expression_indentation'
@@ -132,6 +139,7 @@ require_relative 'rubocop/cop/mixin/comments_help' # relies on visibility_help
 require_relative 'rubocop/cop/mixin/def_node' # relies on visibility_help
 
 require_relative 'rubocop/cop/utils/format_string'
+require_relative 'rubocop/cop/utils/regexp_ranges'
 
 require_relative 'rubocop/cop/migration/department_name'
 
@@ -162,6 +170,7 @@ require_relative 'rubocop/cop/bundler/ordered_gems'
 
 require_relative 'rubocop/cop/gemspec/dependency_version'
 require_relative 'rubocop/cop/gemspec/deprecated_attribute_assignment'
+require_relative 'rubocop/cop/gemspec/development_dependencies'
 require_relative 'rubocop/cop/gemspec/duplicated_assignment'
 require_relative 'rubocop/cop/gemspec/ordered_dependencies'
 require_relative 'rubocop/cop/gemspec/require_mfa'
@@ -291,6 +300,8 @@ 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_match_pattern'
 require_relative 'rubocop/cop/lint/duplicate_methods'
 require_relative 'rubocop/cop/lint/duplicate_regexp_character_class_element'
 require_relative 'rubocop/cop/lint/duplicate_require'
@@ -326,6 +337,7 @@ require_relative 'rubocop/cop/lint/literal_in_interpolation'
 require_relative 'rubocop/cop/lint/loop'
 require_relative 'rubocop/cop/lint/missing_cop_enable_directive'
 require_relative 'rubocop/cop/lint/missing_super'
+require_relative 'rubocop/cop/lint/mixed_case_range'
 require_relative 'rubocop/cop/lint/mixed_regexp_capture_types'
 require_relative 'rubocop/cop/lint/multiple_comparison'
 require_relative 'rubocop/cop/lint/nested_method_definition'
@@ -348,6 +360,7 @@ require_relative 'rubocop/cop/lint/rand_one'
 require_relative 'rubocop/cop/lint/redundant_cop_disable_directive'
 require_relative 'rubocop/cop/lint/redundant_cop_enable_directive'
 require_relative 'rubocop/cop/lint/redundant_dir_glob_sort'
+require_relative 'rubocop/cop/lint/redundant_regexp_quantifiers'
 require_relative 'rubocop/cop/lint/redundant_require_statement'
 require_relative 'rubocop/cop/lint/redundant_safe_navigation'
 require_relative 'rubocop/cop/lint/redundant_splat_expansion'
@@ -394,6 +407,7 @@ require_relative 'rubocop/cop/lint/useless_access_modifier'
 require_relative 'rubocop/cop/lint/useless_assignment'
 require_relative 'rubocop/cop/lint/useless_else_without_rescue'
 require_relative 'rubocop/cop/lint/useless_method_definition'
+require_relative 'rubocop/cop/lint/useless_rescue'
 require_relative 'rubocop/cop/lint/useless_ruby2_keywords'
 require_relative 'rubocop/cop/lint/useless_setter_call'
 require_relative 'rubocop/cop/lint/useless_times'
@@ -408,6 +422,7 @@ require_relative 'rubocop/cop/metrics/abc_size'
 require_relative 'rubocop/cop/metrics/block_length'
 require_relative 'rubocop/cop/metrics/block_nesting'
 require_relative 'rubocop/cop/metrics/class_length'
+require_relative 'rubocop/cop/metrics/collection_literal_length'
 require_relative 'rubocop/cop/metrics/method_length'
 require_relative 'rubocop/cop/metrics/module_length'
 require_relative 'rubocop/cop/metrics/parameter_lists'
@@ -438,6 +453,7 @@ require_relative 'rubocop/cop/style/alias'
 require_relative 'rubocop/cop/style/and_or'
 require_relative 'rubocop/cop/style/arguments_forwarding'
 require_relative 'rubocop/cop/style/array_coercion'
+require_relative 'rubocop/cop/style/array_intersect'
 require_relative 'rubocop/cop/style/array_join'
 require_relative 'rubocop/cop/style/ascii_comments'
 require_relative 'rubocop/cop/style/attr'
@@ -464,12 +480,16 @@ require_relative 'rubocop/cop/style/combinable_loops'
 require_relative 'rubocop/cop/style/command_literal'
 require_relative 'rubocop/cop/style/comment_annotation'
 require_relative 'rubocop/cop/style/commented_keyword'
+require_relative 'rubocop/cop/style/comparable_clamp'
+require_relative 'rubocop/cop/style/concat_array_literals'
 require_relative 'rubocop/cop/style/conditional_assignment'
 require_relative 'rubocop/cop/style/constant_visibility'
 require_relative 'rubocop/cop/style/copyright'
+require_relative 'rubocop/cop/style/data_inheritance'
 require_relative 'rubocop/cop/style/date_time'
 require_relative 'rubocop/cop/style/def_with_parentheses'
 require_relative 'rubocop/cop/style/dir'
+require_relative 'rubocop/cop/style/dir_empty'
 require_relative 'rubocop/cop/style/disable_cops_within_source_code_directive'
 require_relative 'rubocop/cop/style/documentation_method'
 require_relative 'rubocop/cop/style/documentation'
@@ -491,10 +511,12 @@ require_relative 'rubocop/cop/style/end_block'
 require_relative 'rubocop/cop/style/env_home'
 require_relative 'rubocop/cop/style/eval_with_location'
 require_relative 'rubocop/cop/style/even_odd'
+require_relative 'rubocop/cop/style/exact_regexp_match'
 require_relative 'rubocop/cop/style/expand_path_arguments'
 require_relative 'rubocop/cop/style/explicit_block_argument'
 require_relative 'rubocop/cop/style/exponential_notation'
 require_relative 'rubocop/cop/style/fetch_env_var'
+require_relative 'rubocop/cop/style/file_empty'
 require_relative 'rubocop/cop/style/file_read'
 require_relative 'rubocop/cop/style/file_write'
 require_relative 'rubocop/cop/style/float_division'
@@ -524,23 +546,39 @@ require_relative 'rubocop/cop/style/in_pattern_then'
 require_relative 'rubocop/cop/style/infinite_loop'
 require_relative 'rubocop/cop/style/inverse_methods'
 require_relative 'rubocop/cop/style/inline_comment'
+require_relative 'rubocop/cop/style/invertible_unless_condition'
 require_relative 'rubocop/cop/style/ip_addresses'
 require_relative 'rubocop/cop/style/keyword_parameters_order'
 require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
+require_relative 'rubocop/cop/style/magic_comment_format'
 require_relative 'rubocop/cop/style/map_to_hash'
+require_relative 'rubocop/cop/style/map_to_set'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/min_max_comparison'
 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_array_constructor'
 require_relative 'rubocop/cop/style/redundant_assignment'
+require_relative 'rubocop/cop/style/redundant_constant_base'
+require_relative 'rubocop/cop/style/redundant_current_directory_in_path'
+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_filter_chain'
+require_relative 'rubocop/cop/style/redundant_heredoc_delimiter_quotes'
 require_relative 'rubocop/cop/style/redundant_initialize'
+require_relative 'rubocop/cop/style/redundant_line_continuation'
+require_relative 'rubocop/cop/style/redundant_regexp_argument'
+require_relative 'rubocop/cop/style/redundant_regexp_constructor'
 require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
+require_relative 'rubocop/cop/style/require_order'
 require_relative 'rubocop/cop/style/sole_nested_conditional'
 require_relative 'rubocop/cop/style/static_class'
 require_relative 'rubocop/cop/style/map_compact_with_conditional_block'
@@ -610,10 +648,12 @@ 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'
 require_relative 'rubocop/cop/style/return_nil'
+require_relative 'rubocop/cop/style/return_nil_in_predicate_method_definition'
 require_relative 'rubocop/cop/style/safe_navigation'
 require_relative 'rubocop/cop/style/sample'
 require_relative 'rubocop/cop/style/select_by_regexp'
@@ -660,7 +700,9 @@ require_relative 'rubocop/cop/style/when_then'
 require_relative 'rubocop/cop/style/while_until_do'
 require_relative 'rubocop/cop/style/while_until_modifier'
 require_relative 'rubocop/cop/style/word_array'
+require_relative 'rubocop/cop/style/yaml_file_read'
 require_relative 'rubocop/cop/style/yoda_condition'
+require_relative 'rubocop/cop/style/yoda_expression'
 require_relative 'rubocop/cop/style/zero_length_predicate'
 
 require_relative 'rubocop/cop/security/compound_hash'
@@ -695,16 +737,16 @@ require_relative 'rubocop/lockfile'
 require_relative 'rubocop/target_finder'
 require_relative 'rubocop/directive_comment'
 require_relative 'rubocop/comment_config'
-require_relative 'rubocop/magic_comment'
 require_relative 'rubocop/result_cache'
 require_relative 'rubocop/runner'
 require_relative 'rubocop/cli'
 require_relative 'rubocop/cli/command'
 require_relative 'rubocop/cli/environment'
 require_relative 'rubocop/cli/command/base'
-require_relative 'rubocop/cli/command/auto_genenerate_config'
+require_relative 'rubocop/cli/command/auto_generate_config'
 require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
+require_relative 'rubocop/cli/command/lsp'
 require_relative 'rubocop/cli/command/show_cops'
 require_relative 'rubocop/cli/command/show_docs_url'
 require_relative 'rubocop/cli/command/suggest_extensions'
@@ -715,6 +757,8 @@ require_relative 'rubocop/remote_config'
 require_relative 'rubocop/target_ruby'
 require_relative 'rubocop/yaml_duplication_checker'
 
+# rubocop:enable Style/RequireOrder
+
 unless File.exist?("#{__dir__}/../rubocop.gemspec") # Check if we are a gem
   RuboCop::ResultCache.rubocop_required_features = $LOADED_FEATURES - before_us
 end