rubocop 1.27.0 → 1.28.0

data/lib/rubocop/cop/style/special_global_vars.rb

@@ -57,6 +57,34 @@ module RuboCop
       #   puts $=
       #   puts $*
       #
+      # @example EnforcedStyle: use_builtin_english_names
+      #
+      # Like `use_perl_names` but allows builtin global vars.
+      #
+      #   # good
+      #   puts $LOAD_PATH
+      #   puts $LOADED_FEATURES
+      #   puts $PROGRAM_NAME
+      #   puts ARGV
+      #   puts $:
+      #   puts $"
+      #   puts $0
+      #   puts $!
+      #   puts $@
+      #   puts $;
+      #   puts $,
+      #   puts $/
+      #   puts $\
+      #   puts $.
+      #   puts $_
+      #   puts $>
+      #   puts $<
+      #   puts $$
+      #   puts $?
+      #   puts $~
+      #   puts $=
+      #   puts $*
+      #
       class SpecialGlobalVars < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
@@ -91,18 +119,37 @@ module RuboCop
           :$* => %i[$ARGV ARGV]
         }
 
+        # Anything *not* in this set is provided by the English library.
+        NON_ENGLISH_VARS = Set.new(%i[$LOAD_PATH $LOADED_FEATURES $PROGRAM_NAME ARGV]).freeze
+
         PERL_VARS = ENGLISH_VARS.flat_map { |k, vs| vs.map { |v| [v, [k]] } }.to_h
 
         ENGLISH_VARS.merge!(ENGLISH_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }.to_h)
         PERL_VARS.merge!(PERL_VARS.flat_map { |_, vs| vs.map { |v| [v, [v]] } }.to_h)
+        BUILTIN_VARS = PERL_VARS.merge(
+          NON_ENGLISH_VARS
+            .select { |v| v.to_s.start_with?('$') }
+            .flat_map { |v| [[v, [v]], PERL_VARS[v].flat_map { |a| [a, [v]] }] }
+            .to_h
+        )
+
         ENGLISH_VARS.each_value(&:freeze).freeze
         PERL_VARS.each_value(&:freeze).freeze
+        BUILTIN_VARS.each_value(&:freeze).freeze
 
-        # Anything *not* in this set is provided by the English library.
-        NON_ENGLISH_VARS = Set.new(%i[$LOAD_PATH $LOADED_FEATURES $PROGRAM_NAME ARGV]).freeze
+        STYLE_VARS_MAP = {
+          use_english_names: ENGLISH_VARS,
+          use_perl_names: PERL_VARS,
+          use_builtin_english_names: BUILTIN_VARS
+        }.freeze
 
         LIBRARY_NAME = 'English'
 
+        def on_new_investigation
+          super
+          @required_english = false
+        end
+
         def on_gvar(node)
           global_var, = *node
 
@@ -111,7 +158,7 @@ module RuboCop
           if preferred.include?(global_var)
             correct_style_detected
           else
-            opposite_style_detected
+            style_detected(matching_styles(global_var))
 
             add_offense(node, message: message(global_var)) do |corrector|
               autocorrect(corrector, node, global_var)
@@ -130,7 +177,11 @@ module RuboCop
         def autocorrect(corrector, node, global_var)
           node = node.parent while node.parent&.begin_type? && node.parent.children.one?
 
-          ensure_required(corrector, node, LIBRARY_NAME) if should_require_english?(global_var)
+          if should_require_english?(global_var)
+            ensure_required(corrector, node, LIBRARY_NAME)
+
+            @required_english = true
+          end
 
           corrector.replace(node, replacement(node, global_var))
         end
@@ -175,11 +226,17 @@ module RuboCop
         end
 
         def preferred_names(global)
-          if style == :use_english_names
-            ENGLISH_VARS[global]
-          else
-            PERL_VARS[global]
+          vars = STYLE_VARS_MAP.fetch(style) do
+            raise ArgumentError, "Invalid style: #{style.inspect}"
           end
+
+          vars[global]
+        end
+
+        def matching_styles(global)
+          STYLE_VARS_MAP.map do |style, vars|
+            style if vars.values.flatten(1).include? global
+          end.compact
         end
 
         def english_name_replacement(preferred_name, node)
@@ -195,6 +252,7 @@ module RuboCop
         def should_require_english?(global_var)
           style == :use_english_names &&
             add_require_english? &&
+            !@required_english &&
             !NON_ENGLISH_VARS.include?(preferred_names(global_var).first)
         end
       end

data/lib/rubocop/cop/style/symbol_proc.rb

@@ -52,7 +52,24 @@ module RuboCop
       # @example AllowMethodsWithArguments: true
       #   # good
       #   something.do_something(foo) { |o| o.bar }
+      #
+      # @example AllowComments: false (default)
+      #   # bad
+      #   something.do_something do |s| # some comment
+      #     # some comment
+      #     s.upcase # some comment
+      #     # some comment
+      #   end
+      #
+      # @example AllowComments: true
+      #   # good  - if there are comment in either position
+      #   something.do_something do |s| # some comment
+      #     # some comment
+      #     s.upcase # some comment
+      #     # some comment
+      #   end
       class SymbolProc < Base
+        include CommentsHelp
         include RangeHelp
         include IgnoredMethods
         extend AutoCorrector
@@ -78,6 +95,7 @@ module RuboCop
           [Layout::SpaceBeforeBlockBraces]
         end
 
+        # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_block(node)
           symbol_proc?(node) do |dispatch_node, arguments_node, method_name|
             # TODO: Rails-specific handling that we should probably make
@@ -88,10 +106,12 @@ module RuboCop
             return if ignored_method?(dispatch_node.method_name)
             return if allow_if_method_has_argument?(node)
             return if node.block_type? && destructuring_block_argument?(arguments_node)
+            return if allow_comments? && contains_comments?(node)
 
             register_offense(node, method_name, dispatch_node.method_name)
           end
         end
+        # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         alias on_numblock on_block
 
         def destructuring_block_argument?(argument_node)
@@ -148,6 +168,10 @@ module RuboCop
         def allow_if_method_has_argument?(node)
           !!cop_config.fetch('AllowMethodsWithArguments', false) && !node.arguments.count.zero?
         end
+
+        def allow_comments?
+          cop_config.fetch('AllowComments', false)
+        end
       end
     end
   end

data/lib/rubocop/cop/variable_force/branch.rb

@@ -127,7 +127,7 @@ module RuboCop
           alias_method :eql?, :==
 
           def hash
-            control_node.object_id.hash ^ child_node.object_id.hash
+            [control_node.object_id, control_node.object_id].hash
           end
 
           private

data/lib/rubocop/options.rb

@@ -123,6 +123,8 @@ module RuboCop
         option(opts, '--display-time')
         option(opts, '--display-only-failed')
         option(opts, '--display-only-fail-level-offenses')
+        option(opts, '--display-only-correctable')
+        option(opts, '--display-only-safe-correctable')
       end
     end
 
@@ -310,9 +312,12 @@ module RuboCop
         raise OptionArgumentError, '--autocorrect cannot be used with ' \
                                    '--display-only-fail-level-offenses'
       end
+
       validate_auto_gen_config
       validate_auto_correct
       validate_display_only_failed
+      validate_display_only_failed_and_display_only_correctable
+      validate_display_only_correctable_and_auto_correct
       disable_parallel_when_invalid_option_combo
 
       return if incompatible_options.size <= 1
@@ -342,6 +347,24 @@ module RuboCop
             format('--display-only-failed can only be used together with --format junit.')
     end
 
+    def validate_display_only_correctable_and_auto_correct
+      return if !@options.key?(:safe_auto_correct) && !@options.key?(:auto_correct)
+      return if !@options.key?(:display_only_correctable) &&
+                !@options.key?(:display_only_safe_correctable)
+
+      raise OptionArgumentError,
+            '--auto-correct cannot be used with --display-only-[safe-]correctable.'
+    end
+
+    def validate_display_only_failed_and_display_only_correctable
+      return unless @options.key?(:display_only_failed)
+      return if !@options.key?(:display_only_correctable) &&
+                !@options.key?(:display_only_safe_correctable)
+
+      raise OptionArgumentError,
+            format('--display-only-failed cannot be used together with other display options.')
+    end
+
     def validate_auto_correct
       return if @options.key?(:auto_correct)
       return unless @options.key?(:disable_uncorrectable)
@@ -405,7 +428,7 @@ module RuboCop
     def validate_cache_enabled_for_cache_root
       return unless @options[:cache] == 'false'
 
-      raise OptionArgumentError, '--cache-root can not be used with --cache false'
+      raise OptionArgumentError, '--cache-root cannot be used with --cache false'
     end
   end
 
@@ -481,6 +504,9 @@ module RuboCop
       display_only_fail_level_offenses:
                                         ['Only output offense messages at',
                                          'the specified --fail-level or above'],
+      display_only_correctable:         ['Only output correctable offense messages.'],
+      display_only_safe_correctable:    ['Only output safe-correctable offense messages',
+                                         'when combined with --display-only-correctable.'],
       show_cops:                        ['Shows the given cops, or all cops by',
                                          'default, and their configurations for the',
                                          'current directory.'],

data/lib/rubocop/result_cache.rb

@@ -66,12 +66,12 @@ module RuboCop
     end
 
     def self.cache_root(config_store)
-      root = ENV['RUBOCOP_CACHE_ROOT']
+      root = ENV.fetch('RUBOCOP_CACHE_ROOT', nil)
       root ||= config_store.for_pwd.for_all_cops['CacheRootDirectory']
       root ||= if ENV.key?('XDG_CACHE_HOME')
                  # Include user ID in the path to make sure the user has write
                  # access.
-                 File.join(ENV['XDG_CACHE_HOME'], Process.uid.to_s)
+                 File.join(ENV.fetch('XDG_CACHE_HOME'), Process.uid.to_s)
                else
                  # On FreeBSD, the /home path is a symbolic link to /usr/home
                  # and the $HOME environment variable returns the /home path.
@@ -81,7 +81,7 @@ module RuboCop
                  #
                  # To avoid raising warn log messages on FreeBSD, we retrieve
                  # the real path of the home folder.
-                 File.join(File.realpath(ENV['HOME']), '.cache')
+                 File.join(File.realpath(ENV.fetch('HOME')), '.cache')
                end
       File.join(root, 'rubocop_cache')
     end

data/lib/rubocop/rspec/shared_contexts.rb

@@ -5,8 +5,8 @@ require 'tmpdir'
 RSpec.shared_context 'isolated environment', :isolated_environment do
   around do |example|
     Dir.mktmpdir do |tmpdir|
-      original_home = ENV['HOME']
-      original_xdg_config_home = ENV['XDG_CONFIG_HOME']
+      original_home = ENV.fetch('HOME', nil)
+      original_xdg_config_home = ENV.fetch('XDG_CONFIG_HOME', nil)
 
       # Make sure to expand all symlinks in the path first. Otherwise we may
       # get mismatched pathnames when loading config files later on.

data/lib/rubocop/runner.rb

@@ -207,9 +207,7 @@ module RuboCop
     end
 
     def file_finished(file, offenses)
-      if @options[:display_only_fail_level_offenses]
-        offenses = offenses.select { |o| considered_failure?(o) }
-      end
+      offenses = offenses_to_report(offenses)
       formatter_set.file_finished(file, offenses)
     end
 
@@ -380,6 +378,34 @@ module RuboCop
       !offense.corrected? && offense.severity >= minimum_severity_to_fail
     end
 
+    def offenses_to_report(offenses)
+      if @options[:display_only_fail_level_offenses]
+        offenses.select { |o| considered_failure?(o) }
+      elsif @options[:display_only_safe_correctable]
+        offenses.select { |o| supports_safe_auto_correct?(o) }
+      elsif @options[:display_only_correctable]
+        offenses.select(&:correctable?)
+      else
+        offenses
+      end
+    end
+
+    def supports_safe_auto_correct?(offense)
+      cop_class = Cop::Registry.global.find_by_cop_name(offense.cop_name)
+      default_cfg = default_config(offense.cop_name)
+
+      offense.correctable? &&
+        cop_class&.support_autocorrect? && mark_as_safe_by_config?(default_cfg)
+    end
+
+    def mark_as_safe_by_config?(config)
+      config.nil? || (config.fetch('Safe', true) && config.fetch('SafeAutoCorrect', true))
+    end
+
+    def default_config(cop_name)
+      RuboCop::ConfigLoader.default_configuration[cop_name]
+    end
+
     def minimum_severity_to_fail
       @minimum_severity_to_fail ||= begin
         # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail

data/lib/rubocop/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   # This module holds the RuboCop version information.
   module Version
-    STRING = '1.27.0'
+    STRING = '1.28.0'
 
     MSG = '%<version>s (using Parser %<parser_version>s, '\
           'rubocop-ast %<rubocop_ast_version>s, ' \

data/lib/rubocop.rb

@@ -62,6 +62,7 @@ require_relative 'rubocop/cop/mixin/array_syntax'
 require_relative 'rubocop/cop/mixin/alignment'
 require_relative 'rubocop/cop/mixin/allowed_identifiers'
 require_relative 'rubocop/cop/mixin/allowed_methods'
+require_relative 'rubocop/cop/mixin/allowed_pattern'
 require_relative 'rubocop/cop/mixin/auto_corrector'
 require_relative 'rubocop/cop/mixin/check_assignment'
 require_relative 'rubocop/cop/mixin/check_line_breakable'
@@ -86,7 +87,6 @@ require_relative 'rubocop/cop/mixin/gem_declaration'
 require_relative 'rubocop/cop/mixin/gemspec_help'
 require_relative 'rubocop/cop/mixin/hash_alignment_styles'
 require_relative 'rubocop/cop/mixin/hash_transform_method'
-require_relative 'rubocop/cop/mixin/ignored_pattern'
 require_relative 'rubocop/cop/mixin/ignored_methods'
 require_relative 'rubocop/cop/mixin/integer_node'
 require_relative 'rubocop/cop/mixin/interpolation'
@@ -485,6 +485,7 @@ 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/fetch_env_var'
 require_relative 'rubocop/cop/style/file_read'
 require_relative 'rubocop/cop/style/file_write'
 require_relative 'rubocop/cop/style/float_division'
@@ -567,6 +568,7 @@ require_relative 'rubocop/cop/style/numbered_parameters_limit'
 require_relative 'rubocop/cop/style/numeric_literals'
 require_relative 'rubocop/cop/style/numeric_literal_prefix'
 require_relative 'rubocop/cop/style/numeric_predicate'
+require_relative 'rubocop/cop/style/object_then'
 require_relative 'rubocop/cop/style/one_line_conditional'
 require_relative 'rubocop/cop/style/or_assignment'
 require_relative 'rubocop/cop/style/option_hash'
@@ -651,6 +653,7 @@ require_relative 'rubocop/cop/style/word_array'
 require_relative 'rubocop/cop/style/yoda_condition'
 require_relative 'rubocop/cop/style/zero_length_predicate'
 
+require_relative 'rubocop/cop/security/compound_hash'
 require_relative 'rubocop/cop/security/eval'
 require_relative 'rubocop/cop/security/io_methods'
 require_relative 'rubocop/cop/security/json_load'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -100,7 +100,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -110,7 +110,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -522,6 +522,7 @@ files:
 - lib/rubocop/cop/mixin/alignment.rb
 - lib/rubocop/cop/mixin/allowed_identifiers.rb
 - lib/rubocop/cop/mixin/allowed_methods.rb
+- lib/rubocop/cop/mixin/allowed_pattern.rb
 - lib/rubocop/cop/mixin/annotation_comment.rb
 - lib/rubocop/cop/mixin/array_min_size.rb
 - lib/rubocop/cop/mixin/array_syntax.rb
@@ -551,7 +552,6 @@ files:
 - lib/rubocop/cop/mixin/hash_transform_method.rb
 - lib/rubocop/cop/mixin/heredoc.rb
 - lib/rubocop/cop/mixin/ignored_methods.rb
-- lib/rubocop/cop/mixin/ignored_pattern.rb
 - lib/rubocop/cop/mixin/integer_node.rb
 - lib/rubocop/cop/mixin/interpolation.rb
 - lib/rubocop/cop/mixin/line_length_help.rb
@@ -610,6 +610,7 @@ files:
 - lib/rubocop/cop/naming/variable_number.rb
 - lib/rubocop/cop/offense.rb
 - lib/rubocop/cop/registry.rb
+- lib/rubocop/cop/security/compound_hash.rb
 - lib/rubocop/cop/security/eval.rb
 - lib/rubocop/cop/security/io_methods.rb
 - lib/rubocop/cop/security/json_load.rb
@@ -678,6 +679,7 @@ files:
 - lib/rubocop/cop/style/expand_path_arguments.rb
 - lib/rubocop/cop/style/explicit_block_argument.rb
 - lib/rubocop/cop/style/exponential_notation.rb
+- lib/rubocop/cop/style/fetch_env_var.rb
 - lib/rubocop/cop/style/file_read.rb
 - lib/rubocop/cop/style/file_write.rb
 - lib/rubocop/cop/style/float_division.rb
@@ -753,6 +755,7 @@ files:
 - lib/rubocop/cop/style/numeric_literal_prefix.rb
 - lib/rubocop/cop/style/numeric_literals.rb
 - lib/rubocop/cop/style/numeric_predicate.rb
+- lib/rubocop/cop/style/object_then.rb
 - lib/rubocop/cop/style/one_line_conditional.rb
 - lib/rubocop/cop/style/open_struct_use.rb
 - lib/rubocop/cop/style/option_hash.rb
@@ -915,7 +918,7 @@ metadata:
   homepage_uri: https://rubocop.org/
   changelog_uri: https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop/
-  documentation_uri: https://docs.rubocop.org/rubocop/1.27/
+  documentation_uri: https://docs.rubocop.org/rubocop/1.28/
   bug_tracker_uri: https://github.com/rubocop/rubocop/issues
   rubygems_mfa_required: 'true'
 post_install_message: 

data/lib/rubocop/cop/mixin/ignored_pattern.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    # This module encapsulates the ability to ignore certain lines when
-    # parsing.
-    module IgnoredPattern
-      private
-
-      def ignored_line?(line)
-        line = if line.respond_to?(:source_line)
-                 line.source_line
-               elsif line.respond_to?(:node)
-                 line.node.source_range.source_line
-               end
-
-        matches_ignored_pattern?(line)
-      end
-
-      def matches_ignored_pattern?(line)
-        ignored_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
-      end
-
-      def ignored_patterns
-        cop_config['IgnoredPatterns'] || []
-      end
-    end
-  end
-end