rubocop 0.51.0 → 0.87.0

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for the use of randomly generated numbers,
+      # added/subtracted with integer literals, as well as those with
+      # Integer#succ and Integer#pred methods. Prefer using ranges instead,
+      # as it clearly states the intentions.
+      #
+      # @example
+      #   # bad
+      #   rand(6) + 1
+      #   1 + rand(6)
+      #   rand(6) - 1
+      #   1 - rand(6)
+      #   rand(6).succ
+      #   rand(6).pred
+      #   Random.rand(6) + 1
+      #   Kernel.rand(6) + 1
+      #   rand(0..5) + 1
+      #
+      #   # good
+      #   rand(1..6)
+      #   rand(1...7)
+      class RandomWithOffset < Cop
+        MSG = 'Prefer ranges when generating random numbers instead of ' \
+          'integers with offsets.'
+
+        def_node_matcher :integer_op_rand?, <<~PATTERN
+          (send
+            int {:+ :-}
+            (send
+              {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
+              :rand
+              {int irange erange}))
+        PATTERN
+
+        def_node_matcher :rand_op_integer?, <<~PATTERN
+          (send
+            (send
+              {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
+              :rand
+              {int irange erange})
+            {:+ :-}
+            int)
+        PATTERN
+
+        def_node_matcher :rand_modified?, <<~PATTERN
+          (send
+            (send
+              {nil? (const {nil? cbase} :Random) (const {nil? cbase} :Kernel)}
+              :rand
+              {int irange erange})
+            {:succ :pred :next})
+        PATTERN
+
+        def on_send(node)
+          return unless integer_op_rand?(node) ||
+                        rand_op_integer?(node) ||
+                        rand_modified?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if integer_op_rand?(node)
+              corrector.replace(node,
+                                corrected_integer_op_rand(node))
+            elsif rand_op_integer?(node)
+              corrector.replace(node,
+                                corrected_rand_op_integer(node))
+            elsif rand_modified?(node)
+              corrector.replace(node,
+                                corrected_rand_modified(node))
+            end
+          end
+        end
+
+        private
+
+        def_node_matcher :random_call, <<~PATTERN
+          {(send (send $_ _ $_) ...)
+           (send _ _ (send $_ _ $_))}
+        PATTERN
+
+        def corrected_integer_op_rand(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            offset = to_int(node.receiver)
+
+            if node.method?(:+)
+              "#{prefix}(#{offset + left_int}..#{offset + right_int})"
+            else
+              "#{prefix}(#{offset - right_int}..#{offset - left_int})"
+            end
+          end
+        end
+
+        def corrected_rand_op_integer(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            offset = to_int(node.first_argument)
+
+            if node.method?(:+)
+              "#{prefix}(#{left_int + offset}..#{right_int + offset})"
+            else
+              "#{prefix}(#{left_int - offset}..#{right_int - offset})"
+            end
+          end
+        end
+
+        def corrected_rand_modified(node)
+          random_call(node) do |prefix_node, random_node|
+            prefix = prefix_from_prefix_node(prefix_node)
+            left_int, right_int = boundaries_from_random_node(random_node)
+
+            if %i[succ next].include?(node.method_name)
+              "#{prefix}(#{left_int + 1}..#{right_int + 1})"
+            elsif node.method?(:pred)
+              "#{prefix}(#{left_int - 1}..#{right_int - 1})"
+            end
+          end
+        end
+
+        def prefix_from_prefix_node(node)
+          [node&.source, 'rand'].compact.join('.')
+        end
+
+        def boundaries_from_random_node(random_node)
+          case random_node.type
+          when :int
+            [0, to_int(random_node) - 1]
+          when :irange
+            [to_int(random_node.begin), to_int(random_node.end)]
+          when :erange
+            [to_int(random_node.begin), to_int(random_node.end) - 1]
+          end
+        end
+
+        def_node_matcher :to_int, <<~PATTERN
+          (int $_)
+        PATTERN
+      end
+    end
+  end
+end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for redundant assignment before returning.
+      #
+      # @example
+      #   # bad
+      #   def test
+      #     x = foo
+      #     x
+      #   end
+      #
+      #   # bad
+      #   def test
+      #     if x
+      #       z = foo
+      #       z
+      #     elsif y
+      #       z = bar
+      #       z
+      #     end
+      #   end
+      #
+      #   # good
+      #   def test
+      #     foo
+      #   end
+      #
+      #   # good
+      #   def test
+      #     if x
+      #       foo
+      #     elsif y
+      #       bar
+      #     end
+      #   end
+      #
+      class RedundantAssignment < Cop
+        MSG = 'Redundant assignment before returning detected.'
+
+        def_node_matcher :redundant_assignment?, <<~PATTERN
+          (... $(lvasgn _name _expression) (lvar _name))
+        PATTERN
+
+        def on_def(node)
+          check_branch(node.body)
+        end
+        alias on_defs on_def
+
+        def autocorrect(node)
+          lambda do |corrector|
+            expression = node.children[1]
+            corrector.replace(node, expression.source)
+            corrector.remove(right_sibling_of(node))
+          end
+        end
+
+        private
+
+        def check_branch(node)
+          return unless node
+
+          case node.type
+          when :case   then check_case_node(node)
+          when :if     then check_if_node(node)
+          when :rescue, :resbody
+            check_rescue_node(node)
+          when :ensure then check_ensure_node(node)
+          when :begin, :kwbegin
+            check_begin_node(node)
+          end
+        end
+
+        def check_case_node(node)
+          node.when_branches.each { |when_node| check_branch(when_node.body) }
+          check_branch(node.else_branch)
+        end
+
+        def check_if_node(node)
+          return if node.modifier_form? || node.ternary?
+
+          check_branch(node.if_branch)
+          check_branch(node.else_branch)
+        end
+
+        def check_rescue_node(node)
+          node.child_nodes.each do |child_node|
+            check_branch(child_node)
+          end
+        end
+
+        def check_ensure_node(node)
+          check_branch(node.body)
+        end
+
+        def check_begin_node(node)
+          if (assignment = redundant_assignment?(node))
+            add_offense(assignment)
+          else
+            last_expr = node.children.last
+            check_branch(last_expr)
+          end
+        end
+
+        def right_sibling_of(node)
+          siblings_of(node)[node.sibling_index + 1]
+        end
+
+        def siblings_of(node)
+          node.parent.children
+        end
+      end
+    end
+  end
+end

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

@@ -9,6 +9,7 @@ module RuboCop
       #
       # @example
       #
+      #   # bad
       #   def redundant
       #     begin
       #       ala
@@ -18,23 +19,57 @@ module RuboCop
       #     end
       #   end
       #
+      #   # good
       #   def preferred
       #     ala
       #     bala
       #   rescue StandardError => e
       #     something
       #   end
+      #
+      #   # bad
+      #   # When using Ruby 2.5 or later.
+      #   do_something do
+      #     begin
+      #       something
+      #     rescue => ex
+      #       anything
+      #     end
+      #   end
+      #
+      #   # good
+      #   # In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
+      #   do_something do
+      #     something
+      #   rescue => ex
+      #     anything
+      #   end
+      #
+      #   # good
+      #   # Stabby lambdas don't support implicit `begin` in `do-end` blocks.
+      #   -> do
+      #     begin
+      #       foo
+      #     rescue Bar
+      #       baz
+      #     end
+      #   end
       class RedundantBegin < Cop
-        MSG = 'Redundant `begin` block detected.'.freeze
+        MSG = 'Redundant `begin` block detected.'
 
         def on_def(node)
-          return unless node.body && node.body.kwbegin_type?
-
-          add_offense(node.body, location: :begin)
+          check(node)
         end
         alias on_defs on_def
 
-        private
+        def on_block(node)
+          return if target_ruby_version < 2.5
+
+          return if node.send_node.lambda_literal?
+          return if node.braces?
+
+          check(node)
+        end
 
         def autocorrect(node)
           lambda do |corrector|
@@ -42,6 +77,14 @@ module RuboCop
             corrector.remove(node.loc.end)
           end
         end
+
+        private
+
+        def check(node)
+          return unless node.body&.kwbegin_type?
+
+          add_offense(node.body, location: :begin)
+        end
       end
     end
   end

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

@@ -4,16 +4,33 @@ module RuboCop
   module Cop
     module Style
       # This cop checks for usage of the %W() syntax when %w() would do.
-      class UnneededCapitalW < Cop
+      #
+      # @example
+      #   # bad
+      #   %W(cat dog pig)
+      #   %W[door wall floor]
+      #
+      #   # good
+      #   %w/swim run bike/
+      #   %w[shirt pants shoes]
+      #   %W(apple #{fruit} grape)
+      class RedundantCapitalW < Cop
         include PercentLiteral
 
         MSG = 'Do not use `%W` unless interpolation is needed. ' \
-              'If not, use `%w`.'.freeze
+              '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)
@@ -28,13 +45,6 @@ module RuboCop
               double_quotes_required?(string.source)
           end
         end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            src = node.loc.begin.source
-            corrector.replace(node.loc.begin, src.tr('W', 'w'))
-          end
-        end
       end
     end
   end

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

@@ -0,0 +1,124 @@
+# 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 < Cop
+        include RangeHelp
+
+        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)
+
+          add_offense(node, location: range_of_offense(node))
+        end
+
+        def autocorrect(node)
+          lambda 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 :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)
+
+          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 else_source(else_branch)
+          if else_branch.basic_conditional? &&
+             else_branch.modifier_form? ||
+             else_branch.range_type?
+            "(#{else_branch.source})"
+          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
+      end
+    end
+  end
+end

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

@@ -25,11 +25,13 @@ module RuboCop
       #   # good
       #   x != y
       class RedundantConditional < Cop
-        include AutocorrectAlignment
+        include Alignment
 
-        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 `%s`.'.freeze
+        MSG = 'This conditional expression can just be replaced ' \
+              'by `%<msg>s`.'
 
         def on_if(node)
           return unless offense?(node)
@@ -37,32 +39,33 @@ module RuboCop
           add_offense(node)
         end
 
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, replacement_condition(node))
+          end
+        end
+
         private
 
         def message(node)
           replacement = replacement_condition(node)
           msg = node.elsif? ? "\n#{replacement}" : replacement
 
-          format(MSG, msg)
+          format(MSG, msg: msg)
         end
 
-        def_node_matcher :redundant_condition?, <<-RUBY
-          (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) true false)
+        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)
+        def_node_matcher :redundant_condition_inverted?, <<~RUBY
+          (if (send _ #{COMPARISON_OPERATOR_MATCHER} _) false true)
         RUBY
 
         def offense?(node)
           return if node.modifier_form?
-          redundant_condition?(node) || redundant_condition_inverted?(node)
-        end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, replacement_condition(node))
-          end
+          redundant_condition?(node) || redundant_condition_inverted?(node)
         end
 
         def replacement_condition(node)

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

@@ -16,38 +16,47 @@ module RuboCop
       #
       #   # Good
       #   raise 'message'
-      class RedundantException < Cop
-        MSG_1 = 'Redundant `RuntimeError` argument can be removed.'.freeze
+      class RedundantException < Base
+        extend AutoCorrector
+
+        MSG_1 = 'Redundant `RuntimeError` argument can be removed.'
         MSG_2 = 'Redundant `RuntimeError.new` call can be replaced with ' \
-                'just the message.'.freeze
+                'just the message.'
 
+        # Switch `raise RuntimeError, 'message'` to `raise 'message'`, and
+        # `raise RuntimeError.new('message')` to `raise 'message'`.
         def on_send(node)
-          exploded?(node) { return add_offense(node, message: MSG_1) }
-          compact?(node) { add_offense(node, message: MSG_2) }
+          fix_exploded(node) || fix_compact(node)
         end
 
-        # Switch `raise RuntimeError, 'message'` to `raise 'message'`, and
-        # `raise RuntimeError.new('message')` to `raise 'message'`.
-        def autocorrect(node)
+        def fix_exploded(node)
           exploded?(node) do |command, message|
-            return lambda do |corrector|
-              corrector.replace(node.source_range,
-                                "#{command} #{message.source}")
+            add_offense(node, message: MSG_1) do |corrector|
+              if node.parenthesized?
+                corrector.replace(node,
+                                  "#{command}(#{message.source})")
+              else
+                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) $_)
+        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 $_))
+        def_node_matcher :compact?, <<~PATTERN
+          (send nil? {:raise :fail} $(send (const {nil? cbase} :RuntimeError) :new $_))
         PATTERN
       end
     end