Fix deprecated writeTranslations() call with write() when available (#22)

* Fix deprecated writeTranslations() call with write() when available

* Fix tests when writeTranslations() deprecated method is called

* Fix StyleCI fail: Add dot in the end of description

* Actually, we do always pass $options arg - make it required

* Align method parameters to fix StyleCI fails

Author: bocharsky-bw

src/FileStorage.php

@@ -164,7 +164,7 @@ private function writeCatalogue(MessageCatalogue $catalogue, $locale, $domain)
             $path = (string) $resource;
             if (preg_match('|/'.$domain.'\.'.$locale.'\.([a-z]+)$|', $path, $matches)) {
                 $options['path'] = str_replace($matches[0], '', $path);
-                $this->writer->writeTranslations($catalogue, $matches[1], $options);
+                $this->writeTranslations($catalogue, $matches[1], $options);
                 $written = true;
             }
         }
@@ -176,7 +176,7 @@ private function writeCatalogue(MessageCatalogue $catalogue, $locale, $domain)
 
         $options['path'] = reset($this->dir);
         $format = isset($options['default_output_format']) ? $options['default_output_format'] : 'xlf';
-        $this->writer->writeTranslations($catalogue, $format, $options);
+        $this->writeTranslations($catalogue, $format, $options);
     }
 
     /**
@@ -210,4 +210,23 @@ private function loadCatalogue($locale, array $dirs)
 
         $this->catalogues[$locale] = $currentCatalogue;
     }
+
+    /**
+     * This method calls the new TranslationWriter::write() if exist,
+     * otherwise fallback to TranslationWriter::writeTranslations() call
+     * to avoid BC breaks.
+     *
+     * @param MessageCatalogue $catalogue
+     * @param string           $format
+     * @param array            $options
+     */
+    private function writeTranslations(MessageCatalogue $catalogue, $format, array $options)
+    {
+        if (method_exists($this->writer, 'write')) {
+            $this->writer->write($catalogue, $format, $options);
+        } else {
+            // This method is deprecated since 3.4, maintained to avoid BC breaks
+            $this->writer->writeTranslations($catalogue, $format, $options);
+        }
+    }
 }

tests/Unit/FileStorageTest.php

@@ -51,11 +51,11 @@ public function testConstructorEmptyArray()
     public function testCreateNewCatalogue()
     {
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
         $writer->expects($this->once())
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->isInstanceOf(MessageCatalogueInterface::class),
                 'xlf',
@@ -66,11 +66,11 @@ public function testCreateNewCatalogue()
         $storage->create(new Message('key', 'domain', 'en', 'Message'));
 
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
         $writer->expects($this->once())
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->isInstanceOf(MessageCatalogueInterface::class),
                 'format',
@@ -84,11 +84,11 @@ public function testCreateNewCatalogue()
     public function testCreateExistingCatalogue()
     {
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
         $writer->expects($this->once())
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->isInstanceOf(MessageCatalogueInterface::class),
                 'xlf',
@@ -127,11 +127,11 @@ public function testGet()
     public function testUpdate()
     {
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
         $writer->expects($this->exactly(2))
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->isInstanceOf(MessageCatalogueInterface::class),
                 'xlf',
@@ -149,12 +149,12 @@ public function testUpdate()
     public function testDelete()
     {
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
 
         $writer->expects($this->once())
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->callback(function (MessageCatalogueInterface $catalogue) {
                     return !$catalogue->defines('test_0', 'messages');
@@ -173,12 +173,12 @@ public function testDelete()
     public function testImport()
     {
         $writer = $this->getMockBuilder(TranslationWriter::class)
-            ->setMethods(['writeTranslations'])
+            ->setMethods([$this->getMethodNameToWriteTranslations()])
             ->disableOriginalConstructor()
             ->getMock();
 
         $writer->expects($this->once())
-            ->method('writeTranslations')
+            ->method($this->getMethodNameToWriteTranslations())
             ->with(
                 $this->callback(function (MessageCatalogueInterface $catalogue) {
                     return $catalogue->defines('test_4711', 'messages');
@@ -235,4 +235,13 @@ private function createTranslationLoader()
 
         return new TranslationLoader();
     }
+
+    private function getMethodNameToWriteTranslations()
+    {
+        if (method_exists(TranslationWriter::class, 'write')) {
+            return 'write';
+        }
+
+        return 'writeTranslations';
+    }
 }