rubocop-canon 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71d63b013ac3760733a55c5cc9fd5c48cbcd045a9c9565525300d553bf16ef6
-  data.tar.gz: 6c1a59fe8e78ce2fcaf39dff2a20692095634764a85d2c01dc93b16ff63d5881
+  metadata.gz: f8b4a8966824947c873a90109b21e96a5d2c3fa1d01c71c3423ffe45afa7864e
+  data.tar.gz: eea9755c6e9ceab22ab0a316c5ec3eb52e3f290baa9cfe1a546adaaa25dc1bb3
 SHA512:
-  metadata.gz: 3f2a09de9e9c0da1498c32d4e3e3966ab25ade537264012ef775bcfbeed2a1ce553d0f0836cdb97ffcbab52c04fccebd1a09dd77b06b149154c7a861768b73b5
-  data.tar.gz: eb62f5fe37820d9063a9eaf2706319053605533c093deea74eab900a94bf6bd4358693e3e5fa9f606e31e68d35dad07950827a61b58216575c2923b51a7eb832
+  metadata.gz: fd398ceccc79ca4d5d8f575dcf9141e84bd0648e7ca673edb166955c56898b65f61efcd4988435cb21831a83485c2972b7e12c97defeb9f5ab7610eead5ad805
+  data.tar.gz: 65d340eb6eec5fba2b6d95c592abc238d869dd047135059089583596558191633f227a7a0e9aaa125383c241fd433214a435a252f03ca511e808f067a432adca

data/lib/rubocop/canon/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Canon
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/rubocop/cop/canon/blank_line_help.rb

@@ -12,6 +12,7 @@ module RuboCop
         include RangeHelp
 
         BLOCK_TYPES = %i[block numblock].freeze
+        MSG_MULTILINE = 'Add a blank line around the multiline statement.'
 
         private
 
@@ -31,6 +32,26 @@ module RuboCop
           node.first_line != node.last_line
         end
 
+        def multiline_pair?(previous, following)
+          return true if multiline?(previous)
+
+          multiline?(following)
+        end
+
+        def require_blank_line(previous, following, message)
+          return if comments_between?(previous, following)
+          return unless blank_lines_between(previous, following).zero?
+
+          register_missing_blank_line(previous, following, message)
+        end
+
+        def forbid_blank_line(previous, following, message)
+          return if comments_between?(previous, following)
+          return unless blank_lines_between(previous, following) == 1
+
+          register_extra_blank_line(previous, message)
+        end
+
         def comments_between?(previous, following)
           processed_source.comments.any? do |comment|
             comment.loc.line >= previous.last_line && comment.loc.line < following.first_line

data/lib/rubocop/cop/canon/block_phases.rb

@@ -53,7 +53,6 @@ module RuboCop
         MSG_EXTRA = 'Remove the blank line inside the trailing phase.'
         MSG_MISSING = 'Add a blank line before the trailing phase.'
         MSG_SETUP_SPLIT = 'Remove the blank line inside the setup.'
-        MSG_MULTILINE = 'Add a blank line around the multiline statement.'
 
         def on_block(node)
           return unless configured_block?(node)
@@ -99,26 +98,6 @@ module RuboCop
           end
         end
 
-        def require_blank_line(previous, following, message)
-          return if comments_between?(previous, following)
-          return unless blank_lines_between(previous, following).zero?
-
-          register_missing_blank_line(previous, following, message)
-        end
-
-        def forbid_blank_line(previous, following, message)
-          return if comments_between?(previous, following)
-          return unless blank_lines_between(previous, following) == 1
-
-          register_extra_blank_line(previous, message)
-        end
-
-        def multiline_pair?(previous, following)
-          return true if multiline?(previous)
-
-          multiline?(following)
-        end
-
         def detect_trailing_start(statements)
           statements.index { |statement| trailing?(statement) }
         end

data/lib/rubocop/cop/canon/method_body_blank_lines.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Canon
       # Enforces blank lines around a method body's standalone calls and
-      # nowhere else.
+      # multiline statements, and nowhere else.
       #
       # `SeparatedMethods` names the calls that stand on their own —
       # `authorize!`, `expose`, `mail`. Each takes exactly one blank line
@@ -15,8 +15,15 @@ module RuboCop
       # The list is empty by default, so the cop only removes until it is
       # configured.
       #
-      # The position after a guard clause belongs to
-      # `Layout/EmptyLineAfterGuardClause`, so this cop leaves it alone.
+      # Guard clauses group: two in a row take no blank line between them.
+      # The position after the last guard belongs to
+      # `Layout/EmptyLineAfterGuardClause`, so this cop leaves it alone — and
+      # recognises a guard by that cop's own definition: an `if` whose branch
+      # is a single-line `return`, `break`, `next`, `raise` or `fail`. A bare
+      # `raise` on its own line is a statement, not a guard.
+      #
+      # A statement spanning several lines is always set apart by a blank
+      # line on each side, guards included.
       #
       # An entry matches a method name anywhere in the call chain. Write it
       # dotted — `errors.add` — to match a receiver and method together, so
@@ -47,12 +54,12 @@ module RuboCop
       #     Current.account = nil
       #   end
       #
-      #   # good — the guard clause owns its own blank line
+      #   # good — guards group, and the last one owns the blank line after it
       #   def total
-      #     items = order.items
-      #     return 0 if items.empty?
+      #     return 0 if order.nil?
+      #     return 0 if order.items.empty?
       #
-      #     items.sum(&:amount)
+      #     order.items.sum(&:amount)
       #   end
       class MethodBodyBlankLines < Base
         extend AutoCorrector
@@ -60,7 +67,7 @@ module RuboCop
 
         MSG_EXTRA = 'Remove the blank line inside the method body.'
         MSG_MISSING = 'Add a blank line around the standalone call.'
-        JUMP_METHODS = %i[raise fail throw].freeze
+        JUMP_METHODS = %i[raise fail].freeze
 
         def on_def(node)
           check_method_body(node)
@@ -77,29 +84,32 @@ module RuboCop
           return if statements.size < 2
 
           statements.each_cons(2) do |previous, following|
-            next if guard?(previous)
+            next if guard_boundary?(previous, following)
 
-            check_gap(previous, following, expected_blank_lines(previous, following))
+            check_gap(previous, following)
           end
         end
 
-        def check_gap(previous, following, expected)
-          return if comments_between?(previous, following)
-
-          blank_lines = blank_lines_between(previous, following)
-          return if blank_lines == expected
-          return if blank_lines > 1
+        def guard_boundary?(previous, following)
+          return false unless guard?(previous)
 
-          return register_extra_blank_line(previous, MSG_EXTRA) if expected.zero?
+          !guard?(following)
+        end
 
-          register_missing_blank_line(previous, following, MSG_MISSING)
+        def check_gap(previous, following)
+          if multiline_pair?(previous, following)
+            require_blank_line(previous, following, MSG_MULTILINE)
+          elsif separated_pair?(previous, following)
+            require_blank_line(previous, following, MSG_MISSING)
+          else
+            forbid_blank_line(previous, following, MSG_EXTRA)
+          end
         end
 
-        def expected_blank_lines(previous, following)
-          return 1 if separated?(previous)
-          return 1 if separated?(following)
+        def separated_pair?(previous, following)
+          return true if separated?(previous)
 
-          0
+          separated?(following)
         end
 
         def separated?(node)
@@ -116,21 +126,23 @@ module RuboCop
         end
 
         def guard?(node)
-          return true if jump?(node)
           return false unless node.if_type?
-          return false unless node.modifier_form?
-          return true if jump?(node.if_branch)
 
-          jump?(node.else_branch)
+          branch = node.if_branch
+          return false if branch.nil?
+          return true if branch.guard_clause?
+
+          jump?(branch)
         end
 
         def jump?(node)
-          return false if node.nil?
           return true if node.return_type?
           return true if node.break_type?
           return true if node.next_type?
+          return false unless node.send_type?
+          return false unless node.receiver.nil?
 
-          node.send_type? && JUMP_METHODS.include?(node.method_name)
+          JUMP_METHODS.include?(node.method_name)
         end
 
         def separated_methods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-canon
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - skiftle