rubocop 0.88.0 → 0.91.1

data/lib/rubocop.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
+require 'English'
+before_us = $LOADED_FEATURES.dup
 require 'rainbow'
 
-require 'English'
 require 'set'
 require 'forwardable'
 require 'regexp_parser'
 require 'unicode/display_width/no_string_ext'
 require 'rubocop-ast'
 require_relative 'rubocop/ast_aliases'
+require_relative 'rubocop/ext/regexp_node'
 
 require_relative 'rubocop/version'
 
@@ -33,6 +35,7 @@ require_relative 'rubocop/cop/registry'
 require_relative 'rubocop/cop/base'
 require_relative 'rubocop/cop/cop'
 require_relative 'rubocop/cop/commissioner'
+require_relative 'rubocop/cop/documentation'
 require_relative 'rubocop/cop/corrector'
 require_relative 'rubocop/cop/force'
 require_relative 'rubocop/cop/severity'
@@ -81,6 +84,7 @@ require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
 require_relative 'rubocop/cop/mixin/line_length_help'
 require_relative 'rubocop/cop/mixin/match_range'
+require_relative 'rubocop/cop/metrics/utils/repeated_csend_discount'
 require_relative 'rubocop/cop/mixin/method_complexity'
 require_relative 'rubocop/cop/mixin/method_preference'
 require_relative 'rubocop/cop/mixin/min_body_length'
@@ -94,7 +98,6 @@ require_relative 'rubocop/cop/mixin/nil_methods'
 require_relative 'rubocop/cop/mixin/on_normal_if_unless'
 require_relative 'rubocop/cop/mixin/ordered_gem_node'
 require_relative 'rubocop/cop/mixin/parentheses'
-require_relative 'rubocop/cop/mixin/parser_diagnostic'
 require_relative 'rubocop/cop/mixin/percent_array'
 require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
@@ -110,12 +113,12 @@ require_relative 'rubocop/cop/mixin/statement_modifier'
 require_relative 'rubocop/cop/mixin/string_help'
 require_relative 'rubocop/cop/mixin/string_literals_help'
 require_relative 'rubocop/cop/mixin/target_ruby_version'
-require_relative 'rubocop/cop/mixin/too_many_lines'
 require_relative 'rubocop/cop/mixin/trailing_body'
 require_relative 'rubocop/cop/mixin/trailing_comma'
 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/utils/format_string'
 
@@ -151,6 +154,7 @@ require_relative 'rubocop/cop/layout/access_modifier_indentation'
 require_relative 'rubocop/cop/layout/argument_alignment'
 require_relative 'rubocop/cop/layout/array_alignment'
 require_relative 'rubocop/cop/layout/assignment_indentation'
+require_relative 'rubocop/cop/layout/begin_end_alignment'
 require_relative 'rubocop/cop/layout/block_alignment'
 require_relative 'rubocop/cop/layout/block_end_newline'
 require_relative 'rubocop/cop/layout/case_indentation'
@@ -165,6 +169,7 @@ require_relative 'rubocop/cop/layout/else_alignment'
 require_relative 'rubocop/cop/layout/empty_comment'
 require_relative 'rubocop/cop/layout/empty_line_after_guard_clause'
 require_relative 'rubocop/cop/layout/empty_line_after_magic_comment'
+require_relative 'rubocop/cop/layout/empty_line_after_multiline_condition'
 require_relative 'rubocop/cop/layout/empty_line_between_defs'
 require_relative 'rubocop/cop/layout/empty_lines_around_access_modifier'
 require_relative 'rubocop/cop/layout/empty_lines_around_arguments'
@@ -243,8 +248,10 @@ require_relative 'rubocop/cop/lint/ambiguous_operator'
 require_relative 'rubocop/cop/lint/ambiguous_regexp_literal'
 require_relative 'rubocop/cop/lint/assignment_in_condition'
 require_relative 'rubocop/cop/lint/big_decimal_new'
+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_resolution'
 require_relative 'rubocop/cop/lint/debugger'
 require_relative 'rubocop/cop/lint/deprecated_class_methods'
@@ -254,18 +261,24 @@ 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_methods'
+require_relative 'rubocop/cop/lint/duplicate_require'
+require_relative 'rubocop/cop/lint/duplicate_rescue_exception'
 require_relative 'rubocop/cop/lint/each_with_object_argument'
 require_relative 'rubocop/cop/lint/else_layout'
+require_relative 'rubocop/cop/lint/empty_conditional_body'
 require_relative 'rubocop/cop/lint/empty_ensure'
 require_relative 'rubocop/cop/lint/empty_expression'
+require_relative 'rubocop/cop/lint/empty_file'
 require_relative 'rubocop/cop/lint/empty_interpolation'
 require_relative 'rubocop/cop/lint/empty_when'
 require_relative 'rubocop/cop/lint/ensure_return'
 require_relative 'rubocop/cop/lint/erb_new_arguments'
 require_relative 'rubocop/cop/lint/flip_flop'
+require_relative 'rubocop/cop/lint/float_comparison'
 require_relative 'rubocop/cop/lint/float_out_of_range'
 require_relative 'rubocop/cop/lint/format_parameter_mismatch'
 require_relative 'rubocop/cop/lint/heredoc_method_call_position'
+require_relative 'rubocop/cop/lint/identity_comparison'
 require_relative 'rubocop/cop/lint/implicit_string_concatenation'
 require_relative 'rubocop/cop/lint/inherit_exception'
 require_relative 'rubocop/cop/lint/ineffective_access_modifier'
@@ -274,6 +287,7 @@ require_relative 'rubocop/cop/lint/literal_as_condition'
 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_regexp_capture_types'
 require_relative 'rubocop/cop/lint/multiple_comparison'
 require_relative 'rubocop/cop/lint/nested_method_definition'
@@ -283,6 +297,7 @@ 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'
 require_relative 'rubocop/cop/lint/ordered_magic_comments'
+require_relative 'rubocop/cop/lint/out_of_range_regexp_ref'
 require_relative 'rubocop/cop/lint/parentheses_as_grouped_expression'
 require_relative 'rubocop/cop/lint/percent_string_array'
 require_relative 'rubocop/cop/lint/percent_symbol_array'
@@ -304,6 +319,7 @@ require_relative 'rubocop/cop/lint/safe_navigation_consistency'
 require_relative 'rubocop/cop/lint/safe_navigation_chain'
 require_relative 'rubocop/cop/lint/safe_navigation_with_empty'
 require_relative 'rubocop/cop/lint/script_permission'
+require_relative 'rubocop/cop/lint/self_assignment'
 require_relative 'rubocop/cop/lint/send_with_mixin_argument'
 require_relative 'rubocop/cop/lint/shadowed_argument'
 require_relative 'rubocop/cop/lint/shadowed_exception'
@@ -312,18 +328,22 @@ require_relative 'rubocop/cop/lint/struct_new_override'
 require_relative 'rubocop/cop/lint/suppressed_exception'
 require_relative 'rubocop/cop/lint/syntax'
 require_relative 'rubocop/cop/lint/to_json'
+require_relative 'rubocop/cop/lint/top_level_return_with_argument'
+require_relative 'rubocop/cop/lint/trailing_comma_in_attribute_declaration'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require_relative 'rubocop/cop/lint/unified_integer'
 require_relative 'rubocop/cop/lint/unreachable_code'
+require_relative 'rubocop/cop/lint/unreachable_loop'
 require_relative 'rubocop/cop/lint/unused_block_argument'
 require_relative 'rubocop/cop/lint/unused_method_argument'
 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_comparison'
 require_relative 'rubocop/cop/lint/useless_else_without_rescue'
+require_relative 'rubocop/cop/lint/useless_method_definition'
 require_relative 'rubocop/cop/lint/useless_setter_call'
+require_relative 'rubocop/cop/lint/useless_times'
 require_relative 'rubocop/cop/lint/void'
 
 require_relative 'rubocop/cop/metrics/utils/iterating_block'
@@ -377,10 +397,12 @@ require_relative 'rubocop/cop/style/character_literal'
 require_relative 'rubocop/cop/style/class_and_module_children'
 require_relative 'rubocop/cop/style/class_check'
 require_relative 'rubocop/cop/style/class_methods'
+require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'
 require_relative 'rubocop/cop/style/collection_methods'
 require_relative 'rubocop/cop/style/colon_method_call'
 require_relative 'rubocop/cop/style/colon_method_definition'
+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'
@@ -408,12 +430,14 @@ require_relative 'rubocop/cop/style/end_block'
 require_relative 'rubocop/cop/style/eval_with_location'
 require_relative 'rubocop/cop/style/even_odd'
 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/float_division'
 require_relative 'rubocop/cop/style/for'
 require_relative 'rubocop/cop/style/format_string'
 require_relative 'rubocop/cop/style/format_string_token'
 require_relative 'rubocop/cop/style/frozen_string_literal_comment'
+require_relative 'rubocop/cop/style/global_std_stream'
 require_relative 'rubocop/cop/style/global_vars'
 require_relative 'rubocop/cop/style/guard_clause'
 require_relative 'rubocop/cop/style/hash_as_last_array_item'
@@ -432,6 +456,7 @@ 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/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'
@@ -440,11 +465,12 @@ require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
 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'
+require_relative 'rubocop/cop/style/redundant_self_assignment'
+require_relative 'rubocop/cop/style/sole_nested_conditional'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
 require_relative 'rubocop/cop/style/method_called_on_do_end_block'
 require_relative 'rubocop/cop/style/method_def_parentheses'
-require_relative 'rubocop/cop/style/method_missing_super'
 require_relative 'rubocop/cop/style/min_max'
 require_relative 'rubocop/cop/style/missing_else'
 require_relative 'rubocop/cop/style/missing_respond_to_missing'
@@ -477,6 +503,7 @@ require_relative 'rubocop/cop/style/one_line_conditional'
 require_relative 'rubocop/cop/style/or_assignment'
 require_relative 'rubocop/cop/style/option_hash'
 require_relative 'rubocop/cop/style/optional_arguments'
+require_relative 'rubocop/cop/style/optional_boolean_parameter'
 require_relative 'rubocop/cop/style/parallel_assignment'
 require_relative 'rubocop/cop/style/parentheses_around_condition'
 require_relative 'rubocop/cop/style/percent_literal_delimiters'
@@ -511,12 +538,14 @@ require_relative 'rubocop/cop/style/self_assignment'
 require_relative 'rubocop/cop/style/semicolon'
 require_relative 'rubocop/cop/style/send'
 require_relative 'rubocop/cop/style/signal_exception'
+require_relative 'rubocop/cop/style/single_argument_dig'
 require_relative 'rubocop/cop/style/single_line_block_params'
 require_relative 'rubocop/cop/style/single_line_methods'
 require_relative 'rubocop/cop/style/slicing_with_range'
 require_relative 'rubocop/cop/style/special_global_vars'
 require_relative 'rubocop/cop/style/stabby_lambda_parentheses'
 require_relative 'rubocop/cop/style/stderr_puts'
+require_relative 'rubocop/cop/style/string_concatenation'
 require_relative 'rubocop/cop/style/string_hash_keys'
 require_relative 'rubocop/cop/style/string_literals'
 require_relative 'rubocop/cop/style/string_literals_in_interpolation'
@@ -585,6 +614,7 @@ require_relative 'rubocop/config_obsoletion'
 require_relative 'rubocop/config_store'
 require_relative 'rubocop/config_validator'
 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'
@@ -602,3 +632,7 @@ require_relative 'rubocop/options'
 require_relative 'rubocop/remote_config'
 require_relative 'rubocop/target_ruby'
 require_relative 'rubocop/yaml_duplication_checker'
+
+unless File.exist?("#{__dir__}/../rubocop.gemspec") # Check if we are a gem
+  RuboCop::ResultCache.rubocop_required_features = $LOADED_FEATURES - before_us
+end

data/lib/rubocop/cached_data.rb

@@ -4,6 +4,7 @@ require 'json'
 
 module RuboCop
   # Converts RuboCop objects to and from the serialization format JSON.
+  # @api private
   class CachedData
     def initialize(filename)
       @filename = filename

data/lib/rubocop/cli/command.rb

@@ -3,6 +3,7 @@
 module RuboCop
   class CLI
     # Home of subcommands in the CLI.
+    # @api private
     module Command
       class << self
         # Find the command with a given name and run it in an environment.

data/lib/rubocop/cli/command/auto_genenerate_config.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Generate a configuration file acting as a TODO list.
+      # @api private
       class AutoGenerateConfig < Base
         self.command_name = :auto_gen_config
 
@@ -113,7 +114,7 @@ module RuboCop
             return if files.include?(AUTO_GENERATED_FILE)
 
             files.unshift(AUTO_GENERATED_FILE)
-            file_string = "\n  - " + files.join("\n  - ") if files.size > 1
+            file_string = "\n  - #{files.join("\n  - ")}" if files.size > 1
             rubocop_yml_contents = existing_configuration(config_file)
           end
 

data/lib/rubocop/cli/command/base.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # A subcommand in the CLI.
+      # @api private
       class Base
         attr_reader :env
 
@@ -13,6 +14,7 @@ module RuboCop
           attr_accessor :command_name
 
           def inherited(subclass)
+            super
             @subclasses << subclass
           end
 

data/lib/rubocop/cli/command/execute_runner.rb

@@ -4,9 +4,13 @@ module RuboCop
   class CLI
     module Command
       # Run all the selected cops and report the result.
+      # @api private
       class ExecuteRunner < Base
         include Formatter::TextUtil
 
+        # Combination of short and long formatter names.
+        INTEGRATION_FORMATTERS = %w[h html j json ju junit].freeze
+
         self.command_name = :execute_runner
 
         def run
@@ -55,11 +59,16 @@ module RuboCop
             #{Gem.loaded_specs['rubocop'].metadata['bug_tracker_uri']}
 
             Mention the following information in the issue report:
-            #{RuboCop::Version.version(true)}
+            #{RuboCop::Version.version(debug: true)}
           WARNING
         end
 
         def maybe_print_corrected_source
+          # Integration tools (like RubyMine) expect to have only the JSON result
+          # when specifying JSON format. Similar HTML and JUnit are targeted as well.
+          # See: https://github.com/rubocop-hq/rubocop/issues/8673
+          return if INTEGRATION_FORMATTERS.include?(@options[:format])
+
           # If we are asked to autocorrect source code read from stdin, the only
           # reasonable place to write it is to stdout
           # Unfortunately, we also write other information to stdout

data/lib/rubocop/cli/command/init_dotfile.rb

@@ -4,6 +4,7 @@ module RuboCop
   class CLI
     module Command
       # Generate a .rubocop.yml file in the current directory.
+      # @api private
       class InitDotfile < Base
         DOTFILE = ConfigLoader::DOTFILE
 

data/lib/rubocop/cli/command/show_cops.rb

@@ -5,6 +5,7 @@ module RuboCop
     module Command
       # Shows the given cops, or all cops by default, and their configurations
       # for the current directory.
+      # @api private
       class ShowCops < Base
         self.command_name = :show_cops
 
@@ -22,7 +23,7 @@ module RuboCop
         private
 
         def print_available_cops
-          registry = Cop::Cop.registry
+          registry = Cop::Registry.global
           show_all = @options[:show_cops].empty?
 
           if show_all
@@ -68,7 +69,7 @@ module RuboCop
 
         def config_lines(cop)
           cnf = @config.for_cop(cop)
-          cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
+          cnf.to_yaml.lines.to_a.drop(1).map { |line| "  #{line}" }
         end
       end
     end

data/lib/rubocop/cli/command/version.rb

@@ -4,12 +4,13 @@ module RuboCop
   class CLI
     module Command
       # Display version.
+      # @api private
       class Version < Base
         self.command_name = :version
 
         def run
-          puts RuboCop::Version.version(false) if @options[:version]
-          puts RuboCop::Version.version(true) if @options[:verbose_version]
+          puts RuboCop::Version.version(debug: false) if @options[:version]
+          puts RuboCop::Version.version(debug: true) if @options[:verbose_version]
         end
       end
     end

data/lib/rubocop/cli/environment.rb

@@ -3,6 +3,7 @@
 module RuboCop
   class CLI
     # Execution environment for a CLI command.
+    # @api private
     class Environment
       attr_reader :options, :config_store, :paths
 

data/lib/rubocop/comment_config.rb

@@ -4,14 +4,19 @@ module RuboCop
   # This class parses the special `rubocop:disable` comments in a source
   # and provides a way to check if each cop is enabled at arbitrary line.
   class CommentConfig
+    # @api private
     REDUNDANT_DISABLE = 'Lint/RedundantCopDisableDirective'
 
+    # @api private
     COP_NAME_PATTERN = '([A-Z]\w+/)?(?:[A-Z]\w+)'
+    # @api private
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
+    # @api private
     COPS_PATTERN = "(all|#{COP_NAMES_PATTERN})"
 
+    # @api private
     COMMENT_DIRECTIVE_REGEXP = Regexp.new(
-      ('# rubocop : ((?:disable|enable|todo))\b ' + COPS_PATTERN)
+      "# rubocop : ((?:disable|enable|todo))\\b #{COPS_PATTERN}"
         .gsub(' ', '\s*')
     )
 
@@ -36,12 +41,15 @@ module RuboCop
     end
 
     def extra_enabled_comments
-      extra_enabled_comments_with_names([], {})
+      extra_enabled_comments_with_names(
+        extras: Hash.new { |h, k| h[k] = [] },
+        names: Hash.new(0)
+      )
     end
 
     private
 
-    def extra_enabled_comments_with_names(extras, names)
+    def extra_enabled_comments_with_names(extras:, names:)
       each_directive do |comment, cop_names, disabled|
         next unless comment_only_line?(comment.loc.expression.line)
 
@@ -55,7 +63,7 @@ module RuboCop
       extras
     end
 
-    def analyze
+    def analyze # rubocop:todo Metrics/AbcSize
       analyses = Hash.new { |hash, key| hash[key] = CopAnalysis.new([], nil) }
 
       each_mentioned_cop do |cop_name, disabled, line, single_line|
@@ -128,9 +136,7 @@ module RuboCop
     end
 
     def each_directive
-      return if processed_source.comments.nil?
-
-      processed_source.each_comment do |comment|
+      processed_source.comments.each do |comment|
         directive = directive_parts(comment)
         next unless directive
 
@@ -153,11 +159,11 @@ module RuboCop
     end
 
     def qualified_cop_name(cop_name)
-      Cop::Cop.qualified_cop_name(cop_name.strip, processed_source.file_path)
+      Cop::Registry.qualified_cop_name(cop_name.strip, processed_source.file_path)
     end
 
     def all_cop_names
-      @all_cop_names ||= Cop::Cop.registry.names - [REDUNDANT_DISABLE]
+      @all_cop_names ||= Cop::Registry.global.names - [REDUNDANT_DISABLE]
     end
 
     def comment_only_line?(line_number)
@@ -187,18 +193,19 @@ module RuboCop
         enabled_cops += 1
       end
 
-      extras << [comment, 'all'] if enabled_cops.zero?
+      extras[comment] << 'all' if enabled_cops.zero?
     end
 
+    # Collect cops that have been disabled or enabled by name in a directive comment
+    # so that `Lint/RedundantCopEnableDirective` can register offenses correctly.
     def handle_switch(cop_names, names, disabled, extras, comment)
       cop_names.each do |name|
-        names[name] ||= 0
         if disabled
           names[name] += 1
         elsif (names[name]).positive?
           names[name] -= 1
         else
-          extras << [comment, name]
+          extras[comment] << name
         end
       end
     end