rubocop 0.90.0 → 0.93.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39db2826fa916853dc6641e30da24937e009a06b843daf1a7cdb2eca458dfaad
-  data.tar.gz: 9a4ffd95ff0401aeee427555d1baf51517e06580becfa9243dac9c75305998aa
+  metadata.gz: b8ce11205d6a6bb518654cbe498544aa799fbb8d9c9057afd2f551edfc35bbb8
+  data.tar.gz: a1f79001991b28508ca7c9a79d75ed58f39ae0dcf2bad419d6a75919b3a3d539
 SHA512:
-  metadata.gz: 7e502aeecd9ceaeec36624190f4e9b72d075eed552f2e6204e2e842db1a77758f5fd11336f01f400af45bb36b27f13885a27847b17b84595aeef90df6b0db63b
-  data.tar.gz: e7ecf12bfc331ef99870f03e034a5154765ceb93c159fdde0fdf8802609c81fa3459250eb3bf6aa7ee140d5c80958783614f5da81585ba75ad9e252afdb8fc50
+  metadata.gz: a32001a91575c41b5ca71b6a148af79f45b2a7b8cbc3909a0dcbb7a652f5e62b6a79a84c14189eda64fd3d2a9e8c40d207c37c0f5a78a156e1f636c5191b995e
+  data.tar.gz: 9ac5df57938099031807a96bd87a7fb9c5f7f40c314528b4c3254edb45b1386ce199fa9c394c9e7531655d117df9d3d5215bd66e4a927b9b2b0878e0eac2a1f6

data/README.md

@@ -22,7 +22,7 @@
 **RuboCop** is a Ruby static code analyzer (a.k.a. `linter`) and code formatter. Out of the box it
 will enforce many of the guidelines outlined in the community [Ruby Style
 Guide](https://rubystyle.guide). Apart from reporting the problems discovered in your code,
-RuboCop can also automatically fix many of them you.
+RuboCop can also automatically fix many of them for you.
 
 RuboCop is extremely flexible and most aspects of its behavior can be tweaked via various
 [configuration options](https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml).
@@ -49,7 +49,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version lock in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.90.0', require: false
+gem 'rubocop', '~> 0.93.1', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -117,6 +117,8 @@ AllCops:
   # CacheRootDirectory is ~ (nil), which it is by default, the root will be
   # taken from the environment variable `$XDG_CACHE_HOME` if it is set, or if
   # `$XDG_CACHE_HOME` is not set, it will be `$HOME/.cache/`.
+  # The CacheRootDirectory can be overwritten by passing the `--cache-root` command
+  # line option or by setting `$RUBOCOP_CACHE_ROOT` environment variable.
   CacheRootDirectory: ~
   # It is possible for a malicious user to know the location of RuboCop's cache
   # directory by looking at CacheRootDirectory, and create a symlink in its
@@ -309,6 +311,19 @@ Layout/AssignmentIndentation:
   # But it can be overridden by setting this parameter
   IndentationWidth: ~
 
+Layout/BeginEndAlignment:
+  Description: 'Align ends corresponding to begins correctly.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  # The value `start_of_line` means that `end` should be aligned the start of the line
+  # where the `begin` keyword is.
+  # The value `begin` means that `end` should be aligned with the `begin` keyword.
+  EnforcedStyleAlignWith: start_of_line
+  SupportedStylesAlignWith:
+    - start_of_line
+    - begin
+  Severity: warning
+
 Layout/BlockAlignment:
   Description: 'Align block ends correctly.'
   Enabled: true
@@ -1380,6 +1395,12 @@ Lint/CircularArgumentReference:
   Enabled: true
   VersionAdded: '0.33'
 
+Lint/ConstantDefinitionInBlock:
+  Description: 'Do not define constants within a block.'
+  StyleGuide: '#no-constant-definition-in-block'
+  Enabled: pending
+  VersionAdded: '0.91'
+
 Lint/ConstantResolution:
   Description: 'Check that constants are fully qualified with `::`.'
   Enabled: false
@@ -1525,6 +1546,13 @@ Lint/FormatParameterMismatch:
   Enabled: true
   VersionAdded: '0.33'
 
+Lint/HashCompareByIdentity:
+  Description: 'Prefer using `Hash#compare_by_identity` than using `object_id` for keys.'
+  StyleGuide: '#identity-comparison'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '0.93'
+
 Lint/HeredocMethodCallPosition:
   Description: >-
                  Checks for the ordering of a method call where
@@ -1533,6 +1561,12 @@ Lint/HeredocMethodCallPosition:
   StyleGuide: '#heredoc-method-calls'
   VersionAdded: '0.68'
 
+Lint/IdentityComparison:
+  Description: 'Prefer `equal?` over `==` when comparing `object_id`.'
+  Enabled: pending
+  StyleGuide: '#identity-comparison'
+  VersionAdded: '0.91'
+
 Lint/ImplicitStringConcatenation:
   Description: >-
                  Checks for adjacent string literals on the same line, which
@@ -1719,6 +1753,19 @@ Lint/RedundantRequireStatement:
   Enabled: true
   VersionAdded: '0.76'
 
+Lint/RedundantSafeNavigation:
+  Description: 'Checks for redundant safe navigation calls.'
+  Enabled: pending
+  VersionAdded: '0.93'
+  AllowedMethods:
+    - instance_of?
+    - kind_of?
+    - is_a?
+    - eql?
+    - respond_to?
+    - equal?
+  Safe: false
+
 Lint/RedundantSplatExpansion:
   Description: 'Checks for splat unnecessarily being called on literals.'
   Enabled: true
@@ -1784,6 +1831,7 @@ Lint/SafeNavigationChain:
     - presence
     - try
     - try!
+    - in?
 
 Lint/SafeNavigationConsistency:
   Description: >-
@@ -1966,6 +2014,12 @@ Lint/UselessSetterCall:
   VersionChanged: '0.80'
   Safe: false
 
+Lint/UselessTimes:
+  Description: 'Checks for useless `Integer#times` calls.'
+  Enabled: pending
+  VersionAdded: '0.91'
+  Safe: false
+
 Lint/Void:
   Description: 'Possible use of operator/literal/variable in void context.'
   Enabled: true
@@ -2429,7 +2483,7 @@ Style/ArrayCoercion:
                   with a variable you want to treat as an Array, but you're not certain it's an array.
   StyleGuide: '#array-coercion'
   Safe: false
-  Enabled: 'pending'
+  Enabled: false
   VersionAdded: '0.88'
 
 Style/ArrayJoin:
@@ -2668,6 +2722,16 @@ Style/ClassCheck:
     - is_a?
     - kind_of?
 
+Style/ClassEqualityComparison:
+  Description: 'Enforces the use of `Object#instance_of?` instead of class comparison for equality.'
+  StyleGuide: '#instance-of-vs-class-comparison'
+  Enabled: pending
+  VersionAdded: '0.93'
+  IgnoredMethods:
+    - ==
+    - equal?
+    - eql?
+
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
   StyleGuide: '#def-self-class-methods'
@@ -2829,7 +2893,8 @@ Style/DateTime:
   StyleGuide: '#date--time'
   Enabled: false
   VersionAdded: '0.51'
-  VersionChanged: '0.59'
+  VersionChanged: '0.92'
+  SafeAutoCorrect: false
   AllowCoercion: false
 
 Style/DefWithParentheses:
@@ -3074,6 +3139,7 @@ Style/GlobalStdStream:
   StyleGuide: '#global-stdout'
   Enabled: pending
   VersionAdded: '0.89'
+  SafeAutoCorrect: false
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'
@@ -3248,11 +3314,16 @@ Style/IpAddresses:
   Description: "Don't include literal IP addresses in code."
   Enabled: false
   VersionAdded: '0.58'
-  VersionChanged: '0.77'
+  VersionChanged: '0.91'
   # Allow addresses to be permitted
   AllowedAddresses:
     - "::"
     # :: is a valid IPv6 address, but could potentially be legitimately in code
+  Exclude:
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/gems.rb'
+    - '**/*.gemspec'
 
 Style/KeywordParametersOrder:
   Description: 'Enforces that optional keyword parameters are placed at the end of the parameters list.'
@@ -3685,6 +3756,8 @@ Style/OptionalBooleanParameter:
   Enabled: pending
   Safe: false
   VersionAdded: '0.89'
+  AllowedMethods:
+    - respond_to_missing?
 
 Style/OrAssignment:
   Description: 'Recommend usage of double pipe equals (||=) where applicable.'
@@ -3953,6 +4026,8 @@ Style/SafeNavigation:
                   This cop transforms usages of a method call safeguarded by
                   a check for the existence of the object to
                   safe navigation (`&.`).
+                  Auto-correction is unsafe as it assumes the object will
+                  be `nil` or truthy, but never `false`.
   Enabled: true
   VersionAdded: '0.43'
   VersionChanged: '0.77'
@@ -3965,6 +4040,7 @@ Style/SafeNavigation:
     - presence
     - try
     - try!
+  SafeAutoCorrect: false
 
 Style/Sample:
   Description: >-

data/lib/rubocop.rb

@@ -1,18 +1,21 @@
 # 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'
+
+# we have to require RuboCop's version, before rubocop-ast's
+require_relative 'rubocop/version'
 require 'rubocop-ast'
+
 require_relative 'rubocop/ast_aliases'
 require_relative 'rubocop/ext/regexp_node'
 
-require_relative 'rubocop/version'
-
 require_relative 'rubocop/core_ext/string'
 require_relative 'rubocop/ext/processed_source'
 
@@ -24,7 +27,6 @@ require_relative 'rubocop/string_interpreter'
 require_relative 'rubocop/error'
 require_relative 'rubocop/warning'
 
-require_relative 'rubocop/cop/tokens_util'
 require_relative 'rubocop/cop/util'
 require_relative 'rubocop/cop/offense'
 require_relative 'rubocop/cop/message_annotator'
@@ -103,7 +105,6 @@ require_relative 'rubocop/cop/mixin/percent_literal'
 require_relative 'rubocop/cop/mixin/preceding_following_alignment'
 require_relative 'rubocop/cop/mixin/preferred_delimiters'
 require_relative 'rubocop/cop/mixin/rational_literal'
-require_relative 'rubocop/cop/mixin/regexp_literal_help'
 require_relative 'rubocop/cop/mixin/rescue_node'
 require_relative 'rubocop/cop/mixin/safe_assignment'
 require_relative 'rubocop/cop/mixin/space_after_punctuation'
@@ -154,6 +155,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'
@@ -250,6 +252,7 @@ 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'
@@ -275,7 +278,9 @@ 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/hash_compare_by_identity'
 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'
@@ -303,6 +308,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_require_statement'
+require_relative 'rubocop/cop/lint/redundant_safe_navigation'
 require_relative 'rubocop/cop/lint/redundant_splat_expansion'
 require_relative 'rubocop/cop/lint/redundant_string_coercion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
@@ -340,6 +346,7 @@ 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_setter_call'
+require_relative 'rubocop/cop/lint/useless_times'
 require_relative 'rubocop/cop/lint/void'
 
 require_relative 'rubocop/cop/metrics/utils/iterating_block'
@@ -392,6 +399,7 @@ require_relative 'rubocop/cop/style/case_like_if'
 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_equality_comparison'
 require_relative 'rubocop/cop/style/class_methods'
 require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'
@@ -610,6 +618,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'
@@ -623,7 +632,13 @@ require_relative 'rubocop/cli/command/execute_runner'
 require_relative 'rubocop/cli/command/init_dotfile'
 require_relative 'rubocop/cli/command/show_cops'
 require_relative 'rubocop/cli/command/version'
+require_relative 'rubocop/config_regeneration'
 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
+RuboCop::AST.rubocop_loaded if RuboCop::AST.respond_to?(:rubocop_loaded)

data/lib/rubocop/cached_data.rb

@@ -21,6 +21,7 @@ module RuboCop
     private
 
     def serialize_offense(offense)
+      status = :uncorrected if %i[corrected corrected_with_todo].include?(offense.status)
       {
         # Calling #to_s here ensures that the serialization works when using
         # other json serializers such as Oj. Some of these gems do not call
@@ -32,7 +33,7 @@ module RuboCop
         },
         message:  message(offense),
         cop_name: offense.cop_name,
-        status:   :uncorrected
+        status:   status || offense.status
       }
     end
 

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

@@ -8,6 +8,9 @@ module RuboCop
       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
@@ -61,6 +64,11 @@ module RuboCop
         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/comment_config.rb

@@ -41,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)
 
@@ -190,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

data/lib/rubocop/config_loader.rb

@@ -129,9 +129,9 @@ module RuboCop
 
       def default_configuration
         @default_configuration ||= begin
-                                     print 'Default ' if debug?
-                                     load_file(DEFAULT_FILE)
-                                   end
+          print 'Default ' if debug?
+          load_file(DEFAULT_FILE)
+        end
       end
 
       # Returns the path rubocop inferred as the root of the project. No file

data/lib/rubocop/config_regeneration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  # This class handles collecting the options for regenerating a TODO file.
+  # @api private
+  class ConfigRegeneration
+    AUTO_GENERATED_FILE = RuboCop::CLI::Command::AutoGenerateConfig::AUTO_GENERATED_FILE
+    COMMAND_REGEX = /(?<=`rubocop )(.*?)(?=`)/.freeze
+    DEFAULT_OPTIONS = { auto_gen_config: true }.freeze
+
+    # Get options from the comment in the TODO file, and parse them as options
+    def options
+      # If there's no existing TODO file, generate one
+      return DEFAULT_OPTIONS unless todo_exists?
+
+      match = generation_command.match(COMMAND_REGEX)
+      return DEFAULT_OPTIONS unless match
+
+      options = match[1].split(' ')
+      Options.new.parse(options).first
+    end
+
+    private
+
+    def todo_exists?
+      File.exist?(AUTO_GENERATED_FILE) && !File.empty?(AUTO_GENERATED_FILE)
+    end
+
+    def generation_command
+      File.foreach(AUTO_GENERATED_FILE).take(2).last
+    end
+  end
+end