rubocop-canon 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdf44fc516121d61d209401a8c2b58f4603ce3d3c7951ec9a232a4acc8cc5175
-  data.tar.gz: 7881f90e36d55ba4bc3a7cd940640827ab91973e53c13d494da72058ba837c43
+  metadata.gz: 24d224c2ecf5e361f702c300a79778baf8ad63247fb726cb8c39b89534d7dd3f
+  data.tar.gz: 8e4e0ca31f844a61bdba984c2efd2ccadb2d0ddea11693f38dc452c9b356e40c
 SHA512:
-  metadata.gz: 9903f67032ee8161d257aee6f9a773def334c7537eb2e9f066ac0a90bf1fa3dabe21f96a9e7208575ead7baabbef0bb7013ad22502f8a76c2ebbd6a7487f5569
-  data.tar.gz: fcf0cd9d4304f5dee4bb21d73d914a58e8dc240c17f3d55dfedfca2a8ee766368437871a899dd76eb607f81ef616cb7c31fe7b6221d23119b9dba02ccf020c7b
+  metadata.gz: b1eea01a2c5652d7513ccfe08b048cd61817f4f20c3dcb757c5e7b0e96ac99c92d0b52f1840d40b69a9c3c5b2eced42444c22ae29ed3461eedc83c1dbd4b5081
+  data.tar.gz: 98f0a6237ae0b71995af7bf03e8d8b46bcf83ebd92f3fa0ddf81f607a503ab71061b365f2e19a05279702791998be00d7cd1d621224dcdd965ae79d2d3fc2d84

data/lib/rubocop/canon/version.rb

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

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

@@ -15,6 +15,10 @@ module RuboCop
       # 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
@@ -91,12 +95,22 @@ module RuboCop
         end
 
         def check_phase_count(statements)
-          separators = statements.each_cons(2).count do |previous, following|
-            blank_lines_between(previous, following).positive?
+          separators = leading_separators(statements)
+          return if separators.size < max_phases - 1
+
+          surplus = separators[0..-(max_phases - 1)]
+
+          surplus.each do |previous|
+            register_extra_blank_line(previous, format(MSG_TOO_MANY_PHASES, max_phases:))
           end
-          return if separators < max_phases - 1
+        end
 
-          add_offense(statements.first, message: format(MSG_TOO_MANY_PHASES, max_phases:))
+        def leading_separators(statements)
+          statements.each_cons(2).filter_map do |previous, following|
+            next if comments_between?(previous, following)
+
+            previous if blank_lines_between(previous, following) == 1
+          end
         end
 
         def detect_trailing_start(statements)

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

@@ -6,31 +6,26 @@ module RuboCop
       # Enforces blank lines between declaration groups in a class, module or
       # DSL block body.
       #
-      # Two declarations belong to the same group when they call the same
-      # method and both fit on one line. A declaration spanning several lines,
-      # and any block, is a group of one. Groups are separated by exactly one
-      # blank line; declarations inside a group are not separated at all.
+      # `GroupedMethods` is the whole specification: two declarations calling
+      # methods listed in the same group take no blank line between them, and
+      # two calling methods listed in different groups take exactly one. The
+      # 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.
       #
-      # `GroupedMethods` merges method names that belong to one group.
+      # 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.
       #
-      # @example
+      # @example GroupedMethods: [[belongs_to, has_many], [validate, validates]]
       #   # bad
       #   class Shift < ApplicationRecord
-      #     belongs_to :service
-      #
-      #     belongs_to :site
-      #     validates :starts_at, presence: true
-      #   end
-      #
-      #   # good
-      #   class Shift < ApplicationRecord
-      #     belongs_to :service
       #     belongs_to :site
       #
+      #     has_many :shift_assignments, dependent: :destroy
       #     validates :starts_at, presence: true
       #   end
       #
-      # @example GroupedMethods: [[belongs_to, has_many]]
       #   # good
       #   class Shift < ApplicationRecord
       #     belongs_to :site
@@ -38,6 +33,12 @@ module RuboCop
       #
       #     validates :starts_at, presence: true
       #   end
+      #
+      #   # good — neither name is listed, so the cop leaves the body alone
+      #   class Filtering < Capability::Base
+      #     request_transformer RequestTransformer
+      #     api_builder APIBuilder
+      #   end
       class DeclarationGroups < Base
         extend AutoCorrector
         include BlankLineHelp
@@ -46,7 +47,8 @@ module RuboCop
         MSG_MISSING = 'Add a blank line between declaration groups.'
         ACCESS_MODIFIERS = %i[private protected public module_function private_class_method].freeze
         DEFINITION_TYPES = %i[def defs].freeze
-        DECLARATION_TYPES = %i[casgn block numblock def defs].freeze
+        BLOCK_TYPES = %i[block numblock].freeze
+        STANDALONE_TYPES = %i[block numblock def defs].freeze
 
         def on_class(node)
           check_declarations(node)
@@ -75,6 +77,7 @@ module RuboCop
             next if definitions?(previous, following)
             next if access_modifier?(previous)
             next if access_modifier?(following)
+            next unless grouped?(previous, following)
 
             check_gap(previous, following, expected_blank_lines(previous, following))
           end
@@ -92,26 +95,30 @@ module RuboCop
           register_missing_blank_line(previous, following, MSG_MISSING)
         end
 
+        def grouped?(previous, following)
+          return true if standalone?(previous)
+          return true if standalone?(following)
+          return false if group_key(previous).nil?
+
+          !group_key(following).nil?
+        end
+
         def expected_blank_lines(previous, following)
+          return 1 if standalone?(previous)
+          return 1 if standalone?(following)
           return 0 if group_key(previous) == group_key(following)
 
           1
         end
 
-        def group_key(node)
-          return node.object_id if multiline?(node)
-          return :constant if node.casgn_type?
-          return node.object_id unless node.send_type?
-
-          grouped_key(node.method_name)
+        def standalone?(node)
+          STANDALONE_TYPES.include?(node.type)
         end
 
-        def grouped_key(method_name)
-          name = method_name.to_s
-          group_index = grouped_methods.index { |group| group.include?(name) }
-          return name if group_index.nil?
+        def group_key(node)
+          return unless node.send_type?
 
-          group_index
+          grouped_methods.index { |group| group.include?(node.method_name.to_s) }
         end
 
         def declaration_context?(node)
@@ -123,7 +130,9 @@ module RuboCop
         end
 
         def declaration?(node)
-          return true if DECLARATION_TYPES.include?(node.type)
+          return true if node.casgn_type?
+          return true if DEFINITION_TYPES.include?(node.type)
+          return node.send_node.receiver.nil? if BLOCK_TYPES.include?(node.type)
 
           node.send_type? && node.receiver.nil?
         end
@@ -139,10 +148,6 @@ module RuboCop
           ACCESS_MODIFIERS.include?(node.method_name)
         end
 
-        def multiline?(node)
-          node.first_line != node.last_line
-        end
-
         def grouped_methods
           @grouped_methods ||= Array(cop_config['GroupedMethods']).map { |group| Array(group).map(&:to_s) }
         end

metadata

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