rubocop 1.22.0 → 1.45.1

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

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Suggests `ENV.fetch` for the replacement of `ENV[]`.
+      # `ENV[]` silently fails and returns `nil` when the environment variable is unset,
+      # which may cause unexpected behaviors when the developer forgets to set it.
+      # On the other hand, `ENV.fetch` raises KeyError or returns the explicitly
+      # specified default value.
+      #
+      # @example
+      #   # bad
+      #   ENV['X']
+      #   x = ENV['X']
+      #
+      #   # good
+      #   ENV.fetch('X')
+      #   x = ENV.fetch('X')
+      #
+      #   # also good
+      #   !ENV['X']
+      #   ENV['X'].some_method # (e.g. `.nil?`)
+      #
+      class FetchEnvVar < Base
+        extend AutoCorrector
+
+        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
+
+        def on_send(node)
+          env_with_bracket?(node) do |name_node|
+            break unless offensive?(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
+
+        private
+
+        def allowed_var?(node)
+          env_key_node = node.children.last
+          env_key_node.str_type? && cop_config['AllowedVars'].include?(env_key_node.value)
+        end
+
+        def used_as_flag?(node)
+          return false if node.root?
+          return true if used_if_condition_in_body(node)
+
+          node.parent.send_type? && (node.parent.prefix_bang? || node.parent.comparison_method?)
+        end
+
+        def used_if_condition_in_body(node)
+          if_node = node.ancestors.find(&:if_type?)
+
+          return false unless (condition = if_node&.condition)
+          return true if condition.send_type? && (condition.child_nodes == node.child_nodes)
+
+          used_in_condition?(node, condition)
+        end
+
+        def used_in_condition?(node, condition)
+          if condition.send_type?
+            return true if condition.assignment_method? && partial_matched?(node, condition)
+            return false if !condition.comparison_method? && !condition.predicate_method?
+          end
+
+          condition.child_nodes.any?(node)
+        end
+
+        # Avoid offending in the following cases:
+        # `ENV['key'] if ENV['key'] = x`
+        def partial_matched?(node, condition)
+          node.child_nodes == node.child_nodes & condition.child_nodes
+        end
+
+        def offensive?(node)
+          !(allowed_var?(node) || allowable_use?(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?
+
+          parent = node.parent
+          return false if !parent.call_type? || parent.children.first != node
+
+          parent.dot? || parent.safe_navigation?
+        end
+
+        # The following are allowed cases:
+        #
+        # - Used as a flag (e.g., `if ENV['X']` or `!ENV['X']`) because
+        #   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) || or_lhs?(node)
+        end
+
+        # The following are allowed cases:
+        #
+        # - `ENV['key']` is a receiver of `||=`, e.g. `ENV['X'] ||= y`.
+        # - `ENV['key']` is a receiver of `&&=`, e.g. `ENV['X'] &&= y`.
+        def assigned?(node)
+          return false unless (parent = node.parent)&.assignment?
+
+          lhs, _method, _rhs = *parent
+          node == lhs
+        end
+
+        def or_lhs?(node)
+          return false unless (parent = node.parent)&.or_type?
+
+          parent.lhs == node || parent.parent&.or_type?
+        end
+
+        def new_code(name_node)
+          "ENV.fetch(#{name_node.source}, nil)"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Favor `File.(bin)read` convenience methods.
+      #
+      # @example
+      #   ## text mode
+      #   # bad
+      #   File.open(filename).read
+      #   File.open(filename, &:read)
+      #   File.open(filename) { |f| f.read }
+      #   File.open(filename) do |f|
+      #     f.read
+      #   end
+      #   File.open(filename, 'r').read
+      #   File.open(filename, 'r', &:read)
+      #   File.open(filename, 'r') do |f|
+      #     f.read
+      #   end
+      #
+      #   # good
+      #   File.read(filename)
+      #
+      # @example
+      #   ## binary mode
+      #   # bad
+      #   File.open(filename, 'rb').read
+      #   File.open(filename, 'rb', &:read)
+      #   File.open(filename, 'rb') do |f|
+      #     f.read
+      #   end
+      #
+      #   # good
+      #   File.binread(filename)
+      #
+      class FileRead < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `File.%<read_method>s`.'
+
+        RESTRICT_ON_SEND = %i[open].freeze
+
+        READ_FILE_START_TO_FINISH_MODES = %w[r rt rb r+ r+t r+b].to_set.freeze
+
+        # @!method file_open?(node)
+        def_node_matcher :file_open?, <<~PATTERN
+          (send
+            (const {nil? cbase} :File)
+            :open
+            $_
+            (str $%READ_FILE_START_TO_FINISH_MODES)?
+            $(block-pass (sym :read))?
+          )
+        PATTERN
+
+        # @!method send_read?(node)
+        def_node_matcher :send_read?, <<~PATTERN
+          (send _ :read)
+        PATTERN
+
+        # @!method block_read?(node)
+        def_node_matcher :block_read?, <<~PATTERN
+          (block _ (args (arg $_)) (send (lvar $_) :read))
+        PATTERN
+
+        def on_send(node)
+          evidence(node) do |filename, mode, read_node|
+            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)
+              replacement = "#{read_method(mode)}(#{filename.source})"
+
+              corrector.replace(range, replacement)
+            end
+          end
+        end
+
+        private
+
+        def evidence(node)
+          file_open?(node) do |filename, mode_array, block_pass|
+            read_node?(node, block_pass) do |read_node|
+              yield(filename, mode_array.first || 'r', read_node)
+            end
+          end
+        end
+
+        def read_node?(node, block_pass)
+          if block_pass.any?
+            yield(node)
+          elsif file_open_read?(node.parent)
+            yield(node.parent)
+          end
+        end
+
+        def file_open_read?(node)
+          return true if send_read?(node)
+
+          block_read?(node) { |block_arg, read_lvar| block_arg == read_lvar }
+        end
+
+        def read_method(mode)
+          mode.end_with?('b') ? :binread : :read
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Favor `File.(bin)write` convenience methods.
+      #
+      # NOTE: There are different method signatures between `File.write` (class method)
+      # and `File#write` (instance method). The following case will be allowed because
+      # static analysis does not know the contents of the splat argument:
+      #
+      # [source,ruby]
+      # ----
+      # File.open(filename, 'w') do |f|
+      #   f.write(*objects)
+      # end
+      # ----
+      #
+      # @example
+      #   ## text mode
+      #   # bad
+      #   File.open(filename, 'w').write(content)
+      #   File.open(filename, 'w') do |f|
+      #     f.write(content)
+      #   end
+      #
+      #   # good
+      #   File.write(filename, content)
+      #
+      # @example
+      #   ## binary mode
+      #   # bad
+      #   File.open(filename, 'wb').write(content)
+      #   File.open(filename, 'wb') do |f|
+      #     f.write(content)
+      #   end
+      #
+      #   # good
+      #   File.binwrite(filename, content)
+      #
+      class FileWrite < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Use `File.%<write_method>s`.'
+
+        RESTRICT_ON_SEND = %i[open].to_set.freeze
+
+        TRUNCATING_WRITE_MODES = %w[w wt wb w+ w+t w+b].to_set.freeze
+
+        # @!method file_open?(node)
+        def_node_matcher :file_open?, <<~PATTERN
+          (send
+            (const {nil? cbase} :File)
+            :open
+            $_
+            (str $%TRUNCATING_WRITE_MODES)
+            (block-pass (sym :write))?
+          )
+        PATTERN
+
+        # @!method send_write?(node)
+        def_node_matcher :send_write?, <<~PATTERN
+          (send _ :write $_)
+        PATTERN
+
+        # @!method block_write?(node)
+        def_node_matcher :block_write?, <<~PATTERN
+          (block _ (args (arg $_)) (send (lvar $_) :write $_))
+        PATTERN
+
+        def on_send(node)
+          evidence(node) do |filename, mode, content, write_node|
+            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)
+              replacement = replacement(mode, filename, content, write_node)
+
+              corrector.replace(range, replacement)
+            end
+          end
+        end
+
+        def evidence(node)
+          file_open?(node) do |filename, mode|
+            file_open_write?(node.parent) do |content|
+              yield(filename, mode, content, node.parent)
+            end
+          end
+        end
+
+        private
+
+        def file_open_write?(node)
+          content = send_write?(node) || block_write?(node) do |block_arg, lvar, write_arg|
+            write_arg if block_arg == lvar
+          end
+          return false if content&.splat_type?
+
+          yield(content) if content
+        end
+
+        def write_method(mode)
+          mode.end_with?('b') ? :binwrite : :write
+        end
+
+        def replacement(mode, filename, content, write_node)
+          replacement = "#{write_method(mode)}(#{filename.source}, #{content.source})"
+
+          if heredoc?(write_node)
+            first_argument = write_node.body.first_argument
+
+            <<~REPLACEMENT.chomp
+              #{replacement}
+              #{heredoc_range(first_argument).source}
+            REPLACEMENT
+          else
+            replacement
+          end
+        end
+
+        def heredoc?(write_node)
+          write_node.block_type? && (first_argument = write_node.body.first_argument) &&
+            first_argument.respond_to?(:heredoc?) && first_argument.heredoc?
+        end
+
+        def heredoc_range(first_argument)
+          range_between(
+            first_argument.loc.heredoc_body.begin_pos, first_argument.loc.heredoc_end.end_pos
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for division with integers coerced to floats.
+      # Checks for division with integers coerced to floats.
       # It is recommended to either always use `fdiv` or coerce one side only.
       # This cop also provides other options for code consistency.
       #

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for uses of the `for` keyword or `each` method. The
+      # Looks for uses of the `for` keyword or `each` method. The
       # preferred alternative is set in the EnforcedStyle configuration
       # parameter. An `each` call with a block on a single line is always
       # allowed.
@@ -38,6 +38,10 @@ module RuboCop
       #     end
       #   end
       #
+      # @safety
+      #   This cop's autocorrection is unsafe because the scope of
+      #   variables is different between `each` and `for`.
+      #
       class For < Base
         include ConfigurableEnforcedStyle
         include RangeHelp
@@ -71,6 +75,8 @@ module RuboCop
           end
         end
 
+        alias on_numblock on_block
+
         private
 
         def suspect_enumerable?(node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of a single string formatting utility.
+      # Enforces the use of a single string formatting utility.
       # Valid options include Kernel#format, Kernel#sprintf and String#%.
       #
       # The detection of String#% cannot be implemented in a reliable

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,8 +114,43 @@ module RuboCop
           !node.value.include?('%') || node.each_ancestor(:xstr, :regexp).any?
         end
 
-        def use_ignored_method?(node)
-          (parent = node.parent) && parent.send_type? && ignored_method?(parent.method_name)
+        def use_allowed_method?(node)
+          send_parent = node.each_ancestor(:send).first
+          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)
@@ -142,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

@@ -3,12 +3,12 @@
 module RuboCop
   module Cop
     module Style
-      # This cop is designed to help you transition from mutable string literals
+      # Helps you transition from mutable string literals
       # to frozen string literals.
       # It will add the `# frozen_string_literal: true` magic comment to the top
       # of files to enable frozen string literals. Frozen string literals may be
       # default in future Ruby. The comment will be added below a shebang and
-      # encoding comment.
+      # encoding comment. The frozen string literal comment is only valid in Ruby 2.3+.
       #
       # Note that the cop will accept files where the comment exists but is set
       # to `false` instead of `true`.
@@ -86,6 +86,9 @@ module RuboCop
         include FrozenStringLiteral
         include RangeHelp
         extend AutoCorrector
+        extend TargetRubyVersion
+
+        minimum_target_ruby_version 2.3
 
         MSG_MISSING_TRUE = 'Missing magic comment `# frozen_string_literal: true`.'
         MSG_MISSING = 'Missing frozen string literal comment.'
@@ -179,7 +182,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)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop enforces the use of `$stdout/$stderr/$stdin` instead of `STDOUT/STDERR/STDIN`.
+      # Enforces the use of `$stdout/$stderr/$stdin` instead of `STDOUT/STDERR/STDIN`.
       # `STDOUT/STDERR/STDIN` are constants, and while you can actually
       # reassign (possibly to redirect some stream) constants in Ruby, you'll get
       # an interpreter warning if you do so.

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Style
-      # This cop looks for uses of global variables.
+      # Looks for uses of global variables.
       # It does not report offenses for built-in global variables.
       # Built-in global variables are allowed by default. Additionally
       # users can allow additional variables via the AllowedVariables option.