rubocop 1.30.1 → 1.31.0

data/lib/rubocop/server/core.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'securerandom'
+
+#
+# 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
+    # The core of server process. It starts TCP server and perform socket communication.
+    # @api private
+    class Core
+      def self.token
+        @token ||= SecureRandom.hex(4)
+      end
+
+      def token
+        self.class.token
+      end
+
+      def start(host, port)
+        $PROGRAM_NAME = "rubocop --server #{Cache.project_dir}"
+
+        require 'rubocop'
+        start_server(host, port)
+
+        demonize if server_mode?
+      end
+
+      private
+
+      def demonize
+        Cache.write_port_and_token_files(port: @server.addr[1], token: token)
+
+        pid = fork do
+          Process.daemon(true)
+          Cache.write_pid_file do
+            read_socket(@server.accept) until @server.closed?
+          end
+        end
+
+        Process.waitpid(pid)
+      end
+
+      def server_mode?
+        true
+      end
+
+      def start_server(host, port)
+        @server = TCPServer.open(host, port)
+
+        puts "RuboCop server starting on #{@server.addr[3]}:#{@server.addr[1]}."
+      end
+
+      def read_socket(socket)
+        SocketReader.new(socket).read!
+      rescue InvalidTokenError
+        socket.puts 'token is not valid.'
+      rescue ServerStopRequest
+        @server.close
+      rescue UnknownServerCommandError => e
+        socket.puts e.message
+      rescue Errno::EPIPE => e
+        warn e.inspect
+      rescue StandardError => e
+        socket.puts e.full_message
+      ensure
+        socket.close
+      end
+    end
+  end
+end

data/lib/rubocop/server/errors.rb

@@ -0,0 +1,23 @@
+# 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
+    class InvalidTokenError < StandardError; end
+
+    # @api private
+    class ServerStopRequest < StandardError; end
+
+    # @api private
+    class UnknownServerCommandError < StandardError; end
+  end
+end

data/lib/rubocop/server/helper.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
+    # This module has a helper memthod for `RuboCop::Server::SocketReader`.
+    # @api private
+    module Helper
+      def self.redirect(stdin: $stdin, stdout: $stdout, stderr: $stderr, &_block)
+        old_stdin = $stdin.dup
+        old_stdout = $stdout.dup
+        old_stderr = $stderr.dup
+
+        $stdin = stdin
+        $stdout = stdout
+        $stderr = stderr
+
+        yield
+      ensure
+        $stdin = old_stdin
+        $stdout = old_stdout
+        $stderr = old_stderr
+      end
+    end
+  end
+end

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

@@ -3,13 +3,15 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.30.1'
+    STRING = '1.31.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)'
 
-    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)
@@ -43,16 +45,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

@@ -63,7 +63,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'
@@ -160,7 +160,6 @@ 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'
@@ -220,6 +219,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'
@@ -278,6 +279,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'
@@ -329,6 +331,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'
@@ -387,6 +390,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'
@@ -665,30 +669,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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.30.1
+  version: 1.31.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -255,7 +255,6 @@ files:
 - lib/rubocop/cop/documentation.rb
 - lib/rubocop/cop/exclude_limit.rb
 - lib/rubocop/cop/force.rb
-- lib/rubocop/cop/gemspec/date_assignment.rb
 - lib/rubocop/cop/gemspec/dependency_version.rb
 - lib/rubocop/cop/gemspec/deprecated_attribute_assignment.rb
 - lib/rubocop/cop/gemspec/duplicated_assignment.rb
@@ -339,6 +338,8 @@ files:
 - lib/rubocop/cop/layout/initial_indentation.rb
 - lib/rubocop/cop/layout/leading_comment_space.rb
 - lib/rubocop/cop/layout/leading_empty_lines.rb
+- lib/rubocop/cop/layout/line_continuation_leading_space.rb
+- lib/rubocop/cop/layout/line_continuation_spacing.rb
 - lib/rubocop/cop/layout/line_end_string_concatenation_indentation.rb
 - lib/rubocop/cop/layout/line_length.rb
 - lib/rubocop/cop/layout/multiline_array_brace_layout.rb
@@ -398,6 +399,7 @@ files:
 - lib/rubocop/cop/lint/boolean_symbol.rb
 - lib/rubocop/cop/lint/circular_argument_reference.rb
 - lib/rubocop/cop/lint/constant_definition_in_block.rb
+- lib/rubocop/cop/lint/constant_overwritten_in_rescue.rb
 - lib/rubocop/cop/lint/constant_resolution.rb
 - lib/rubocop/cop/lint/debugger.rb
 - lib/rubocop/cop/lint/deprecated_class_methods.rb
@@ -449,6 +451,7 @@ files:
 - lib/rubocop/cop/lint/nested_percent_literal.rb
 - lib/rubocop/cop/lint/next_without_accumulator.rb
 - lib/rubocop/cop/lint/no_return_in_begin_end_blocks.rb
+- lib/rubocop/cop/lint/non_atomic_file_operation.rb
 - lib/rubocop/cop/lint/non_deterministic_require_order.rb
 - lib/rubocop/cop/lint/non_local_exit_from_iterator.rb
 - lib/rubocop/cop/lint/number_conversion.rb
@@ -507,6 +510,7 @@ files:
 - lib/rubocop/cop/lint/uri_regexp.rb
 - lib/rubocop/cop/lint/useless_access_modifier.rb
 - lib/rubocop/cop/lint/useless_assignment.rb
+- lib/rubocop/cop/lint/useless_else_without_rescue.rb
 - lib/rubocop/cop/lint/useless_method_definition.rb
 - lib/rubocop/cop/lint/useless_ruby2_keywords.rb
 - lib/rubocop/cop/lint/useless_setter_call.rb
@@ -878,6 +882,7 @@ files:
 - lib/rubocop/ext/regexp_node.rb
 - lib/rubocop/ext/regexp_parser.rb
 - lib/rubocop/file_finder.rb
+- lib/rubocop/formatter.rb
 - lib/rubocop/formatter/auto_gen_config_formatter.rb
 - lib/rubocop/formatter/base_formatter.rb
 - lib/rubocop/formatter/clang_style_formatter.rb
@@ -916,6 +921,24 @@ files:
 - lib/rubocop/rspec/shared_contexts.rb
 - lib/rubocop/rspec/support.rb
 - lib/rubocop/runner.rb
+- lib/rubocop/server.rb
+- lib/rubocop/server/cache.rb
+- lib/rubocop/server/cli.rb
+- lib/rubocop/server/client_command.rb
+- lib/rubocop/server/client_command/base.rb
+- lib/rubocop/server/client_command/exec.rb
+- lib/rubocop/server/client_command/restart.rb
+- lib/rubocop/server/client_command/start.rb
+- lib/rubocop/server/client_command/status.rb
+- lib/rubocop/server/client_command/stop.rb
+- lib/rubocop/server/core.rb
+- lib/rubocop/server/errors.rb
+- lib/rubocop/server/helper.rb
+- lib/rubocop/server/server_command.rb
+- lib/rubocop/server/server_command/base.rb
+- lib/rubocop/server/server_command/exec.rb
+- lib/rubocop/server/server_command/stop.rb
+- lib/rubocop/server/socket_reader.rb
 - lib/rubocop/string_interpreter.rb
 - lib/rubocop/target_finder.rb
 - lib/rubocop/target_ruby.rb
@@ -930,7 +953,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.30/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.31/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: 

data/lib/rubocop/cop/gemspec/date_assignment.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Gemspec
-      # Checks that `date =` is not used in gemspec file.
-      # It is set automatically when the gem is packaged.
-      #
-      # @example
-      #
-      #   # bad
-      #   Gem::Specification.new do |spec|
-      #     spec.name = 'your_cool_gem_name'
-      #     spec.date = Time.now.strftime('%Y-%m-%d')
-      #   end
-      #
-      #   # good
-      #   Gem::Specification.new do |spec|
-      #     spec.name = 'your_cool_gem_name'
-      #   end
-      #
-      class DateAssignment < Base
-        include RangeHelp
-        include GemspecHelp
-        extend AutoCorrector
-
-        MSG = 'Do not use `date =` in gemspec, it is set automatically when the gem is packaged.'
-
-        def on_block(block_node)
-          return unless gem_specification?(block_node)
-
-          block_parameter = block_node.arguments.first.source
-
-          date_assignment = block_node.descendants.detect do |node|
-            node.send_type? && node.receiver&.source == block_parameter && node.method?(:date=)
-          end
-
-          return unless date_assignment
-
-          add_offense(date_assignment) do |corrector|
-            range = range_by_whole_lines(date_assignment.source_range, include_final_newline: true)
-
-            corrector.remove(range)
-          end
-        end
-      end
-    end
-  end
-end