rubocop 0.86.0 → 0.89.1

data/lib/rubocop/cop/lint/deprecated_open_ssl_constant.rb

@@ -15,7 +15,7 @@ module RuboCop
       #   OpenSSL::Cipher::AES.new(128, :GCM)
       #
       #   # good
-      #   OpenSSL::Cipher.new('AES-128-GCM')
+      #   OpenSSL::Cipher.new('aes-128-gcm')
       #
       # @example
       #
@@ -37,8 +37,9 @@ module RuboCop
       #   # good
       #   OpenSSL::Digest.digest('SHA256', 'foo')
       #
-      class DeprecatedOpenSSLConstant < Cop
+      class DeprecatedOpenSSLConstant < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `%<constant>s.%<method>s(%<replacement_args>s)`' \
           ' instead of `%<original>s`.'
@@ -54,26 +55,29 @@ module RuboCop
 
         def on_send(node)
           return if node.arguments.any? { |arg| arg.variable? || arg.send_type? || arg.const_type? }
+          return unless algorithm_const(node)
 
-          add_offense(node) if algorithm_const(node)
+          message = message(node)
+
+          add_offense(node, message: message) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
 
-        def autocorrect(node)
+        private
+
+        def autocorrect(corrector, node)
           algorithm_constant, = algorithm_const(node)
 
-          lambda do |corrector|
-            corrector.remove(algorithm_constant.loc.double_colon)
-            corrector.remove(algorithm_constant.loc.name)
+          corrector.remove(algorithm_constant.loc.double_colon)
+          corrector.remove(algorithm_constant.loc.name)
 
-            corrector.replace(
-              correction_range(node),
-              "#{node.loc.selector.source}(#{replacement_args(node)})"
-            )
-          end
+          corrector.replace(
+            correction_range(node),
+            "#{node.loc.selector.source}(#{replacement_args(node)})"
+          )
         end
 
-        private
-
         def message(node)
           algorithm_constant, = algorithm_const(node)
           parent_constant = openssl_class(algorithm_constant)
@@ -127,9 +131,9 @@ module RuboCop
         end
 
         def build_cipher_arguments(node, algorithm_name)
-          algorithm_parts = algorithm_name.split('-')
-          size_and_mode = sanitize_arguments(node.arguments)
-          "'#{(algorithm_parts + size_and_mode + ['CBC']).take(3).join('-')}'"
+          algorithm_parts = algorithm_name.downcase.split('-')
+          size_and_mode = sanitize_arguments(node.arguments).map(&:downcase)
+          "'#{(algorithm_parts + size_and_mode + ['cbc']).take(3).join('-')}'"
         end
       end
     end

data/lib/rubocop/cop/lint/disjunctive_assignment_in_constructor.rb

@@ -22,7 +22,9 @@ module RuboCop
       #   def initialize
       #     @x = 1
       #   end
-      class DisjunctiveAssignmentInConstructor < Cop
+      class DisjunctiveAssignmentInConstructor < Base
+        extend AutoCorrector
+
         MSG = 'Unnecessary disjunctive assignment. Use plain assignment.'
 
         def on_def(node)
@@ -73,7 +75,11 @@ module RuboCop
         # @param [Node] node a disjunctive assignment
         def check_disjunctive_assignment(node)
           lhs = node.child_nodes.first
-          add_offense(node, location: :operator) if lhs.ivasgn_type?
+          return unless lhs.ivasgn_type?
+
+          add_offense(node.loc.operator) do |corrector|
+            corrector.replace(node.loc.operator, '=')
+          end
         end
       end
     end

data/lib/rubocop/cop/lint/duplicate_case_condition.rb

@@ -27,7 +27,7 @@ module RuboCop
       #   when 'second'
       #     do_something_else
       #   end
-      class DuplicateCaseCondition < Cop
+      class DuplicateCaseCondition < Base
         MSG = 'Duplicate `when` condition detected.'
 
         def on_case(case_node)

data/lib/rubocop/cop/lint/duplicate_elsif_condition.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks that there are no repeated conditions used in if 'elsif'.
+      #
+      # @example
+      #   # bad
+      #   if x == 1
+      #     do_something
+      #   elsif x == 1
+      #     do_something_else
+      #   end
+      #
+      #   # good
+      #   if x == 1
+      #     do_something
+      #   elsif x == 2
+      #     do_something_else
+      #   end
+      #
+      class DuplicateElsifCondition < Base
+        MSG = 'Duplicate `elsif` condition detected.'
+
+        def on_if(node)
+          previous = []
+          while node.if? || node.elsif?
+            condition = node.condition
+            add_offense(condition) if previous.include?(condition)
+            previous << condition
+            node = node.else_branch
+            break unless node&.if_type?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/duplicate_hash_key.rb

@@ -18,7 +18,7 @@ module RuboCop
       #   # good
       #
       #   hash = { food: 'apple', other_food: 'orange' }
-      class DuplicateHashKey < Cop
+      class DuplicateHashKey < Base
         include Duplication
 
         MSG = 'Duplicated key in hash literal.'

data/lib/rubocop/cop/lint/duplicate_methods.rb

@@ -49,10 +49,13 @@ module RuboCop
       #   end
       #
       #   alias bar foo
-      class DuplicateMethods < Cop
+      class DuplicateMethods < Base
         MSG = 'Method `%<method>s` is defined at both %<defined>s and ' \
               '%<current>s.'
 
+        METHOD_DEF_METHODS = %i[alias_method attr_reader attr_writer
+                                attr_accessor attr].to_set.freeze
+
         def initialize(config = nil, options = nil)
           super
           @definitions = {}
@@ -96,10 +99,10 @@ module RuboCop
         PATTERN
 
         def_node_matcher :sym_name, '(sym $_name)'
-
         def on_send(node)
+          return unless METHOD_DEF_METHODS.include?(node.method_name)
+
           if (name = alias_method?(node))
-            return unless name
             return if node.ancestors.any?(&:if_type?)
             return if possible_dsl?(node)
 
@@ -126,7 +129,7 @@ module RuboCop
         end
 
         def message_for_dup(node, method_name)
-          format(MSG, method: method_name, defined: @definitions[method_name],
+          format(MSG, method: method_name, defined: source_location(@definitions[method_name]),
                       current: source_location(node))
         end
 
@@ -150,9 +153,9 @@ module RuboCop
                   end
             message = message_for_dup(node, method_name)
 
-            add_offense(node, location: loc, message: message)
+            add_offense(loc, message: message)
           else
-            @definitions[method_name] = source_location(node)
+            @definitions[method_name] = node
           end
         end
 

data/lib/rubocop/cop/lint/duplicate_rescue_exception.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks that there are no repeated exceptions
+      # used in 'rescue' expressions.
+      #
+      # @example
+      #   # bad
+      #   begin
+      #     something
+      #   rescue FirstException
+      #     handle_exception
+      #   rescue FirstException
+      #     handle_other_exception
+      #   end
+      #
+      #   # good
+      #   begin
+      #     something
+      #   rescue FirstException
+      #     handle_exception
+      #   rescue SecondException
+      #     handle_other_exception
+      #   end
+      #
+      class DuplicateRescueException < Base
+        include RescueNode
+
+        MSG = 'Duplicate `rescue` exception detected.'
+
+        def on_rescue(node)
+          return if rescue_modifier?(node)
+
+          _body, *resbodies, _else = *node
+
+          resbodies.each_with_object(Set.new) do |resbody, previous|
+            rescued_exceptions = rescued_exceptions(resbody)
+
+            rescued_exceptions.each do |exception|
+              add_offense(exception) unless previous.add?(exception)
+            end
+          end
+        end
+
+        private
+
+        def rescued_exceptions(resbody)
+          rescue_group, = *resbody
+          if rescue_group
+            rescue_group.values
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/each_with_object_argument.rb

@@ -21,7 +21,7 @@ module RuboCop
       #
       #   num = 0
       #   sum = numbers.each_with_object(num) { |e, a| a += e }
-      class EachWithObjectArgument < Cop
+      class EachWithObjectArgument < Base
         MSG = 'The argument to each_with_object cannot be immutable.'
 
         def_node_matcher :each_with_object?, <<~PATTERN

data/lib/rubocop/cop/lint/else_layout.rb

@@ -27,7 +27,7 @@ module RuboCop
       #     do_this
       #     do_that
       #   end
-      class ElseLayout < Cop
+      class ElseLayout < Base
         MSG = 'Odd `else` layout detected. Did you mean to use `elsif`?'
 
         def on_if(node)

data/lib/rubocop/cop/lint/empty_conditional_body.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks for the presence of `if`, `elsif` and `unless` branches without a body.
+      # @example
+      #   # bad
+      #   if condition
+      #   end
+      #
+      #   # bad
+      #   unless condition
+      #   end
+      #
+      #   # bad
+      #   if condition
+      #     do_something
+      #   elsif other_condition
+      #   end
+      #
+      #   # good
+      #   if condition
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   unless condition
+      #     do_something
+      #   end
+      #
+      #   # good
+      #   if condition
+      #     do_something
+      #   elsif other_condition
+      #     do_something_else
+      #   end
+      #
+      # @example AllowComments: true (default)
+      #   # good
+      #   if condition
+      #     do_something
+      #   elsif other_condition
+      #     # noop
+      #   end
+      #
+      # @example AllowComments: false
+      #   # bad
+      #   if condition
+      #     do_something
+      #   elsif other_condition
+      #     # noop
+      #   end
+      #
+      class EmptyConditionalBody < Base
+        MSG = 'Avoid `%<keyword>s` branches without a body.'
+
+        def on_if(node)
+          return if node.body
+          return if cop_config['AllowComments'] && comment_lines?(node)
+
+          add_offense(node, message: format(MSG, keyword: node.keyword))
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/empty_ensure.rb

@@ -42,15 +42,15 @@ module RuboCop
       #   ensure
       #     do_something_else
       #   end
-      class EmptyEnsure < Cop
+      class EmptyEnsure < Base
+        extend AutoCorrector
+
         MSG = 'Empty `ensure` block detected.'
 
         def on_ensure(node)
-          add_offense(node, location: :keyword) unless node.body
-        end
+          return if node.body
 
-        def autocorrect(node)
-          lambda do |corrector|
+          add_offense(node.loc.keyword) do |corrector|
             corrector.remove(node.loc.keyword)
           end
         end

data/lib/rubocop/cop/lint/empty_expression.rb

@@ -22,13 +22,13 @@ module RuboCop
       #   if (some_expression)
       #     bar
       #   end
-      class EmptyExpression < Cop
+      class EmptyExpression < Base
         MSG = 'Avoid empty expressions.'
 
         def on_begin(node)
           return unless empty_expression?(node)
 
-          add_offense(node, location: node.source_range)
+          add_offense(node)
         end
 
         private

data/lib/rubocop/cop/lint/empty_interpolation.rb

@@ -16,18 +16,17 @@ module RuboCop
       #   # good
       #
       #   "result is #{some_result}"
-      class EmptyInterpolation < Cop
+      class EmptyInterpolation < Base
         include Interpolation
+        extend AutoCorrector
 
         MSG = 'Empty interpolation detected.'
 
         def on_interpolation(begin_node)
-          add_offense(begin_node) if begin_node.children.empty?
-        end
+          return unless begin_node.children.empty?
 
-        def autocorrect(node)
-          lambda do |collector|
-            collector.remove(node.loc.expression)
+          add_offense(begin_node) do |corrector|
+            corrector.remove(begin_node.loc.expression)
           end
         end
       end

data/lib/rubocop/cop/lint/empty_when.rb

@@ -44,7 +44,7 @@ module RuboCop
       #     # do nothing
       #   end
       #
-      class EmptyWhen < Cop
+      class EmptyWhen < Base
         MSG = 'Avoid `when` branches without a body.'
 
         def on_case(node)
@@ -52,7 +52,7 @@ module RuboCop
             next if when_node.body
             next if cop_config['AllowComments'] && comment_lines?(node)
 
-            add_offense(when_node, location: when_node.source_range)
+            add_offense(when_node)
           end
         end
       end

data/lib/rubocop/cop/lint/ensure_return.rb

@@ -4,57 +4,55 @@ module RuboCop
   module Cop
     module Lint
       # This cop checks for `return` from an `ensure` block.
-      # Explicit return from an ensure block alters the control flow
-      # as the return will take precedence over any exception being raised,
+      # `return` from an ensure block is a dangerous code smell as it
+      # will take precedence over any exception being raised,
       # and the exception will be silently thrown away as if it were rescued.
       #
+      # If you want to rescue some (or all) exceptions, best to do it explicitly
+      #
       # @example
       #
       #   # bad
       #
-      #   begin
+      #   def foo
       #     do_something
       #   ensure
-      #     do_something_else
-      #     return
+      #     cleanup
+      #     return self
       #   end
       #
       # @example
       #
       #   # good
       #
-      #   begin
+      #   def foo
       #     do_something
+      #     self
+      #   ensure
+      #     cleanup
+      #   end
+      #
+      #   # also good
+      #
+      #   def foo
+      #     begin
+      #       do_something
+      #     rescue SomeException
+      #       # Let's ignore this exception
+      #     end
+      #     self
       #   ensure
-      #     do_something_else
+      #     cleanup
       #   end
-      class EnsureReturn < Cop
+      class EnsureReturn < Base
+        extend AutoCorrector
         include RangeHelp
 
         MSG = 'Do not return from an `ensure` block.'
 
         def on_ensure(node)
-          ensure_body = node.body
-
-          return unless ensure_body
-
-          ensure_body.each_node(:return) do |return_node|
-            next if return_node.arguments.size >= 2
-
-            add_offense(return_node, location: :keyword)
-          end
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            if node.arguments?
-              corrector.replace(node, node.source.gsub(/return\s*/, ''))
-            else
-              range = range_by_whole_lines(
-                node.loc.expression, include_final_newline: true
-              )
-              corrector.remove(range)
-            end
+          node.body&.each_node(:return) do |return_node|
+            add_offense(return_node)
           end
         end
       end