rubocop 0.87.1

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

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # Use `next` to skip iteration instead of a condition at the end.
+      #
+      # @example EnforcedStyle: skip_modifier_ifs (default)
+      #   # bad
+      #   [1, 2].each do |a|
+      #     if a == 1
+      #       puts a
+      #     end
+      #   end
+      #
+      #   # good
+      #   [1, 2].each do |a|
+      #     next unless a == 1
+      #     puts a
+      #   end
+      #
+      #   # good
+      #   [1, 2].each do |a|
+      #     puts a if a == 1
+      #   end
+      #
+      # @example EnforcedStyle: always
+      #   # With `always` all conditions at the end of an iteration needs to be
+      #   # replaced by next - with `skip_modifier_ifs` the modifier if like
+      #   # this one are ignored: `[1, 2].each { |a| puts a if a == 1 }`
+      #
+      #   # bad
+      #   [1, 2].each do |a|
+      #     puts a if a == 1
+      #   end
+      #
+      #   # bad
+      #   [1, 2].each do |a|
+      #     if a == 1
+      #       puts a
+      #     end
+      #   end
+      #
+      #   # good
+      #   [1, 2].each do |a|
+      #     next unless a == 1
+      #     puts a
+      #   end
+      class Next < Cop
+        include ConfigurableEnforcedStyle
+        include MinBodyLength
+        include RangeHelp
+
+        MSG = 'Use `next` to skip iteration.'
+        EXIT_TYPES = %i[break return].freeze
+
+        def self.autocorrect_incompatible_with
+          [Style::SafeNavigation]
+        end
+
+        def investigate(_processed_source)
+          # When correcting nested offenses, we need to keep track of how much
+          # we have adjusted the indentation of each line
+          @reindented_lines = Hash.new(0)
+        end
+
+        def on_block(node)
+          return unless node.send_node.send_type? &&
+                        node.send_node.enumerator_method?
+
+          check(node)
+        end
+
+        def on_while(node)
+          check(node)
+        end
+        alias on_until on_while
+        alias on_for on_while
+
+        def autocorrect(node)
+          lambda do |corrector|
+            if node.modifier_form?
+              autocorrect_modifier(corrector, node)
+            else
+              autocorrect_block(corrector, node)
+            end
+          end
+        end
+
+        private
+
+        def check(node)
+          return unless node.body && ends_with_condition?(node.body)
+
+          offending_node = offense_node(node.body)
+
+          add_offense(offending_node,
+                      location: offense_location(offending_node))
+        end
+
+        def ends_with_condition?(body)
+          return true if simple_if_without_break?(body)
+
+          body.begin_type? && simple_if_without_break?(body.children.last)
+        end
+
+        def simple_if_without_break?(node)
+          return false unless if_without_else?(node)
+          return false if if_else_children?(node)
+          return false if allowed_modifier_if?(node)
+
+          !exit_body_type?(node)
+        end
+
+        def allowed_modifier_if?(node)
+          if node.modifier_form?
+            style == :skip_modifier_ifs
+          else
+            !min_body_length?(node)
+          end
+        end
+
+        def if_else_children?(node)
+          node.each_child_node(:if).any?(&:else?)
+        end
+
+        def if_without_else?(node)
+          node&.if_type? && !node.ternary? && !node.else?
+        end
+
+        def exit_body_type?(node)
+          return false unless node.if_branch
+
+          EXIT_TYPES.include?(node.if_branch.type)
+        end
+
+        def offense_node(body)
+          *_, condition = *body
+
+          condition&.if_type? ? condition : body
+        end
+
+        def offense_location(offense_node)
+          offense_begin_pos = offense_node.source_range.begin
+          offense_begin_pos.join(offense_node.condition.source_range)
+        end
+
+        def autocorrect_modifier(corrector, node)
+          body = node.if_branch || node.else_branch
+
+          replacement =
+            "next #{node.inverse_keyword} #{node.condition.source}\n" \
+            "#{' ' * node.source_range.column}#{body.source}"
+
+          corrector.replace(node, replacement)
+        end
+
+        def autocorrect_block(corrector, node)
+          next_code = "next #{node.inverse_keyword} #{node.condition.source}"
+
+          corrector.insert_before(node, next_code)
+
+          corrector.remove(cond_range(node, node.condition))
+          corrector.remove(end_range(node))
+
+          lines = reindentable_lines(node)
+
+          return if lines.empty?
+
+          reindent(lines, node.condition, corrector)
+        end
+
+        def cond_range(node, cond)
+          end_pos = if node.loc.begin
+                      node.loc.begin.end_pos # after "then"
+                    else
+                      cond.source_range.end_pos
+                    end
+
+          range_between(node.source_range.begin_pos, end_pos)
+        end
+
+        def end_range(node)
+          source_buffer = node.source_range.source_buffer
+          end_pos = node.loc.end.end_pos
+          begin_pos = node.loc.end.begin_pos - node.loc.end.column
+          begin_pos -= 1 if end_followed_by_whitespace_only?(source_buffer,
+                                                             end_pos)
+
+          range_between(begin_pos, end_pos)
+        end
+
+        def end_followed_by_whitespace_only?(source_buffer, end_pos)
+          /\A\s*$/.match?(source_buffer.source[end_pos..-1])
+        end
+
+        def reindentable_lines(node)
+          buffer = node.source_range.source_buffer
+
+          # end_range starts with the final newline of the if body
+          lines = (node.source_range.line + 1)...node.loc.end.line
+          lines = lines.to_a - heredoc_lines(node)
+          # Skip blank lines
+          lines.reject { |lineno| /\A\s*\z/.match?(buffer.source_line(lineno)) }
+        end
+
+        # Adjust indentation of `lines` to match `node`
+        def reindent(lines, node, corrector)
+          range  = node.source_range
+          buffer = range.source_buffer
+
+          target_indent = range.source_line =~ /\S/
+          delta = actual_indent(lines, buffer) - target_indent
+          lines.each do |lineno|
+            reindent_line(corrector, lineno, delta, buffer)
+          end
+        end
+
+        def actual_indent(lines, buffer)
+          lines.map { |lineno| buffer.source_line(lineno) =~ /\S/ }.min
+        end
+
+        def heredoc_lines(node)
+          node.each_node(:dstr)
+              .select(&:heredoc?)
+              .map { |n| n.loc.heredoc_body }
+              .flat_map { |b| (b.line...b.last_line).to_a }
+        end
+
+        def reindent_line(corrector, lineno, delta, buffer)
+          adjustment = delta + @reindented_lines[lineno]
+          @reindented_lines[lineno] = adjustment
+
+          if adjustment.positive?
+            corrector.remove_leading(buffer.line_range(lineno), adjustment)
+          elsif adjustment.negative?
+            corrector.insert_before(buffer.line_range(lineno),
+                                    ' ' * -adjustment)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for comparison of something with nil using `==` and
+      # `nil?`.
+      #
+      # Supported styles are: predicate, comparison.
+      #
+      # @example EnforcedStyle: predicate (default)
+      #
+      #   # bad
+      #   if x == nil
+      #   end
+      #
+      #   # good
+      #   if x.nil?
+      #   end
+      #
+      # @example EnforcedStyle: comparison
+      #
+      #   # bad
+      #   if x.nil?
+      #   end
+      #
+      #   # good
+      #   if x == nil
+      #   end
+      #
+      class NilComparison < Cop
+        include ConfigurableEnforcedStyle
+
+        PREDICATE_MSG = 'Prefer the use of the `nil?` predicate.'
+        EXPLICIT_MSG = 'Prefer the use of the `==` comparison.'
+
+        def_node_matcher :nil_comparison?, '(send _ {:== :===} nil)'
+        def_node_matcher :nil_check?, '(send _ :nil?)'
+
+        def on_send(node)
+          style_check?(node) do
+            add_offense(node, location: :selector)
+          end
+        end
+
+        def autocorrect(node)
+          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, 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
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for non-nil checks, which are usually redundant.
+      #
+      # With `IncludeSemanticChanges` set to `false` by default, this cop
+      # does not report offenses for `!x.nil?` and does no changes that might
+      # change behavior.
+      #
+      # 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.
+      #
+      # @example
+      #   # bad
+      #   if x != nil
+      #   end
+      #
+      #   # good
+      #   if x
+      #   end
+      #
+      #   # Non-nil checks are allowed if they are the final nodes of predicate.
+      #   # good
+      #   def signed_in?
+      #     !current_user.nil?
+      #   end
+      #
+      # @example IncludeSemanticChanges: false (default)
+      #   # good
+      #   if !x.nil?
+      #   end
+      #
+      # @example IncludeSemanticChanges: true
+      #   # bad
+      #   if !x.nil?
+      #   end
+      #
+      class NonNilCheck < Cop
+        def_node_matcher :not_equal_to_nil?, '(send _ :!= nil)'
+        def_node_matcher :unless_check?, '(if (send _ :nil?) ...)'
+        def_node_matcher :nil_check?, '(send _ :nil?)'
+        def_node_matcher :not_and_nil_check?, '(send (send _ :nil?) :!)'
+
+        def on_send(node)
+          return if ignored_node?(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
+        end
+
+        def on_def(node)
+          body = node.body
+
+          return unless node.predicate_method? && body
+
+          if body.begin_type?
+            ignore_node(body.children.last)
+          else
+            ignore_node(body)
+          end
+        end
+        alias on_defs on_def
+
+        def autocorrect(node)
+          case node.method_name
+          when :!=
+            autocorrect_comparison(node)
+          when :!
+            autocorrect_non_nil(node, node.receiver)
+          when :nil?
+            autocorrect_unless_nil(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?
+        end
+
+        def message(node)
+          if node.method?(:!=)
+            'Prefer `!expression.nil?` over `expression != nil`.'
+          else
+            'Explicit non-nil checks are usually redundant.'
+          end
+        end
+
+        def include_semantic_changes?
+          cop_config['IncludeSemanticChanges']
+        end
+
+        def autocorrect_comparison(node)
+          expr = node.source
+
+          new_code = if include_semantic_changes?
+                       expr.sub(/\s*!=\s*nil/, '')
+                     else
+                       expr.sub(/^(\S*)\s*!=\s*nil/, '!\1.nil?')
+                     end
+
+          return if expr == new_code
+
+          ->(corrector) { 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
+          end
+        end
+
+        def autocorrect_unless_nil(node, receiver)
+          lambda do |corrector|
+            corrector.replace(node.parent.loc.keyword, 'if')
+            corrector.replace(node, receiver.source)
+          end
+        end
+      end
+    end
+  end
+end