rubocop 0.93.1 → 1.79.2

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

@@ -3,10 +3,14 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for odd else block layout - like
-      # having an expression on the same line as the else keyword,
+      # Checks for odd `else` block layout - like
+      # having an expression on the same line as the `else` keyword,
       # which is usually a mistake.
       #
+      # Its autocorrection tweaks layout to keep the syntax. So, this autocorrection
+      # is compatible correction for bad case syntax, but if your code makes a mistake
+      # with `elsif` and `else`, you will have to correct it manually.
+      #
       # @example
       #
       #   # bad
@@ -17,21 +21,35 @@ module RuboCop
       #     do_that
       #   end
       #
-      # @example
-      #
       #   # good
       #
+      #   # This code is compatible with the bad case. It will be autocorrected like this.
       #   if something
       #     # ...
       #   else
       #     do_this
       #     do_that
       #   end
+      #
+      #   # This code is incompatible with the bad case.
+      #   # If `do_this` is a condition, `elsif` should be used instead of `else`.
+      #   if something
+      #     # ...
+      #   elsif do_this
+      #     do_that
+      #   end
       class ElseLayout < Base
+        include Alignment
+        include RangeHelp
+        extend AutoCorrector
+
         MSG = 'Odd `else` layout detected. Did you mean to use `elsif`?'
 
         def on_if(node)
-          return if node.ternary? || node.elsif?
+          return if node.ternary?
+
+          # If the if is on a single line, it'll be handled by `Style/OneLineConditional`
+          return if node.single_line?
 
           check(node)
         end
@@ -50,15 +68,19 @@ module RuboCop
 
         def check_else(node)
           else_branch = node.else_branch
+          first_else = else_branch.begin_type? ? else_branch.children.first : else_branch
 
-          return unless else_branch.begin_type?
+          return unless first_else
+          return unless same_line?(first_else, node.loc.else)
 
-          first_else = else_branch.children.first
+          add_offense(first_else) { |corrector| autocorrect(corrector, node, first_else) }
+        end
 
-          return unless first_else
-          return unless first_else.source_range.line == node.loc.else.line
+        def autocorrect(corrector, node, first_else)
+          corrector.insert_after(node.loc.else, "\n")
 
-          add_offense(first_else)
+          blank_range = range_between(node.loc.else.end_pos, first_else.source_range.begin_pos)
+          corrector.replace(blank_range, indentation(node))
         end
       end
     end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for blocks without a body.
+      # Such empty blocks are typically an oversight or we should provide a comment
+      # to clarify what we're aiming for.
+      #
+      # Empty lambdas and procs are ignored by default.
+      #
+      # NOTE: For backwards compatibility, the configuration that allows/disallows
+      # empty lambdas and procs is called `AllowEmptyLambdas`, even though it also
+      # applies to procs.
+      #
+      # @example
+      #   # bad
+      #   items.each { |item| }
+      #
+      #   # good
+      #   items.each { |item| puts item }
+      #
+      # @example AllowComments: true (default)
+      #   # good
+      #   items.each do |item|
+      #     # TODO: implement later (inner comment)
+      #   end
+      #
+      #   items.each { |item| } # TODO: implement later (inline comment)
+      #
+      # @example AllowComments: false
+      #   # bad
+      #   items.each do |item|
+      #     # TODO: implement later (inner comment)
+      #   end
+      #
+      #   items.each { |item| } # TODO: implement later (inline comment)
+      #
+      # @example AllowEmptyLambdas: true (default)
+      #   # good
+      #   allow(subject).to receive(:callable).and_return(-> {})
+      #
+      #   placeholder = lambda do
+      #   end
+      #   (callable || placeholder).call
+      #
+      #   proc { }
+      #
+      #   Proc.new { }
+      #
+      # @example AllowEmptyLambdas: false
+      #   # bad
+      #   allow(subject).to receive(:callable).and_return(-> {})
+      #
+      #   placeholder = lambda do
+      #   end
+      #   (callable || placeholder).call
+      #
+      #   proc { }
+      #
+      #   Proc.new { }
+      #
+      class EmptyBlock < Base
+        MSG = 'Empty block detected.'
+
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
+          return if node.body
+          return if allow_empty_lambdas? && node.lambda_or_proc?
+          return if cop_config['AllowComments'] && allow_comment?(node)
+
+          add_offense(node)
+        end
+
+        private
+
+        def allow_comment?(node)
+          return false unless processed_source.contains_comment?(node.source_range)
+
+          line_comment = processed_source.comment_at_line(node.source_range.line)
+          !line_comment || !comment_disables_cop?(line_comment.source)
+        end
+
+        def allow_empty_lambdas?
+          cop_config['AllowEmptyLambdas']
+        end
+
+        def comment_disables_cop?(comment)
+          regexp_pattern = "# rubocop : (disable|todo) ([^,],)* (all|#{cop_name})"
+          Regexp.new(regexp_pattern.gsub(' ', '\s*')).match?(comment)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for classes and metaclasses without a body.
+      # Such empty classes and metaclasses are typically an oversight or we should provide a comment
+      # to be clearer what we're aiming for.
+      #
+      # @example
+      #   # bad
+      #   class Foo
+      #   end
+      #
+      #   class Bar
+      #     class << self
+      #     end
+      #   end
+      #
+      #   class << obj
+      #   end
+      #
+      #   # good
+      #   class Foo
+      #     def do_something
+      #       # ... code
+      #     end
+      #   end
+      #
+      #   class Bar
+      #     class << self
+      #       attr_reader :bar
+      #     end
+      #   end
+      #
+      #   class << obj
+      #     attr_reader :bar
+      #   end
+      #
+      # @example AllowComments: false (default)
+      #   # bad
+      #   class Foo
+      #     # TODO: implement later
+      #   end
+      #
+      #   class Bar
+      #     class << self
+      #       # TODO: implement later
+      #     end
+      #   end
+      #
+      #   class << obj
+      #     # TODO: implement later
+      #   end
+      #
+      # @example AllowComments: true
+      #   # good
+      #   class Foo
+      #     # TODO: implement later
+      #   end
+      #
+      #   class Bar
+      #     class << self
+      #       # TODO: implement later
+      #     end
+      #   end
+      #
+      #   class << obj
+      #     # TODO: implement later
+      #   end
+      #
+      class EmptyClass < Base
+        CLASS_MSG = 'Empty class detected.'
+        METACLASS_MSG = 'Empty metaclass detected.'
+
+        def on_class(node)
+          add_offense(node, message: CLASS_MSG) unless body_or_allowed_comment_lines?(node) ||
+                                                       node.parent_class
+        end
+
+        def on_sclass(node)
+          add_offense(node, message: METACLASS_MSG) unless body_or_allowed_comment_lines?(node)
+        end
+
+        private
+
+        def body_or_allowed_comment_lines?(node)
+          return true if node.body
+
+          cop_config['AllowComments'] && processed_source.contains_comment?(node.source_range)
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,10 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of `if`, `elsif` and `unless` branches without a body.
+      # Checks for the presence of `if`, `elsif` and `unless` branches without a body.
+      #
+      # NOTE: empty `else` branches are handled by `Style/EmptyElse`.
+      #
       # @example
       #   # bad
       #   if condition
@@ -33,6 +36,13 @@ module RuboCop
       #   if condition
       #     do_something
       #   elsif other_condition
+      #     nil
+      #   end
+      #
+      #   # good
+      #   if condition
+      #     do_something
+      #   elsif other_condition
       #     do_something_else
       #   end
       #
@@ -53,13 +63,84 @@ module RuboCop
       #   end
       #
       class EmptyConditionalBody < Base
+        extend AutoCorrector
+        include CommentsHelp
+
         MSG = 'Avoid `%<keyword>s` branches without a body.'
 
         def on_if(node)
-          return if node.body
-          return if cop_config['AllowComments'] && comment_lines?(node)
+          return if node.body || same_line?(node.loc.begin, node.loc.end)
+          return if cop_config['AllowComments'] && contains_comments?(node)
+
+          range = offense_range(node)
+
+          add_offense(range, message: format(MSG, keyword: node.keyword)) do |corrector|
+            next unless can_simplify_conditional?(node)
+
+            flip_orphaned_else(corrector, node)
+          end
+        end
+
+        private
+
+        def offense_range(node)
+          if node.loc.else
+            node.source_range.begin.join(node.loc.else.begin)
+          else
+            node.source_range
+          end
+        end
+
+        def can_simplify_conditional?(node)
+          node.else_branch && node.loc.else.source == 'else'
+        end
+
+        def remove_empty_branch(corrector, node)
+          range = if empty_if_branch?(node) && else_branch?(node)
+                    branch_range(node)
+                  else
+                    deletion_range(branch_range(node))
+                  end
+
+          corrector.remove(range)
+        end
+
+        def flip_orphaned_else(corrector, node)
+          corrector.replace(node.loc.else, "#{node.inverse_keyword} #{node.condition.source}")
+          remove_empty_branch(corrector, node)
+        end
+
+        def empty_if_branch?(node)
+          return false unless (parent = node.parent)
+          return true unless parent.if_type?
+          return true unless (if_branch = parent.if_branch)
+
+          if_branch.if_type? && !if_branch.body
+        end
+
+        def else_branch?(node)
+          node.else_branch && !node.else_branch.if_type?
+        end
+
+        def branch_range(node)
+          if empty_if_branch?(node) && else_branch?(node)
+            node.source_range.with(end_pos: node.loc.else.begin_pos)
+          elsif node.loc.else
+            node.source_range.with(end_pos: node.condition.source_range.end_pos)
+          end
+        end
+
+        def deletion_range(range)
+          # Collect a range between the start of the `if` node and the next relevant node,
+          # including final new line.
+          # Based on `RangeHelp#range_by_whole_lines` but allows the `if` to not start
+          # on the first column.
+          buffer = @processed_source.buffer
+
+          last_line = buffer.source_line(range.last_line)
+          end_offset = last_line.length - range.last_column + 1
 
-          add_offense(node, message: format(MSG, keyword: node.keyword))
+          range.adjust(end_pos: end_offset).intersect(buffer.source_range)
         end
       end
     end

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

@@ -3,40 +3,30 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for empty `ensure` blocks
+      # Checks for empty `ensure` blocks.
       #
       # @example
       #
       #   # bad
-      #
       #   def some_method
       #     do_something
       #   ensure
       #   end
       #
-      # @example
-      #
       #   # bad
-      #
       #   begin
       #     do_something
       #   ensure
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def some_method
       #     do_something
       #   ensure
       #     do_something_else
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   begin
       #     do_something
       #   ensure
@@ -48,11 +38,9 @@ module RuboCop
         MSG = 'Empty `ensure` block detected.'
 
         def on_ensure(node)
-          return if node.body
+          return if node.branch
 
-          add_offense(node.loc.keyword) do |corrector|
-            corrector.remove(node.loc.keyword)
-          end
+          add_offense(node.loc.keyword) { |corrector| corrector.remove(node.loc.keyword) }
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of empty expressions.
+      # Checks for the presence of empty expressions.
       #
       # @example
       #
@@ -14,8 +14,6 @@ module RuboCop
       #     bar
       #   end
       #
-      # @example
-      #
       #   # good
       #
       #   foo = (some_expression)

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop enforces that Ruby source files are not empty.
+      # Enforces that Ruby source files are not empty.
       #
       # @example
       #   # bad
@@ -21,8 +21,6 @@ module RuboCop
       #   # File consisting only of comments
       #
       class EmptyFile < Base
-        include RangeHelp
-
         MSG = 'Empty file detected.'
 
         def on_new_investigation
@@ -40,9 +38,7 @@ module RuboCop
         end
 
         def contains_only_comments?
-          processed_source.lines.all? do |line|
-            line.blank? || comment_line?(line)
-          end
+          processed_source.lines.all? { |line| line.blank? || comment_line?(line) }
         end
       end
     end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Checks for the presence of `in` pattern branches without a body.
+      #
+      # @example
+      #
+      #   # bad
+      #   case condition
+      #   in [a]
+      #     do_something
+      #   in [a, b]
+      #   end
+      #
+      #   # good
+      #   case condition
+      #   in [a]
+      #     do_something
+      #   in [a, b]
+      #     nil
+      #   end
+      #
+      # @example AllowComments: true (default)
+      #
+      #   # good
+      #   case condition
+      #   in [a]
+      #     do_something
+      #   in [a, b]
+      #     # noop
+      #   end
+      #
+      # @example AllowComments: false
+      #
+      #   # bad
+      #   case condition
+      #   in [a]
+      #     do_something
+      #   in [a, b]
+      #     # noop
+      #   end
+      #
+      class EmptyInPattern < Base
+        extend TargetRubyVersion
+        include CommentsHelp
+
+        MSG = 'Avoid `in` branches without a body.'
+
+        minimum_target_ruby_version 2.7
+
+        def on_case_match(node)
+          node.in_pattern_branches.each do |branch|
+            next if branch.body
+            next if cop_config['AllowComments'] && contains_comments?(branch)
+
+            add_offense(branch)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,18 +3,14 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for empty interpolation.
+      # Checks for empty interpolation.
       #
       # @example
       #
       #   # bad
-      #
       #   "result is #{}"
       #
-      # @example
-      #
       #   # good
-      #
       #   "result is #{some_result}"
       class EmptyInterpolation < Base
         include Interpolation
@@ -23,11 +19,11 @@ module RuboCop
         MSG = 'Empty interpolation detected.'
 
         def on_interpolation(begin_node)
-          return unless begin_node.children.empty?
+          node_children = begin_node.children.dup
+          node_children.delete_if { |e| e.nil_type? || (e.basic_literal? && e.str_content&.empty?) }
+          return unless node_children.empty?
 
-          add_offense(begin_node) do |corrector|
-            corrector.remove(begin_node.loc.expression)
-          end
+          add_offense(begin_node) { |corrector| corrector.remove(begin_node) }
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for the presence of `when` branches without a body.
+      # Checks for the presence of `when` branches without a body.
       #
       # @example
       #
@@ -14,8 +14,6 @@ module RuboCop
       #   when baz
       #   end
       #
-      # @example
-      #
       #   # good
       #   case condition
       #   when foo
@@ -45,12 +43,14 @@ module RuboCop
       #   end
       #
       class EmptyWhen < Base
+        include CommentsHelp
+
         MSG = 'Avoid `when` branches without a body.'
 
         def on_case(node)
-          node.each_when do |when_node|
+          node.when_branches.each do |when_node|
             next if when_node.body
-            next if cop_config['AllowComments'] && comment_lines?(node)
+            next if cop_config['AllowComments'] && contains_comments?(when_node)
 
             add_offense(when_node)
           end

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

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop checks for `return` from an `ensure` block.
+      # Checks for `return` from an `ensure` block.
       # `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.
@@ -13,7 +13,6 @@ module RuboCop
       # @example
       #
       #   # bad
-      #
       #   def foo
       #     do_something
       #   ensure
@@ -21,10 +20,7 @@ module RuboCop
       #     return self
       #   end
       #
-      # @example
-      #
       #   # good
-      #
       #   def foo
       #     do_something
       #     self
@@ -32,8 +28,7 @@ module RuboCop
       #     cleanup
       #   end
       #
-      #   # also good
-      #
+      #   # good
       #   def foo
       #     begin
       #       do_something
@@ -45,15 +40,10 @@ module RuboCop
       #     cleanup
       #   end
       class EnsureReturn < Base
-        extend AutoCorrector
-        include RangeHelp
-
         MSG = 'Do not return from an `ensure` block.'
 
         def on_ensure(node)
-          node.body&.each_node(:return) do |return_node|
-            add_offense(return_node)
-          end
+          node.branch&.each_node(:return) { |return_node| add_offense(return_node) }
         end
       end
     end