Bug 22236: Translation should generate tags with consistent attribute order
authorMarcel de Rooy <m.de.rooy@rijksmuseum.nl>
Wed, 30 Jan 2019 15:37:10 +0000 (15:37 +0000)
committerNick Clemens <nick@bywatersolutions.com>
Mon, 4 Feb 2019 14:40:46 +0000 (14:40 +0000)
When running misc/translator/translate, the order of attributes in the translated templates is not consistent and may vary. This is caused by the random order of hash keys in perl.

This causes things like this in run 1:
<input type="submit" class="btn" value="Plaats aanvraag" />
And this in run 2:
<input value="Plaats aanvraag" type="submit" class="btn" />
As you can see, there is actually no difference apart from the order.

When comparing the result of various translation runs, I would rather get rid of such noise and only see the real changes.

The needed change is not trivial to find, but only requires a simple addition to a sort operation in tmpl_process3.pl. The current sort only makes sure that the '/' comes at the end. We should sort the names of the keys too when this value is 0 (just meaning: no end tag symbol).

Test plan:
[1] Run a translation without this patch and set a few templates aside.
[2] Run a translation with this patch.
[3] Run a compare (diff) on the templates copied in step 1. Verify that the
    only changes are found in the sort order of attributes in html tags.

Signed-off-by: Pierre-Marc Thibault <pierre-marc.thibault@inLibro.com>

Signed-off-by: Josef Moravec <josef.moravec@gmail.com>

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

misc/translator/tmpl_process3.pl

index e39e64c..6f4c39e 100755 (executable)
@@ -91,6 +91,7 @@ sub text_replace_tag ($$) {
                          
               } sort {
                   $attr->{$a}->[3] <=> $attr->{$b}->[3] #FIXME
+                      || $a cmp $b # Sort attributes BZ 22236
               } keys %$attr);
         $it .= '>';
     }