rubocop-canon 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e0b8c697ca4788f1bf6836c36cffa1d3eb6ddbf2e6422416a2a20e3fb85c41
-  data.tar.gz: f07d041294a92e97cff5e83c8bfa05ec9f83cca4c00ac0c1ee3a626d0a2da75a
+  metadata.gz: c71d63b013ac3760733a55c5cc9fd5c48cbcd045a9c9565525300d553bf16ef6
+  data.tar.gz: 6c1a59fe8e78ce2fcaf39dff2a20692095634764a85d2c01dc93b16ff63d5881
 SHA512:
-  metadata.gz: d50e6ec2327f88dcca6a886c87e164a592c13bea20e84c95b081f31299f701c97690b62332bfca9ffe8278260d7129cc28ca658db747220783dfe9706657e25c
-  data.tar.gz: 939c0422bbb87f0a328ae04ccab63c9e816046e8dbbe422faf4879f32d1bd00ceac92e0d840d660ae96e3ead1a13bf5960a3cd7ae2d60c64fb07852d2c61807b
+  metadata.gz: 3f2a09de9e9c0da1498c32d4e3e3966ab25ade537264012ef775bcfbeed2a1ce553d0f0836cdb97ffcbab52c04fccebd1a09dd77b06b149154c7a861768b73b5
+  data.tar.gz: eb62f5fe37820d9063a9eaf2706319053605533c093deea74eab900a94bf6bd4358693e3e5fa9f606e31e68d35dad07950827a61b58216575c2923b51a7eb832

data/lib/rubocop/canon/version.rb

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

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

@@ -3,20 +3,17 @@
 module RuboCop
   module Cop
     module Canon
-      # Enforces the phase structure of a block body.
+      # Enforces the two-phase structure of a block body.
       #
-      # A body checked by this cop ends in a *trailing phase*: the run of
-      # statements that call one of `TrailingMethods`. Exactly one blank line
-      # opens that run. Before it come an arrange phase and, when the last
-      # leading statement is a call rather than an assignment, an act phase
-      # opened by one blank line. Inside a phase no blank line is allowed.
+      # A body checked by this cop has two phases. The *trailing phase* begins
+      # at the first call to one of `TrailingMethods` and runs to the end of
+      # the body, whatever else it holds. Everything before it is the *setup*.
+      # Exactly one blank line separates the two, and no blank line appears
+      # inside either — except around a statement spanning several lines,
+      # which is always set apart.
       #
-      # An assignment cannot end the act phase. When the last statement before
-      # the trailing phase assigns, there is no act: every leading statement
-      # belongs to one arrange phase.
-      #
-      # A statement spanning several lines is always set apart by a blank line
-      # on each side, whatever phase it is in.
+      # There is no act phase and nothing is left to the author: where a blank
+      # line goes follows from the statements alone.
       #
       # `Blocks` names the methods whose blocks are checked and
       # `TrailingMethods` the calls that make up the trailing phase, matched
@@ -24,36 +21,30 @@ module RuboCop
       # the cop does nothing until it is configured.
       #
       # @example Blocks: ['step'], TrailingMethods: ['report']
-      #   # bad — no blank line opens the trailing phase
-      #   step 'totals the order' do
-      #     order = build_order
-      #     report order.total
-      #   end
-      #
-      #   # bad — an assignment is arrange, not act
+      #   # bad
       #   step 'totals the order' do
       #     order = build_order
       #
-      #     total = order.total
-      #
-      #     report total
+      #     settle(order)
+      #     report order.total
       #   end
       #
       #   # good
       #   step 'totals the order' do
       #     order = build_order
-      #     total = order.total
+      #     settle(order)
       #
-      #     report total
+      #     report order.total
       #   end
       #
-      #   # good — the call is the act
-      #   step 'totals the order' do
-      #     order = build_order
-      #
-      #     settle(order)
+      #   # good — everything from the first trailing call on is one phase
+      #   step 'lists the orders' do
+      #     fetch_orders
       #
-      #     report order.total
+      #     report status
+      #     body = parse_body
+      #     reload
+      #     report body
       #   end
       class BlockPhases < Base
         extend AutoCorrector
@@ -61,10 +52,8 @@ module RuboCop
 
         MSG_EXTRA = 'Remove the blank line inside the trailing phase.'
         MSG_MISSING = 'Add a blank line before the trailing phase.'
-        MSG_ARRANGE_SPLIT = 'Remove the blank line inside the arrange phase.'
-        MSG_ACT_UNSEPARATED = 'Add a blank line before the act.'
+        MSG_SETUP_SPLIT = 'Remove the blank line inside the setup.'
         MSG_MULTILINE = 'Add a blank line around the multiline statement.'
-        ASSIGNMENT_TYPES = %i[lvasgn ivasgn cvasgn gvasgn masgn op_asgn or_asgn and_asgn].freeze
 
         def on_block(node)
           return unless configured_block?(node)
@@ -83,40 +72,30 @@ module RuboCop
           trailing_start = detect_trailing_start(statements)
           return if trailing_start.nil?
 
-          check_trailing_phase(statements, trailing_start)
-          check_leading_phases(statements, trailing_start)
+          check_trailing_phase(statements[trailing_start..])
+          check_setup(statements[...trailing_start], statements[trailing_start])
         end
 
-        def check_trailing_phase(statements, trailing_start)
-          statements[trailing_start..].each_cons(2) do |previous, following|
-            if multiline_pair?(previous, following)
-              require_blank_line(previous, following, MSG_MULTILINE)
-            else
-              forbid_blank_line(previous, following, MSG_EXTRA)
-            end
+        def check_trailing_phase(statements)
+          statements.each_cons(2) do |previous, following|
+            check_gap(previous, following, MSG_EXTRA)
           end
         end
 
-        def check_leading_phases(statements, trailing_start)
-          return if trailing_start.zero?
-
-          require_blank_line(statements[trailing_start - 1], statements[trailing_start], MSG_MISSING)
-          leading = statements[..(trailing_start - 1)]
+        def check_setup(statements, first_trailing)
+          return if statements.empty?
 
-          leading.each_cons(2).with_index do |(previous, following), index|
-            check_leading_gap(leading, previous, following, index)
+          require_blank_line(statements.last, first_trailing, MSG_MISSING)
+          statements.each_cons(2) do |previous, following|
+            check_gap(previous, following, MSG_SETUP_SPLIT)
           end
         end
 
-        def check_leading_gap(leading, previous, following, index)
+        def check_gap(previous, following, extra_message)
           if multiline_pair?(previous, following)
             require_blank_line(previous, following, MSG_MULTILINE)
-          elsif assignment?(leading.last)
-            forbid_blank_line(previous, following, MSG_ARRANGE_SPLIT)
-          elsif index == leading.size - 2
-            require_blank_line(previous, following, MSG_ACT_UNSEPARATED)
           else
-            forbid_blank_line(previous, following, MSG_ARRANGE_SPLIT)
+            forbid_blank_line(previous, following, extra_message)
           end
         end
 
@@ -140,20 +119,8 @@ module RuboCop
           multiline?(following)
         end
 
-        def assignment?(node)
-          ASSIGNMENT_TYPES.include?(node.type)
-        end
-
         def detect_trailing_start(statements)
-          trailing_start = nil
-
-          statements.each_with_index.reverse_each do |statement, index|
-            break unless trailing?(statement)
-
-            trailing_start = index
-          end
-
-          trailing_start
+          statements.index { |statement| trailing?(statement) }
         end
 
         def configured_block?(node)

metadata

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