rubocop 0.52.1 → 0.93.1

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

@@ -26,35 +26,34 @@ module RuboCop
       #     v
       #   end
       #
-      class RedundantWithObject < Cop
+      class RedundantWithObject < Base
+        include RangeHelp
+        extend AutoCorrector
+
         MSG_EACH_WITH_OBJECT = 'Use `each` instead of `each_with_object`.'
-                               .freeze
-        MSG_WITH_OBJECT = 'Remove redundant `with_object`.'.freeze
 
-        def_node_matcher :redundant_with_object?, <<-PATTERN
+        MSG_WITH_OBJECT = 'Remove redundant `with_object`.'
+
+        def_node_matcher :redundant_with_object?, <<~PATTERN
           (block
             $(send _ {:each_with_object :with_object}
-              (_))
+              _)
             (args
               (arg _))
             ...)
         PATTERN
 
         def on_block(node)
-          redundant_with_object?(node) do |send|
-            add_offense(node, location: with_object_range(send))
-          end
-        end
+          return unless (send = redundant_with_object?(node))
+
+          range = with_object_range(send)
 
-        def autocorrect(node)
-          lambda do |corrector|
-            redundant_with_object?(node) do |send|
-              if send.method_name == :each_with_object
-                corrector.replace(with_object_range(send), 'each')
-              else
-                corrector.remove(with_object_range(send))
-                corrector.remove(send.loc.dot)
-              end
+          add_offense(range, message: message(send)) do |corrector|
+            if send.method?(:each_with_object)
+              corrector.replace(range, 'each')
+            else
+              corrector.remove(range)
+              corrector.remove(send.loc.dot)
             end
           end
         end
@@ -62,7 +61,7 @@ module RuboCop
         private
 
         def message(node)
-          if node.method_name == :each_with_object
+          if node.method?(:each_with_object)
             MSG_EACH_WITH_OBJECT
           else
             MSG_WITH_OBJECT

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

@@ -16,12 +16,16 @@ module RuboCop
       #   if /foo/ =~ $_
       #     do_something
       #   end
-      class RegexpAsCondition < Cop
+      class RegexpAsCondition < Base
+        extend AutoCorrector
+
         MSG = 'Do not use regexp literal as a condition.' \
-              ' The regexp literal matches `$_` implicitly.'.freeze
+              ' The regexp literal matches `$_` implicitly.'
 
         def on_match_current_line(node)
-          add_offense(node)
+          add_offense(node) do |corrector|
+            corrector.replace(node, "#{node.source} =~ $_")
+          end
         end
       end
     end

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

@@ -27,9 +27,11 @@ module RuboCop
       #   if day.is?(:tuesday) && month == :jan
       #     # ...
       #   end
-      class RequireParentheses < Cop
+      class RequireParentheses < Base
+        include RangeHelp
+
         MSG = 'Use parentheses in the method call to avoid confusion about ' \
-              'precedence.'.freeze
+              'precedence.'
 
         def on_send(node)
           return if !node.arguments? || node.parenthesized?
@@ -40,6 +42,7 @@ module RuboCop
             check_predicate(node.last_argument, node)
           end
         end
+        alias on_csend on_send
 
         private
 
@@ -49,7 +52,7 @@ module RuboCop
           range = range_between(node.source_range.begin_pos,
                                 ternary.condition.source_range.end_pos)
 
-          add_offense(range, location: range)
+          add_offense(range)
         end
 
         def check_predicate(predicate, node)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for *rescue* blocks targeting the Exception class.
+      # This cop checks for `rescue` blocks targeting the Exception class.
       #
       # @example
       #
@@ -24,12 +24,13 @@ module RuboCop
       #   rescue ArgumentError
       #     handle_exception
       #   end
-      class RescueException < Cop
+      class RescueException < Base
         MSG = 'Avoid rescuing the `Exception` class. ' \
-              'Perhaps you meant to rescue `StandardError`?'.freeze
+              'Perhaps you meant to rescue `StandardError`?'
 
         def on_resbody(node)
           return unless node.children.first
+
           rescue_args = node.children.first.children
           return unless rescue_args.any? { |a| targets_exception?(a) }
 

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

@@ -34,36 +34,39 @@ module RuboCop
       #   rescue NameError
       #     baz
       #   end
-      class RescueType < Cop
-        include RescueNode
+      class RescueType < Base
+        extend AutoCorrector
 
-        MSG = 'Rescuing from `%s` will raise a `TypeError` instead of ' \
-              'catching the actual exception.'.freeze
+        MSG = 'Rescuing from `%<invalid_exceptions>s` will raise a ' \
+              '`TypeError` instead of catching the actual exception.'
         INVALID_TYPES = %i[array dstr float hash nil int str sym].freeze
 
         def on_resbody(node)
           rescued, _, _body = *node
           return if rescued.nil?
+
           exceptions = *rescued
           invalid_exceptions = invalid_exceptions(exceptions)
           return if invalid_exceptions.empty?
 
           add_offense(
-            node,
-            location: node.loc.keyword.join(rescued.loc.expression),
-            message: format(MSG, invalid_exceptions.map(&:source).join(', '))
-          )
+            node.loc.keyword.join(rescued.loc.expression),
+            message: format(
+              MSG, invalid_exceptions: invalid_exceptions.map(&:source)
+                                                         .join(', ')
+            )
+          ) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
 
-        def autocorrect(node)
+        def autocorrect(corrector, node)
           rescued, _, _body = *node
           range = Parser::Source::Range.new(node.loc.expression.source_buffer,
                                             node.loc.keyword.end_pos,
                                             rescued.loc.expression.end_pos)
 
-          lambda do |corrector|
-            corrector.replace(range, correction(*rescued))
-          end
+          corrector.replace(range, correction(*rescued))
         end
 
         private

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

@@ -31,23 +31,21 @@ module RuboCop
       #   def foo=(bar)
       #     return
       #   end
-      class ReturnInVoidContext < Cop
-        MSG = 'Do not return a value in `%s`.'.freeze
+      class ReturnInVoidContext < Base
+        MSG = 'Do not return a value in `%<method>s`.'
 
         def on_return(return_node)
           return unless return_node.descendants.any?
 
           context_node = non_void_context(return_node)
 
-          return unless context_node && context_node.def_type?
+          return unless context_node&.def_type?
 
           method_name = method_name(context_node)
 
           return unless method_name && void_context_method?(method_name)
 
-          add_offense(return_node,
-                      location: :keyword,
-                      message: format(message, method_name))
+          add_offense(return_node.loc.keyword, message: format(message, method: method_name))
         end
 
         private

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

@@ -4,8 +4,8 @@ module RuboCop
   module Cop
     module Lint
       # The safe navigation operator returns nil if the receiver is
-      # nil.  If you chain an ordinary method call after a safe
-      # navigation operator, it raises NoMethodError.  We should use a
+      # nil. If you chain an ordinary method call after a safe
+      # navigation operator, it raises NoMethodError. We should use a
       # safe navigation operator after a safe navigation operator.
       # This cop checks for the problem outlined above.
       #
@@ -23,46 +23,38 @@ module RuboCop
       #
       #   x&.foo&.bar
       #   x&.foo || bar
-      class SafeNavigationChain < Cop
-        extend TargetRubyVersion
+      class SafeNavigationChain < Base
+        include NilMethods
 
         MSG = 'Do not chain ordinary method call' \
-              ' after safe navigation operator.'.freeze
+              ' after safe navigation operator.'
 
-        def_node_matcher :bad_method?, <<-PATTERN
-          (send (csend ...) $_ ...)
+        def_node_matcher :bad_method?, <<~PATTERN
+          {
+            (send $(csend ...) $_ ...)
+            (send $({block numblock} (csend ...) ...) $_ ...)
+          }
         PATTERN
 
-        minimum_target_ruby_version 2.3
-
         def on_send(node)
-          bad_method?(node) do |method|
+          bad_method?(node) do |safe_nav, method|
             return if nil_methods.include?(method)
 
-            loc = node.loc.dot || :selector
-
-            add_offense(node, location: loc)
-          end
-        end
-
-        def autocorrect(node)
-          dot = node.loc.dot
-
-          return unless dot
-
-          lambda do |corrector|
-            corrector.insert_before(dot, '&')
+            method_chain = method_chain(node)
+            location =
+              Parser::Source::Range.new(node.source_range.source_buffer,
+                                        safe_nav.source_range.end_pos,
+                                        method_chain.source_range.end_pos)
+            add_offense(location)
           end
         end
 
         private
 
-        def nil_methods
-          nil.methods + whitelist
-        end
-
-        def whitelist
-          cop_config['Whitelist'].map(&:to_sym)
+        def method_chain(node)
+          chain = node
+          chain = chain.parent if chain.send_type? && chain.parent&.call_type?
+          chain
         end
       end
     end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop check to make sure that if safe navigation is used for a method
+      # call in an `&&` or `||` condition that safe navigation is used for all
+      # method calls on that same object.
+      #
+      # @example
+      #   # bad
+      #   foo&.bar && foo.baz
+      #
+      #   # bad
+      #   foo.bar || foo&.baz
+      #
+      #   # bad
+      #   foo&.bar && (foobar.baz || foo.baz)
+      #
+      #   # good
+      #   foo.bar && foo.baz
+      #
+      #   # good
+      #   foo&.bar || foo&.baz
+      #
+      #   # good
+      #   foo&.bar && (foobar.baz || foo&.baz)
+      #
+      class SafeNavigationConsistency < Base
+        include IgnoredNode
+        include NilMethods
+        extend AutoCorrector
+
+        MSG = 'Ensure that safe navigation is used consistently ' \
+          'inside of `&&` and `||`.'
+
+        def on_csend(node)
+          return unless node.parent&.operator_keyword?
+
+          check(node)
+        end
+
+        def check(node)
+          ancestor = top_conditional_ancestor(node)
+          conditions = ancestor.conditions
+          safe_nav_receiver = node.receiver
+
+          method_calls = conditions.select(&:send_type?)
+          unsafe_method_calls =
+            unsafe_method_calls(method_calls, safe_nav_receiver)
+
+          unsafe_method_calls.each do |unsafe_method_call|
+            location = location(node, unsafe_method_call)
+
+            add_offense(location) do |corrector|
+              autocorrect(corrector, unsafe_method_call)
+            end
+
+            ignore_node(unsafe_method_call)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          return unless node.dot?
+
+          corrector.insert_before(node.loc.dot, '&')
+        end
+
+        def location(node, unsafe_method_call)
+          node.loc.expression.join(unsafe_method_call.loc.expression)
+        end
+
+        def top_conditional_ancestor(node)
+          parent = node.parent
+          unless parent &&
+                 (parent.operator_keyword? ||
+                  (parent.begin_type? &&
+                   parent.parent &&
+                   parent.parent.operator_keyword?))
+            return node
+          end
+
+          top_conditional_ancestor(parent)
+        end
+
+        def unsafe_method_calls(method_calls, safe_nav_receiver)
+          method_calls.select do |method_call|
+            safe_nav_receiver == method_call.receiver &&
+              !nil_methods.include?(method_call.method_name) &&
+              !ignored_node?(method_call)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks to make sure safe navigation isn't used with `empty?` in
+      # a conditional.
+      #
+      # While the safe navigation operator is generally a good idea, when
+      # checking `foo&.empty?` in a conditional, `foo` being `nil` will actually
+      # do the opposite of what the author intends.
+      #
+      # @example
+      #   # bad
+      #   return if foo&.empty?
+      #   return unless foo&.empty?
+      #
+      #   # good
+      #   return if foo && foo.empty?
+      #   return unless foo && foo.empty?
+      #
+      class SafeNavigationWithEmpty < Base
+        extend AutoCorrector
+
+        MSG = 'Avoid calling `empty?` with the safe navigation operator ' \
+          'in conditionals.'
+
+        def_node_matcher :safe_navigation_empty_in_conditional?, <<~PATTERN
+          (if (csend (send ...) :empty?) ...)
+        PATTERN
+
+        def on_if(node)
+          return unless safe_navigation_empty_in_conditional?(node)
+
+          condition = node.condition
+
+          add_offense(condition) do |corrector|
+            receiver = condition.receiver.source
+
+            corrector.replace(condition, "#{receiver} && #{receiver}.#{condition.method_name}")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,43 +5,67 @@ module RuboCop
     module Lint
       # This cop checks if a file which has a shebang line as
       # its first line is granted execute permission.
-      class ScriptPermission < Cop
-        MSG = "Script file %s doesn't have execute permission.".freeze
-        SHEBANG = '#!'.freeze
+      #
+      # @example
+      #   # bad
+      #
+      #   # A file which has a shebang line as its first line is not
+      #   # granted execute permission.
+      #
+      #   #!/usr/bin/env ruby
+      #   puts 'hello, world'
+      #
+      #   # good
+      #
+      #   # A file which has a shebang line as its first line is
+      #   # granted execute permission.
+      #
+      #   #!/usr/bin/env ruby
+      #   puts 'hello, world'
+      #
+      #   # good
+      #
+      #   # A file which has not a shebang line as its first line is not
+      #   # granted execute permission.
+      #
+      #   puts 'hello, world'
+      #
+      class ScriptPermission < Base
+        extend AutoCorrector
 
-        def investigate(processed_source)
+        MSG = "Script file %<file>s doesn't have execute permission."
+        SHEBANG = '#!'
+
+        def on_new_investigation
           return if @options.key?(:stdin)
           return if Platform.windows?
-          return unless start_with_shebang?(processed_source)
+          return unless processed_source.start_with?(SHEBANG)
           return if executable?(processed_source)
+
           comment = processed_source.comments[0]
           message = format_message_from(processed_source)
-          add_offense(comment, message: message)
-        end
 
-        def autocorrect(node)
-          lambda do |_corrector|
-            FileUtils.chmod('+x', node.loc.expression.source_buffer.name)
+          add_offense(comment, message: message) do
+            autocorrect(comment) if autocorrect_requested?
           end
         end
 
         private
 
-        def start_with_shebang?(processed_source)
-          return false if processed_source[0].nil?
-          processed_source[0].start_with?(SHEBANG)
+        def autocorrect(comment)
+          FileUtils.chmod('+x', comment.loc.expression.source_buffer.name)
         end
 
         def executable?(processed_source)
           # Returns true if stat is executable or if the operating system
           # doesn't distinguish executable files from nonexecutable files.
           # See at: https://github.com/ruby/ruby/blob/ruby_2_4/file.c#L5362
-          File.stat(processed_source.buffer.name).executable?
+          File.stat(processed_source.file_path).executable?
         end
 
         def format_message_from(processed_source)
-          basename = File.basename(processed_source.buffer.name)
-          format(MSG, basename)
+          basename = File.basename(processed_source.file_path)
+          format(MSG, file: basename)
         end
       end
     end