rubocop 0.81.0 → 0.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af0dab74354064816d5756cb5a49ab7160c444292ef32e9ee7980dff8a18110f
-  data.tar.gz: 96288aa5f77f19813ef7cac495f7c86d912f3be28da021b01d30136a2ef28f99
+  metadata.gz: 9e04c6e897293df4ef1c7bf05a0c0077512e2cba797a7caee484b1c08a7300ad
+  data.tar.gz: 92fbc98b5068e5c30bf83d058e3cfe774a1a65cc90608027ff8d6624c8c2910c
 SHA512:
-  metadata.gz: 015244a9c6aff6e2d5640e68b286127944418221bb8c76db04273c5c35b5bc41e03bf7d85c44a3b630a0dd8a24f5a4531ddaf61adb0b75a0b39e2e6c2e08d8cf
-  data.tar.gz: 8e209ee81ebf1d5a3215292c7d7eddabaacb64e0fa1da7935372495ad13e5bdd896b7fd27fde25fc0e8ffaa7d1b0873f47c40f505d4828e23a52f0ca2ee847e6
+  metadata.gz: cacf128617d233de65c2061d0300d345357840b151f65c78a2463fa23830115dcaa667cc2110ef39cacd14d957e626fc3fb4857443e40a1ab0fb485ce9cbfeed
+  data.tar.gz: f7a095da673a5b32de33293c6056c580995d1b2ad913e2891c1740ab1ffb42896f1b0c69491eb75656907b60e4de6f6a58a119c8936cff26d1ed678bc1159e0c

data/README.md

@@ -53,7 +53,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.81.0', require: false
+gem 'rubocop', '~> 0.82.0', require: false
 ```
 
 ## Quickstart
@@ -73,7 +73,7 @@ You can read a lot more about RuboCop in its [official docs](https://docs.ruboco
 
 RuboCop supports the following Ruby implementations:
 
-* MRI 2.3+
+* MRI 2.4+
 * JRuby 9.2+
 
 ## Team

data/config/default.yml

@@ -97,6 +97,14 @@ AllCops:
   # to true in the same configuration.
   EnabledByDefault: false
   DisabledByDefault: false
+  # New cops introduced between major versions are set to a special pending status
+  # and are not enabled by default with warning message.
+  # Change this behavior by overriding either `NewCops: enable` or `NewCops: disable`.
+  # When `NewCops` is `enable`, pending cops are enabled in bulk. Can be overridden by
+  # the `--enable-pending-cops` command-line option.
+  # When `NewCops` is `disable`, pending cops are disabled in bulk. Can be overridden by
+  # the `--disable-pending-cops` command-line option.
+  NewCops: pending
   # Enables the result cache if `true`. Can be overridden by the `--cache` command
   # line option.
   UseCache: true
@@ -125,7 +133,7 @@ AllCops:
   # followed by the Gemfile.lock or gems.locked file. (Although the Ruby version
   # is specified in the Gemfile or gems.rb file, RuboCop reads the final value
   # from the lock file.) If the Ruby version is still unresolved, RuboCop will
-  # use the oldest officially supported Ruby version (currently Ruby 2.3).
+  # use the oldest officially supported Ruby version (currently Ruby 2.4).
   TargetRubyVersion: ~
 
 #################### Bundler ###############################
@@ -793,6 +801,22 @@ Layout/IndentationConsistency:
     # A reference to `EnforcedStyle: indented_internal_methods`.
     - https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#follow-the-coding-conventions
 
+Layout/IndentationStyle:
+  Description: 'Consistent indentation either with tabs only or spaces only.'
+  StyleGuide: '#spaces-indentation'
+  Enabled: true
+  VersionAdded: '0.49'
+  VersionChanged: '0.82'
+  # By default, the indentation width from Layout/IndentationWidth is used
+  # But it can be overridden by setting this parameter
+  # It is used during auto-correction to determine how many spaces should
+  # replace each tab.
+  IndentationWidth: ~
+  EnforcedStyle: spaces
+  SupportedStyles:
+    - spaces
+    - tabs
+
 Layout/IndentationWidth:
   Description: 'Use 2 spaces for indentation.'
   StyleGuide: '#spaces-indentation'
@@ -1080,6 +1104,11 @@ Layout/SpaceAroundKeyword:
   Enabled: true
   VersionAdded: '0.49'
 
+Layout/SpaceAroundMethodCallOperator:
+  Description: 'Checks method call operators to not have spaces around them.'
+  Enabled: pending
+  VersionAdded: '0.82'
+
 Layout/SpaceAroundOperators:
   Description: 'Use a single space around operators.'
   StyleGuide: '#spaces-operators'
@@ -1250,18 +1279,6 @@ Layout/SpaceInsideStringInterpolation:
     - space
     - no_space
 
-Layout/Tab:
-  Description: 'No hard tabs.'
-  StyleGuide: '#spaces-indentation'
-  Enabled: true
-  VersionAdded: '0.49'
-  VersionChanged: '0.51'
-  # By default, the indentation width from Layout/IndentationWidth is used
-  # But it can be overridden by setting this parameter
-  # It is used during auto-correction to determine how many spaces should
-  # replace each tab.
-  IndentationWidth: ~
-
 Layout/TrailingEmptyLines:
   Description: 'Checks trailing blank lines and final newline.'
   StyleGuide: '#newline-eof'
@@ -1567,6 +1584,8 @@ Lint/RaiseException:
   StyleGuide: '#raise-exception'
   Enabled: pending
   VersionAdded: '0.81'
+  AllowedImplicitNamespaces:
+    - 'Gem'
 
 Lint/RandOne:
   Description: >-
@@ -2409,6 +2428,15 @@ Style/CaseEquality:
   StyleGuide: '#no-case-equality'
   Enabled: true
   VersionAdded: '0.9'
+  # If AllowOnConstant is enabled, the cop will ignore violations when the receiver of
+  # the case equality operator is a constant.
+  #
+  #   # bad
+  #   /string/ === "string"
+  #
+  #   # good
+  #   String === "string"
+  AllowOnConstant: false
 
 Style/CharacterLiteral:
   Description: 'Checks for uses of character literals.'
@@ -2449,6 +2477,7 @@ Style/ClassAndModuleChildren:
 
 Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
+  StyleGuide: '#is-a-vs-kind-of'
   Enabled: true
   VersionAdded: '0.24'
   EnforcedStyle: is_a?
@@ -2616,6 +2645,12 @@ Style/Dir:
   Enabled: true
   VersionAdded: '0.50'
 
+Style/DisableCopsWithinSourceCodeDirective:
+  Description: >-
+                 Forbids disabling/enabling cops within source code.
+  Enabled: false
+  VersionAdded: '0.82'
+
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
   Enabled: true
@@ -2734,6 +2769,17 @@ Style/ExpandPathArguments:
   Enabled: true
   VersionAdded: '0.53'
 
+Style/ExponentialNotation:
+  Description: 'When using exponential notation, favor a mantissa between 1 (inclusive) and 10 (exclusive).'
+  StyleGuide: '#exponential-notation'
+  Enabled: pending
+  VersionAdded: '0.82'
+  EnforcedStyle: scientific
+  SupportedStyles:
+    - scientific
+    - engineering
+    - integral
+
 Style/FloatDivision:
   Description: 'For performing float division, coerce one side only.'
   StyleGuide: '#float-division'

data/lib/rubocop.rb

@@ -235,6 +235,7 @@ require_relative 'rubocop/cop/layout/hash_alignment'
 require_relative 'rubocop/cop/layout/heredoc_argument_closing_parenthesis'
 require_relative 'rubocop/cop/layout/heredoc_indentation'
 require_relative 'rubocop/cop/layout/indentation_consistency'
+require_relative 'rubocop/cop/layout/indentation_style'
 require_relative 'rubocop/cop/layout/indentation_width'
 require_relative 'rubocop/cop/layout/initial_indentation'
 require_relative 'rubocop/cop/layout/leading_comment_space'
@@ -261,6 +262,7 @@ require_relative 'rubocop/cop/layout/space_after_semicolon'
 require_relative 'rubocop/cop/layout/space_around_block_parameters'
 require_relative 'rubocop/cop/layout/space_around_equals_in_parameter_default'
 require_relative 'rubocop/cop/layout/space_around_keyword'
+require_relative 'rubocop/cop/layout/space_around_method_call_operator'
 require_relative 'rubocop/cop/layout/space_around_operators'
 require_relative 'rubocop/cop/layout/space_before_block_braces'
 require_relative 'rubocop/cop/layout/space_before_comma'
@@ -277,7 +279,6 @@ require_relative 'rubocop/cop/layout/space_inside_percent_literal_delimiters'
 require_relative 'rubocop/cop/layout/space_inside_range_literal'
 require_relative 'rubocop/cop/layout/space_inside_reference_brackets'
 require_relative 'rubocop/cop/layout/space_inside_string_interpolation'
-require_relative 'rubocop/cop/layout/tab'
 require_relative 'rubocop/cop/layout/trailing_empty_lines'
 require_relative 'rubocop/cop/layout/trailing_whitespace'
 
@@ -423,6 +424,7 @@ require_relative 'rubocop/cop/style/copyright'
 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/disable_cops_within_source_code_directive'
 require_relative 'rubocop/cop/style/documentation_method'
 require_relative 'rubocop/cop/style/documentation'
 require_relative 'rubocop/cop/style/double_cop_disable_directive'
@@ -440,6 +442,7 @@ 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/exponential_notation'
 require_relative 'rubocop/cop/style/float_division'
 require_relative 'rubocop/cop/style/for'
 require_relative 'rubocop/cop/style/format_string'
@@ -585,7 +588,6 @@ 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/disabled_lines_formatter'
 require_relative 'rubocop/formatter/emacs_style_formatter'
 require_relative 'rubocop/formatter/file_list_formatter'
 require_relative 'rubocop/formatter/fuubar_style_formatter'

data/lib/rubocop/ast/node.rb

@@ -116,7 +116,7 @@ module RuboCop
       #
       # @return [Integer] the index of the receiver node in its siblings
       def sibling_index
-        parent.children.index { |sibling| sibling.equal?(self) }
+        parent&.children&.index { |sibling| sibling.equal?(self) }
       end
 
       # Common destructuring method. This can be used to normalize

data/lib/rubocop/ast/node/array_node.rb

@@ -18,6 +18,19 @@ module RuboCop
         each_child_node.to_a
       end
 
+      # Calls the given block for all values in the `array` literal.
+      #
+      # @yieldparam [Node] node each node
+      # @return [self] if a block is given
+      # @return [Enumerator] if no block is given
+      def each_value(&block)
+        return to_enum(__method__) unless block_given?
+
+        values.each(&block)
+
+        self
+      end
+
       # Checks whether the `array` literal is delimited by square brackets.
       #
       # @return [Boolean] whether the array is enclosed in square brackets

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -121,6 +121,14 @@ module RuboCop
         loc.respond_to?(:dot) && loc.dot && loc.dot.is?('::')
       end
 
+      # Checks whether the dispatched method uses a safe navigation operator to
+      # connect the receiver and the method name.
+      #
+      # @return [Boolean] whether the method was called with a connecting dot
+      def safe_navigation?
+        loc.respond_to?(:dot) && loc.dot && loc.dot.is?('&.')
+      end
+
       # Checks whether the *explicit* receiver of this method dispatch is
       # `self`.
       #

data/lib/rubocop/cli.rb

@@ -83,10 +83,7 @@ module RuboCop
     end
 
     def act_on_options
-      ConfigLoader.debug = @options[:debug]
-      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
-      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
-      ConfigLoader.options_config = @options[:config]
+      set_options_to_config_loader
 
       @config_store.options_config = @options[:config] if @options[:config]
       @config_store.force_default_config! if @options[:force_default_config]
@@ -102,6 +99,15 @@ module RuboCop
       end
     end
 
+    def set_options_to_config_loader
+      ConfigLoader.debug = @options[:debug]
+      ConfigLoader.auto_gen_config = @options[:auto_gen_config]
+      ConfigLoader.disable_pending_cops = @options[:disable_pending_cops]
+      ConfigLoader.enable_pending_cops = @options[:enable_pending_cops]
+      ConfigLoader.ignore_parent_exclusion = @options[:ignore_parent_exclusion]
+      ConfigLoader.options_config = @options[:config]
+    end
+
     def handle_exiting_options
       return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }
 

data/lib/rubocop/config.rb

@@ -47,7 +47,7 @@ module RuboCop
     end
 
     def_delegators :@hash, :[], :[]=, :delete, :each, :key?, :keys, :each_key,
-                   :map, :merge, :to_h, :to_hash
+                   :map, :merge, :to_h, :to_hash, :transform_values
     def_delegators :@validator, :validate, :target_ruby_version
 
     def to_s
@@ -116,6 +116,14 @@ module RuboCop
       @for_all_cops ||= self['AllCops'] || {}
     end
 
+    def disabled_new_cops?
+      for_all_cops['NewCops'] == 'disable'
+    end
+
+    def enabled_new_cops?
+      for_all_cops['NewCops'] == 'enable'
+    end
+
     def file_to_include?(file)
       relative_file_path = path_relative_to_config(file)
 

data/lib/rubocop/config_loader.rb

@@ -24,7 +24,7 @@ module RuboCop
       include FileFinder
 
       attr_accessor :debug, :auto_gen_config, :ignore_parent_exclusion,
-                    :options_config
+                    :options_config, :disable_pending_cops, :enable_pending_cops
       attr_writer :default_configuration
 
       alias debug? debug
@@ -55,7 +55,10 @@ module RuboCop
       end
 
       def add_missing_namespaces(path, hash)
-        hash.keys.each do |key|
+        # Using `hash.each_key` will cause the
+        # `can't add a new key into hash during iteration` error
+        hash_keys = hash.keys
+        hash_keys.each do |key|
           q = Cop::Cop.qualified_cop_name(key, path)
           next if q == key
 
@@ -76,30 +79,35 @@ module RuboCop
       # user's home directory is checked. If there's no .rubocop.yml
       # there either, the path to the default file is returned.
       def configuration_file_for(target_dir)
-        find_project_dotfile(target_dir) ||
-          find_user_dotfile ||
-          find_user_xdg_config ||
-          DEFAULT_FILE
+        find_project_dotfile(target_dir) || find_user_dotfile ||
+          find_user_xdg_config || DEFAULT_FILE
       end
 
       def configuration_from_file(config_file)
-        config = load_file(config_file)
-        return config if config_file == DEFAULT_FILE
+        return ConfigLoader.default_configuration if config_file == DEFAULT_FILE
 
+        config = load_file(config_file)
         if ignore_parent_exclusion?
           print 'Ignoring AllCops/Exclude from parent folders' if debug?
         else
           add_excludes_from_files(config, config_file)
         end
+
         merge_with_default(config, config_file).tap do |merged_config|
-          warn_on_pending_cops(merged_config.pending_cops)
+          unless possible_new_cops?(config)
+            warn_on_pending_cops(merged_config.pending_cops)
+          end
         end
       end
 
+      def possible_new_cops?(config)
+        disable_pending_cops || enable_pending_cops ||
+          config.disabled_new_cops? || config.enabled_new_cops?
+      end
+
       def add_excludes_from_files(config, config_file)
-        found_files =
-          find_files_upwards(DOTFILE, config_file) +
-          [find_user_dotfile, find_user_xdg_config].compact
+        found_files = find_files_upwards(DOTFILE, config_file) +
+                      [find_user_dotfile, find_user_xdg_config].compact
 
         return if found_files.empty?
         return if PathUtil.relative_path(found_files.last) ==
@@ -198,7 +206,9 @@ module RuboCop
       def write_config_file(file_name, file_string, rubocop_yml_contents)
         File.open(file_name, 'w') do |f|
           f.write "inherit_from:#{file_string}\n"
-          f.write "\n#{rubocop_yml_contents}" if rubocop_yml_contents =~ /\S/
+          if /\S/.match?(rubocop_yml_contents)
+            f.write "\n#{rubocop_yml_contents}"
+          end
         end
       end
 
@@ -250,8 +260,7 @@ module RuboCop
 
       def yaml_safe_load(yaml_code, filename)
         if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
-          SafeYAML.load(yaml_code, filename,
-                        whitelisted_tags: %w[!ruby/regexp])
+          SafeYAML.load(yaml_code, filename, whitelisted_tags: %w[!ruby/regexp])
         # Ruby 2.6+
         elsif Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0')
           YAML.safe_load(

data/lib/rubocop/config_loader_resolver.rb

@@ -181,7 +181,7 @@ module RuboCop
     end
 
     def transform(config)
-      Hash[config.map { |cop, params| [cop, yield(params)] }]
+      config.transform_values { |params| yield(params) }
     end
 
     def gem_config_path(gem_name, relative_config_path)

data/lib/rubocop/config_obsoletion.rb

@@ -17,6 +17,7 @@ module RuboCop
       'Layout/IndentHash' => 'Layout/FirstHashElementIndentation',
       'Layout/IndentHeredoc' => 'Layout/HeredocIndentation',
       'Layout/LeadingBlankLines' => 'Layout/LeadingEmptyLines',
+      'Layout/Tab' => 'Layout/IndentationStyle',
       'Layout/TrailingBlankLines' => 'Layout/TrailingEmptyLines',
       'Lint/DuplicatedKey' => 'Lint/DuplicateHashKey',
       'Lint/EndInMethod' => 'Style/EndBlock',

data/lib/rubocop/config_validator.rb

@@ -13,6 +13,7 @@ module RuboCop
     INTERNAL_PARAMS = %w[Description StyleGuide
                          VersionAdded VersionChanged VersionRemoved
                          Reference Safe SafeAutoCorrect].freeze
+    NEW_COPS_VALUES = %w[pending disable enable].freeze
 
     def_delegators :@config, :smart_loaded_path, :for_all_cops
 
@@ -22,6 +23,7 @@ module RuboCop
       @target_ruby = TargetRuby.new(config)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def validate
       check_cop_config_value(@config)
       reject_conflicting_safe_settings
@@ -37,11 +39,13 @@ module RuboCop
 
       alert_about_unrecognized_cops(invalid_cop_names)
       check_target_ruby
+      validate_new_cops_parameter
       validate_parameter_names(valid_cop_names)
       validate_enforced_styles(valid_cop_names)
       validate_syntax_cop
       reject_mutually_exclusive_defaults
     end
+    # rubocop:enable Metrics/AbcSize
 
     def target_ruby_version
       target_ruby.version
@@ -107,6 +111,18 @@ module RuboCop
             'It\'s not possible to disable this cop.'
     end
 
+    def validate_new_cops_parameter
+      new_cop_parameter = @config.for_all_cops['NewCops']
+      return if new_cop_parameter.nil? ||
+                NEW_COPS_VALUES.include?(new_cop_parameter)
+
+      message = "invalid #{new_cop_parameter} for `NewCops` found in" \
+                "#{smart_loaded_path}\n" \
+                "Valid choices are: #{NEW_COPS_VALUES.join(', ')}"
+
+      raise ValidationError, message
+    end
+
     def validate_parameter_names(valid_cop_names)
       valid_cop_names.each do |name|
         validate_section_presence(name)