rubocop 0.49.1 → 0.52.0

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

@@ -25,14 +25,17 @@ module RuboCop
       #     something
       #   end
       class RedundantBegin < Cop
-        include OnMethodDef
-
         MSG = 'Redundant `begin` block detected.'.freeze
 
-        def on_method_def(_node, _method_name, _args, body)
-          return unless body && body.kwbegin_type?
+        def on_def(node)
+          check(node)
+        end
+        alias on_defs on_def
 
-          add_offense(body, :begin)
+        def on_block(node)
+          return if target_ruby_version < 2.5
+          return if node.braces?
+          check(node)
         end
 
         def autocorrect(node)
@@ -41,6 +44,14 @@ module RuboCop
             corrector.remove(node.loc.end)
           end
         end
+
+        private
+
+        def check(node)
+          return unless node.body && node.body.kwbegin_type?
+
+          add_offense(node.body, location: :begin)
+        end
       end
     end
   end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for redundant returning of true/false in conditionals.
+      #
+      # @example
+      #   # bad
+      #   x == y ? true : false
+      #
+      #   # bad
+      #   if x == y
+      #     true
+      #   else
+      #     false
+      #   end
+      #
+      #   # good
+      #   x == y
+      #
+      #   # bad
+      #   x == y ? false : true
+      #
+      #   # good
+      #   x != y
+      class RedundantConditional < Cop
+        include AutocorrectAlignment
+
+        COMPARISON_OPERATORS = RuboCop::AST::Node::COMPARISON_OPERATORS
+
+        MSG = 'This conditional expression can just be replaced ' \
+              'by `%<msg>s`.'.freeze
+
+        def on_if(node)
+          return unless offense?(node)
+
+          add_offense(node)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node.loc.expression, replacement_condition(node))
+          end
+        end
+
+        private
+
+        def message(node)
+          replacement = replacement_condition(node)
+          msg = node.elsif? ? "\n#{replacement}" : replacement
+
+          format(MSG, msg: msg)
+        end
+
+        def_node_matcher :redundant_condition?, <<-RUBY
+          (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) true false)
+        RUBY
+
+        def_node_matcher :redundant_condition_inverted?, <<-RUBY
+          (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) false true)
+        RUBY
+
+        def offense?(node)
+          return if node.modifier_form?
+          redundant_condition?(node) || redundant_condition_inverted?(node)
+        end
+
+        def replacement_condition(node)
+          condition = node.condition.source
+          expression = invert_expression?(node) ? "!(#{condition})" : condition
+
+          node.elsif? ? indented_else_node(expression, node) : expression
+        end
+
+        def invert_expression?(node)
+          (
+            (node.if? || node.elsif? || node.ternary?) &&
+            redundant_condition_inverted?(node)
+          ) || (
+            node.unless? &&
+            redundant_condition?(node)
+          )
+        end
+
+        def indented_else_node(expression, node)
+          "else\n#{indentation(node)}#{expression}"
+        end
+
+        def configured_indentation_width
+          super || 2
+        end
+      end
+    end
+  end
+end

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

@@ -22,8 +22,8 @@ module RuboCop
                 'just the message.'.freeze
 
         def on_send(node)
-          exploded?(node) { return add_offense(node, :expression, MSG_1) }
-          compact?(node) { add_offense(node, :expression, MSG_2) }
+          exploded?(node) { return add_offense(node, message: MSG_1) }
+          compact?(node) { add_offense(node, message: MSG_2) }
         end
 
         # Switch `raise RuntimeError, 'message'` to `raise 'message'`, and
@@ -43,11 +43,11 @@ module RuboCop
         end
 
         def_node_matcher :exploded?, <<-PATTERN
-          (send nil ${:raise :fail} (const nil :RuntimeError) $_)
+          (send nil? ${:raise :fail} (const nil? :RuntimeError) $_)
         PATTERN
 
         def_node_matcher :compact?, <<-PATTERN
-          (send nil {:raise :fail} $(send (const nil :RuntimeError) :new $_))
+          (send nil? {:raise :fail} $(send (const nil? :RuntimeError) :new $_))
         PATTERN
       end
     end

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

@@ -21,7 +21,7 @@ module RuboCop
           return unless node.receiver && node.method?(:freeze) &&
                         immutable_literal?(node.receiver)
 
-          add_offense(node, :expression)
+          add_offense(node)
         end
 
         def autocorrect(node)

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

@@ -31,11 +31,17 @@ module RuboCop
           check(node)
         end
 
+        private
+
         def parens_allowed?(node)
           empty_parentheses?(node) ||
-            allowed_ancestor?(node) ||
             hash_literal_as_first_arg?(node) ||
             rescue?(node) ||
+            allowed_expression?(node)
+        end
+
+        def allowed_expression?(node)
+          allowed_ancestor?(node) ||
             allowed_method_call?(node) ||
             allowed_array_or_hash_element?(node) ||
             allowed_multiple_expression?(node)
@@ -52,7 +58,7 @@ module RuboCop
         end
 
         def allowed_multiple_expression?(node)
-          return false if node.children.size == 1
+          return false if node.children.one?
           ancestor = node.ancestors.first
           return false unless ancestor
           !ancestor.begin_type? && !ancestor.def_type? && !ancestor.block_type?
@@ -65,7 +71,7 @@ module RuboCop
 
         def hash_literal_as_first_arg?(node)
           # Don't flag `method ({key: value})`
-          node.children.first.hash_type? && first_arg?(node) &&
+          node.children.first.hash_type? && first_argument?(node) &&
             !parentheses?(node.parent)
         end
 
@@ -104,7 +110,7 @@ module RuboCop
         end
 
         def offense(node, msg)
-          add_offense(node, :expression, "Don't use parentheses around #{msg}.")
+          add_offense(node, message: "Don't use parentheses around #{msg}.")
         end
 
         def keyword_ancestor?(node)
@@ -177,16 +183,12 @@ module RuboCop
         end
 
         def only_begin_arg?(args)
-          args.size == 1 && args.first && args.first.begin_type?
+          args.one? && args.first.begin_type?
         end
 
-        def first_arg?(node)
-          send_node = node.parent
-          return false unless send_node && send_node.send_type?
-
-          _receiver, _method_name, *args = *send_node
-          node.equal?(args.first)
-        end
+        def_node_matcher :first_argument?, <<-PATTERN
+          ^(send _ _ equal?(%0) ...)
+        PATTERN
 
         def call_chain_starts_with_int?(begin_node, send_node)
           recv = first_part_of_call_chain(send_node)

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

@@ -21,13 +21,17 @@ module RuboCop
       # It should be extended to handle methods whose body is if/else
       # or a case expression with a default branch.
       class RedundantReturn < Cop
-        include OnMethodDef
-
         MSG = 'Redundant `return` detected.'.freeze
+        MULTI_RETURN_MSG = 'To return multiple values, use an array.'.freeze
 
-        private
+        def on_def(node)
+          return unless node.body
+
+          check_branch(node.body)
+        end
+        alias on_defs on_def
 
-        def autocorrect(node)
+        def autocorrect(node) # rubocop:disable Metrics/MethodLength
           lambda do |corrector|
             unless arguments?(node.children)
               corrector.replace(node.source_range, 'nil')
@@ -40,11 +44,14 @@ module RuboCop
             elsif return_value.hash_type?
               add_braces(corrector, return_value) unless return_value.braces?
             end
-            return_kw = range_with_surrounding_space(node.loc.keyword, :right)
+            return_kw = range_with_surrounding_space(range: node.loc.keyword,
+                                                     side: :right)
             corrector.remove(return_kw)
           end
         end
 
+        private
+
         def add_brackets(corrector, node)
           kids = node.children.map(&:source_range)
           corrector.insert_before(kids.first, '[')
@@ -64,18 +71,12 @@ module RuboCop
           !args.first.begin_type? || !args.first.children.empty?
         end
 
-        def on_method_def(_node, _method_name, _args, body)
-          return unless body
-
-          check_branch(body)
-        end
-
         def check_branch(node)
           case node.type
           when :return then check_return_node(node)
-          when :case then check_case_node(node)
-          when :if then check_if_node(node)
-          when :begin then check_begin_node(node)
+          when :case   then check_case_node(node)
+          when :if     then check_if_node(node)
+          when :begin  then check_begin_node(node)
           end
         end
 
@@ -83,7 +84,7 @@ module RuboCop
           return if cop_config['AllowMultipleReturnValues'] &&
                     node.children.size > 1
 
-          add_offense(node, :keyword)
+          add_offense(node, location: :keyword)
         end
 
         def check_case_node(node)
@@ -115,6 +116,18 @@ module RuboCop
 
           check_return_node(last_expr)
         end
+
+        def allow_multiple_return_values?
+          cop_config['AllowMultipleReturnValues'] || false
+        end
+
+        def message(node)
+          if !allow_multiple_return_values? && node.children.size > 1
+            "#{MSG} #{MULTI_RETURN_MSG}"
+          else
+            MSG
+          end
+        end
       end
     end
   end

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

@@ -5,46 +5,49 @@ module RuboCop
     module Style
       # This cop checks for redundant uses of `self`.
       #
-      # `self` is only needed when:
+      # The usage of `self` is only needed when:
       #
       # * Sending a message to same object with zero arguments in
       #   presence of a method name clash with an argument or a local
       #   variable.
       #
-      #   Note, with using explicit self you can only send messages
-      #   with public or protected scope, you cannot send private
-      #   messages this way.
+      # * Calling an attribute writer to prevent an local variable assignment.
       #
-      #   Example:
+      # Note, with using explicit self you can only send messages with public or
+      # protected scope, you cannot send private messages this way.
       #
-      #   def bar
-      #     :baz
+      # Note we allow uses of `self` with operators because it would be awkward
+      # otherwise.
+      #
+      # @example
+      #
+      #   # bad
+      #   def foo(bar)
+      #     self.baz
       #   end
       #
+      #   # good
       #   def foo(bar)
-      #     self.bar # resolves name clash with argument
+      #     self.bar  # Resolves name clash with the argument.
       #   end
       #
-      #   def foo2
+      #   def foo
       #     bar = 1
-      #     self.bar # resolves name clash with local variable
+      #     self.bar  # Resolves name clash with the local variable.
       #   end
       #
-      # * Calling an attribute writer to prevent an local variable assignment
-      #
-      #   attr_writer :bar
-      #
       #   def foo
-      #     self.bar= 1 # Make sure above attr writer is called
+      #     %w[x y z].select do |bar|
+      #       self.bar == bar  # Resolves name clash with argument of the block.
+      #     end
       #   end
-      #
-      # Special cases:
-      #
-      # We allow uses of `self` with operators because it would be awkward
-      # otherwise.
       class RedundantSelf < Cop
         MSG = 'Redundant `self` detected.'.freeze
 
+        def self.autocorrect_incompatible_with
+          [ColonMethodCall]
+        end
+
         def initialize(config = nil, options = nil)
           super
           @allowed_send_nodes = []
@@ -57,7 +60,6 @@ module RuboCop
           lhs, _rhs = *node
           allow_self(lhs)
         end
-
         alias on_and_asgn on_or_asgn
 
         def on_op_asgn(node)
@@ -70,7 +72,6 @@ module RuboCop
         def on_def(node)
           add_scope(node)
         end
-
         alias on_defs on_def
 
         def on_args(node)
@@ -90,10 +91,13 @@ module RuboCop
           return unless node.self_receiver? && regular_method_call?(node)
           return if node.parent && node.parent.mlhs_type?
 
-          return if @allowed_send_nodes.include?(node) ||
-                    @local_variables_scopes[node].include?(node.method_name)
+          return if allowed_send_node?(node)
 
-          add_offense(node, :expression)
+          add_offense(node)
+        end
+
+        def on_block(node)
+          add_scope(node, @local_variables_scopes[node])
         end
 
         def autocorrect(node)
@@ -105,13 +109,17 @@ module RuboCop
 
         private
 
-        def add_scope(node)
-          local_variables = []
+        def add_scope(node, local_variables = [])
           node.descendants.each do |child_node|
             @local_variables_scopes[child_node] = local_variables
           end
         end
 
+        def allowed_send_node?(node)
+          @allowed_send_nodes.include?(node) ||
+            @local_variables_scopes[node].include?(node.method_name)
+        end
+
         def regular_method_call?(node)
           !(operator?(node.method_name) ||
             keyword?(node.method_name) ||

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

@@ -5,28 +5,81 @@ module RuboCop
     module Style
       # This cop enforces using // or %r around regular expressions.
       #
-      # @example
-      #   # Good if EnforcedStyle is slashes or mixed, bad if percent_r.
+      # @example EnforcedStyle: slashes (default)
+      #   # bad
+      #   snake_case = %r{^[\dA-Z_]+$}
+      #
+      #   # bad
+      #   regex = %r{
+      #     foo
+      #     (bar)
+      #     (baz)
+      #   }x
+      #
+      #   # good
+      #   snake_case = /^[\dA-Z_]+$/
+      #
+      #   # good
+      #   regex = /
+      #     foo
+      #     (bar)
+      #     (baz)
+      #   /x
+      #
+      # @example EnforcedStyle: percent_r
+      #   # bad
       #   snake_case = /^[\dA-Z_]+$/
       #
-      #   # Good if EnforcedStyle is percent_r, bad if slashes or mixed.
+      #   # bad
+      #   regex = /
+      #     foo
+      #     (bar)
+      #     (baz)
+      #   /x
+      #
+      #   # good
       #   snake_case = %r{^[\dA-Z_]+$}
       #
-      #   # Good if EnforcedStyle is slashes, bad if percent_r or mixed.
+      #   # good
+      #   regex = %r{
+      #     foo
+      #     (bar)
+      #     (baz)
+      #   }x
+      #
+      # @example EnforcedStyle: mixed
+      #   # bad
+      #   snake_case = %r{^[\dA-Z_]+$}
+      #
+      #   # bad
       #   regex = /
       #     foo
       #     (bar)
       #     (baz)
       #   /x
       #
-      #   # Good if EnforcedStyle is percent_r or mixed, bad if slashes.
+      #   # good
+      #   snake_case = /^[\dA-Z_]+$/
+      #
+      #   # good
       #   regex = %r{
       #     foo
       #     (bar)
       #     (baz)
       #   }x
       #
-      #   # Bad unless AllowInnerSlashes is true.
+      # @example AllowInnerSlashes: false (default)
+      #   # If `false`, the cop will always recommend using `%r` if one or more
+      #   # slashes are found in the regexp string.
+      #
+      #   # bad
+      #   x =~ /home\//
+      #
+      #   # good
+      #   x =~ %r{home/}
+      #
+      # @example AllowInnerSlashes: true
+      #   # good
       #   x =~ /home\//
       class RegexpLiteral < Cop
         include ConfigurableEnforcedStyle
@@ -42,31 +95,54 @@ module RuboCop
           end
         end
 
+        def autocorrect(node)
+          return if contains_slash?(node)
+
+          replacement = if slash_literal?(node)
+                          ['%r', ''].zip(preferred_delimiters).map(&:join)
+                        else
+                          %w[/ /]
+                        end
+
+          lambda do |corrector|
+            corrector.replace(node.loc.begin, replacement.first)
+            corrector.replace(node.loc.end, replacement.last)
+          end
+        end
+
         private
 
         def check_slash_literal(node)
           return if allowed_slash_literal?(node)
 
-          add_offense(node, :expression, MSG_USE_PERCENT_R)
+          add_offense(node, message: MSG_USE_PERCENT_R)
         end
 
         def check_percent_r_literal(node)
           return if allowed_percent_r_literal?(node)
 
-          add_offense(node, :expression, MSG_USE_SLASHES)
+          add_offense(node, message: MSG_USE_SLASHES)
         end
 
         def allowed_slash_literal?(node)
           style == :slashes && !contains_disallowed_slash?(node) ||
-            style == :mixed && node.single_line? &&
-              !contains_disallowed_slash?(node)
+            allowed_mixed_slash?(node)
+        end
+
+        def allowed_mixed_slash?(node)
+          style == :mixed && node.single_line? &&
+            !contains_disallowed_slash?(node)
         end
 
         def allowed_percent_r_literal?(node)
           style == :slashes && contains_disallowed_slash?(node) ||
             style == :percent_r ||
-            style == :mixed && node.multiline? ||
-            style == :mixed && contains_disallowed_slash?(node)
+            allowed_mixed_percent_r?(node)
+        end
+
+        def allowed_mixed_percent_r?(node)
+          style == :mixed && node.multiline? ||
+            contains_disallowed_slash?(node)
         end
 
         def contains_disallowed_slash?(node)
@@ -93,21 +169,6 @@ module RuboCop
           config.for_cop('Style/PercentLiteralDelimiters') \
             ['PreferredDelimiters']['%r'].split(//)
         end
-
-        def autocorrect(node)
-          return if contains_slash?(node)
-
-          replacement = if slash_literal?(node)
-                          ['%r', ''].zip(preferred_delimiters).map(&:join)
-                        else
-                          %w[/ /]
-                        end
-
-          lambda do |corrector|
-            corrector.replace(node.loc.begin, replacement.first)
-            corrector.replace(node.loc.end, replacement.last)
-          end
-        end
       end
     end
   end