rubocop 0.78.0 → 0.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1c6769965ef19c24fed5115e5ee0e6949aef81f2d4f0c64a28e867b694b8f8b
-  data.tar.gz: 6785ee7c23edbb4b47414ca32a9cb7b7e24565c454c8e4a33f742b9a15de8e5b
+  metadata.gz: 3bdc80758a1e3604ccf4fc91cedac86412bea6d234b27c9b7ae064fb364076ce
+  data.tar.gz: 2890ef6acaede12b528cf963cdbb8a90f64ecbcef6c5da6b3684fcf90c7d4c07
 SHA512:
-  metadata.gz: e3e28e9ed24f5e757ce4c24f4ee4d079eb5e7ac1c6f50bd50fb512c5b4986d84ec19b0ba426a9b077ca734177a5e5139a50c12f5fe331216abee67bd6a2436b4
-  data.tar.gz: 2f2739072557a141d69a51037e38a0973bee53caf40d216610eaffd3a8f14409e64562ed71a49803ad8b11b71fedc51312657efaecb27189900c7b5c44b2cb8c
+  metadata.gz: 8eb332a372b879708bedba857c21532665ad9b459b18977180fdc5d5ec0cb0f035968a907adfe70bd6e5688a97d9c321503d97d37e87cbf77b04168d1e071c1d
+  data.tar.gz: 98d0a07c70c4dca7c63cc96fb473a0079eee449d045b3543b55b90da3f1700c564d0f2ab7ccd909f63fefff7956680fd862710fabe2ccb0e9969b424b943216d

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

data/config/default.yml

@@ -2758,7 +2758,7 @@ Style/FrozenStringLiteralComment:
                  to help transition to frozen string literals by default.
   Enabled: true
   VersionAdded: '0.36'
-  VersionChanged: '0.69'
+  VersionChanged: '0.79'
   EnforcedStyle: always
   SupportedStyles:
     # `always` will always add the frozen string literal comment to a file
@@ -2769,6 +2769,7 @@ Style/FrozenStringLiteralComment:
     # `never` will enforce that the frozen string literal comment does not
     # exist in a file.
     - never
+  Safe: false
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'

data/lib/rubocop.rb

@@ -43,6 +43,7 @@ require_relative 'rubocop/ast/node/def_node'
 require_relative 'rubocop/ast/node/defined_node'
 require_relative 'rubocop/ast/node/ensure_node'
 require_relative 'rubocop/ast/node/for_node'
+require_relative 'rubocop/ast/node/forward_args_node'
 require_relative 'rubocop/ast/node/float_node'
 require_relative 'rubocop/ast/node/hash_node'
 require_relative 'rubocop/ast/node/if_node'
@@ -459,7 +460,11 @@ require_relative 'rubocop/cop/style/lambda'
 require_relative 'rubocop/cop/style/lambda_call'
 require_relative 'rubocop/cop/style/line_end_concatenation'
 require_relative 'rubocop/cop/style/method_call_without_args_parentheses'
+# rubocop:disable Layout/LineLength
 require_relative 'rubocop/cop/style/method_call_with_args_parentheses'
+require_relative 'rubocop/cop/style/method_call_with_args_parentheses/omit_parentheses'
+require_relative 'rubocop/cop/style/method_call_with_args_parentheses/require_parentheses'
+# rubocop:enable Layout/LineLength
 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'
@@ -616,4 +621,5 @@ require_relative 'rubocop/cli/command/show_cops'
 require_relative 'rubocop/cli/command/version'
 require_relative 'rubocop/options'
 require_relative 'rubocop/remote_config'
+require_relative 'rubocop/target_ruby'
 require_relative 'rubocop/yaml_duplication_checker'

data/lib/rubocop/ast/builder.rb

@@ -15,48 +15,49 @@ module RuboCop
     #   root_node = parser.parse(buffer)
     class Builder < Parser::Builders::Default
       NODE_MAP = {
-        and:        AndNode,
-        alias:      AliasNode,
-        args:       ArgsNode,
-        array:      ArrayNode,
-        block:      BlockNode,
-        break:      BreakNode,
-        case:       CaseNode,
-        class:      ClassNode,
-        def:        DefNode,
-        defined?:   DefinedNode,
-        defs:       DefNode,
-        ensure:     EnsureNode,
-        for:        ForNode,
-        float:      FloatNode,
-        hash:       HashNode,
-        if:         IfNode,
-        int:        IntNode,
-        irange:     RangeNode,
-        erange:     RangeNode,
-        kwsplat:    KeywordSplatNode,
-        module:     ModuleNode,
-        or:         OrNode,
-        pair:       PairNode,
-        regexp:     RegexpNode,
-        resbody:    ResbodyNode,
-        retry:      RetryNode,
-        return:     ReturnNode,
-        csend:      SendNode,
-        send:       SendNode,
-        str:        StrNode,
-        dstr:       StrNode,
-        xstr:       StrNode,
-        sclass:     SelfClassNode,
-        super:      SuperNode,
-        zsuper:     SuperNode,
-        sym:        SymbolNode,
-        until:      UntilNode,
-        until_post: UntilNode,
-        when:       WhenNode,
-        while:      WhileNode,
-        while_post: WhileNode,
-        yield:      YieldNode
+        and:          AndNode,
+        alias:        AliasNode,
+        args:         ArgsNode,
+        array:        ArrayNode,
+        block:        BlockNode,
+        break:        BreakNode,
+        case:         CaseNode,
+        class:        ClassNode,
+        def:          DefNode,
+        defined?:     DefinedNode,
+        defs:         DefNode,
+        ensure:       EnsureNode,
+        for:          ForNode,
+        forward_args: ForwardArgsNode,
+        float:        FloatNode,
+        hash:         HashNode,
+        if:           IfNode,
+        int:          IntNode,
+        irange:       RangeNode,
+        erange:       RangeNode,
+        kwsplat:      KeywordSplatNode,
+        module:       ModuleNode,
+        or:           OrNode,
+        pair:         PairNode,
+        regexp:       RegexpNode,
+        resbody:      ResbodyNode,
+        retry:        RetryNode,
+        return:       ReturnNode,
+        csend:        SendNode,
+        send:         SendNode,
+        str:          StrNode,
+        dstr:         StrNode,
+        xstr:         StrNode,
+        sclass:       SelfClassNode,
+        super:        SuperNode,
+        zsuper:       SuperNode,
+        sym:          SymbolNode,
+        until:        UntilNode,
+        until_post:   UntilNode,
+        when:         WhenNode,
+        while:        WhileNode,
+        while_post:   WhileNode,
+        yield:        YieldNode
       }.freeze
 
       # Generates {Node} from the given information.

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

@@ -16,6 +16,17 @@ module RuboCop
         method?(:initialize) || assignment_method?
       end
 
+      # Checks whether this method definition node forwards its arguments
+      # as per the feature added in Ruby 2.7.
+      #
+      # @note This is written in a way that may support lead arguments
+      #       which are rumored to be added in a later version of Ruby.
+      #
+      # @return [Boolean] whether the `def` node uses argument forwarding
+      def argument_forwarding?
+        arguments.any?(&:forward_args_type?)
+      end
+
       # The name of the defined method as a symbol.
       #
       # @return [Symbol] the name of the defined method

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `forward-args` nodes. This will be used in place
+    # of a plain node when the builder constructs the AST, making its methods
+    # available to all `forward-args` nodes within RuboCop.
+    class ForwardArgsNode < Node
+      include CollectionNode
+
+      # Node wraps itself in an array to be compatible with other
+      # enumerable argument types.
+      def to_a
+        [self]
+      end
+    end
+  end
+end

data/lib/rubocop/ast/traversal.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/ModuleLength
 module RuboCop
   module AST
     # Provides methods for traversing an AST.
@@ -18,15 +19,21 @@ module RuboCop
                              rational str sym regopt self lvar
                              ivar cvar gvar nth_ref back_ref cbase
                              arg restarg blockarg shadowarg
-                             kwrestarg zsuper lambda redo retry].freeze
+                             kwrestarg zsuper lambda redo retry
+                             forward_args forwarded_args
+                             match_var match_nil_pattern].freeze
       ONE_CHILD_NODE    = %i[splat kwsplat block_pass not break next
                              preexe postexe match_current_line defined?
-                             arg_expr].freeze
+                             arg_expr pin match_rest if_guard unless_guard
+                             match_with_trailing_comma].freeze
       MANY_CHILD_NODES  = %i[dstr dsym xstr regexp array hash pair
                              mlhs masgn or_asgn and_asgn
                              undef alias args super yield or and
                              while_post until_post iflipflop eflipflop
-                             match_with_lvasgn begin kwbegin return].freeze
+                             match_with_lvasgn begin kwbegin return
+                             in_match case_match in_pattern match_alt
+                             match_as array_pattern array_pattern_with_tail
+                             hash_pattern const_pattern].freeze
       SECOND_CHILD_ONLY = %i[lvasgn ivasgn cvasgn gvasgn optarg kwarg
                              kwoptarg].freeze
 
@@ -181,3 +188,4 @@ module RuboCop
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

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

@@ -8,6 +8,13 @@ module RuboCop
       class ShowCops < Base
         self.command_name = :show_cops
 
+        def initialize(env)
+          super
+
+          # Load the configs so the require()s are done for custom cops
+          @config = @config_store.for(Dir.pwd)
+        end
+
         def run
           print_available_cops
         end
@@ -15,8 +22,6 @@ module RuboCop
         private
 
         def print_available_cops
-          # Load the configs so the require()s are done for custom cops
-          @config_store.for(Dir.pwd)
           registry = Cop::Cop.registry
           show_all = @options[:show_cops].empty?
 
@@ -46,7 +51,9 @@ module RuboCop
 
         def print_cop_details(cops)
           cops.each do |cop|
-            puts '# Supports --auto-correct' if cop.new.support_autocorrect?
+            if cop.new(@config).support_autocorrect?
+              puts '# Supports --auto-correct'
+            end
             puts "#{cop.cop_name}:"
             puts config_lines(cop)
             puts
@@ -64,7 +71,7 @@ module RuboCop
         end
 
         def config_lines(cop)
-          cnf = @config_store.for(Dir.pwd).for_cop(cop)
+          cnf = @config.for_cop(cop)
           cnf.to_yaml.lines.to_a.drop(1).map { |line| '  ' + line }
         end
       end

data/lib/rubocop/config_loader.rb

@@ -91,7 +91,9 @@ module RuboCop
         else
           add_excludes_from_files(config, config_file)
         end
-        merge_with_default(config, config_file)
+        merge_with_default(config, config_file).tap do |merged_config|
+          warn_on_pending_cops(merged_config)
+        end
       end
 
       def add_excludes_from_files(config, config_file)
@@ -114,6 +116,22 @@ module RuboCop
                                    end
       end
 
+      def warn_on_pending_cops(config)
+        pending_cops = config.keys.select do |key|
+          config[key]['Enabled'] == 'pending'
+        end
+
+        return if pending_cops.none?
+
+        warn Rainbow('The following cops were added to RuboCop, but are not ' \
+                     'configured. Please set Enabled to either `true` or ' \
+                     '`false` in your `.rubocop.yml` file:').yellow
+
+        pending_cops.each do |cop|
+          warn Rainbow(" - #{cop}").yellow
+        end
+      end
+
       # Merges the given configuration with the default one. If
       # AllCops:DisabledByDefault is true, it changes the Enabled params so
       # that only cops from user configuration are enabled.
@@ -199,8 +217,6 @@ module RuboCop
           raise(TypeError, "Malformed configuration in #{absolute_path}")
         end
 
-        check_cop_config_value(hash)
-
         hash
       end
 
@@ -222,22 +238,6 @@ module RuboCop
         end
       end
 
-      def check_cop_config_value(hash, parent = nil)
-        hash.each do |key, value|
-          check_cop_config_value(value, key) if value.is_a?(Hash)
-
-          next unless %w[Enabled
-                         Safe
-                         SafeAutoCorrect
-                         AutoCorrect].include?(key) && value.is_a?(String)
-
-          abort(
-            "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
-            " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
-          )
-        end
-      end
-
       # Read the specified file, or exit with a friendly, concise message on
       # stderr. Care is taken to use the standard OS exit code for a "file not
       # found" error.

data/lib/rubocop/config_validator.rb

@@ -14,25 +14,19 @@ module RuboCop
                          VersionAdded VersionChanged VersionRemoved
                          Reference Safe SafeAutoCorrect].freeze
 
-    # 2.3 is the oldest officially supported Ruby version.
-    DEFAULT_RUBY_VERSION = 2.3
-    KNOWN_RUBIES = [2.3, 2.4, 2.5, 2.6, 2.7].freeze
-    OBSOLETE_RUBIES = {
-      1.9 => '0.50', 2.0 => '0.50', 2.1 => '0.58', 2.2 => '0.69'
-    }.freeze
-    RUBY_VERSION_FILENAME = '.ruby-version'
-
-    def_delegators :@config,
-                   :smart_loaded_path, :for_all_cops, :find_file_upwards,
-                   :base_dir_for_path_parameters, :bundler_lock_file_path
+    def_delegators :@config, :smart_loaded_path, :for_all_cops
 
     def initialize(config)
       @config = config
       @config_obsoletion = ConfigObsoletion.new(config)
+      @target_ruby = TargetRuby.new(config)
     end
 
     def validate
-      # Don't validate RuboCop's own files. Avoids infinite recursion.
+      check_cop_config_value(@config)
+      reject_conflicting_safe_settings
+
+      # Don't validate RuboCop's own files further. Avoids infinite recursion.
       return if @config.internal?
 
       valid_cop_names, invalid_cop_names = @config.keys.partition do |key|
@@ -50,23 +44,7 @@ module RuboCop
     end
 
     def target_ruby_version
-      @target_ruby_version ||= begin
-        if for_all_cops['TargetRubyVersion']
-          @target_ruby_version_source = :rubocop_yml
-
-          for_all_cops['TargetRubyVersion'].to_f
-        elsif target_ruby_version_from_version_file
-          @target_ruby_version_source = :ruby_version_file
-
-          target_ruby_version_from_version_file
-        elsif target_ruby_version_from_bundler_lock_file
-          @target_ruby_version_source = :bundler_lock_file
-
-          target_ruby_version_from_bundler_lock_file
-        else
-          DEFAULT_RUBY_VERSION
-        end
-      end
+      target_ruby.version
     end
 
     def validate_section_presence(name)
@@ -78,20 +56,24 @@ module RuboCop
 
     private
 
+    attr_reader :target_ruby
+
     def check_target_ruby
-      return if KNOWN_RUBIES.include?(target_ruby_version)
+      return if target_ruby.supported?
 
-      msg = if OBSOLETE_RUBIES.include?(target_ruby_version)
+      source = target_ruby.source
+      last_version = target_ruby.rubocop_version_with_support
+
+      msg = if last_version
               "RuboCop found unsupported Ruby version #{target_ruby_version} " \
-              "in #{target_ruby_source}. #{target_ruby_version}-compatible " \
-              'analysis was dropped after version ' \
-              "#{OBSOLETE_RUBIES[target_ruby_version]}."
+              "in #{source}. #{target_ruby_version}-compatible " \
+              "analysis was dropped after version #{last_version}."
             else
               'RuboCop found unknown Ruby version ' \
-              "#{target_ruby_version.inspect} in #{target_ruby_source}."
+              "#{target_ruby_version.inspect} in #{source}."
             end
 
-      msg += "\nSupported versions: #{KNOWN_RUBIES.join(', ')}"
+      msg += "\nSupported versions: #{TargetRuby.supported_versions.join(', ')}"
 
       raise ValidationError, msg
     end
@@ -178,71 +160,47 @@ module RuboCop
         formats.all? { |format| valid.include?(format) }
     end
 
-    def target_ruby_source
-      case @target_ruby_version_source
-      when :ruby_version_file
-        "`#{RUBY_VERSION_FILENAME}`"
-      when :bundler_lock_file
-        "`#{bundler_lock_file_path}`"
-      when :rubocop_yml
-        "`TargetRubyVersion` parameter (in #{smart_loaded_path})"
-      end
-    end
+    def reject_mutually_exclusive_defaults
+      disabled_by_default = for_all_cops['DisabledByDefault']
+      enabled_by_default = for_all_cops['EnabledByDefault']
+      return unless disabled_by_default && enabled_by_default
 
-    def ruby_version_file
-      @ruby_version_file ||=
-        find_file_upwards(RUBY_VERSION_FILENAME, base_dir_for_path_parameters)
+      msg = 'Cops cannot be both enabled by default and disabled by default'
+      raise ValidationError, msg
     end
 
-    def target_ruby_version_from_version_file
-      file = ruby_version_file
-      return unless file && File.file?(file)
+    def reject_conflicting_safe_settings
+      @config.each do |name, cop_config|
+        next unless cop_config.is_a?(Hash)
+        next unless cop_config['Safe'] == false &&
+                    cop_config['SafeAutoCorrect'] == true
 
-      @target_ruby_version_from_version_file ||=
-        File.read(file).match(/\A(ruby-)?(?<version>\d+\.\d+)/) do |md|
-          md[:version].to_f
-        end
+        msg = 'Unsafe cops cannot have a safe auto-correction ' \
+              "(section #{name} in #{smart_loaded_path})"
+        raise ValidationError, msg
+      end
     end
 
-    def target_ruby_version_from_bundler_lock_file
-      @target_ruby_version_from_bundler_lock_file ||=
-        read_ruby_version_from_bundler_lock_file
-    end
+    def check_cop_config_value(hash, parent = nil)
+      hash.each do |key, value|
+        check_cop_config_value(value, key) if value.is_a?(Hash)
+
+        next unless %w[Enabled
+                       Safe
+                       SafeAutoCorrect
+                       AutoCorrect].include?(key) && value.is_a?(String)
+
+        next if key == 'Enabled' && value == 'pending'
 
-    def read_ruby_version_from_bundler_lock_file
-      lock_file_path = bundler_lock_file_path
-      return nil unless lock_file_path
-
-      in_ruby_section = false
-      File.foreach(lock_file_path) do |line|
-        # If ruby is in Gemfile.lock or gems.lock, there should be two lines
-        # towards the bottom of the file that look like:
-        #     RUBY VERSION
-        #       ruby W.X.YpZ
-        # We ultimately want to match the "ruby W.X.Y.pZ" line, but there's
-        # extra logic to make sure we only start looking once we've seen the
-        # "RUBY VERSION" line.
-        in_ruby_section ||= line.match(/^\s*RUBY\s*VERSION\s*$/)
-        next unless in_ruby_section
-
-        # We currently only allow this feature to work with MRI ruby. If jruby
-        # (or something else) is used by the project, it's lock file will have a
-        # line that looks like:
-        #     RUBY VERSION
-        #       ruby W.X.YpZ (jruby x.x.x.x)
-        # The regex won't match in this situation.
-        result = line.match(/^\s*ruby\s+(\d+\.\d+)[p.\d]*\s*$/)
-        return result.captures.first.to_f if result
+        raise ValidationError, msg_not_boolean(parent, key, value)
       end
     end
 
-    def reject_mutually_exclusive_defaults
-      disabled_by_default = for_all_cops['DisabledByDefault']
-      enabled_by_default = for_all_cops['EnabledByDefault']
-      return unless disabled_by_default && enabled_by_default
-
-      msg = 'Cops cannot be both enabled by default and disabled by default'
-      raise ValidationError, msg
+    # FIXME: Handling colors in exception messages like this is ugly.
+    def msg_not_boolean(parent, key, value)
+      "#{Rainbow('').reset}" \
+        "Property #{Rainbow(key).yellow} of cop #{Rainbow(parent).yellow}" \
+        " is supposed to be a boolean and #{Rainbow(value).yellow} is not."
     end
   end
 end