rubocop 1.29.1 → 1.36.0

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # Abstract base class for server command.
+      # @api private
+      class Base
+        # Common functionality for working with subclasses of this class.
+        # @api private
+        module Runner
+          def run
+            validate_token!
+            Dir.chdir(@cwd) do
+              super
+            end
+          end
+        end
+
+        def self.inherited(child)
+          super
+          child.prepend Runner
+        end
+
+        def initialize(args, token: '', cwd: Dir.pwd)
+          @args = args
+          @token = token
+          @cwd = cwd
+        end
+
+        def run; end
+
+        private
+
+        def validate_token!
+          raise InvalidTokenError unless Cache.token_path.read == @token
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # This class is a server command to execute `rubocop` command using `RuboCop::CLI.new#run`.
+      # @api private
+      class Exec < Base
+        def run
+          Cache.status_path.delete if Cache.status_path.file?
+          # RuboCop output is colorized by default where there is a TTY.
+          # 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`).
+          # so that they use the correct exit code.
+          # Status is 1 when there are any issues, and 0 otherwise.
+          Cache.write_status_file(status)
+        rescue SystemExit
+          Cache.write_status_file(1)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    module ServerCommand
+      # This class is a server command to stop server process.
+      # @api private
+      class Stop < Base
+        def run
+          raise ServerStopRequest
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server/server_command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # @api private
+    module ServerCommand
+      autoload :Base, 'rubocop/server/server_command/base'
+      autoload :Exec, 'rubocop/server/server_command/exec'
+      autoload :Stop, 'rubocop/server/server_command/stop'
+    end
+  end
+end

data/lib/rubocop/server/socket_reader.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  module Server
+    # This class sends the request read from the socket to server.
+    # @api private
+    class SocketReader
+      Request = Struct.new(:header, :body)
+      Header = Struct.new(:token, :cwd, :command, :args)
+
+      def initialize(socket)
+        @socket = socket
+      end
+
+      def read!
+        request = parse_request(@socket.read)
+
+        Helper.redirect(
+          stdin: StringIO.new(request.body),
+          stdout: @socket,
+          stderr: @socket
+        ) do
+          create_command_instance(request).run
+        end
+      end
+
+      private
+
+      def parse_request(content)
+        raw_header, *body = content.lines
+
+        Request.new(parse_header(raw_header), body.join)
+      end
+
+      def parse_header(header)
+        token, cwd, command, *args = header.shellsplit
+        Header.new(token, cwd, command, args)
+      end
+
+      def create_command_instance(request)
+        klass = find_command_class(request.header.command)
+
+        klass.new(request.header.args, token: request.header.token, cwd: request.header.cwd)
+      end
+
+      def find_command_class(command)
+        case command
+        when 'stop' then ServerCommand::Stop
+        when 'exec' then ServerCommand::Exec
+        else
+          raise UnknownServerCommandError, "#{command.inspect} is not a valid command"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/server.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'platform'
+
+#
+# This code is based on https://github.com/fohte/rubocop-daemon.
+#
+# Copyright (c) 2018 Hayato Kawai
+#
+# The MIT License (MIT)
+#
+# https://github.com/fohte/rubocop-daemon/blob/master/LICENSE.txt
+#
+module RuboCop
+  # The bootstrap module for server.
+  # @api private
+  module Server
+    TIMEOUT = 20
+
+    autoload :CLI, 'rubocop/server/cli'
+    autoload :Cache, 'rubocop/server/cache'
+    autoload :ClientCommand, 'rubocop/server/client_command'
+    autoload :Helper, 'rubocop/server/helper'
+    autoload :Core, 'rubocop/server/core'
+    autoload :ServerCommand, 'rubocop/server/server_command'
+    autoload :SocketReader, 'rubocop/server/socket_reader'
+
+    class << self
+      def support_server?
+        RUBY_ENGINE == 'ruby' && !RuboCop::Platform.windows?
+      end
+
+      def running?
+        return false unless support_server? # Never running.
+
+        Cache.dir.exist? && Cache.pid_path.file? && Cache.pid_running?
+      end
+
+      def wait_for_running_status!(expected)
+        start_time = Time.now
+        while Server.running? != expected
+          sleep 0.1
+          next unless Time.now - start_time > TIMEOUT
+
+          warn "running? was not #{expected} after #{TIMEOUT} seconds!"
+          exit 1
+        end
+      end
+    end
+  end
+end
+
+require_relative 'server/errors'

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.5, 2.6, 2.7, 3.0, 3.1, 3.2].freeze
-    DEFAULT_VERSION = KNOWN_RUBIES.first
+    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
 
     OBSOLETE_RUBIES = {
       1.9 => '0.41',
@@ -172,7 +172,7 @@ module RuboCop
         right_hand_side = version_from_gemspec_file(file)
         return if right_hand_side.nil?
 
-        find_minimal_known_ruby(right_hand_side)
+        find_default_minimal_known_ruby(right_hand_side)
       end
 
       def gemspec_filename
@@ -206,11 +206,13 @@ module RuboCop
         array.children.map(&:value)
       end
 
-      def find_minimal_known_ruby(right_hand_side)
+      def find_default_minimal_known_ruby(right_hand_side)
         version = version_from_right_hand_side(right_hand_side)
         requirement = Gem::Requirement.new(version)
 
-        KNOWN_RUBIES.detect { |v| requirement.satisfied_by?(Gem::Version.new("#{v}.99")) }
+        KNOWN_RUBIES.detect do |v|
+          v >= DEFAULT_VERSION && requirement.satisfied_by?(Gem::Version.new("#{v}.99"))
+        end
       end
     end
 

data/lib/rubocop/version.rb

@@ -3,13 +3,15 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.29.1'
+    STRING = '1.36.0'
 
-    MSG = '%<version>s (using Parser %<parser_version>s, '\
+    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>s [%<ruby_platform>s]'
 
-    CANONICAL_FEATURE_NAMES = { 'Rspec' => 'RSpec' }.freeze
+    CANONICAL_FEATURE_NAMES = { 'Rspec' => 'RSpec', 'Graphql' => 'GraphQL', 'Md' => 'Markdown',
+                                'Thread_safety' => 'ThreadSafety' }.freeze
+    EXTENSION_PATH_NAMES = { 'rubocop-md' => 'markdown' }.freeze
 
     # @api private
     def self.version(debug: false, env: nil)
@@ -17,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: Server.running? ? ' +server' : '',
                                       ruby_platform: RUBY_PLATFORM)
         return verbose_version unless env
 
@@ -43,16 +46,21 @@ module RuboCop
       features.map do |loaded_feature|
         next unless (match = loaded_feature.match(/rubocop-(?<feature>.*)/))
 
-        feature = match[:feature]
+        # Get the expected name of the folder containing the extension code.
+        # Usually it would be the same as the extension name. but sometimes authors
+        # can choose slightly different name for their gems, e.g. rubocop-md instead of
+        # rubocop-markdown.
+        feature = EXTENSION_PATH_NAMES.fetch(loaded_feature, match[:feature])
+
         begin
           require "rubocop/#{feature}/version"
         rescue LoadError
           # Not worth mentioning libs that are not installed
-        else
-          next unless (feature_version = feature_version(feature))
-
-          "  - #{loaded_feature} #{feature_version}"
         end
+
+        next unless (feature_version = feature_version(feature))
+
+        "  - #{loaded_feature} #{feature_version}"
       end.compact
     end
 

data/lib/rubocop.rb

@@ -16,6 +16,7 @@ require 'rubocop-ast'
 require_relative 'rubocop/ast_aliases'
 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'
@@ -47,6 +48,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'
@@ -63,7 +65,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/auto_corrector'
+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'
 require_relative 'rubocop/cop/mixin/configurable_max'
@@ -72,7 +74,6 @@ require_relative 'rubocop/cop/mixin/configurable_enforced_style'
 require_relative 'rubocop/cop/mixin/configurable_formatting'
 require_relative 'rubocop/cop/mixin/configurable_naming'
 require_relative 'rubocop/cop/mixin/configurable_numbering'
-require_relative 'rubocop/cop/mixin/def_node'
 require_relative 'rubocop/cop/mixin/documentation_comment'
 require_relative 'rubocop/cop/mixin/duplication'
 require_relative 'rubocop/cop/mixin/range_help'
@@ -87,7 +88,6 @@ require_relative 'rubocop/cop/mixin/gem_declaration'
 require_relative 'rubocop/cop/mixin/gemspec_help'
 require_relative 'rubocop/cop/mixin/hash_alignment_styles'
 require_relative 'rubocop/cop/mixin/hash_transform_method'
-require_relative 'rubocop/cop/mixin/ignored_methods'
 require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
@@ -130,6 +130,7 @@ require_relative 'rubocop/cop/mixin/uncommunicative_name'
 require_relative 'rubocop/cop/mixin/unused_argument'
 require_relative 'rubocop/cop/mixin/visibility_help'
 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'
 
@@ -160,8 +161,8 @@ require_relative 'rubocop/cop/bundler/gem_version'
 require_relative 'rubocop/cop/bundler/insecure_protocol_source'
 require_relative 'rubocop/cop/bundler/ordered_gems'
 
-require_relative 'rubocop/cop/gemspec/date_assignment'
 require_relative 'rubocop/cop/gemspec/dependency_version'
+require_relative 'rubocop/cop/gemspec/deprecated_attribute_assignment'
 require_relative 'rubocop/cop/gemspec/duplicated_assignment'
 require_relative 'rubocop/cop/gemspec/ordered_dependencies'
 require_relative 'rubocop/cop/gemspec/require_mfa'
@@ -219,6 +220,8 @@ require_relative 'rubocop/cop/layout/indentation_width'
 require_relative 'rubocop/cop/layout/initial_indentation'
 require_relative 'rubocop/cop/layout/leading_comment_space'
 require_relative 'rubocop/cop/layout/leading_empty_lines'
+require_relative 'rubocop/cop/layout/line_continuation_leading_space'
+require_relative 'rubocop/cop/layout/line_continuation_spacing'
 require_relative 'rubocop/cop/layout/line_end_string_concatenation_indentation'
 require_relative 'rubocop/cop/layout/line_length'
 require_relative 'rubocop/cop/layout/multiline_array_brace_layout'
@@ -231,6 +234,7 @@ require_relative 'rubocop/cop/layout/multiline_method_argument_line_breaks'
 require_relative 'rubocop/cop/layout/multiline_method_call_brace_layout'
 require_relative 'rubocop/cop/layout/multiline_method_call_indentation'
 require_relative 'rubocop/cop/layout/multiline_method_definition_brace_layout'
+require_relative 'rubocop/cop/layout/multiline_method_parameter_line_breaks'
 require_relative 'rubocop/cop/layout/multiline_operation_indentation'
 require_relative 'rubocop/cop/layout/parameter_alignment'
 require_relative 'rubocop/cop/layout/redundant_line_break'
@@ -277,6 +281,7 @@ require_relative 'rubocop/cop/lint/binary_operator_with_identical_operands'
 require_relative 'rubocop/cop/lint/boolean_symbol'
 require_relative 'rubocop/cop/lint/circular_argument_reference'
 require_relative 'rubocop/cop/lint/constant_definition_in_block'
+require_relative 'rubocop/cop/lint/constant_overwritten_in_rescue'
 require_relative 'rubocop/cop/lint/constant_resolution'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
@@ -328,6 +333,7 @@ require_relative 'rubocop/cop/lint/nested_method_definition'
 require_relative 'rubocop/cop/lint/nested_percent_literal'
 require_relative 'rubocop/cop/lint/next_without_accumulator'
 require_relative 'rubocop/cop/lint/no_return_in_begin_end_blocks'
+require_relative 'rubocop/cop/lint/non_atomic_file_operation'
 require_relative 'rubocop/cop/lint/non_deterministic_require_order'
 require_relative 'rubocop/cop/lint/non_local_exit_from_iterator'
 require_relative 'rubocop/cop/lint/number_conversion'
@@ -352,6 +358,7 @@ require_relative 'rubocop/cop/lint/redundant_with_object'
 require_relative 'rubocop/cop/lint/refinement_import_methods'
 require_relative 'rubocop/cop/lint/regexp_as_condition'
 require_relative 'rubocop/cop/lint/require_parentheses'
+require_relative 'rubocop/cop/lint/require_range_parentheses'
 require_relative 'rubocop/cop/lint/require_relative_self_path'
 require_relative 'rubocop/cop/lint/rescue_exception'
 require_relative 'rubocop/cop/lint/rescue_type'
@@ -386,6 +393,7 @@ require_relative 'rubocop/cop/lint/uri_escape_unescape'
 require_relative 'rubocop/cop/lint/uri_regexp'
 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_ruby2_keywords'
 require_relative 'rubocop/cop/lint/useless_setter_call'
@@ -474,6 +482,7 @@ require_relative 'rubocop/cop/style/each_with_object'
 require_relative 'rubocop/cop/style/empty_block_parameter'
 require_relative 'rubocop/cop/style/empty_case_condition'
 require_relative 'rubocop/cop/style/empty_else'
+require_relative 'rubocop/cop/style/empty_heredoc'
 require_relative 'rubocop/cop/style/empty_lambda_parameter'
 require_relative 'rubocop/cop/style/empty_literal'
 require_relative 'rubocop/cop/style/empty_method'
@@ -521,6 +530,7 @@ 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/method_call_without_args_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
@@ -535,6 +545,7 @@ require_relative 'rubocop/cop/style/redundant_self_assignment'
 require_relative 'rubocop/cop/style/redundant_self_assignment_branch'
 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'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
 require_relative 'rubocop/cop/style/min_max'
@@ -663,30 +674,7 @@ require_relative 'rubocop/cop/security/open'
 require_relative 'rubocop/cop/security/yaml_load'
 
 require_relative 'rubocop/cop/team'
-
-require_relative 'rubocop/formatter/base_formatter'
-require_relative 'rubocop/formatter/simple_text_formatter'
-# relies on simple text
-require_relative 'rubocop/formatter/clang_style_formatter'
-require_relative 'rubocop/formatter/disabled_config_formatter'
-require_relative 'rubocop/formatter/emacs_style_formatter'
-require_relative 'rubocop/formatter/file_list_formatter'
-require_relative 'rubocop/formatter/fuubar_style_formatter'
-require_relative 'rubocop/formatter/git_hub_actions_formatter'
-require_relative 'rubocop/formatter/html_formatter'
-require_relative 'rubocop/formatter/json_formatter'
-require_relative 'rubocop/formatter/junit_formatter'
-require_relative 'rubocop/formatter/markdown_formatter'
-require_relative 'rubocop/formatter/offense_count_formatter'
-require_relative 'rubocop/formatter/progress_formatter'
-require_relative 'rubocop/formatter/quiet_formatter'
-require_relative 'rubocop/formatter/tap_formatter'
-require_relative 'rubocop/formatter/worst_offenders_formatter'
-require_relative 'rubocop/formatter/pacman_formatter'
-# relies on progress formatter
-require_relative 'rubocop/formatter/auto_gen_config_formatter'
-
-require_relative 'rubocop/formatter/formatter_set'
+require_relative 'rubocop/formatter'
 
 require_relative 'rubocop/cached_data'
 require_relative 'rubocop/config'
@@ -704,18 +692,18 @@ require_relative 'rubocop/config_obsoletion/split_cop'
 require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
+require_relative 'rubocop/feature_loader'
 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/show_cops'