rubocop-canon 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24d224c2ecf5e361f702c300a79778baf8ad63247fb726cb8c39b89534d7dd3f
-  data.tar.gz: 8e4e0ca31f844a61bdba984c2efd2ccadb2d0ddea11693f38dc452c9b356e40c
+  metadata.gz: 26e0b8c697ca4788f1bf6836c36cffa1d3eb6ddbf2e6422416a2a20e3fb85c41
+  data.tar.gz: f07d041294a92e97cff5e83c8bfa05ec9f83cca4c00ac0c1ee3a626d0a2da75a
 SHA512:
-  metadata.gz: b1eea01a2c5652d7513ccfe08b048cd61817f4f20c3dcb757c5e7b0e96ac99c92d0b52f1840d40b69a9c3c5b2eced42444c22ae29ed3461eedc83c1dbd4b5081
-  data.tar.gz: 98f0a6237ae0b71995af7bf03e8d8b46bcf83ebd92f3fa0ddf81f607a503ab71061b365f2e19a05279702791998be00d7cd1d621224dcdd965ae79d2d3fc2d84
+  metadata.gz: d50e6ec2327f88dcca6a886c87e164a592c13bea20e84c95b081f31299f701c97690b62332bfca9ffe8278260d7129cc28ca658db747220783dfe9706657e25c
+  data.tar.gz: 939c0422bbb87f0a328ae04ccab63c9e816046e8dbbe422faf4879f32d1bd00ceac92e0d840d660ae96e3ead1a13bf5960a3cd7ae2d60c64fb07852d2c61807b

data/README.md

@@ -40,7 +40,6 @@ Canon/BlockPhases:
     - it
   TrailingMethods:          # calls that make up the trailing phase (required)
     - expect
-  MaxPhases: 3              # phases allowed before the trailing one
 
 Canon/DeclarationGroups:
   GroupedMethods:           # method names that form one group

data/config/default.yml

@@ -3,7 +3,6 @@ Canon/BlockPhases:
   Enabled: false
   VersionAdded: '0.2'
   Blocks: []
-  MaxPhases: 3
   TrailingMethods: []
 
 Canon/DeclarationGroups:

data/lib/rubocop/canon/version.rb

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

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

@@ -27,6 +27,10 @@ module RuboCop
           following.first_line - previous.last_line - 1
         end
 
+        def multiline?(node)
+          node.first_line != node.last_line
+        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

@@ -7,18 +7,22 @@ module RuboCop
       #
       # 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, no blank line splits it, and the statements before it
-      # form at most `MaxPhases` - 1 further phases.
+      # 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.
+      #
+      # 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.
       #
       # `Blocks` names the methods whose blocks are checked and
       # `TrailingMethods` the calls that make up the trailing phase, matched
       # against the leftmost call in a chain. Both are empty by default, so
       # the cop does nothing until it is configured.
       #
-      # A body carrying more phases than `MaxPhases` allows keeps the last
-      # separator before the trailing phase and loses the earlier ones —
-      # everything ahead of the last leading statement is one phase.
-      #
       # @example Blocks: ['step'], TrailingMethods: ['report']
       #   # bad — no blank line opens the trailing phase
       #   step 'totals the order' do
@@ -26,21 +30,30 @@ module RuboCop
       #     report order.total
       #   end
       #
-      #   # bad — a blank line splits the trailing phase
+      #   # bad — an assignment is arrange, not act
       #   step 'totals the order' do
       #     order = build_order
       #
-      #     report order.total
+      #     total = order.total
       #
-      #     report order.currency
+      #     report total
       #   end
       #
       #   # good
       #   step 'totals the order' do
       #     order = build_order
+      #     total = order.total
+      #
+      #     report total
+      #   end
+      #
+      #   # good — the call is the act
+      #   step 'totals the order' do
+      #     order = build_order
+      #
+      #     settle(order)
       #
       #     report order.total
-      #     report order.currency
       #   end
       class BlockPhases < Base
         extend AutoCorrector
@@ -48,7 +61,10 @@ module RuboCop
 
         MSG_EXTRA = 'Remove the blank line inside the trailing phase.'
         MSG_MISSING = 'Add a blank line before the trailing phase.'
-        MSG_TOO_MANY_PHASES = 'Use at most %<max_phases>d phases in a block body.'
+        MSG_ARRANGE_SPLIT = 'Remove the blank line inside the arrange phase.'
+        MSG_ACT_UNSEPARATED = 'Add a blank line before the act.'
+        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)
@@ -73,44 +89,59 @@ module RuboCop
 
         def check_trailing_phase(statements, trailing_start)
           statements[trailing_start..].each_cons(2) do |previous, following|
-            next if comments_between?(previous, following)
-            next if blank_lines_between(previous, following) != 1
-
-            register_extra_blank_line(previous, MSG_EXTRA)
+            if multiline_pair?(previous, following)
+              require_blank_line(previous, following, MSG_MULTILINE)
+            else
+              forbid_blank_line(previous, following, MSG_EXTRA)
+            end
           end
         end
 
         def check_leading_phases(statements, trailing_start)
           return if trailing_start.zero?
 
-          check_separator(statements[trailing_start - 1], statements[trailing_start])
-          check_phase_count(statements[..(trailing_start - 1)])
+          require_blank_line(statements[trailing_start - 1], statements[trailing_start], MSG_MISSING)
+          leading = statements[..(trailing_start - 1)]
+
+          leading.each_cons(2).with_index do |(previous, following), index|
+            check_leading_gap(leading, previous, following, index)
+          end
+        end
+
+        def check_leading_gap(leading, previous, following, index)
+          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)
+          end
         end
 
-        def check_separator(previous, following)
+        def require_blank_line(previous, following, message)
           return if comments_between?(previous, following)
-          return if blank_lines_between(previous, following) == 1
+          return unless blank_lines_between(previous, following).zero?
 
-          register_missing_blank_line(previous, following, MSG_MISSING)
+          register_missing_blank_line(previous, following, message)
         end
 
-        def check_phase_count(statements)
-          separators = leading_separators(statements)
-          return if separators.size < max_phases - 1
-
-          surplus = separators[0..-(max_phases - 1)]
+        def forbid_blank_line(previous, following, message)
+          return if comments_between?(previous, following)
+          return unless blank_lines_between(previous, following) == 1
 
-          surplus.each do |previous|
-            register_extra_blank_line(previous, format(MSG_TOO_MANY_PHASES, max_phases:))
-          end
+          register_extra_blank_line(previous, message)
         end
 
-        def leading_separators(statements)
-          statements.each_cons(2).filter_map do |previous, following|
-            next if comments_between?(previous, following)
+        def multiline_pair?(previous, following)
+          return true if multiline?(previous)
 
-            previous if blank_lines_between(previous, following) == 1
-          end
+          multiline?(following)
+        end
+
+        def assignment?(node)
+          ASSIGNMENT_TYPES.include?(node.type)
         end
 
         def detect_trailing_start(statements)
@@ -145,10 +176,6 @@ module RuboCop
         def trailing_methods
           @trailing_methods ||= Array(cop_config['TrailingMethods']).map(&:to_s)
         end
-
-        def max_phases
-          cop_config['MaxPhases']
-        end
       end
     end
   end

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

@@ -12,10 +12,10 @@ module RuboCop
       # cop says nothing about a method name it has not been given, so a DSL
       # it does not know stays as its author wrote it.
       #
-      # A block is a group of one whatever it calls, so a DSL block always
-      # stands apart from the declarations around it. Everything else the cop
-      # has not been told about — an unlisted method name, a constant — it
-      # leaves alone.
+      # A declaration spanning several lines, and any block, is a group of one
+      # whatever it calls, so it always stands apart from its neighbours.
+      # Everything else the cop has not been told about — an unlisted method
+      # name on one line, a constant — it leaves alone.
       #
       # @example GroupedMethods: [[belongs_to, has_many], [validate, validates]]
       #   # bad
@@ -112,7 +112,9 @@ module RuboCop
         end
 
         def standalone?(node)
-          STANDALONE_TYPES.include?(node.type)
+          return true if STANDALONE_TYPES.include?(node.type)
+
+          multiline?(node)
         end
 
         def group_key(node)

metadata

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