rubocop 0.82.0 → 1.18.4

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

@@ -8,10 +8,13 @@ module RuboCop
       # With `IncludeSemanticChanges` set to `false` by default, this cop
       # does not report offenses for `!x.nil?` and does no changes that might
       # change behavior.
+      # Also `IncludeSemanticChanges` set to `false` with `EnforcedStyle: comparison` of
+      # `Style/NilComparison` cop, this cop does not report offenses for `x != nil` and
+      # does no changes to `!x.nil?` style.
       #
       # With `IncludeSemanticChanges` set to `true`, this cop reports offenses
       # for `!x.nil?` and autocorrects that and `x != nil` to solely `x`, which
-      # is **usually** OK, but might change behavior.
+      # is *usually* OK, but might change behavior.
       #
       # @example
       #   # bad
@@ -38,21 +41,33 @@ module RuboCop
       #   if !x.nil?
       #   end
       #
-      class NonNilCheck < Cop
+      class NonNilCheck < Base
+        extend AutoCorrector
+
+        MSG_FOR_REPLACEMENT = 'Prefer `%<prefer>s` over `%<current>s`.'
+        MSG_FOR_REDUNDANCY = 'Explicit non-nil checks are usually redundant.'
+
+        RESTRICT_ON_SEND = %i[!= nil? !].freeze
+
+        # @!method not_equal_to_nil?(node)
         def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+
+        # @!method unless_check?(node)
         def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+
+        # @!method nil_check?(node)
         def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        # @!method not_and_nil_check?(node)
         def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
 
         def on_send(node)
-          return if ignored_node?(node)
+          return if ignored_node?(node) ||
+                    !include_semantic_changes? && nil_comparison_style == 'comparison'
+          return unless register_offense?(node)
 
-          if not_equal_to_nil?(node)
-            add_offense(node, location: :selector)
-          elsif include_semantic_changes? &&
-                (not_and_nil_check?(node) || unless_and_nil_check?(node))
-            add_offense(node)
-          end
+          message = message(node)
+          add_offense(node, message: message) { |corrector| autocorrect(corrector, node) }
         end
 
         def on_def(node)
@@ -68,31 +83,36 @@ module RuboCop
         end
         alias on_defs on_def
 
-        def autocorrect(node)
+        private
+
+        def register_offense?(node)
+          not_equal_to_nil?(node) ||
+            include_semantic_changes? && (not_and_nil_check?(node) || unless_and_nil_check?(node))
+        end
+
+        def autocorrect(corrector, node)
           case node.method_name
           when :!=
-            autocorrect_comparison(node)
+            autocorrect_comparison(corrector, node)
           when :!
-            autocorrect_non_nil(node, node.receiver)
+            autocorrect_non_nil(corrector, node, node.receiver)
           when :nil?
-            autocorrect_unless_nil(node, node.receiver)
+            autocorrect_unless_nil(corrector, node, node.receiver)
           end
         end
 
-        private
-
         def unless_and_nil_check?(send_node)
           parent = send_node.parent
 
-          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? &&
-            parent.unless?
+          nil_check?(send_node) && unless_check?(parent) && !parent.ternary? && parent.unless?
         end
 
         def message(node)
-          if node.method?(:!=)
-            'Prefer `!expression.nil?` over `expression != nil`.'
+          if node.method?(:!=) && !include_semantic_changes?
+            prefer = "!#{node.receiver.source}.nil?"
+            format(MSG_FOR_REPLACEMENT, prefer: prefer, current: node.source)
           else
-            'Explicit non-nil checks are usually redundant.'
+            MSG_FOR_REDUNDANCY
           end
         end
 
@@ -100,7 +120,7 @@ module RuboCop
           cop_config['IncludeSemanticChanges']
         end
 
-        def autocorrect_comparison(node)
+        def autocorrect_comparison(corrector, node)
           expr = node.source
 
           new_code = if include_semantic_changes?
@@ -111,24 +131,26 @@ module RuboCop
 
           return if expr == new_code
 
-          ->(corrector) { corrector.replace(node, new_code) }
+          corrector.replace(node, new_code)
         end
 
-        def autocorrect_non_nil(node, inner_node)
-          lambda do |corrector|
-            if inner_node.receiver
-              corrector.replace(node, inner_node.receiver.source)
-            else
-              corrector.replace(node, 'self')
-            end
+        def autocorrect_non_nil(corrector, node, inner_node)
+          if inner_node.receiver
+            corrector.replace(node, inner_node.receiver.source)
+          else
+            corrector.replace(node, 'self')
           end
         end
 
-        def autocorrect_unless_nil(node, receiver)
-          lambda do |corrector|
-            corrector.replace(node.parent.loc.keyword, 'if')
-            corrector.replace(node, receiver.source)
-          end
+        def autocorrect_unless_nil(corrector, node, receiver)
+          corrector.replace(node.parent.loc.keyword, 'if')
+          corrector.replace(node, receiver.source)
+        end
+
+        def nil_comparison_style
+          nil_comparison_conf = config.for_cop('Style/NilComparison')
+
+          nil_comparison_conf['Enabled'] && nil_comparison_conf['EnforcedStyle']
         end
       end
     end

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

@@ -13,10 +13,12 @@ module RuboCop
       #   # good
       #   x = !something
       #
-      class Not < Cop
+      class Not < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `!` instead of `not`.'
+        RESTRICT_ON_SEND = %i[!].freeze
 
         OPPOSITE_METHODS = {
           :== => :!=,
@@ -30,19 +32,16 @@ module RuboCop
         def on_send(node)
           return unless node.prefix_not?
 
-          add_offense(node, location: :selector)
-        end
-
-        def autocorrect(node)
-          range = range_with_surrounding_space(range: node.loc.selector,
-                                               side: :right)
+          add_offense(node.loc.selector) do |corrector|
+            range = range_with_surrounding_space(range: node.loc.selector, side: :right)
 
-          if opposite_method?(node.receiver)
-            correct_opposite_method(range, node.receiver)
-          elsif requires_parens?(node.receiver)
-            correct_with_parens(range, node)
-          else
-            correct_without_parens(range)
+            if opposite_method?(node.receiver)
+              correct_opposite_method(corrector, range, node.receiver)
+            elsif requires_parens?(node.receiver)
+              correct_with_parens(corrector, range, node)
+            else
+              correct_without_parens(corrector, range)
+            end
           end
         end
 
@@ -58,23 +57,18 @@ module RuboCop
             child.if_type? && child.ternary?
         end
 
-        def correct_opposite_method(range, child)
-          lambda do |corrector|
-            corrector.remove(range)
-            corrector.replace(child.loc.selector,
-                              OPPOSITE_METHODS[child.method_name].to_s)
-          end
+        def correct_opposite_method(corrector, range, child)
+          corrector.remove(range)
+          corrector.replace(child.loc.selector, OPPOSITE_METHODS[child.method_name].to_s)
         end
 
-        def correct_with_parens(range, node)
-          lambda do |corrector|
-            corrector.replace(range, '!(')
-            corrector.insert_after(node, ')')
-          end
+        def correct_with_parens(corrector, range, node)
+          corrector.replace(range, '!(')
+          corrector.insert_after(node, ')')
         end
 
-        def correct_without_parens(range)
-          ->(corrector) { corrector.replace(range, '!') }
+        def correct_without_parens(corrector, range)
+          corrector.replace(range, '!')
         end
       end
     end

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

@@ -33,8 +33,9 @@ module RuboCop
       #
       #   # good
       #   num = 01234
-      class NumericLiteralPrefix < Cop
+      class NumericLiteralPrefix < Base
         include IntegerNode
+        extend AutoCorrector
 
         OCTAL_ZERO_ONLY_REGEX = /^0[Oo][0-7]+$/.freeze
         OCTAL_REGEX = /^0O?[0-7]+$/.freeze
@@ -53,14 +54,8 @@ module RuboCop
 
           return unless type
 
-          add_offense(node)
-        end
-
-        def autocorrect(node)
-          lambda do |corrector|
-            type = literal_type(node)
-            corrector.replace(node,
-                              send(:"format_#{type}", node.source))
+          add_offense(node) do |corrector|
+            corrector.replace(node, send(:"format_#{type}", node.source))
           end
         end
 
@@ -77,9 +72,9 @@ module RuboCop
         end
 
         def octal_literal_type(literal)
-          if literal =~ OCTAL_ZERO_ONLY_REGEX && octal_zero_only?
+          if OCTAL_ZERO_ONLY_REGEX.match?(literal) && octal_zero_only?
             :octal_zero_only
-          elsif literal =~ OCTAL_REGEX && !octal_zero_only?
+          elsif OCTAL_REGEX.match?(literal) && !octal_zero_only?
             :octal
           end
         end

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

@@ -27,17 +27,18 @@ module RuboCop
       #   # bad
       #   10_000_00 # typical representation of $10,000 in cents
       #
-      class NumericLiterals < Cop
-        # The parameter is called MinDigits (meaning the minimum number of
-        # digits for which an offense can be registered), but essentially it's
-        # a Max parameter (the maximum number of something that's allowed).
-        include ConfigurableMax
+      class NumericLiterals < Base
         include IntegerNode
+        extend AutoCorrector
 
-        MSG = 'Use underscores(_) as thousands separator and ' \
-              'separate every 3 digits with them.'
+        MSG = 'Use underscores(_) as thousands separator and separate every 3 digits with them.'
         DELIMITER_REGEXP = /[eE.]/.freeze
 
+        # The parameter is called MinDigits (meaning the minimum number of
+        # digits for which an offense can be registered), but essentially it's
+        # a Max parameter (the maximum number of something that's allowed).
+        exclude_limit 'MinDigits'
+
         def on_int(node)
           check(node)
         end
@@ -46,18 +47,8 @@ module RuboCop
           check(node)
         end
 
-        def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node, format_number(node))
-          end
-        end
-
         private
 
-        def max_parameter_name
-          'MinDigits'
-        end
-
         def check(node)
           int = integer_part(node)
 
@@ -67,14 +58,20 @@ module RuboCop
 
           case int
           when /^\d+$/
-            add_offense(node) { self.max = int.size + 1 }
+            return unless (self.min_digits = int.size + 1)
+
+            register_offense(node)
           when /\d{4}/, short_group_regex
-            add_offense(node) do
-              self.config_to_allow_offenses = { 'Enabled' => false }
-            end
+            return unless (self.config_to_allow_offenses = { 'Enabled' => false })
+
+            register_offense(node)
           end
         end
 
+        def register_offense(node)
+          add_offense(node) { |corrector| corrector.replace(node, format_number(node)) }
+        end
+
         def short_group_regex
           cop_config['Strict'] ? /_\d{1,2}(_|$)/ : /_\d{1,2}_/
         end
@@ -95,12 +92,7 @@ module RuboCop
         # @param int_part [String]
         def format_int_part(int_part)
           int_part = Integer(int_part)
-          formatted_int = int_part
-                          .abs
-                          .to_s
-                          .reverse
-                          .gsub(/...(?=.)/, '\&_')
-                          .reverse
+          formatted_int = int_part.abs.to_s.reverse.gsub(/...(?=.)/, '\&_').reverse
           formatted_int.insert(0, '-') if int_part.negative?
           formatted_int
         end

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

@@ -8,7 +8,7 @@ module RuboCop
       # These can be replaced by their respective predicate methods.
       # The cop can also be configured to do the reverse.
       #
-      # The cop disregards `#nonzero?` as it its value is truthy or falsey,
+      # The cop disregards `#nonzero?` as its value is truthy or falsey,
       # but not `true` and `false`, and thus not always interchangeable with
       # `!= 0`.
       #
@@ -41,38 +41,28 @@ module RuboCop
       #   foo == 0
       #   0 > foo
       #   bar.baz > 0
-      class NumericPredicate < Cop
+      class NumericPredicate < Base
         include ConfigurableEnforcedStyle
         include IgnoredMethods
+        extend AutoCorrector
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
 
-        REPLACEMENTS = {
-          'zero?' => '==',
-          'positive?' => '>',
-          'negative?' => '<'
-        }.freeze
+        REPLACEMENTS = { 'zero?' => '==', 'positive?' => '>', 'negative?' => '<' }.freeze
+
+        RESTRICT_ON_SEND = %i[== > < positive? negative? zero?].freeze
 
         def on_send(node)
+          numeric, replacement = check(node)
+          return unless numeric
+
           return if ignored_method?(node.method_name) ||
                     node.each_ancestor(:send, :block).any? do |ancestor|
                       ignored_method?(ancestor.method_name)
                     end
 
-          numeric, replacement = check(node)
-
-          return unless numeric
-
-          add_offense(node,
-                      message: format(MSG,
-                                      prefer: replacement,
-                                      current: node.source))
-        end
-
-        def autocorrect(node)
-          _, replacement = check(node)
-
-          lambda do |corrector|
+          message = format(MSG, prefer: replacement, current: node.source)
+          add_offense(node, message: message) do |corrector|
             corrector.replace(node, replacement)
           end
         end
@@ -94,8 +84,7 @@ module RuboCop
 
         def replacement(numeric, operation)
           if style == :predicate
-            [parenthesized_source(numeric),
-             REPLACEMENTS.invert[operation.to_s]].join('.')
+            [parenthesized_source(numeric), REPLACEMENTS.invert[operation.to_s]].join('.')
           else
             [numeric.source, REPLACEMENTS[operation.to_s], 0].join(' ')
           end
@@ -121,14 +110,17 @@ module RuboCop
           end
         end
 
+        # @!method predicate(node)
         def_node_matcher :predicate, <<~PATTERN
           (send $(...) ${:zero? :positive? :negative?})
         PATTERN
 
+        # @!method comparison(node)
         def_node_matcher :comparison, <<~PATTERN
           (send [$(...) !gvar_type?] ${:== :> :<} (int 0))
         PATTERN
 
+        # @!method inverted_comparison(node)
         def_node_matcher :inverted_comparison, <<~PATTERN
           (send (int 0) ${:== :> :<} [$(...) !gvar_type?])
         PATTERN

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

@@ -3,39 +3,48 @@
 module RuboCop
   module Cop
     module Style
-      # TODO: Make configurable.
-      # Checks for uses of if/then/else/end on a single line.
+      # Checks for uses of if/then/else/end constructs on a single line.
+      # AlwaysCorrectToMultiline config option can be set to true to auto-convert all offenses to
+      # multi-line constructs. When AlwaysCorrectToMultiline is false (default case) the
+      # auto-correct will first try converting them to ternary operators.
       #
       # @example
       #   # bad
-      #   if foo then boo else doo end
-      #   unless foo then boo else goo end
+      #   if foo then bar else baz end
+      #
+      #   # bad
+      #   unless foo then baz else bar end
       #
       #   # good
-      #   foo ? boo : doo
-      #   boo if foo
-      #   if foo then boo end
+      #   foo ? bar : baz
+      #
+      #   # good
+      #   bar if foo
+      #
+      #   # good
+      #   if foo then bar end
       #
       #   # good
       #   if foo
-      #     boo
+      #     bar
       #   else
-      #     doo
+      #     baz
       #   end
-      class OneLineConditional < Cop
+      class OneLineConditional < Base
+        include ConfigurableEnforcedStyle
         include OnNormalIfUnless
+        extend AutoCorrector
 
-        MSG = 'Favor the ternary operator (`?:`) ' \
-              'over `%<keyword>s/then/else/end` constructs.'
+        MSG = 'Favor the ternary operator (`?:`) or multi-line constructs ' \
+              'over single-line `%<keyword>s/then/else/end` constructs.'
 
         def on_normal_if_unless(node)
-          return unless node.single_line? && node.else_branch
-
-          add_offense(node)
-        end
+          return unless node.single_line?
+          return unless node.else_branch
+          return if node.elsif?
 
-        def autocorrect(node)
-          lambda do |corrector|
+          message = message(node)
+          add_offense(node, message: message) do |corrector|
             corrector.replace(node, replacement(node))
           end
         end
@@ -47,20 +56,57 @@ module RuboCop
         end
 
         def replacement(node)
-          return to_ternary(node) unless node.parent
-
-          if %i[and or].include?(node.parent.type)
-            return "(#{to_ternary(node)})"
+          if always_multiline? || cannot_replace_to_ternary?(node)
+            multiline_replacement(node)
+          else
+            replaced_node = ternary_replacement(node)
+            return replaced_node unless node.parent
+            return "(#{replaced_node})" if %i[and or].include?(node.parent.type)
+            return "(#{replaced_node})" if node.parent.send_type? && node.parent.operator_method?
+
+            replaced_node
           end
+        end
+
+        def always_multiline?
+          @config.for_cop('Style/OneLineConditional')['AlwaysCorrectToMultiline']
+        end
+
+        def cannot_replace_to_ternary?(node)
+          node.elsif_conditional?
+        end
+
+        def multiline_replacement(node, indentation = nil)
+          indentation = ' ' * node.source_range.column if indentation.nil?
+          if_branch_source = node.if_branch&.source || 'nil'
+          elsif_indentation = indentation if node.respond_to?(:elsif?) && node.elsif?
+          if_branch = <<~RUBY
+            #{elsif_indentation}#{node.keyword} #{node.condition.source}
+            #{indentation}#{branch_body_indentation}#{if_branch_source}
+          RUBY
+          else_branch = else_branch_to_multiline(node.else_branch, indentation)
+          if_branch + else_branch
+        end
 
-          if node.parent.send_type? && node.parent.operator_method?
-            return "(#{to_ternary(node)})"
+        def else_branch_to_multiline(else_branch, indentation)
+          if else_branch.nil?
+            'end'
+          elsif else_branch.if_type? && else_branch.elsif?
+            multiline_replacement(else_branch, indentation)
+          else
+            <<~RUBY.chomp
+              #{indentation}else
+              #{indentation}#{branch_body_indentation}#{else_branch.source}
+              #{indentation}end
+            RUBY
           end
+        end
 
-          to_ternary(node)
+        def branch_body_indentation
+          ' ' * (@config.for_cop('Layout/IndentationWidth')['Width'] || 2)
         end
 
-        def to_ternary(node)
+        def ternary_replacement(node)
           condition, if_branch, else_branch = *node
 
           "#{expr_replacement(condition)} ? " \
@@ -93,8 +139,7 @@ module RuboCop
           return false unless node.keyword?
           return true if node.respond_to?(:prefix_not?) && node.prefix_not?
 
-          node.respond_to?(:arguments?) && node.arguments? &&
-            !node.parenthesized_call?
+          node.respond_to?(:arguments?) && node.arguments? && !node.parenthesized_call?
         end
       end
     end