Merge pull request #225 from asmecher/xliff-set-ids

#224 Allow for setting custom ID to avoid translation clobbering

Author: oscarotero

src/Extractors/Xliff.php

@@ -11,11 +11,18 @@
  */
 class Xliff extends Extractor implements ExtractorInterface
 {
+
+    public static $options = [
+        'unitid_as_id' => false
+    ];
+
     /**
      * {@inheritdoc}
      */
     public static function fromString($string, Translations $translations, array $options = [])
     {
+        $options += static::$options;
+
         $xml = new SimpleXMLElement($string, null, false);
 
         foreach ($xml->file as $file) {
@@ -35,7 +42,11 @@ public static function fromString($string, Translations $translations, array $op
 
                     $translation = new Translation(null, (string) $segment->source);
                     if (isset($unit['id'])) {
-                        $translation->addComment("XLIFF_UNIT_ID: $unit[id]");
+                        $unitId = (string) $unit['id'];
+                        $translation->addComment("XLIFF_UNIT_ID: $unitId");
+                        if ($options['unitid_as_id']) {
+                            $translation->setId($unitId);
+                        }
                     }
                     $translation->setTranslation(array_shift($targets));
                     $translation->setPluralTranslations($targets);

src/Translation.php

@@ -7,6 +7,7 @@
  */
 class Translation
 {
+    protected $id;
     protected $context;
     protected $original;
     protected $translation = '';
@@ -69,14 +70,30 @@ public function getClone($context = null, $original = null)
         return $new;
     }
 
+    /**
+     * Sets the id of this translation.
+     * @warning The use of this function to set a custom ID will prevent
+     *  Translations::find from matching this translation.
+     *
+     * @param string $id
+     */
+    public function setId($id)
+    {
+        $this->id = $id;
+    }
+
+
     /**
      * Returns the id of this translation.
      *
      * @return string
      */
     public function getId()
     {
-        return static::generateId($this->context, $this->original);
+        if ($this->id === null) {
+            return static::generateId($this->context, $this->original);
+        }
+        return $this->id;
     }
 
     /**

src/Translations.php

@@ -413,6 +413,7 @@ public function hasDomain()
      *
      * @param string|Translation $context  The context of the translation or a translation instance
      * @param string             $original The original string
+     * @warning Translations with custom identifiers (e.g. XLIFF unit IDs) cannot be found using this function.
      *
      * @return Translation|false
      */

tests/AssetsTest.php

@@ -548,25 +548,38 @@ public function testVueJs2MultipleDomainScanning()
         }
     }
 
-    public function testXliff()
+    public function testXliffUnitIds()
     {
-        $translations = static::get('xliff/Xliff', 'Xliff');
-        $countTranslations = 2;
-        $countTranslated = 2;
+        $translations = static::get('xliff/Xliff', 'Xliff', ['unitid_as_id' => true]);
+        $countTranslations = 3;
+        $countTranslated = 3;
         $countHeaders = 9;
 
         $this->assertCount($countTranslations, $translations);
         $this->assertCount($countHeaders, $translations->getHeaders());
-        $this->assertEquals(2, $translations->countTranslated());
-
-        $translation1 = $translations->find(null, 'one file');
-        $this->assertEquals(\Gettext\Generators\Xliff::getUnitID($translation1), 'custom.unit.id');
-
-        $translation2 = $translations->find(null, 'one');
-        $this->assertEquals(\Gettext\Generators\Xliff::getUnitID($translation2), 'second.custom.unit.id');
+        $this->assertEquals($countTranslated, $translations->countTranslated());
 
-        $this->assertContent($translations, 'xliff/Po');
+        foreach ($translations as $translation) {
+            switch (\Gettext\Generators\Xliff::getUnitID($translation)) {
+                case 'custom.unit.id':
+                    $this->assertEquals($translation->getOriginal(), 'one file');
+                    $this->assertEquals($translation->getTranslation(), '1 plik');
+                    break;
+                case 'second.custom.unit.id':
+                    $this->assertEquals($translation->getOriginal(), 'one');
+                    $this->assertEquals($translation->getTranslation(), '1');
+                    break;
+                case 'duplicate.source.unit.id':
+                    $this->assertEquals($translation->getOriginal(), 'one');
+                    $this->assertEquals($translation->getTranslation(), 'uno');
+                    break;
+                default:
+                    $this->assertFalse(true);
+            }
+        }
 
-        $this->runTestFormat('xliff/Po', $countTranslations, $countTranslated, $countHeaders);
+        // Converting from an XLIFF that contains duplicate <source> elements
+        // to a PO file will result in the loss of the duplicates.
+        $this->runTestFormat('xliff/Po', $countTranslations-1, $countTranslated-1, $countHeaders);
     }
 }

tests/assets/xliff/Xliff.xlf

@@ -31,5 +31,14 @@
         <target>1</target>
       </segment>
     </unit>
+    <unit id="duplicate.source.unit.id">
+      <notes>
+        <note category="context"></note>
+      </notes>
+      <segment>
+        <source>one</source>
+        <target>uno</target>
+      </segment>
+    </unit>
   </file>
 </xliff>