rubocop 0.78.0

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks the args passed to `fail` and `raise`. For exploded
+      # style (default), it recommends passing the exception class and message
+      # to `raise`, rather than construct an instance of the error. It will
+      # still allow passing just a message, or the construction of an error
+      # with more than one argument.
+      #
+      # The exploded style works identically, but with the addition that it
+      # will also suggest constructing error objects when the exception is
+      # passed multiple arguments.
+      #
+      # @example EnforcedStyle: exploded (default)
+      #   # bad
+      #   raise StandardError.new("message")
+      #
+      #   # good
+      #   raise StandardError, "message"
+      #   fail "message"
+      #   raise MyCustomError.new(arg1, arg2, arg3)
+      #   raise MyKwArgError.new(key1: val1, key2: val2)
+      #
+      # @example EnforcedStyle: compact
+      #   # bad
+      #   raise StandardError, "message"
+      #   raise RuntimeError, arg1, arg2, arg3
+      #
+      #   # good
+      #   raise StandardError.new("message")
+      #   raise MyCustomError.new(arg1, arg2, arg3)
+      #   fail "message"
+      class RaiseArgs < Cop
+        include ConfigurableEnforcedStyle
+
+        EXPLODED_MSG = 'Provide an exception class and message ' \
+          'as arguments to `%<method>s`.'
+        COMPACT_MSG = 'Provide an exception object ' \
+          'as an argument to `%<method>s`.'
+
+        def on_send(node)
+          return unless node.command?(:raise) || node.command?(:fail)
+
+          case style
+          when :compact
+            check_compact(node)
+          when :exploded
+            check_exploded(node)
+          end
+        end
+
+        def autocorrect(node)
+          replacement = if style == :compact
+                          correction_exploded_to_compact(node)
+                        else
+                          correction_compact_to_exploded(node)
+                        end
+
+          ->(corrector) { corrector.replace(node.source_range, replacement) }
+        end
+
+        private
+
+        def correction_compact_to_exploded(node)
+          exception_node, _new, message_node = *node.first_argument
+
+          arguments =
+            [exception_node, message_node].compact.map(&:source).join(', ')
+
+          if node.parent && requires_parens?(node.parent)
+            "#{node.method_name}(#{arguments})"
+          else
+            "#{node.method_name} #{arguments}"
+          end
+        end
+
+        def correction_exploded_to_compact(node)
+          exception_node, *message_nodes = *node.arguments
+          return node.source if message_nodes.size > 1
+
+          argument = message_nodes.first.source
+
+          if node.parent && requires_parens?(node.parent)
+            "#{node.method_name}(#{exception_node.const_name}.new(#{argument}))"
+          else
+            "#{node.method_name} #{exception_node.const_name}.new(#{argument})"
+          end
+        end
+
+        def check_compact(node)
+          if node.arguments.size > 1
+            add_offense(node) do
+              opposite_style_detected
+            end
+          else
+            correct_style_detected
+          end
+        end
+
+        def check_exploded(node)
+          return correct_style_detected unless node.arguments.one?
+
+          first_arg = node.first_argument
+
+          return unless first_arg.send_type? && first_arg.method?(:new)
+
+          return if acceptable_exploded_args?(first_arg.arguments)
+
+          add_offense(node) do
+            opposite_style_detected
+          end
+        end
+
+        def acceptable_exploded_args?(args)
+          # Allow code like `raise Ex.new(arg1, arg2)`.
+          return true if args.size > 1
+
+          # Disallow zero arguments.
+          return false if args.empty?
+
+          arg = args.first
+
+          # Allow code like `raise Ex.new(kw: arg)`.
+          # Allow code like `raise Ex.new(*args)`.
+          arg.hash_type? || arg.splat_type?
+        end
+
+        def requires_parens?(parent)
+          parent.and_type? || parent.or_type? ||
+            parent.if_type? && parent.ternary?
+        end
+
+        def message(node)
+          if style == :compact
+            format(COMPACT_MSG, method: node.method_name)
+          else
+            format(EXPLODED_MSG, method: node.method_name)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+# 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? :Random) (const nil? :Kernel)}
+              :rand
+              {int irange erange}))
+        PATTERN
+
+        def_node_matcher :rand_op_integer?, <<~PATTERN
+          (send
+            (send
+              {nil? (const nil? :Random) (const nil? :Kernel)}
+              :rand
+              {int irange erange})
+            {:+ :-}
+            int)
+        PATTERN
+
+        def_node_matcher :rand_modified?, <<~PATTERN
+          (send
+            (send
+              {nil? (const nil? :Random) (const nil? :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.source_range,
+                                corrected_integer_op_rand(node))
+            elsif rand_op_integer?(node)
+              corrector.replace(node.source_range,
+                                corrected_rand_op_integer(node))
+            elsif rand_modified?(node)
+              corrector.replace(node.source_range,
+                                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_node_matcher :namespace, <<~PATTERN
+          {$nil? (const nil? $_)}
+        PATTERN
+
+        def prefix_from_prefix_node(node)
+          namespace(node) do |namespace|
+            [namespace, 'rand'].compact.join('.')
+          end
+        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_begin.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for redundant `begin` blocks.
+      #
+      # Currently it checks for code like this:
+      #
+      # @example
+      #
+      #   # bad
+      #   def redundant
+      #     begin
+      #       ala
+      #       bala
+      #     rescue StandardError => e
+      #       something
+      #     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.'
+
+        def on_def(node)
+          check(node)
+        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?
+
+          check(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.remove(node.loc.begin)
+            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
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for usage of the %W() syntax when %w() would do.
+      #
+      # @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`.'
+
+        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)
+        end
+
+        def requires_interpolation?(node)
+          node.child_nodes.any? do |string|
+            string.dstr_type? ||
+              double_quotes_required?(string.source)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,112 @@
+# 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?
+              corrector.replace(range_of_offense(node), '||')
+            elsif node.modifier_form? || !node.else_branch
+              corrector.replace(node.source_range, node.if_branch.source)
+            else
+              corrected = make_ternary_form(node)
+
+              corrector.replace(node.source_range, 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)
+          wrap_else =
+            else_branch.basic_conditional? && else_branch.modifier_form?
+          wrap_else ? "(#{else_branch.source})" : else_branch.source
+        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
+      end
+    end
+  end
+end