rubocop-aaa 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88bb8909e976646d38fa8d819807e978ad8e2db91592ee69fe1e8f848dc13692
-  data.tar.gz: 84ae0416f47272ccdcf38fc48b55c060106b96cff1b5828075da5aaf4886140a
+  metadata.gz: e6004f573b4c0674b182fb676a0736cb40e9bbe92118c0c77e50ffb9c4f3c035
+  data.tar.gz: 0aa8a6cb45918ee3a50aa68bcaea9e97808c5166386c271a646b0749ea4654e9
 SHA512:
-  metadata.gz: 5eea4bdadc3cbc5755f3c40d300dc188df672d20032c2781fd832d65c5fe795f020e1834c288acf271492450933d7f5ff9938b2bcbce28ab9e51749a60a979a3
-  data.tar.gz: 6a8e83b998e8e385064ee34311bd280ea9c6ae251a2ed4a9ad081790e564233283052ae4221a4d163340a04894d14001af6d8ef82cfb1d517b166802f9be2b80
+  metadata.gz: 8efaad9641a3826f7a343d06d0b3b489e4046e572831923015c80a868f146006e519ce82e30126515b6c0fb98c6b2bc0d0494803d2c2358e28f7d5cc491a0d72
+  data.tar.gz: f1ed6f5e2ba4596918841a93c4d081ef20109e18335da6bb00900e21132addedb03bf62fb950302da25e09ab1b3a2a3c82f1d6927e790fb97830b31e22159fb3

data/README.md

@@ -83,6 +83,12 @@ AAA/Pattern:
     assert:  [検証, 確認]
 ```
 
+## Auto-correct
+
+When **all three** section comments are missing, `rubocop -a` (or `rubocop --autocorrect`) inserts a `# arrange` / `# act` / `# assert` template at the top of the block. You then move each comment above the code that belongs to it.
+
+Other cases — one or two sections missing, wrong order, empty section — are reported with explicit hints in the offense message but are not auto-corrected, because the correct insertion point depends on the test's intent.
+
 ## License
 
 MIT

data/lib/rubocop/cop/aaa/pattern.rb

@@ -2,11 +2,16 @@ module RuboCop
   module Cop
     module AAA
       class Pattern < Base
+        extend AutoCorrector
+
         SECTIONS = %i[arrange act assert].freeze
 
-        MSG_MISSING = 'Missing "%<section>s" comment in test block.'.freeze
-        MSG_ORDER   = 'AAA comments must appear in order: arrange -> act -> assert.'.freeze
-        MSG_EMPTY   = 'Section "%<section>s" has no statements.'.freeze
+        MSG_MISSING_ALL = 'Missing arrange/act/assert section comments. Insert # %<arrange>s, # %<act>s, and # %<assert>s to mark each section (auto-correct scaffolds a template at the top of the block).'.freeze
+        MSG_MISSING_ARRANGE = 'Missing "arrange" comment. Insert # %<label>s before the code that sets up test state.'.freeze
+        MSG_MISSING_ACT     = 'Missing "act" comment. Insert # %<label>s before the code that triggers the behavior under test.'.freeze
+        MSG_MISSING_ASSERT  = 'Missing "assert" comment. Insert # %<label>s before the code that verifies the result.'.freeze
+        MSG_ORDER = 'AAA comments must appear in order: arrange -> act -> assert. Found "%<found>s" after "%<previous>s".'.freeze
+        MSG_EMPTY = 'Section "%<section>s" has no statements. Add code between # %<section>s and the next section, or remove the # %<section>s comment.'.freeze
 
         DEFAULT_LABELS = {
           'arrange' => %w[arrange],
@@ -23,19 +28,27 @@ module RuboCop
           seen = {}
           found.each { |section, comment| seen[section] ||= comment }
 
-          SECTIONS.each do |section|
-            unless seen[section]
-              add_offense(node, message: format(MSG_MISSING, section: section))
-              return
-            end
+          missing = SECTIONS.reject { |s| seen[s] }
+
+          if missing.size == SECTIONS.size
+            report_all_missing(node)
+            return
+          end
+
+          unless missing.empty?
+            missing.each { |s| report_missing_one(node, s) }
+            return
           end
 
           ordered = SECTIONS.map { |s| seen[s] }
           (1...ordered.size).each do |i|
-            if ordered[i].loc.expression.begin_pos < ordered[i - 1].loc.expression.begin_pos
-              add_offense(ordered[i], message: MSG_ORDER)
-              return
-            end
+            next unless ordered[i].loc.expression.begin_pos < ordered[i - 1].loc.expression.begin_pos
+
+            add_offense(
+              ordered[i],
+              message: format(MSG_ORDER, found: SECTIONS[i], previous: SECTIONS[i - 1])
+            )
+            return
           end
 
           return if allow_empty_section?
@@ -46,6 +59,64 @@ module RuboCop
 
         private
 
+        def report_all_missing(node)
+          labels_for_template = {
+            arrange: preferred_label('arrange'),
+            act:     preferred_label('act'),
+            assert:  preferred_label('assert')
+          }
+          message = format(MSG_MISSING_ALL, labels_for_template)
+
+          add_offense(node, message: message) do |corrector|
+            insert_template(corrector, node, labels_for_template)
+          end
+        end
+
+        def report_missing_one(node, section)
+          message_template = {
+            arrange: MSG_MISSING_ARRANGE,
+            act:     MSG_MISSING_ACT,
+            assert:  MSG_MISSING_ASSERT
+          }[section]
+          # Anchor each offense to a distinct location so RuboCop does not dedupe
+          # them when multiple sections are missing.
+          location = {
+            arrange: node.send_node.loc.expression,
+            act:     node.loc.begin,
+            assert:  node.loc.end
+          }[section]
+          add_offense(location, message: format(message_template, label: preferred_label(section.to_s)))
+        end
+
+        def insert_template(corrector, node, labels_for_template)
+          source = processed_source.raw_source
+          block_start = node.loc.begin.end_pos # position right after "do" / "{"
+          indent = detect_indent(node, block_start)
+
+          template = +"\n#{indent}# #{labels_for_template[:arrange]}"
+          template << "\n#{indent}# #{labels_for_template[:act]}"
+          template << "\n#{indent}# #{labels_for_template[:assert]}"
+
+          corrector.insert_after(node.loc.begin, template)
+        end
+
+        def detect_indent(node, block_start)
+          source = processed_source.raw_source
+          # Prefer the indentation of the first line of body content.
+          tail = source[block_start..-1] || ''
+          tail.each_line do |line|
+            next if line.strip.empty?
+
+            stripped = line.sub(/^\n/, '')
+            match = stripped.match(/\A([ \t]*)\S/)
+            return match[1] if match
+          end
+          # Fallback: use the block's own indent + 2 spaces.
+          block_line = source[0...node.loc.expression.begin_pos].rpartition("\n").last
+          lead = block_line.match(/\A[ \t]*/)[0]
+          "#{lead}  "
+        end
+
         def collect_sections(node)
           block_range = node.loc.expression
           processed_source.comments.each_with_object([]) do |comment, acc|
@@ -98,6 +169,10 @@ module RuboCop
           comment.text.sub(/\A#\s*/, '').strip
         end
 
+        def preferred_label(section)
+          (labels[section] && labels[section].first) || section
+        end
+
         def test_method?(name)
           test_functions.include?(name.to_s)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-aaa
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - babu-ch