rubocop 0.75.0 → 0.76.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78f22d960f9c7b85730f215741a8e083b3b63396f414478d4831762e4c4cf7cb
-  data.tar.gz: b933d30e9d959fd0ef51958f5815349cab06f8dc7069b4f10c16907e43be53a5
+  metadata.gz: bd5622915d19930481b80ac553a18b3500306bca922491f83290451a3cd267c9
+  data.tar.gz: 73002e0e186887f12add4e88154bf2510280d531ecd66f73b9eb57fb842d7f2a
 SHA512:
-  metadata.gz: 070a442e799b151ea2be23c3eb0d00ad25cc269ed6296ca3862fb6b3b25bfff238886423e7ae52cea853041038fefa354f818377cfde730b4464d7503b0680da
-  data.tar.gz: b14a228097fd48fc7c3dd4c7674b607574f99fba7b9870b64e97b836340181b57563794dd1d5371929fa1dac7e33430eb14189447b05caba84e8ce2b5034f12e
+  metadata.gz: 7a866f9130e0388351acd83aee37bf7a15f1e64c94c51a3d58f3c439b90cbffb5a173837b48aae3ba86ab8005bbe73e6b088c905000910c4cf523395c8887b39
+  data.tar.gz: e8c2655aa3c419850da067790d456ed96c67bb43eee41d4cd9389185dbb9965329f405a2146949062daf57cd15a8e0d375b00df4df09fbc03fd06d9369f213ce

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.75.0', require: false
+gem 'rubocop', '~> 0.76.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -1512,6 +1512,29 @@ Lint/RandOne:
   Enabled: true
   VersionAdded: '0.36'
 
+Lint/RedundantCopDisableDirective:
+  Description: >-
+                 Checks for rubocop:disable comments that can be removed.
+                 Note: this cop is not disabled when disabling all cops.
+                 It must be explicitly disabled.
+  Enabled: true
+  VersionAdded: '0.76'
+
+Lint/RedundantCopEnableDirective:
+  Description: Checks for rubocop:enable comments that can be removed.
+  Enabled: true
+  VersionAdded: '0.76'
+
+Lint/RedundantRequireStatement:
+  Description: 'Checks for unnecessary `require` statement.'
+  Enabled: true
+  VersionAdded: '0.76'
+
+Lint/RedundantSplatExpansion:
+  Description: 'Checks for splat unnecessarily being called on literals.'
+  Enabled: true
+  VersionChanged: '0.76'
+
 Lint/RedundantWithIndex:
   Description: 'Checks for redundant `with_index`.'
   Enabled: true
@@ -1645,30 +1668,6 @@ Lint/UnifiedInteger:
   Enabled: true
   VersionAdded: '0.43'
 
-Lint/UnneededCopDisableDirective:
-  Description: >-
-                 Checks for rubocop:disable comments that can be removed.
-                 Note: this cop is not disabled when disabling all cops.
-                 It must be explicitly disabled.
-  Enabled: true
-  VersionAdded: '0.53'
-
-Lint/UnneededCopEnableDirective:
-  Description: Checks for rubocop:enable comments that can be removed.
-  Enabled: true
-  VersionAdded: '0.53'
-
-Lint/UnneededRequireStatement:
-  Description: 'Checks for unnecessary `require` statement.'
-  Enabled: true
-  VersionAdded: '0.51'
-
-Lint/UnneededSplatExpansion:
-  Description: 'Checks for splat unnecessarily being called on literals.'
-  Enabled: true
-  VersionAdded: '0.43'
-  VersionChanged: '0.74'
-
 Lint/UnreachableCode:
   Description: 'Unreachable code.'
   Enabled: true
@@ -1815,7 +1814,7 @@ Metrics/LineLength:
     - https
   # The IgnoreCopDirectives option causes the LineLength rule to ignore cop
   # directives like '# rubocop: enable ...' when calculating a line's length.
-  IgnoreCopDirectives: false
+  IgnoreCopDirectives: true
   # The IgnoredPatterns option is a list of !ruby/regexp and/or string
   # elements. Strings will be converted to Regexp objects. A line that matches
   # any regular expression listed in this option will be ignored by LineLength.
@@ -2076,6 +2075,7 @@ Naming/UncommunicativeMethodParamName:
     - at
     - ip
     - db
+    - os
   # Blacklisted names that will register an offense
   ForbiddenNames: []
 
@@ -3402,6 +3402,16 @@ Style/RedundantBegin:
   VersionAdded: '0.10'
   VersionChanged: '0.21'
 
+Style/RedundantCapitalW:
+  Description: 'Checks for %W when interpolation is not needed.'
+  Enabled: true
+  VersionAdded: '0.76'
+
+Style/RedundantCondition:
+  Description: 'Checks for unnecessary conditional expressions.'
+  Enabled: true
+  VersionAdded: '0.76'
+
 Style/RedundantConditional:
   Description: "Don't return true/false from a conditional."
   Enabled: true
@@ -3420,11 +3430,22 @@ Style/RedundantFreeze:
   VersionAdded: '0.34'
   VersionChanged: '0.66'
 
+Style/RedundantInterpolation:
+  Description: 'Checks for strings that are just an interpolated expression.'
+  Enabled: true
+  VersionAdded: '0.76'
+
 Style/RedundantParentheses:
   Description: "Checks for parentheses that seem not to serve any purpose."
   Enabled: true
   VersionAdded: '0.36'
 
+Style/RedundantPercentQ:
+  Description: 'Checks for %q/%Q when single quotes or double quotes would do.'
+  StyleGuide: '#percent-q'
+  Enabled: true
+  VersionAdded: '0.76'
+
 Style/RedundantReturn:
   Description: "Don't use return where it's not required."
   StyleGuide: '#no-explicit-return'
@@ -3441,6 +3462,13 @@ Style/RedundantSelf:
   VersionAdded: '0.10'
   VersionChanged: '0.13'
 
+Style/RedundantSort:
+  Description: >-
+                  Use `min` instead of `sort.first`,
+                  `max_by` instead of `sort_by...last`, etc.
+  Enabled: true
+  VersionAdded: '0.76'
+
 Style/RedundantSortBy:
   Description: 'Use `sort` instead of `sort_by { |x| x }`.'
   Enabled: true
@@ -3828,35 +3856,6 @@ Style/UnlessElse:
   Enabled: true
   VersionAdded: '0.9'
 
-Style/UnneededCapitalW:
-  Description: 'Checks for %W when interpolation is not needed.'
-  Enabled: true
-  VersionAdded: '0.21'
-  VersionChanged: '0.24'
-
-Style/UnneededCondition:
-  Description: 'Checks for unnecessary conditional expressions.'
-  Enabled: true
-  VersionAdded: '0.57'
-
-Style/UnneededInterpolation:
-  Description: 'Checks for strings that are just an interpolated expression.'
-  Enabled: true
-  VersionAdded: '0.36'
-
-Style/UnneededPercentQ:
-  Description: 'Checks for %q/%Q when single quotes or double quotes would do.'
-  StyleGuide: '#percent-q'
-  Enabled: true
-  VersionAdded: '0.24'
-
-Style/UnneededSort:
-  Description: >-
-                  Use `min` instead of `sort.first`,
-                  `max_by` instead of `sort_by...last`, etc.
-  Enabled: true
-  VersionAdded: '0.55'
-
 Style/UnpackFirst:
   Description: >-
                  Checks for accessing the first element of `String#unpack`

data/lib/rubocop.rb

@@ -55,6 +55,7 @@ require_relative 'rubocop/ast/node/range_node'
 require_relative 'rubocop/ast/node/regexp_node'
 require_relative 'rubocop/ast/node/resbody_node'
 require_relative 'rubocop/ast/node/retry_node'
+require_relative 'rubocop/ast/node/return_node'
 require_relative 'rubocop/ast/node/self_class_node'
 require_relative 'rubocop/ast/node/send_node'
 require_relative 'rubocop/ast/node/str_node'
@@ -321,6 +322,10 @@ 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'
 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_splat_expansion'
 require_relative 'rubocop/cop/lint/redundant_with_index'
 require_relative 'rubocop/cop/lint/redundant_with_object'
 require_relative 'rubocop/cop/lint/regexp_as_condition'
@@ -341,10 +346,6 @@ require_relative 'rubocop/cop/lint/syntax'
 require_relative 'rubocop/cop/lint/to_json'
 require_relative 'rubocop/cop/lint/underscore_prefixed_variable_name'
 require_relative 'rubocop/cop/lint/unified_integer'
-require_relative 'rubocop/cop/lint/unneeded_cop_disable_directive'
-require_relative 'rubocop/cop/lint/unneeded_cop_enable_directive'
-require_relative 'rubocop/cop/lint/unneeded_require_statement'
-require_relative 'rubocop/cop/lint/unneeded_splat_expansion'
 require_relative 'rubocop/cop/lint/unreachable_code'
 require_relative 'rubocop/cop/lint/unused_block_argument'
 require_relative 'rubocop/cop/lint/unused_method_argument'
@@ -502,12 +503,17 @@ require_relative 'rubocop/cop/style/proc'
 require_relative 'rubocop/cop/style/raise_args'
 require_relative 'rubocop/cop/style/random_with_offset'
 require_relative 'rubocop/cop/style/redundant_begin'
+require_relative 'rubocop/cop/style/redundant_capital_w'
+require_relative 'rubocop/cop/style/redundant_condition'
 require_relative 'rubocop/cop/style/redundant_conditional'
 require_relative 'rubocop/cop/style/redundant_exception'
 require_relative 'rubocop/cop/style/redundant_freeze'
+require_relative 'rubocop/cop/style/redundant_interpolation'
 require_relative 'rubocop/cop/style/redundant_parentheses'
+require_relative 'rubocop/cop/style/redundant_percent_q'
 require_relative 'rubocop/cop/style/redundant_return'
 require_relative 'rubocop/cop/style/redundant_self'
+require_relative 'rubocop/cop/style/redundant_sort'
 require_relative 'rubocop/cop/style/redundant_sort_by'
 require_relative 'rubocop/cop/style/regexp_literal'
 require_relative 'rubocop/cop/style/rescue_modifier'
@@ -544,11 +550,6 @@ require_relative 'rubocop/cop/style/trailing_method_end_statement'
 require_relative 'rubocop/cop/style/trailing_underscore_variable'
 require_relative 'rubocop/cop/style/trivial_accessors'
 require_relative 'rubocop/cop/style/unless_else'
-require_relative 'rubocop/cop/style/unneeded_capital_w'
-require_relative 'rubocop/cop/style/unneeded_condition'
-require_relative 'rubocop/cop/style/unneeded_interpolation'
-require_relative 'rubocop/cop/style/unneeded_percent_q'
-require_relative 'rubocop/cop/style/unneeded_sort'
 require_relative 'rubocop/cop/style/unpack_first'
 require_relative 'rubocop/cop/style/variable_interpolation'
 require_relative 'rubocop/cop/style/when_then'

data/lib/rubocop/ast/builder.rb

@@ -41,6 +41,7 @@ module RuboCop
         regexp:     RegexpNode,
         resbody:    ResbodyNode,
         retry:      RetryNode,
+        return:     ReturnNode,
         csend:      SendNode,
         send:       SendNode,
         str:        StrNode,

data/lib/rubocop/ast/node.rb

@@ -469,6 +469,10 @@ module RuboCop
         parent&.send_type? && parent.arguments.include?(self)
       end
 
+      def boolean_type?
+        true_type? || false_type?
+      end
+
       def numeric_type?
         int_type? || float_type?
       end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `return` nodes. This will be used in place of a
+    # plain node when the builder constructs the AST, making its methods
+    # available to all `return` nodes within RuboCop.
+    class ReturnNode < Node
+      include MethodDispatchNode
+      include ParameterizedNode
+
+      # Returns the arguments of the `return`.
+      #
+      # @return [Array] The arguments of the `return`.
+      def arguments
+        if node_parts.one? && node_parts.first.begin_type?
+          node_parts.first.children
+        else
+          node_parts
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cli.rb

@@ -83,18 +83,21 @@ module RuboCop
 
     def maybe_run_line_length_cop(paths)
       if !line_length_enabled?(@config_store.for(Dir.pwd))
-        puts Rainbow("#{PHASE_1} #{PHASE_1_DISABLED}").yellow
-        ''
+        skip_line_length_cop(PHASE_1_DISABLED)
       elsif !same_max_line_length?(
         @config_store.for(Dir.pwd), ConfigLoader.default_configuration
       )
-        puts Rainbow("#{PHASE_1} #{PHASE_1_OVERRIDDEN}").yellow
-        ''
+        skip_line_length_cop(PHASE_1_OVERRIDDEN)
       else
         run_line_length_cop_auto_gen_config(paths)
       end
     end
 
+    def skip_line_length_cop(reason)
+      puts Rainbow("#{PHASE_1} #{reason}").yellow
+      ''
+    end
+
     def line_length_enabled?(config)
       line_length_cop(config)['Enabled']
     end

data/lib/rubocop/comment_config.rb

@@ -4,7 +4,7 @@ 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
-    UNNEEDED_DISABLE = 'Lint/UnneededCopDisableDirective'
+    REDUNDANT_DISABLE = 'Lint/RedundantCopDisableDirective'
 
     COP_NAME_PATTERN = '([A-Z]\w+/)?(?:[A-Z]\w+)'
     COP_NAMES_PATTERN = "(?:#{COP_NAME_PATTERN} , )*#{COP_NAME_PATTERN}"
@@ -152,7 +152,7 @@ module RuboCop
     end
 
     def all_cop_names
-      @all_cop_names ||= Cop::Cop.registry.names - [UNNEEDED_DISABLE]
+      @all_cop_names ||= Cop::Cop.registry.names - [REDUNDANT_DISABLE]
     end
 
     def comment_only_line?(line_number)

data/lib/rubocop/config.rb

@@ -53,6 +53,13 @@ module RuboCop
       @signature ||= Digest::SHA1.hexdigest(to_s)
     end
 
+    # True if this is a config file that is shipped with RuboCop
+    def internal?
+      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
+                                                    'config'))
+      File.expand_path(loaded_path).start_with?(base_config_path)
+    end
+
     def make_excludes_absolute
       each_key do |key|
         @validator.validate_section_presence(key)

data/lib/rubocop/config_loader.rb

@@ -46,7 +46,7 @@ module RuboCop
 
         add_missing_namespaces(path, hash)
 
-        resolver.resolve_inheritance_from_gems(hash, hash.delete('inherit_gem'))
+        resolver.resolve_inheritance_from_gems(hash)
         resolver.resolve_inheritance(path, hash, file, debug?)
 
         hash.delete('inherit_from')

data/lib/rubocop/config_loader_resolver.rb

@@ -35,7 +35,8 @@ module RuboCop
       end
     end
 
-    def resolve_inheritance_from_gems(hash, gems)
+    def resolve_inheritance_from_gems(hash)
+      gems = hash.delete('inherit_gem')
       (gems || {}).each_pair do |gem_name, config_path|
         if gem_name == 'rubocop'
           raise ArgumentError,

data/lib/rubocop/config_obsoletion.rb

@@ -4,10 +4,19 @@ module RuboCop
   # This class handles obsolete configuration.
   class ConfigObsoletion
     RENAMED_COPS = {
+      'Lint/UnneededCopDisableDirective' => 'Lint/RedundantCopDisableDirective',
+      'Lint/UnneededCopEnableDirective' => 'Lint/RedundantCopEnableDirective',
+      'Lint/UnneededRequireStatement' => 'Lint/RedundantRequireStatement',
+      'Lint/UnneededSplatExpansion' => 'Lint/RedundantSplatExpansion',
       'Style/SingleSpaceBeforeFirstArg' => 'Layout/SpaceBeforeFirstArg',
       'Style/MethodCallParentheses' => 'Style/MethodCallWithoutArgsParentheses',
       'Style/DeprecatedHashMethods' => 'Style/PreferredHashMethods',
       'Style/OpMethod' => 'Naming/BinaryOperatorParameterName',
+      'Style/UnneededCapitalW' => 'Style/RedundantCapitalW',
+      'Style/UnneededCondition' => 'Style/RedundantCondition',
+      'Style/UnneededInterpolation' => 'Style/RedundantInterpolation',
+      'Style/UnneededPercentQ' => 'Style/RedundantPercentQ',
+      'Style/UnneededSort' => 'Style/RedundantSort',
       'Layout/FirstParameterIndentation' => 'Layout/IndentFirstArgument',
       'Layout/IndentArray' => 'Layout/IndentFirstArrayElement',
       'Layout/IndentHash' => 'Layout/IndentFirstHashElement'

data/lib/rubocop/config_validator.rb

@@ -10,8 +10,9 @@ module RuboCop
 
     COMMON_PARAMS = %w[Exclude Include Severity inherit_mode
                        AutoCorrect StyleGuide Details].freeze
-    INTERNAL_PARAMS = %w[Description StyleGuide VersionAdded
-                         VersionChanged Reference Safe SafeAutoCorrect].freeze
+    INTERNAL_PARAMS = %w[Description StyleGuide
+                         VersionAdded VersionChanged VersionRemoved
+                         Reference Safe SafeAutoCorrect].freeze
 
     # 2.3 is the oldest officially supported Ruby version.
     DEFAULT_RUBY_VERSION = 2.3
@@ -32,10 +33,7 @@ module RuboCop
 
     def validate
       # Don't validate RuboCop's own files. Avoids infinite recursion.
-      base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
-                                                    'config'))
-      return if File.expand_path(@config.loaded_path)
-                    .start_with?(base_config_path)
+      return if @config.internal?
 
       valid_cop_names, invalid_cop_names = @config.keys.partition do |key|
         ConfigLoader.default_configuration.key?(key)
@@ -128,21 +126,32 @@ module RuboCop
     def validate_parameter_names(valid_cop_names)
       valid_cop_names.each do |name|
         validate_section_presence(name)
-        default_config = ConfigLoader.default_configuration[name]
+        each_invalid_parameter(name) do |param, supported_params|
+          # FIXME: Remove .to_s, which works around a JRuby bug:
+          #   https://github.com/jruby/jruby/issues/5935
+          warn Rainbow(<<~MESSAGE).yellow.to_s
+            Warning: #{name} does not support #{param} parameter.
 
-        @config[name].each_key do |param|
-          next if COMMON_PARAMS.include?(param) || default_config.key?(param)
+            Supported parameters are:
 
-          message =
-            "Warning: #{name} does not support #{param} parameter.\n\n" \
-            "Supported parameters are:\n\n" \
-            "  - #{(default_config.keys - INTERNAL_PARAMS).join("\n  - ")}\n"
-
-          warn Rainbow(message).yellow.to_s
+              - #{supported_params.join("\n  - ")}
+          MESSAGE
         end
       end
     end
 
+    def each_invalid_parameter(cop_name)
+      default_config = ConfigLoader.default_configuration[cop_name]
+
+      @config[cop_name].each_key do |param|
+        next if COMMON_PARAMS.include?(param) || default_config.key?(param)
+
+        supported_params = default_config.keys - INTERNAL_PARAMS
+
+        yield param, supported_params
+      end
+    end
+
     def validate_enforced_styles(valid_cop_names)
       valid_cop_names.each do |name|
         styles = @config[name].select { |key, _| key.start_with?('Enforced') }