Skip to content

MBlock-Migration: Felder nach Kommentar am Zeilenende und mit Block-Index > 0 - #473

Merged
skerbis merged 2 commits into
mainfrom
fix/mblock-analyzer-trailing-comments
Nov 7, 2026
Merged

skerbis merged 2 commits into
mainfrom
fix/mblock-analyzer-trailing-comments

Conversation

@skerbis

@skerbis skerbis commented Nov 7, 2026 •

Copy link
Copy Markdown
Member

Problem

Beim Umstellen eines bestehenden Projekts (REDAXO 5.21, sechs MBlock-Module) hat mform:migrate Felder übersehen. Zwei Ursachen:

  1. Kommentar am Zeilenende: In älteren Modulen steht oft $mform->addTextField("$id.0.alt", [...]); // use string for x.0 json values. formRegion() zerlegt den Code an ; – der Kommentar landet am Anfang der nächsten Anweisung, die dann nicht mehr mit $mform-> beginnt und ausgeblendet wird. Folge: Diese Felder fehlen in Analyse, Key-Map und Konvertierung. Besonders unangenehm bei addCustomLinkField("$id.0.1") – die Daten werden dann nicht von 1 auf link umbenannt.
  2. Block-Index ungleich 0: "$id.2.extern" / "$id.3.content" wurden weder erkannt noch im Eingabe-Code umgeschrieben. MBlock nummeriert den Index beim Speichern ohnehin um und speichert nur extern bzw. content.

Lösung

  • MBlockModuleAnalyzer::formRegion(): Für die Zuordnung zum Formular werden führende //- und #-Kommentarzeilen einer Anweisung übersprungen (#[ für Attribute bleibt ausgenommen, wie in blankComments()).
  • Analyzer und Konverter akzeptieren jeden Block-Index (\.\d+\. statt \.0\.), auch bei verschachtelten Namen.
  • CHANGELOG (10.0.7, unveröffentlicht).

Tests

Neue Fixture mblock_trailing_comments_input.php.txt (Muster aus dem Praxisfall, ohne Projektdaten) und drei Tests:

  • testKeepsFieldsAfterTrailingComments – Custom-Link, alt und Feld nach #-Kommentar werden erkannt, Key-Map 1 => link.
  • testRecognizesFieldsWithNonZeroBlockIndex – "$id.2.target", "$id.3.content".
  • testConvertInputStripsNonZeroBlockIndexAndKeepsCommentedLines – Konverter schreibt alle Felder um.

Ohne die Korrektur schlagen die drei neuen Tests fehl; mit ihr: OK (64 tests, 252 assertions).

Summary by CodeRabbit

  • Fehlerbehebungen
    • Die MBlock-Migration erkennt Felder auch bei Block-Indizes größer als 0 und konvertiert ihre Feldnamen korrekt.
    • Kommentare am Ende von Anweisungen verhindern nicht mehr, dass nachfolgende Felder erkannt und zugeordnet werden.

…ndex > 0

Der Analyzer ordnete Anweisungen nach einer Zeile mit Kommentar am Ende nicht
mehr dem Block-Formular zu (Kommentar stand am Anfang der Folgeanweisung).
Felder wie "$id.2.extern" wurden nicht erkannt und nicht konvertiert.
Tests und Fixture ergänzt.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

Moin. Der Analyzer und der Konverter erkennen bei der MBlock-Migration Feldnamen mit beliebigen numerischen Block-Indizes. Der Analyzer überspringt außerdem führende Zeilenendkommentare bei der Prüfung von Statements. Neue Tests und eine Fixture prüfen diese Fälle.

Changes

MBlock-Migration

Layer / File(s) Summary
Felderkennung und Präfixkonvertierung
lib/MForm/Migration/MBlockModuleAnalyzer.php, lib/MForm/Migration/MBlockToRepeaterConverter.php, tests/Fixtures/mblock_trailing_comments_input.php.txt, tests/Unit/Migration/MBlockModuleAnalyzerTest.php, tests/Unit/Migration/MBlockToRepeaterConverterTest.php, CHANGELOG.md
Der Analyzer erkennt Felder mit beliebigen numerischen Block-Indizes und entfernt führende Zeilenendkommentare aus dem Statement-Probe-Text. Der Konverter entfernt Präfixe mit beliebigen numerischen Block-Indizes. Tests und Fixture prüfen die Feldzuordnung und die konvertierte Ausgabe. Der Changelog dokumentiert die Änderungen.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Possibly related PRs

  • FriendsOfREDAXO/mform#468: PR #468 wendet bearbeitete Key-Maps auf erkannte Analysefelder und die Konvertierung an. PR #473 erweitert die Felderkennung und Key-Map für Kommentare und Block-Indizes größer als 0.
Merge Risk: Moderate · up to 581e5

Fix the migration before merging: existing links can disappear from their fields, and unrelated labels can be altered. Conversion notices also misidentify the removed prefixes.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@skerbis
skerbis merged commit f962d95 into main Nov 7, 2026
5 checks passed
@skerbis
skerbis deleted the fix/mblock-analyzer-trailing-comments branch November 7, 2026 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant