rubocop 0.66.0 → 1.25.1

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

@@ -28,7 +28,14 @@ module RuboCop
       #   end
       #
       #   # bad
-      #   # When using Ruby 2.5 or later.
+      #   begin
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   do_something
+      #
+      #   # bad
       #   do_something do
       #     begin
       #       something
@@ -54,36 +61,116 @@ module RuboCop
       #       baz
       #     end
       #   end
-      class RedundantBegin < Cop
-        MSG = 'Redundant `begin` block detected.'.freeze
+      class RedundantBegin < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Redundant `begin` block detected.'
 
         def on_def(node)
-          check(node)
+          return unless node.body&.kwbegin_type?
+
+          register_offense(node.body)
         end
         alias on_defs on_def
 
         def on_block(node)
-          return if target_ruby_version < 2.5
-
           return if node.send_node.lambda_literal?
           return if node.braces?
+          return unless node.body&.kwbegin_type?
+
+          register_offense(node.body)
+        end
 
-          check(node)
+        def on_kwbegin(node)
+          return if empty_begin?(node) ||
+                    begin_block_has_multiline_statements?(node) ||
+                    contain_rescue_or_ensure?(node) ||
+                    valid_context_using_only_begin?(node)
+
+          register_offense(node)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.begin)
+        private
+
+        def register_offense(node)
+          offense_range = node.loc.begin
+
+          add_offense(offense_range) do |corrector|
+            if node.parent&.assignment?
+              replace_begin_with_statement(corrector, offense_range, node)
+            else
+              corrector.remove(offense_range)
+            end
+
+            if use_modifier_form_after_multiline_begin_block?(node)
+              correct_modifier_form_after_multiline_begin_block(corrector, node)
+            end
             corrector.remove(node.loc.end)
           end
         end
 
-        private
+        def replace_begin_with_statement(corrector, offense_range, node)
+          first_child = node.children.first
+
+          source = first_child.source
+          source = "(#{source})" if first_child.if_type? && first_child.modifier_form?
+
+          corrector.replace(offense_range, source)
+          corrector.remove(range_between(offense_range.end_pos, first_child.source_range.end_pos))
+
+          restore_removed_comments(corrector, offense_range, node, first_child)
+        end
 
-        def check(node)
-          return unless node.body && node.body.kwbegin_type?
+        # Restore comments that occur between "begin" and "first_child".
+        # These comments will be moved to above the assignment line.
+        def restore_removed_comments(corrector, offense_range, node, first_child)
+          comments_range = range_between(offense_range.end_pos, first_child.source_range.begin_pos)
+          comments = comments_range.source
+
+          corrector.insert_before(node.parent, comments) unless comments.blank?
+        end
+
+        def use_modifier_form_after_multiline_begin_block?(node)
+          return unless (parent = node.parent)
+
+          node.multiline? && parent.if_type? && parent.modifier_form?
+        end
+
+        def correct_modifier_form_after_multiline_begin_block(corrector, node)
+          condition_range = condition_range(node.parent)
+
+          corrector.insert_after(node.children.first, " #{condition_range.source}")
+          corrector.remove(range_by_whole_lines(condition_range, include_final_newline: true))
+        end
+
+        def condition_range(node)
+          range_between(node.loc.keyword.begin_pos, node.condition.source_range.end_pos)
+        end
+
+        def empty_begin?(node)
+          node.children.empty?
+        end
+
+        def begin_block_has_multiline_statements?(node)
+          node.children.count >= 2
+        end
+
+        def contain_rescue_or_ensure?(node)
+          first_child = node.children.first
+
+          first_child.rescue_type? || first_child.ensure_type?
+        end
+
+        def valid_context_using_only_begin?(node)
+          parent = node.parent
+
+          valid_begin_assignment?(node) || parent&.post_condition_loop? ||
+            parent&.send_type? || parent&.operator_keyword?
+        end
 
-          add_offense(node.body, location: :begin)
+        def valid_begin_assignment?(node)
+          node.parent&.assignment? && !node.children.one?
         end
       end
     end

data/lib/rubocop/cop/style/{unneeded_capital_w.rb → redundant_capital_w.rb}

@@ -14,29 +14,25 @@ module RuboCop
       #   %w/swim run bike/
       #   %w[shirt pants shoes]
       #   %W(apple #{fruit} grape)
-      class UnneededCapitalW < Cop
+      class RedundantCapitalW < Base
         include PercentLiteral
+        extend AutoCorrector
 
-        MSG = 'Do not use `%W` unless interpolation is needed. ' \
-              'If not, use `%w`.'.freeze
+        MSG = 'Do not use `%W` unless interpolation is needed. If not, use `%w`.'
 
         def on_array(node)
           process(node, '%W')
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            src = node.loc.begin.source
-            corrector.replace(node.loc.begin, src.tr('W', 'w'))
-          end
-        end
-
         private
 
         def on_percent_literal(node)
           return if requires_interpolation?(node)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            src = node.loc.begin.source
+            corrector.replace(node.loc.begin, src.tr('W', 'w'))
+          end
         end
 
         def requires_interpolation?(node)

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for unnecessary conditional expressions.
+      #
+      # @example
+      #   # bad
+      #   a = b ? b : c
+      #
+      #   # good
+      #   a = b || c
+      #
+      # @example
+      #   # bad
+      #   if b
+      #     b
+      #   else
+      #     c
+      #   end
+      #
+      #   # good
+      #   b || c
+      #
+      #   # good
+      #   if b
+      #     b
+      #   elsif cond
+      #     c
+      #   end
+      #
+      class RedundantCondition < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use double pipes `||` instead.'
+        REDUNDANT_CONDITION = 'This condition is not needed.'
+
+        def on_if(node)
+          return if node.elsif_conditional?
+          return unless offense?(node)
+
+          message = message(node)
+
+          add_offense(range_of_offense(node), message: message) do |corrector|
+            if node.ternary?
+              correct_ternary(corrector, node)
+            elsif node.modifier_form? || !node.else_branch
+              corrector.replace(node, node.if_branch.source)
+            else
+              corrected = make_ternary_form(node)
+
+              corrector.replace(node, corrected)
+            end
+          end
+        end
+
+        private
+
+        def message(node)
+          if node.modifier_form? || !node.else_branch
+            REDUNDANT_CONDITION
+          else
+            MSG
+          end
+        end
+
+        def range_of_offense(node)
+          return node.loc.expression unless node.ternary?
+
+          range_between(node.loc.question.begin_pos, node.loc.colon.end_pos)
+        end
+
+        def offense?(node)
+          condition, if_branch, else_branch = *node
+
+          return false if use_if_branch?(else_branch) || use_hash_key_assignment?(else_branch)
+
+          condition == if_branch && !node.elsif? && (
+            node.ternary? || !else_branch.instance_of?(AST::Node) || else_branch.single_line?
+          )
+        end
+
+        def use_if_branch?(else_branch)
+          else_branch&.if_type?
+        end
+
+        def use_hash_key_assignment?(else_branch)
+          else_branch&.send_type? && else_branch&.method?(:[]=)
+        end
+
+        def else_source(else_branch)
+          if require_parentheses?(else_branch)
+            "(#{else_branch.source})"
+          elsif without_argument_parentheses_method?(else_branch)
+            "#{else_branch.method_name}(#{else_branch.arguments.map(&:source).join(', ')})"
+          else
+            else_branch.source
+          end
+        end
+
+        def make_ternary_form(node)
+          _condition, if_branch, else_branch = *node
+          ternary_form = [if_branch.source, else_source(else_branch)].join(' || ')
+
+          if node.parent&.send_type?
+            "(#{ternary_form})"
+          else
+            ternary_form
+          end
+        end
+
+        def correct_ternary(corrector, node)
+          corrector.replace(range_of_offense(node), '||')
+
+          return unless node.else_branch.range_type?
+
+          corrector.wrap(node.else_branch, '(', ')')
+        end
+
+        def require_parentheses?(node)
+          (node.basic_conditional? && node.modifier_form?) ||
+            node.range_type? ||
+            node.rescue_type? ||
+            (node.respond_to?(:semantic_operator?) && node.semantic_operator?)
+        end
+
+        def without_argument_parentheses_method?(node)
+          node.send_type? &&
+            !node.arguments.empty? && !node.parenthesized? && !node.operator_method?
+        end
+      end
+    end
+  end
+end

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

@@ -24,23 +24,22 @@ module RuboCop
       #
       #   # good
       #   x != y
-      class RedundantConditional < Cop
+      class RedundantConditional < Base
         include Alignment
+        extend AutoCorrector
 
-        COMPARISON_OPERATORS = RuboCop::AST::Node::COMPARISON_OPERATORS
+        operators = RuboCop::AST::Node::COMPARISON_OPERATORS.to_a
+        COMPARISON_OPERATOR_MATCHER = "{:#{operators.join(' :')}}"
 
-        MSG = 'This conditional expression can just be replaced ' \
-              'by `%<msg>s`.'.freeze
+        MSG = 'This conditional expression can just be replaced by `%<msg>s`.'
 
         def on_if(node)
           return unless offense?(node)
 
-          add_offense(node)
-        end
+          message = message(node)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, replacement_condition(node))
+          add_offense(node, message: message) do |corrector|
+            corrector.replace(node, replacement_condition(node))
           end
         end
 
@@ -53,12 +52,14 @@ module RuboCop
           format(MSG, msg: msg)
         end
 
-        def_node_matcher :redundant_condition?, <<-RUBY
-          (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) true false)
+        # @!method redundant_condition?(node)
+        def_node_matcher :redundant_condition?, <<~RUBY
+          (if (send _ #{COMPARISON_OPERATOR_MATCHER} _) true false)
         RUBY
 
-        def_node_matcher :redundant_condition_inverted?, <<-RUBY
-          (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) false true)
+        # @!method redundant_condition_inverted?(node)
+        def_node_matcher :redundant_condition_inverted?, <<~RUBY
+          (if (send _ #{COMPARISON_OPERATOR_MATCHER} _) false true)
         RUBY
 
         def offense?(node)
@@ -76,11 +77,9 @@ module RuboCop
 
         def invert_expression?(node)
           (
-            (node.if? || node.elsif? || node.ternary?) &&
-            redundant_condition_inverted?(node)
+            (node.if? || node.elsif? || node.ternary?) && redundant_condition_inverted?(node)
           ) || (
-            node.unless? &&
-            redundant_condition?(node)
+            node.unless? && redundant_condition?(node)
           )
         end
 

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

@@ -16,43 +16,48 @@ module RuboCop
       #
       #   # Good
       #   raise 'message'
-      class RedundantException < Cop
-        MSG_1 = 'Redundant `RuntimeError` argument can be removed.'.freeze
-        MSG_2 = 'Redundant `RuntimeError.new` call can be replaced with ' \
-                'just the message.'.freeze
+      class RedundantException < Base
+        extend AutoCorrector
 
-        def on_send(node)
-          exploded?(node) { return add_offense(node, message: MSG_1) }
-          compact?(node) { add_offense(node, message: MSG_2) }
-        end
+        MSG_1 = 'Redundant `RuntimeError` argument can be removed.'
+        MSG_2 = 'Redundant `RuntimeError.new` call can be replaced with just the message.'
+
+        RESTRICT_ON_SEND = %i[raise fail].freeze
 
         # Switch `raise RuntimeError, 'message'` to `raise 'message'`, and
         # `raise RuntimeError.new('message')` to `raise 'message'`.
-        def autocorrect(node) # rubocop:disable Metrics/MethodLength
+        def on_send(node)
+          fix_exploded(node) || fix_compact(node)
+        end
+
+        def fix_exploded(node)
           exploded?(node) do |command, message|
-            return lambda do |corrector|
+            add_offense(node, message: MSG_1) do |corrector|
               if node.parenthesized?
-                corrector.replace(node.source_range,
-                                  "#{command}(#{message.source})")
+                corrector.replace(node, "#{command}(#{message.source})")
               else
-                corrector.replace(node.source_range,
-                                  "#{command} #{message.source}")
+                corrector.replace(node, "#{command} #{message.source}")
               end
             end
           end
+        end
+
+        def fix_compact(node)
           compact?(node) do |new_call, message|
-            lambda do |corrector|
-              corrector.replace(new_call.source_range, message.source)
+            add_offense(node, message: MSG_2) do |corrector|
+              corrector.replace(new_call, message.source)
             end
           end
         end
 
-        def_node_matcher :exploded?, <<-PATTERN
-          (send nil? ${:raise :fail} (const nil? :RuntimeError) $_)
+        # @!method exploded?(node)
+        def_node_matcher :exploded?, <<~PATTERN
+          (send nil? ${:raise :fail} (const {nil? cbase} :RuntimeError) $_)
         PATTERN
 
-        def_node_matcher :compact?, <<-PATTERN
-          (send nil? {:raise :fail} $(send (const nil? :RuntimeError) :new $_))
+        # @!method compact?(node)
+        def_node_matcher :compact?, <<~PATTERN
+          (send nil? {:raise :fail} $(send (const {nil? cbase} :RuntimeError) :new $_))
         PATTERN
       end
     end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop identifies places where `fetch(key) { value }`
+      # can be replaced by `fetch(key, value)`.
+      #
+      # In such cases `fetch(key, value)` method is faster
+      # than `fetch(key) { value }`.
+      #
+      # @safety
+      #   This cop is unsafe because it cannot be guaranteed that the receiver
+      #   does not have a different implementation of `fetch`.
+      #
+      # @example SafeForConstants: false (default)
+      #   # bad
+      #   hash.fetch(:key) { 5 }
+      #   hash.fetch(:key) { true }
+      #   hash.fetch(:key) { nil }
+      #   array.fetch(5) { :value }
+      #   ENV.fetch(:key) { 'value' }
+      #
+      #   # good
+      #   hash.fetch(:key, 5)
+      #   hash.fetch(:key, true)
+      #   hash.fetch(:key, nil)
+      #   array.fetch(5, :value)
+      #   ENV.fetch(:key, 'value')
+      #
+      # @example SafeForConstants: true
+      #   # bad
+      #   ENV.fetch(:key) { VALUE }
+      #
+      #   # good
+      #   ENV.fetch(:key, VALUE)
+      #
+      class RedundantFetchBlock < Base
+        include FrozenStringLiteral
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<good>s` instead of `%<bad>s`.'
+
+        # @!method redundant_fetch_block_candidate?(node)
+        def_node_matcher :redundant_fetch_block_candidate?, <<~PATTERN
+          (block
+            $(send _ :fetch _)
+            (args)
+            ${nil? #basic_literal? #const_type?})
+        PATTERN
+
+        def on_block(node)
+          redundant_fetch_block_candidate?(node) do |send, body|
+            return if should_not_check?(send, body)
+
+            range = fetch_range(send, node)
+            good = build_good_method(send, body)
+            bad = build_bad_method(send, body)
+
+            add_offense(range, message: format(MSG, good: good, bad: bad)) do |corrector|
+              receiver, _, key = send.children
+              default_value = body ? body.source : 'nil'
+
+              corrector.replace(node, "#{receiver.source}.fetch(#{key.source}, #{default_value})")
+            end
+          end
+        end
+
+        private
+
+        def basic_literal?(node)
+          node&.basic_literal?
+        end
+
+        def const_type?(node)
+          node&.const_type?
+        end
+
+        def should_not_check?(send, body)
+          (body&.const_type? && !check_for_constant?) ||
+            (body&.str_type? && !check_for_string?) ||
+            rails_cache?(send.receiver)
+        end
+
+        # @!method rails_cache?(node)
+        def_node_matcher :rails_cache?, <<~PATTERN
+          (send (const _ :Rails) :cache)
+        PATTERN
+
+        def fetch_range(send, node)
+          range_between(send.loc.selector.begin_pos, node.loc.end.end_pos)
+        end
+
+        def build_good_method(send, body)
+          key = send.children[2].source
+          default_value = body ? body.source : 'nil'
+
+          "fetch(#{key}, #{default_value})"
+        end
+
+        def build_bad_method(send, body)
+          key = send.children[2].source
+          block = body ? "{ #{body.source} }" : '{}'
+
+          "fetch(#{key}) #{block}"
+        end
+
+        def check_for_constant?
+          cop_config['SafeForConstants']
+        end
+
+        def check_for_string?
+          frozen_string_literals_enabled?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the presence of superfluous `.rb` extension in
+      # the filename provided to `require` and `require_relative`.
+      #
+      # Note: If the extension is omitted, Ruby tries adding '.rb', '.so',
+      #       and so on to the name until found. If the file named cannot be found,
+      #       a `LoadError` will be raised.
+      #       There is an edge case where `foo.so` file is loaded instead of a `LoadError`
+      #       if `foo.so` file exists when `require 'foo.rb'` will be changed to `require 'foo'`,
+      #       but that seems harmless.
+      #
+      # @example
+      #   # bad
+      #   require 'foo.rb'
+      #   require_relative '../foo.rb'
+      #
+      #   # good
+      #   require 'foo'
+      #   require 'foo.so'
+      #   require_relative '../foo'
+      #   require_relative '../foo.so'
+      #
+      class RedundantFileExtensionInRequire < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Redundant `.rb` file extension detected.'
+        RESTRICT_ON_SEND = %i[require require_relative].freeze
+
+        # @!method require_call?(node)
+        def_node_matcher :require_call?, <<~PATTERN
+          (send nil? {:require :require_relative} $str_type?)
+        PATTERN
+
+        def on_send(node)
+          require_call?(node) do |name_node|
+            return unless name_node.value.end_with?('.rb')
+
+            extension_range = extension_range(name_node)
+
+            add_offense(extension_range) do |corrector|
+              corrector.remove(extension_range)
+            end
+          end
+        end
+
+        private
+
+        def extension_range(name_node)
+          end_of_path_string = name_node.source_range.end_pos
+
+          range_between(end_of_path_string - 4, end_of_path_string - 1)
+        end
+      end
+    end
+  end
+end