rubocop 1.30.1 → 1.64.0

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

@@ -9,32 +9,15 @@ module RuboCop
       # On the other hand, `ENV.fetch` raises KeyError or returns the explicitly
       # specified default value.
       #
-      # When an `ENV[]` is the LHS of `||`, the autocorrect makes the RHS
-      # the default value of `ENV.fetch`.
-      #
       # @example
       #   # bad
       #   ENV['X']
-      #   ENV['X'] || 'string literal'
-      #   ENV['X'] || some_method
       #   x = ENV['X']
       #
-      #   ENV['X'] || y.map do |a|
-      #     puts a * 2
-      #   end
-      #
       #   # good
       #   ENV.fetch('X')
-      #   ENV.fetch('X', 'string literal')
-      #   ENV.fetch('X') { some_method }
       #   x = ENV.fetch('X')
       #
-      #   ENV.fetch('X') do
-      #     y.map do |a|
-      #       puts a * 2
-      #     end
-      #   end
-      #
       #   # also good
       #   !ENV['X']
       #   ENV['X'].some_method # (e.g. `.nil?`)
@@ -42,48 +25,20 @@ module RuboCop
       class FetchEnvVar < Base
         extend AutoCorrector
 
-        # rubocop:disable Layout/LineLength
-        MSG_DEFAULT_NIL = 'Use `ENV.fetch(%<key>s)` or `ENV.fetch(%<key>s, nil)` instead of `ENV[%<key>s]`.'
-        MSG_DEFAULT_RHS_SECOND_ARG_OF_FETCH = 'Use `ENV.fetch(%<key>s, %<default>s)` instead of `ENV[%<key>s] || %<default>s`.'
-        MSG_DEFAULT_RHS_SINGLE_LINE_BLOCK = 'Use `ENV.fetch(%<key>s) { %<default>s }` instead of `ENV[%<key>s] || %<default>s`.'
-        MSG_DEFAULT_RHS_MULTILINE_BLOCK = 'Use `ENV.fetch(%<key>s)` with a block containing `%<default>s ...`'
-        # rubocop:enable Layout/LineLength
+        MSG = 'Use `ENV.fetch(%<key>s)` or `ENV.fetch(%<key>s, nil)` instead of `ENV[%<key>s]`.'
 
         # @!method env_with_bracket?(node)
         def_node_matcher :env_with_bracket?, <<~PATTERN
           (send (const nil? :ENV) :[] $_)
         PATTERN
 
-        # @!method operand_of_or?(node)
-        def_node_matcher :operand_of_or?, <<~PATTERN
-          (^or ...)
-        PATTERN
-
-        # @!method block_control?(node)
-        def_node_matcher :block_control?, <<~PATTERN
-          ({next | break | retry | redo})
-        PATTERN
-
-        # @!method offensive_nodes(node)
-        def_node_search :offensive_nodes, <<~PATTERN
-          [#env_with_bracket? #offensive?]
-        PATTERN
-
         def on_send(node)
           env_with_bracket?(node) do |name_node|
             break unless offensive?(node)
 
-            if operand_of_or?(node)
-              target_node = offensive_nodes(or_chain_root(node)).to_a.last
-              target_name_node = env_with_bracket?(target_node)
-
-              if default_to_rhs?(target_node)
-                default_rhs(target_node, target_name_node)
-              else
-                default_nil(target_node, target_name_node)
-              end
-            else
-              default_nil(node, name_node)
+            message = format(MSG, key: name_node.source)
+            add_offense(node, message: message) do |corrector|
+              corrector.replace(node, new_code(name_node))
             end
           end
         end
@@ -130,17 +85,6 @@ module RuboCop
           !(allowed_var?(node) || allowable_use?(node))
         end
 
-        def or_chain_root(node)
-          while operand_of_or?(ancestor_or ||= node.parent)
-            ancestor_or = ancestor_or.parent
-          end
-          ancestor_or
-        end
-
-        def default_to_rhs?(node)
-          operand_of_or?(node) && !right_end_of_or_chains?(node) && rhs_can_be_default_value?(node)
-        end
-
         # Check if the node is a receiver and receives a message with dot syntax.
         def message_chained_with_dot?(node)
           return false if node.root?
@@ -157,8 +101,9 @@ module RuboCop
         #   it simply checks whether the variable is set.
         # - Receiving a message with dot syntax, e.g. `ENV['X'].nil?`.
         # - `ENV['key']` assigned by logical AND/OR assignment.
+        # - `ENV['key']` is the LHS of a `||`.
         def allowable_use?(node)
-          used_as_flag?(node) || message_chained_with_dot?(node) || assigned?(node)
+          used_as_flag?(node) || message_chained_with_dot?(node) || assigned?(node) || or_lhs?(node)
         end
 
         # The following are allowed cases:
@@ -172,127 +117,15 @@ module RuboCop
           node == lhs
         end
 
-        def left_end_of_or_chains?(node)
-          return false unless operand_of_or?(node)
-
-          node.parent.lhs == node
-        end
-
-        def right_end_of_or_chains?(node)
-          !(left_end_of_or_chains?(node) || node.parent&.parent&.or_type?)
-        end
-
-        def conterpart_rhs_of(node)
-          left_end_of_or_chains?(node) ? node.parent.rhs : node.parent.parent.rhs
-        end
-
-        def rhs_can_be_default_value?(node)
-          !rhs_is_block_control?(node)
-        end
+        def or_lhs?(node)
+          return false unless (parent = node.parent)&.or_type?
 
-        def rhs_is_block_control?(node)
-          block_control?(conterpart_rhs_of(node))
+          parent.lhs == node || parent.parent&.or_type?
         end
 
-        def new_code_default_nil(name_node)
+        def new_code(name_node)
           "ENV.fetch(#{name_node.source}, nil)"
         end
-
-        def new_code_default_rhs_single_line(node, name_node)
-          parent = node.parent
-          if parent.rhs.basic_literal?
-            "ENV.fetch(#{name_node.source}, #{parent.rhs.source})"
-          else
-            "ENV.fetch(#{name_node.source}) { #{parent.rhs.source} }"
-          end
-        end
-
-        def new_code_default_rhs_multiline(node, name_node)
-          env_indent = indent(node.parent)
-          default = node.parent.rhs.source.split("\n").map do |line|
-            "#{env_indent}#{line}"
-          end.join("\n")
-          <<~NEW_CODE.chomp
-            ENV.fetch(#{name_node.source}) do
-            #{configured_indentation}#{default}
-            #{env_indent}end
-          NEW_CODE
-        end
-
-        def new_code_default_rhs(node, name_node)
-          if node.parent.rhs.single_line?
-            new_code_default_rhs_single_line(node, name_node)
-          else
-            new_code_default_rhs_multiline(node, name_node)
-          end
-        end
-
-        def default_rhs(node, name_node)
-          if left_end_of_or_chains?(node)
-            default_rhs_in_same_or(node, name_node)
-          else
-            default_rhs_in_outer_or(node, name_node)
-          end
-        end
-
-        # Adds an offense and sets `nil` to the default value of `ENV.fetch`.
-        # `ENV['X']` --> `ENV.fetch('X', nil)`
-        def default_nil(node, name_node)
-          message = format(MSG_DEFAULT_NIL, key: name_node.source)
-
-          add_offense(node, message: message) do |corrector|
-            corrector.replace(node, new_code_default_nil(name_node))
-          end
-        end
-
-        # Adds an offense and makes the RHS the default value of `ENV.fetch`.
-        # `ENV['X'] || y` --> `ENV.fetch('X') { y }`
-        def default_rhs_in_same_or(node, name_node)
-          template = message_template_for(node.parent.rhs)
-          message = format(template,
-                           key: name_node.source,
-                           default: first_line_of(node.parent.rhs.source))
-
-          add_offense(node, message: message) do |corrector|
-            corrector.replace(node.parent, new_code_default_rhs(node, name_node))
-          end
-        end
-
-        # Adds an offense and makes the RHS the default value of `ENV.fetch`.
-        # `z || ENV['X'] || y` --> `z || ENV.fetch('X') { y }`
-        def default_rhs_in_outer_or(node, name_node)
-          parent = node.parent
-          grand_parent = parent.parent
-
-          template = message_template_for(grand_parent.rhs)
-          message = format(template,
-                           key: name_node.source,
-                           default: first_line_of(grand_parent.rhs.source))
-
-          add_offense(node, message: message) do |corrector|
-            lhs_code = parent.lhs.source
-            rhs_code = new_code_default_rhs(parent, name_node)
-            corrector.replace(grand_parent, "#{lhs_code} || #{rhs_code}")
-          end
-        end
-
-        def message_template_for(rhs)
-          if rhs.multiline?
-            MSG_DEFAULT_RHS_MULTILINE_BLOCK
-          elsif rhs.basic_literal?
-            MSG_DEFAULT_RHS_SECOND_ARG_OF_FETCH
-          else
-            MSG_DEFAULT_RHS_SINGLE_LINE_BLOCK
-          end
-        end
-
-        def configured_indentation
-          ' ' * (config.for_cop('Layout/IndentationWidth')['Width'] || 2)
-        end
-
-        def first_line_of(source)
-          source.split("\n").first
-        end
       end
     end
   end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Prefer to use `File.empty?('path/to/file')` when checking if a file is empty.
+      #
+      # @safety
+      #   This cop is unsafe, because `File.size`, `File.read`, and `File.binread`
+      #   raise `ENOENT` exception when there is no file corresponding to the path,
+      #   while `File.empty?` does not raise an exception.
+      #
+      # @example
+      #   # bad
+      #   File.zero?('path/to/file')
+      #   File.size('path/to/file') == 0
+      #   File.size('path/to/file') >= 0
+      #   File.size('path/to/file').zero?
+      #   File.read('path/to/file').empty?
+      #   File.binread('path/to/file') == ''
+      #   FileTest.zero?('path/to/file')
+      #
+      #   # good
+      #   File.empty?('path/to/file')
+      #   FileTest.empty?('path/to/file')
+      #
+      class FileEmpty < Base
+        extend AutoCorrector
+        extend TargetRubyVersion
+
+        MSG = 'Use `%<file_class>s.empty?(%<arg>s)` instead.'
+        RESTRICT_ON_SEND = %i[>= != == zero? empty?].freeze
+
+        minimum_target_ruby_version 2.4
+
+        # @!method offensive?(node)
+        def_node_matcher :offensive?, <<~PATTERN
+          {
+            (send $(const {nil? cbase} {:File :FileTest}) :zero? $_)
+            (send (send $(const {nil? cbase} {:File :FileTest}) :size $_) {:== :>=} (int 0))
+            (send (send (send $(const {nil? cbase} {:File :FileTest}) :size $_) :!) {:== :>=} (int 0))
+            (send (send $(const {nil? cbase} {:File :FileTest}) :size $_) :zero?)
+            (send (send $(const {nil? cbase} {:File :FileTest}) {:read :binread} $_) {:!= :==} (str empty?))
+            (send (send (send $(const {nil? cbase} {:File :FileTest}) {:read :binread} $_) :!) {:!= :==} (str empty?))
+            (send (send $(const {nil? cbase} {:File :FileTest}) {:read :binread} $_) :empty?)
+          }
+        PATTERN
+
+        def on_send(node)
+          offensive?(node) do |const_node, arg_node|
+            add_offense(node,
+                        message: format(MSG, file_class: const_node.source,
+                                             arg: arg_node.source)) do |corrector|
+              corrector.replace(node,
+                                "#{bang(node)}#{const_node.source}.empty?(#{arg_node.source})")
+            end
+          end
+        end
+
+        private
+
+        def bang(node)
+          if (node.method?(:==) && node.child_nodes.first.method?(:!)) ||
+             (%i[>= !=].include?(node.method_name) && !node.child_nodes.first.method?(:!))
+            '!'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -63,7 +63,7 @@ module RuboCop
 
         # @!method block_read?(node)
         def_node_matcher :block_read?, <<~PATTERN
-          (block _ (args (arg $_)) (send (lvar $_) :read))
+          (block _ (args (arg _name)) (send (lvar _name) :read))
         PATTERN
 
         def on_send(node)
@@ -71,7 +71,7 @@ module RuboCop
             message = format(MSG, read_method: read_method(mode))
 
             add_offense(read_node, message: message) do |corrector|
-              range = range_between(node.loc.selector.begin_pos, read_node.loc.expression.end_pos)
+              range = range_between(node.loc.selector.begin_pos, read_node.source_range.end_pos)
               replacement = "#{read_method(mode)}(#{filename.source})"
 
               corrector.replace(range, replacement)
@@ -100,7 +100,7 @@ module RuboCop
         def file_open_read?(node)
           return true if send_read?(node)
 
-          block_read?(node) { |block_arg, read_lvar| block_arg == read_lvar }
+          block_read?(node)
         end
 
         def read_method(mode)

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

@@ -74,7 +74,7 @@ module RuboCop
             message = format(MSG, write_method: write_method(mode))
 
             add_offense(write_node, message: message) do |corrector|
-              range = range_between(node.loc.selector.begin_pos, write_node.loc.expression.end_pos)
+              range = range_between(node.loc.selector.begin_pos, write_node.source_range.end_pos)
               replacement = replacement(mode, filename, content, write_node)
 
               corrector.replace(range, replacement)

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

@@ -66,6 +66,8 @@ module RuboCop
           return unless suspect_enumerable?(node)
 
           if style == :for
+            return unless node.receiver
+
             add_offense(node, message: PREFER_FOR) do |corrector|
               EachToForCorrector.new(node).call(corrector)
               opposite_style_detected
@@ -75,10 +77,12 @@ module RuboCop
           end
         end
 
+        alias on_numblock on_block
+
         private
 
         def suspect_enumerable?(node)
-          node.multiline? && node.send_node.method?(:each) && !node.send_node.arguments?
+          node.multiline? && node.method?(:each) && !node.send_node.arguments?
         end
       end
     end

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

@@ -4,36 +4,48 @@ module RuboCop
   module Cop
     module Style
       # Enforces the use of a single string formatting utility.
-      # Valid options include Kernel#format, Kernel#sprintf and String#%.
+      # Valid options include `Kernel#format`, `Kernel#sprintf`, and `String#%`.
       #
-      # The detection of String#% cannot be implemented in a reliable
+      # The detection of `String#%` cannot be implemented in a reliable
       # manner for all cases, so only two scenarios are considered -
       # if the first argument is a string literal and if the second
       # argument is an array literal.
       #
+      # Autocorrection will be applied when using argument is a literal or known built-in conversion
+      # methods such as `to_d`, `to_f`, `to_h`, `to_i`, `to_r`, `to_s`, and `to_sym` on variables,
+      # provided that their return value is not an array. For example, when using `to_s`,
+      # `'%s' % [1, 2, 3].to_s` can be autocorrected without any incompatibility:
+      #
+      # [source,ruby]
+      # ----
+      # '%s' % [1, 2, 3]        #=> '1'
+      # format('%s', [1, 2, 3]) #=> '[1, 2, 3]'
+      # '%s' % [1, 2, 3].to_s   #=> '[1, 2, 3]'
+      # ----
+      #
       # @example EnforcedStyle: format (default)
       #   # bad
-      #   puts sprintf('%10s', 'hoge')
-      #   puts '%10s' % 'hoge'
+      #   puts sprintf('%10s', 'foo')
+      #   puts '%10s' % 'foo'
       #
       #   # good
-      #   puts format('%10s', 'hoge')
+      #   puts format('%10s', 'foo')
       #
       # @example EnforcedStyle: sprintf
       #   # bad
-      #   puts format('%10s', 'hoge')
-      #   puts '%10s' % 'hoge'
+      #   puts format('%10s', 'foo')
+      #   puts '%10s' % 'foo'
       #
       #   # good
-      #   puts sprintf('%10s', 'hoge')
+      #   puts sprintf('%10s', 'foo')
       #
       # @example EnforcedStyle: percent
       #   # bad
-      #   puts format('%10s', 'hoge')
-      #   puts sprintf('%10s', 'hoge')
+      #   puts format('%10s', 'foo')
+      #   puts sprintf('%10s', 'foo')
       #
       #   # good
-      #   puts '%10s' % 'hoge'
+      #   puts '%10s' % 'foo'
       #
       class FormatString < Base
         include ConfigurableEnforcedStyle
@@ -42,6 +54,9 @@ module RuboCop
         MSG = 'Favor `%<prefer>s` over `%<current>s`.'
         RESTRICT_ON_SEND = %i[format sprintf %].freeze
 
+        # Known conversion methods whose return value is not an array.
+        AUTOCORRECTABLE_METHODS = %i[to_d to_f to_h to_i to_r to_s to_sym].freeze
+
         # @!method formatter(node)
         def_node_matcher :formatter, <<~PATTERN
           {
@@ -53,7 +68,7 @@ module RuboCop
 
         # @!method variable_argument?(node)
         def_node_matcher :variable_argument?, <<~PATTERN
-          (send {str dstr} :% {send_type? lvar_type?})
+          (send {str dstr} :% #autocorrectable?)
         PATTERN
 
         def on_send(node)
@@ -70,6 +85,12 @@ module RuboCop
 
         private
 
+        def autocorrectable?(node)
+          return true if node.lvar_type?
+
+          node.send_type? && !AUTOCORRECTABLE_METHODS.include?(node.method_name)
+        end
+
         def message(detected_style)
           format(MSG, prefer: method_name(style), current: method_name(detected_style))
         end

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

@@ -11,7 +11,8 @@ module RuboCop
       # The reason is that _unannotated_ format is very similar
       # to encoded URLs or Date/Time formatting strings.
       #
-      # This cop can be customized ignored methods with `IgnoredMethods`.
+      # This cop can be customized allowed methods with `AllowedMethods`.
+      # By default, there are no methods to allowed.
       #
       # @example EnforcedStyle: annotated (default)
       #
@@ -61,29 +62,41 @@ module RuboCop
       #   # good
       #   format('%06d', 10)
       #
-      # @example IgnoredMethods: [redirect]
+      # @example AllowedMethods: [] (default)
+      #
+      #   # bad
+      #   redirect('foo/%{bar_id}')
+      #
+      # @example AllowedMethods: [redirect]
+      #
+      #   # good
+      #   redirect('foo/%{bar_id}')
+      #
+      # @example AllowedPatterns: [] (default)
+      #
+      #   # bad
+      #   redirect('foo/%{bar_id}')
+      #
+      # @example AllowedPatterns: ['redirect']
       #
       #   # good
       #   redirect('foo/%{bar_id}')
       #
       class FormatStringToken < Base
         include ConfigurableEnforcedStyle
-        include IgnoredMethods
+        include AllowedMethods
+        include AllowedPattern
+        extend AutoCorrector
 
         def on_str(node)
-          return if format_string_token?(node) || use_ignored_method?(node)
+          return if format_string_token?(node) || use_allowed_method?(node)
 
           detections = collect_detections(node)
           return if detections.empty?
           return if allowed_unannotated?(detections)
 
-          detections.each do |detected_style, token_range|
-            if detected_style == style
-              correct_style_detected
-            else
-              style_detected(detected_style)
-              add_offense(token_range, message: message(detected_style))
-            end
+          detections.each do |detected_sequence, token_range|
+            check_sequence(detected_sequence, token_range)
           end
         end
 
@@ -101,9 +114,43 @@ module RuboCop
           !node.value.include?('%') || node.each_ancestor(:xstr, :regexp).any?
         end
 
-        def use_ignored_method?(node)
+        def use_allowed_method?(node)
           send_parent = node.each_ancestor(:send).first
-          send_parent && ignored_method?(send_parent.method_name)
+          send_parent &&
+            (allowed_method?(send_parent.method_name) ||
+            matches_allowed_pattern?(send_parent.method_name))
+        end
+
+        def check_sequence(detected_sequence, token_range)
+          if detected_sequence.style == style
+            correct_style_detected
+          elsif correctable_sequence?(detected_sequence.type)
+            style_detected(detected_sequence.style)
+            add_offense(token_range, message: message(detected_sequence.style)) do |corrector|
+              autocorrect_sequence(corrector, detected_sequence, token_range)
+            end
+          end
+        end
+
+        def correctable_sequence?(detected_type)
+          detected_type == 's' || style == :annotated || style == :unannotated
+        end
+
+        def autocorrect_sequence(corrector, detected_sequence, token_range)
+          return if style == :unannotated
+
+          name = detected_sequence.name
+          return if name.nil?
+
+          flags = detected_sequence.flags
+          width = detected_sequence.width
+          precision = detected_sequence.precision
+          type = detected_sequence.style == :template ? 's' : detected_sequence.type
+          correction = case style
+                       when :annotated then "%<#{name}>#{flags}#{width}#{precision}#{type}"
+                       when :template then "%#{flags}#{width}#{precision}{#{name}}"
+                       end
+          corrector.replace(token_range, correction)
         end
 
         def unannotated_format?(node, detected_style)
@@ -143,30 +190,33 @@ module RuboCop
         def token_ranges(contents)
           format_string = RuboCop::Cop::Utils::FormatString.new(contents.source)
 
-          format_string.format_sequences.each do |seq|
-            next if seq.percent?
+          format_string.format_sequences.each do |detected_sequence|
+            next if detected_sequence.percent?
 
-            detected_style = seq.style
-            token = contents.begin.adjust(begin_pos: seq.begin_pos, end_pos: seq.end_pos)
+            token = contents.begin.adjust(begin_pos: detected_sequence.begin_pos,
+                                          end_pos: detected_sequence.end_pos)
 
-            yield(detected_style, token)
+            yield(detected_sequence, token)
           end
         end
 
         def collect_detections(node)
           detections = []
-          tokens(node) do |detected_style, token_range|
-            unless unannotated_format?(node, detected_style)
-              detections << [detected_style, token_range]
+          tokens(node) do |detected_sequence, token_range|
+            unless unannotated_format?(node, detected_sequence.style)
+              detections << [detected_sequence, token_range]
             end
           end
           detections
         end
 
         def allowed_unannotated?(detections)
-          return false if detections.size > max_unannotated_placeholders_allowed
+          return false unless detections.all? do |detected_sequence,|
+                                detected_sequence.style == :unannotated
+                              end
+          return true if detections.size <= max_unannotated_placeholders_allowed
 
-          detections.all? { |detected_style,| detected_style == :unannotated }
+          detections.any? { |detected_sequence,| !correctable_sequence?(detected_sequence.type) }
         end
 
         def max_unannotated_placeholders_allowed

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

@@ -142,13 +142,15 @@ module RuboCop
           end
 
           next_token = processed_source.tokens[token_number]
-          token = next_token if Encoding::ENCODING_PATTERN.match?(next_token&.text)
+          if next_token&.text&.valid_encoding? && Encoding::ENCODING_PATTERN.match?(next_token.text)
+            token = next_token
+          end
 
           token
         end
 
         def frozen_string_literal_comment(processed_source)
-          processed_source.find_token do |token|
+          processed_source.tokens.find do |token|
             token.text.start_with?(FROZEN_STRING_LITERAL)
           end
         end
@@ -182,7 +184,7 @@ module RuboCop
         end
 
         def remove_comment(corrector, node)
-          corrector.remove(range_with_surrounding_space(range: node.pos, side: :right))
+          corrector.remove(range_with_surrounding_space(node.pos, side: :right))
         end
 
         def enable_comment(corrector)