rubocop 0.58.2 → 0.59.0

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

@@ -69,7 +69,7 @@ module RuboCop
         private
 
         def includes_format_methods?(node)
-          node.each_ancestor.any? do |ancestor|
+          node.each_ancestor(:send).any? do |ancestor|
             FORMAT_STRING_METHODS.include?(ancestor.method_name)
           end
         end

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

@@ -21,6 +21,7 @@ module RuboCop
         def on_normal_if_unless(node)
           beginning = node.loc.begin
           return unless beginning && beginning.is?(';')
+
           add_offense(node)
         end
       end

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

@@ -55,6 +55,7 @@ module RuboCop
 
         def on_send(node)
           return if part_of_ignored_node?(node)
+
           inverse_candidate?(node) do |_method_call, lhs, method, rhs|
             return unless inverse_methods.key?(method)
             return if possible_class_hierarchy_check?(lhs, rhs, method)

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

@@ -129,6 +129,7 @@ module RuboCop
           corrector.replace(block_method.source_range, 'lambda')
           corrector.remove(args.source_range) if args.source_range
           return if args.children.empty?
+
           arg_str = " |#{lambda_arg_string(args)}|"
           corrector.insert_after(node.loc.begin, arg_str)
         end

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

@@ -40,6 +40,8 @@ module RuboCop
       #     bar :baz
       #   end
       class MethodCallWithArgsParentheses < Cop
+        include IgnoredMethods
+
         MSG = 'Use parentheses for method calls with arguments.'.freeze
 
         def on_send(node)
@@ -66,11 +68,7 @@ module RuboCop
         def ignored_method?(node)
           node.operator_method? || node.setter_method? ||
             ignore_macros? && node.macro? ||
-            ignored_list.include?(node.method_name)
-        end
-
-        def ignored_list
-          cop_config['IgnoredMethods'].map(&:to_sym)
+            super(node.method_name)
         end
 
         def ignore_macros?

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

@@ -12,6 +12,8 @@ module RuboCop
       #   # good
       #   object.some_method
       class MethodCallWithoutArgsParentheses < Cop
+        include IgnoredMethods
+
         MSG = 'Do not use parentheses for method calls with ' \
               'no arguments.'.freeze
 
@@ -36,11 +38,7 @@ module RuboCop
         private
 
         def ineligible_node?(node)
-          node.camel_case_method? || node.implicit_call? || node.keyword_not?
-        end
-
-        def ignored_method?(method)
-          cop_config['IgnoredMethods'].to_a.map(&:to_sym).include?(method)
+          node.camel_case_method? || node.implicit_call? || node.prefix_not?
         end
 
         def same_name_assignment?(node)

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

@@ -60,8 +60,8 @@ module RuboCop
       #
       # @example EnforcedStyle: require_no_parentheses_except_multiline
       #   # The `require_no_parentheses_except_multiline` style prefers no
-      #   # parantheses when method definition arguments fit on single line,
-      #   # but prefers parantheses when arguments span multiple lines.
+      #   # parentheses when method definition arguments fit on single line,
+      #   # but prefers parentheses when arguments span multiple lines.
       #
       #   # bad
       #   def bar(num1, num2)

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

@@ -167,6 +167,7 @@ module RuboCop
 
         def empty_else_style
           return unless empty_else_config.key?('EnforcedStyle')
+
           empty_else_config['EnforcedStyle'].to_sym
         end
 

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

@@ -58,6 +58,7 @@ module RuboCop
 
         def bad_rhs?(rhs)
           return false unless rhs.multiline?
+
           if style == :keyword
             rhs.begin_type?
           else

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for method signatures that span multiple lines.
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   def foo(bar, baz)
+      #   end
+      #
+      #   # bad
+      #
+      #   def foo(bar,
+      #           baz)
+      #   end
+      #
+      class MultilineMethodSignature < Cop
+        MSG = 'Avoid multi-line method signatures.'.freeze
+
+        def on_def(node)
+          return if opening_line(node) == closing_line(node)
+          return if correction_exceeds_max_line_length?(node)
+
+          add_offense(node)
+        end
+        alias on_defs on_def
+
+        private
+
+        def opening_line(node)
+          node.first_line
+        end
+
+        def closing_line(node)
+          if node.arguments?
+            node.arguments.last_line
+          else
+            node.first_line
+          end
+        end
+
+        def correction_exceeds_max_line_length?(node)
+          indentation_width(node) + definition_width(node) > max_line_length
+        end
+
+        def indentation_width(node)
+          processed_source.line_indentation(node.loc.expression.line)
+        end
+
+        def definition_width(node)
+          node.loc.expression.source.squeeze.length -
+            node.loc.end.source.length
+        end
+
+        def max_line_length
+          config.for_cop('Metrics/LineLength')['Max'] || 80
+        end
+      end
+    end
+  end
+end

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

@@ -37,6 +37,7 @@ module RuboCop
 
         def nested_variable_comparison?(node)
           return false unless nested_comparison?(node)
+
           variables_in_node(node).count == 1
         end
 

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

@@ -3,9 +3,12 @@
 module RuboCop
   module Cop
     module Style
-      # This cop checks for comparison of something with nil using ==.
+      # This cop checks for comparison of something with nil using `==` and
+      # `nil?`.
       #
-      # @example
+      # Supported styles are: predicate, comparison.
+      #
+      # @example EnforcedStyle: predicate (default)
       #
       #   # bad
       #   if x == nil
@@ -14,21 +17,58 @@ module RuboCop
       #   # good
       #   if x.nil?
       #   end
+      #
+      # @example EnforcedStyle: comparison
+      #
+      #   # bad
+      #   if x.nil?
+      #   end
+      #
+      #   # good
+      #   if x == nil
+      #   end
+      #
       class NilComparison < Cop
-        MSG = 'Prefer the use of the `nil?` predicate.'.freeze
+        include ConfigurableEnforcedStyle
+
+        PREDICATE_MSG = 'Prefer the use of the `nil?` predicate.'.freeze
+        EXPLICIT_MSG = 'Prefer the use of the `==` comparison.'.freeze
 
         def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+        def_node_matcher :nil_check?, '(send _ :nil?)'
 
         def on_send(node)
-          nil_comparison?(node) do
+          style_check?(node) do
             add_offense(node, location: :selector)
           end
         end
 
         def autocorrect(node)
-          new_code = node.source.sub(/\s*={2,3}\s*nil/, '.nil?')
+          new_code = if prefer_comparison?
+                       node.source.sub('.nil?', ' == nil')
+                     else
+                       node.source.sub(/\s*={2,3}\s*nil/, '.nil?')
+                     end
           ->(corrector) { corrector.replace(node.source_range, new_code) }
         end
+
+        private
+
+        def message(_node)
+          prefer_comparison? ? EXPLICIT_MSG : PREDICATE_MSG
+        end
+
+        def style_check?(node, &block)
+          if prefer_comparison?
+            nil_check?(node, &block)
+          else
+            nil_comparison?(node, &block)
+          end
+        end
+
+        def prefer_comparison?
+          style == :comparison
+        end
       end
     end
   end

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

@@ -28,7 +28,7 @@ module RuboCop
         }.freeze
 
         def on_send(node)
-          return unless node.keyword_not?
+          return unless node.prefix_not?
 
           add_offense(node, location: :selector)
         end

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

@@ -43,6 +43,7 @@ module RuboCop
       #   bar.baz > 0
       class NumericPredicate < Cop
         include ConfigurableEnforcedStyle
+        include IgnoredMethods
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'.freeze
 
@@ -53,6 +54,10 @@ module RuboCop
         }.freeze
 
         def on_send(node)
+          return if node.each_ancestor(:send, :block).any? do |ancestor|
+            ignored_method?(ancestor.method_name)
+          end
+
           numeric, replacement = check(node)
 
           return unless numeric

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

@@ -87,7 +87,7 @@ module RuboCop
 
         def keyword_with_changed_precedence?(node)
           return false unless node.keyword?
-          return true if node.keyword_not?
+          return true if node.prefix_not?
 
           !node.parenthesized_call?
         end

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

@@ -46,11 +46,13 @@ module RuboCop
 
         def on_if(node)
           return unless unless_assignment?(node)
+
           add_offense(node)
         end
 
         def on_lvasgn(node)
           return unless ternary_assignment?(node)
+
           add_offense(node)
         end
 

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

@@ -30,7 +30,7 @@ module RuboCop
         include ConfigurableEnforcedStyle
 
         LOWER_CASE_Q_MSG = 'Do not use `%Q` unless interpolation is ' \
-                           'needed.  Use `%q`.'.freeze
+                           'needed. Use `%q`.'.freeze
         UPPER_CASE_Q_MSG = 'Use `%Q` instead of `%q`.'.freeze
 
         def on_str(node)

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

@@ -59,6 +59,7 @@ module RuboCop
           return unless integer_op_rand?(node) ||
                         rand_op_integer?(node) ||
                         rand_modified?(node)
+
           add_offense(node)
         end
 

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

@@ -44,6 +44,16 @@ module RuboCop
       #   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
 
@@ -54,7 +64,10 @@ module RuboCop
 
         def on_block(node)
           return if target_ruby_version < 2.5
+
+          return if node.send_node.stabby_lambda?
           return if node.braces?
+
           check(node)
         end
 

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

@@ -63,6 +63,7 @@ module RuboCop
 
         def offense?(node)
           return if node.modifier_form?
+
           redundant_condition?(node) || redundant_condition_inverted?(node)
         end
 

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

@@ -28,6 +28,7 @@ module RuboCop
 
         def on_begin(node)
           return if !parentheses?(node) || parens_allowed?(node)
+
           check(node)
         end
 
@@ -63,8 +64,10 @@ module RuboCop
 
         def allowed_multiple_expression?(node)
           return false if node.children.one?
+
           ancestor = node.ancestors.first
           return false unless ancestor
+
           !ancestor.begin_type? && !ancestor.def_type? && !ancestor.block_type?
         end
 
@@ -89,6 +92,7 @@ module RuboCop
           end
           return offense(begin_node, 'a variable') if node.variable?
           return offense(begin_node, 'a constant') if node.const_type?
+
           check_send(begin_node, node) if node.send_type?
         end
 
@@ -157,6 +161,7 @@ module RuboCop
 
           siblings = begin_node.parent && begin_node.parent.children
           return false if siblings.nil?
+
           next_sibling = siblings[begin_node.sibling_index + 1]
           base_value = node.children.first
 
@@ -178,7 +183,7 @@ module RuboCop
 
         def method_call_with_redundant_parentheses?(node)
           return false unless node.send_type?
-          return false if node.keyword_not?
+          return false if node.prefix_not?
           return false if range_end?(node)
 
           send_node, args = method_node_and_args(node)

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

@@ -118,6 +118,7 @@ module RuboCop
 
         def check_when_node(node)
           return unless node
+
           _cond, body = *node
           check_branch(body) if body
         end

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

@@ -23,6 +23,7 @@ module RuboCop
 
         def on_resbody(node)
           return unless rescue_modifier?(node)
+
           add_offense(node.parent)
         end
 

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

@@ -90,6 +90,7 @@ module RuboCop
 
         def on_resbody(node)
           return if rescue_modifier?(node)
+
           case style
           when :implicit
             rescue_standard_error?(node) do |error|

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

@@ -88,6 +88,7 @@ module RuboCop
 
         def on_if(node)
           return if allowed_if_condition?(node)
+
           check_node(node)
         end
 
@@ -97,6 +98,7 @@ module RuboCop
 
         def check_node(node)
           return if target_ruby_version < 2.3
+
           checked_variable, receiver, method_chain, method = extract_parts(node)
           return unless receiver == checked_variable
           # method is already a method call so this is actually checking for a
@@ -176,12 +178,14 @@ module RuboCop
                      end
 
           return receiver if receiver == checked_variable
+
           find_matching_receiver_invocation(receiver, checked_variable)
         end
 
         def chain_size(method_chain, method)
           method.each_ancestor(:send).inject(0) do |total, ancestor|
             break total + 1 if ancestor == method_chain
+
             total + 1
           end
         end