rubocop 0.89.1 → 0.93.0

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

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces using `def self.method_name` or `class << self` to define class methods.
+      #
+      # @example EnforcedStyle: def_self (default)
+      #   # bad
+      #   class SomeClass
+      #     class << self
+      #       attr_accessor :class_accessor
+      #
+      #       def class_method
+      #         # ...
+      #       end
+      #     end
+      #   end
+      #
+      #   # good
+      #   class SomeClass
+      #     def self.class_method
+      #       # ...
+      #     end
+      #
+      #     class << self
+      #       attr_accessor :class_accessor
+      #     end
+      #   end
+      #
+      #   # good - contains private method
+      #   class SomeClass
+      #     class << self
+      #       attr_accessor :class_accessor
+      #
+      #       private
+      #
+      #       def private_class_method
+      #         # ...
+      #       end
+      #     end
+      #   end
+      #
+      # @example EnforcedStyle: self_class
+      #   # bad
+      #   class SomeClass
+      #     def self.class_method
+      #       # ...
+      #     end
+      #   end
+      #
+      #   # good
+      #   class SomeClass
+      #     class << self
+      #       def class_method
+      #         # ...
+      #       end
+      #     end
+      #   end
+      #
+      class ClassMethodsDefinitions < Base
+        include ConfigurableEnforcedStyle
+        include CommentsHelp
+        include VisibilityHelp
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<preferred>s` to define a class method.'
+        MSG_SCLASS = 'Do not define public methods within class << self.'
+
+        def on_sclass(node)
+          return unless def_self_style?
+          return unless node.identifier.source == 'self'
+          return unless all_methods_public?(node)
+
+          add_offense(node, message: MSG_SCLASS) do |corrector|
+            autocorrect_sclass(node, corrector)
+          end
+        end
+
+        def on_defs(node)
+          return if def_self_style?
+
+          message = format(MSG, preferred: 'class << self')
+          add_offense(node, message: message)
+        end
+
+        private
+
+        def def_self_style?
+          style == :def_self
+        end
+
+        def all_methods_public?(sclass_node)
+          def_nodes = def_nodes(sclass_node)
+          return false if def_nodes.empty?
+
+          def_nodes.all? { |def_node| node_visibility(def_node) == :public }
+        end
+
+        def def_nodes(sclass_node)
+          sclass_def = sclass_node.body
+          return [] unless sclass_def
+
+          if sclass_def.def_type?
+            [sclass_def]
+          elsif sclass_def.begin_type?
+            sclass_def.each_child_node(:def).to_a
+          else
+            []
+          end
+        end
+
+        def autocorrect_sclass(node, corrector)
+          rewritten_defs = []
+
+          def_nodes(node).each do |def_node|
+            next unless node_visibility(def_node) == :public
+
+            range, source = extract_def_from_sclass(def_node, node)
+
+            corrector.remove(range)
+            rewritten_defs << source
+          end
+
+          if sclass_only_has_methods?(node)
+            corrector.remove(node)
+            rewritten_defs.first&.strip!
+          else
+            corrector.insert_after(node, "\n")
+          end
+
+          corrector.insert_after(node, rewritten_defs.join("\n"))
+        end
+
+        def sclass_only_has_methods?(node)
+          node.body.def_type? || node.body.each_child_node.all?(&:def_type?)
+        end
+
+        def extract_def_from_sclass(def_node, sclass_node)
+          range = source_range_with_comment(def_node)
+          source = range.source.sub!(
+            "def #{def_node.method_name}",
+            "def self.#{def_node.method_name}"
+          )
+
+          source = source.gsub(/^ {#{indentation_diff(def_node, sclass_node)}}/, '')
+          [range, source.chomp]
+        end
+
+        def indentation_diff(node1, node2)
+          node1.loc.column - node2.loc.column
+        end
+      end
+    end
+  end
+end

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

@@ -47,14 +47,13 @@ module RuboCop
       #
       class ClassVars < Base
         MSG = 'Replace class var %<class_var>s with a class instance var.'
+        RESTRICT_ON_SEND = %i[class_variable_set].freeze
 
         def on_cvasgn(node)
           add_offense(node.loc.name, message: format(MSG, class_var: node.children.first))
         end
 
         def on_send(node)
-          return unless node.method?(:class_variable_set)
-
           add_offense(
             node.first_argument, message: format(MSG, class_var: node.first_argument.source)
           )

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop checks for places where multiple consecutive loops over the same data
+      # can be combined into a single loop. It is very likely that combining them
+      # will make the code more efficient and more concise.
+      #
+      # It is marked as unsafe, because the first loop might modify
+      # a state that the second loop depends on; these two aren't combinable.
+      #
+      # @example
+      #   # bad
+      #   def method
+      #     items.each do |item|
+      #       do_something(item)
+      #     end
+      #
+      #     items.each do |item|
+      #       do_something_else(item)
+      #     end
+      #   end
+      #
+      #   # good
+      #   def method
+      #     items.each do |item|
+      #       do_something(item)
+      #       do_something_else(item)
+      #     end
+      #   end
+      #
+      #   # bad
+      #   def method
+      #     for item in items do
+      #       do_something(item)
+      #     end
+      #
+      #     for item in items do
+      #       do_something_else(item)
+      #     end
+      #   end
+      #
+      #   # good
+      #   def method
+      #     for item in items do
+      #       do_something(item)
+      #       do_something_else(item)
+      #     end
+      #   end
+      #
+      #   # good
+      #   def method
+      #     each_slice(2) { |slice| do_something(slice) }
+      #     each_slice(3) { |slice| do_something(slice) }
+      #   end
+      #
+      class CombinableLoops < Base
+        MSG = 'Combine this loop with the previous loop.'
+
+        def on_block(node)
+          return unless node.parent&.begin_type?
+          return unless collection_looping_method?(node)
+
+          add_offense(node) if same_collection_looping?(node, node.left_sibling)
+        end
+
+        def on_for(node)
+          return unless node.parent&.begin_type?
+
+          sibling = node.left_sibling
+          add_offense(node) if sibling&.for_type? && node.collection == sibling.collection
+        end
+
+        private
+
+        def collection_looping_method?(node)
+          method_name = node.send_node.method_name
+          method_name.match?(/^each/) || method_name.match?(/_each$/)
+        end
+
+        def same_collection_looping?(node, sibling)
+          sibling&.block_type? &&
+            sibling.send_node.method?(node.method_name) &&
+            sibling.send_node.receiver == node.send_node.receiver &&
+            sibling.send_node.arguments == node.send_node.arguments
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,12 @@ module RuboCop
       # This cop checks that comment annotation keywords are written according
       # to guidelines.
       #
+      # NOTE: With a multiline comment block (where each line is only a
+      # comment), only the first line will be able to register an offense, even
+      # if an annotation keyword starts another line. This is done to prevent
+      # incorrect registering of keywords (eg. `review`) inside a paragraph as an
+      # annotation.
+      #
       # @example
       #   # bad
       #   # TODO make better

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

@@ -33,13 +33,17 @@ module RuboCop
       #   class X # :nodoc:
       #     y
       #   end
-      class CommentedKeyword < Cop
+      class CommentedKeyword < Base
         MSG = 'Do not place comments on the same line as the ' \
               '`%<keyword>s` keyword.'
 
-        def investigate(processed_source)
+        def on_new_investigation
           processed_source.comments.each do |comment|
-            add_offense(comment) if offensive?(comment)
+            next unless (match = line(comment).match(/(?<keyword>\S+).*#/))
+
+            if offensive?(comment)
+              add_offense(comment, message: format(MSG, keyword: match[:keyword]))
+            end
           end
         end
 
@@ -62,11 +66,6 @@ module RuboCop
             ALLOWED_COMMENT_REGEXES.none? { |r| r.match?(line) }
         end
 
-        def message(comment)
-          keyword = line(comment).match(/(\S+).*#/)[1]
-          format(MSG, keyword: keyword)
-        end
-
         def line(comment)
           comment.location.expression.source_line
         end

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

@@ -208,10 +208,11 @@ module RuboCop
       #     some_other_method
       #     bar = 2
       #   end
-      class ConditionalAssignment < Cop
+      class ConditionalAssignment < Base
         include ConditionalAssignmentHelper
         include ConfigurableEnforcedStyle
         include IgnoredNode
+        extend AutoCorrector
 
         MSG = 'Use the return of the conditional for variable assignment ' \
               'and comparison.'
@@ -275,14 +276,6 @@ module RuboCop
           check_node(node, branches)
         end
 
-        def autocorrect(node)
-          if assignment_type?(node)
-            move_assignment_inside_condition(node)
-          else
-            move_assignment_outside_condition(node)
-          end
-        end
-
         private
 
         def check_assignment_to_condition(node)
@@ -298,7 +291,9 @@ module RuboCop
           return unless else_branch
           return if allowed_single_line?([*branches, else_branch])
 
-          add_offense(node, message: ASSIGN_TO_CONDITION_MSG)
+          add_offense(node, message: ASSIGN_TO_CONDITION_MSG) do |corrector|
+            autocorrect(corrector, node)
+          end
         end
 
         def candidate_node?(node)
@@ -326,25 +321,25 @@ module RuboCop
           assignment
         end
 
-        def move_assignment_outside_condition(node)
+        def move_assignment_outside_condition(corrector, node)
           if node.case_type?
-            CaseCorrector.correct(self, node)
+            CaseCorrector.correct(corrector, self, node)
           elsif node.ternary?
-            TernaryCorrector.correct(node)
+            TernaryCorrector.correct(corrector, node)
           elsif node.if? || node.unless?
-            IfCorrector.correct(self, node)
+            IfCorrector.correct(corrector, self, node)
           end
         end
 
-        def move_assignment_inside_condition(node)
+        def move_assignment_inside_condition(corrector, node)
           *_assignment, condition = *node
 
           if ternary_condition?(condition)
-            TernaryCorrector.move_assignment_inside_condition(node)
+            TernaryCorrector.move_assignment_inside_condition(corrector, node)
           elsif condition.case_type?
-            CaseCorrector.move_assignment_inside_condition(node)
+            CaseCorrector.move_assignment_inside_condition(corrector, node)
           elsif condition.if_type?
-            IfCorrector.move_assignment_inside_condition(node)
+            IfCorrector.move_assignment_inside_condition(corrector, node)
           end
         end
 
@@ -371,7 +366,17 @@ module RuboCop
           return if allowed_single_line?(branches)
           return if correction_exceeds_line_limit?(node, branches)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        def autocorrect(corrector, node)
+          if assignment_type?(node)
+            move_assignment_inside_condition(corrector, node)
+          else
+            move_assignment_outside_condition(corrector, node)
+          end
         end
 
         def allowed_statements?(branches)
@@ -499,24 +504,20 @@ module RuboCop
           include ConditionalAssignmentHelper
           include ConditionalCorrectorHelper
 
-          def correct(node)
-            lambda do |corrector|
-              corrector.replace(node, correction(node))
-            end
+          def correct(corrector, node)
+            corrector.replace(node, correction(node))
           end
 
-          def move_assignment_inside_condition(node)
+          def move_assignment_inside_condition(corrector, node)
             *_var, rhs = *node
             if_branch, else_branch = extract_branches(node)
             assignment = assignment(node)
 
-            lambda do |corrector|
-              remove_parentheses(corrector, rhs) if Util.parentheses?(rhs)
-              corrector.remove(assignment)
+            remove_parentheses(corrector, rhs) if Util.parentheses?(rhs)
+            corrector.remove(assignment)
 
-              move_branch_inside_condition(corrector, if_branch, assignment)
-              move_branch_inside_condition(corrector, else_branch, assignment)
-            end
+            move_branch_inside_condition(corrector, if_branch, assignment)
+            move_branch_inside_condition(corrector, else_branch, assignment)
           end
 
           private
@@ -565,22 +566,19 @@ module RuboCop
           include ConditionalAssignmentHelper
           include ConditionalCorrectorHelper
 
-          def correct(cop, node)
-            ->(corrector) { correct_if_branches(corrector, cop, node) }
+          def correct(corrector, cop, node)
+            correct_if_branches(corrector, cop, node)
           end
 
-          def move_assignment_inside_condition(node)
+          def move_assignment_inside_condition(corrector, node)
             column = node.loc.expression.column
             *_var, condition = *node
             assignment = assignment(node)
 
-            lambda do |corrector|
-              corrector.remove(assignment)
+            corrector.remove(assignment)
 
-              condition.branches.flatten.each do |branch|
-                move_branch_inside_condition(corrector, branch, condition,
-                                             assignment, column)
-              end
+            condition.branches.flatten.each do |branch|
+              move_branch_inside_condition(corrector, branch, condition, assignment, column)
             end
           end
 
@@ -614,31 +612,25 @@ module RuboCop
           include ConditionalAssignmentHelper
           include ConditionalCorrectorHelper
 
-          def correct(cop, node)
+          def correct(corrector, cop, node)
             when_branches, else_branch = extract_tail_branches(node)
 
-            lambda do |corrector|
-              corrector.insert_before(node, lhs(else_branch))
-              correct_branches(corrector, when_branches)
-              replace_branch_assignment(corrector, else_branch)
+            corrector.insert_before(node, lhs(else_branch))
+            correct_branches(corrector, when_branches)
+            replace_branch_assignment(corrector, else_branch)
 
-              corrector.insert_before(node.loc.end,
-                                      indent(cop, lhs(else_branch)))
-            end
+            corrector.insert_before(node.loc.end, indent(cop, lhs(else_branch)))
           end
 
-          def move_assignment_inside_condition(node)
+          def move_assignment_inside_condition(corrector, node)
             column = node.loc.expression.column
             *_var, condition = *node
             assignment = assignment(node)
 
-            lambda do |corrector|
-              corrector.remove(assignment)
+            corrector.remove(assignment)
 
-              extract_branches(condition).flatten.each do |branch|
-                move_branch_inside_condition(corrector, branch, condition,
-                                             assignment, column)
-              end
+            extract_branches(condition).flatten.each do |branch|
+              move_branch_inside_condition(corrector, branch, condition, assignment, column)
             end
           end
 
@@ -656,17 +648,14 @@ module RuboCop
             [when_branches, case_node.else_branch]
           end
 
-          def move_branch_inside_condition(corrector, branch, condition,
-                                           assignment, column)
+          def move_branch_inside_condition(corrector, branch, condition, assignment, column)
             branch_assignment = tail(branch)
-            corrector.insert_before(branch_assignment,
-                                    assignment.source)
+            corrector.insert_before(branch_assignment, assignment.source)
 
             remove_whitespace_in_branches(corrector, branch, condition, column)
 
             parent_keyword = branch.parent.loc.keyword
-            corrector.remove_preceding(parent_keyword,
-                                       parent_keyword.column - column)
+            corrector.remove_preceding(parent_keyword, parent_keyword.column - column)
           end
         end
       end