[Translation][File dumper] allow get file content without writing in file.

aitboudad · aitboudad · commit 6d2666e36fb7 · 2015-09-14T12:02:00.000Z
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -5,8 +5,9 @@ CHANGELOG
 -----
 
  * deprecated Translator::getMessages(), rely on TranslatorBagInterface::getCatalogue() instead.
- * added option `json_encoding` to JsonFileDumper
- * added options `as_tree`, `inline` to YamlFileDumper
+ * added option `save_handler` to FileDumper.
+ * added option `json_encoding` to JsonFileDumper.
+ * added options `as_tree`, `inline` to YamlFileDumper.
  * added support for XLIFF target and tool attributes.
  * added message parameters to DataCollectorTranslator.
  * [DEPRECATION] The `DiffOperation` class has been deprecated and
diff --git a/src/Symfony/Component/Translation/Dumper/FileDumper.php b/src/Symfony/Component/Translation/Dumper/FileDumper.php
@@ -63,26 +63,38 @@ public function setBackup($backup)
      */
     public function dump(MessageCatalogue $messages, $options = array())
     {
-        if (!array_key_exists('path', $options)) {
-            throw new \InvalidArgumentException('The file dumper needs a path option.');
+        if (!array_key_exists('path', $options) && !array_key_exists('save_handler', $options)) {
+            throw new \InvalidArgumentException('The file dumper needs a path or save_handler option.');
         }
 
         // save a file for each domain
         foreach ($messages->getDomains() as $domain) {
-            // backup
-            $fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());
-            if (file_exists($fullpath)) {
-                if ($this->backup) {
-                    copy($fullpath, $fullpath.'~');
+            $content = $this->formatCatalogue($messages, $domain, $options);
+            if (array_key_exists('path', $options)) {
+                // backup
+                $fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());
+                if (file_exists($fullpath)) {
+                    if ($this->backup) {
+                        copy($fullpath, $fullpath.'~');
+                    }
+                } else {
+                    $directory = dirname($fullpath);
+                    if (!file_exists($directory) && !@mkdir($directory, 0777, true)) {
+                        throw new \RuntimeException(sprintf('Unable to create directory "%s".', $directory));
+                    }
                 }
-            } else {
-                $directory = dirname($fullpath);
-                if (!file_exists($directory) && !@mkdir($directory, 0777, true)) {
-                    throw new \RuntimeException(sprintf('Unable to create directory "%s".', $directory));
+
+                // save file
+                file_put_contents($fullpath, $content);
+            }
+
+            if (array_key_exists('save_handler', $options)) {
+                if (!is_callable($options['save_handler'])) {
+                    throw new \InvalidArgumentException(sprintf('Invalid type for save_handler option. Expected callable, but got "%s".', gettype($options['save_handler'])));
                 }
+
+                call_user_func($options['save_handler'], $content);
             }
-            // save file
-            file_put_contents($fullpath, $this->formatCatalogue($messages, $domain, $options));
         }
     }
 
diff --git a/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php b/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php
@@ -16,6 +16,21 @@
 
 class FileDumperTest extends \PHPUnit_Framework_TestCase
 {
+    public function testDumpWithSaveHandler()
+    {
+        $catalogue = new MessageCatalogue('en');
+        $catalogue->add(array('foo' => 'bar'));
+
+        $dumper = new ConcreteFileDumper();
+
+        $dumpContent = '';
+        $dumper->dump($catalogue, array('save_handler' => function ($content) use (&$dumpContent) {
+            $dumpContent = $content;
+        }));
+
+        $this->assertEquals(serialize($catalogue->all()), $dumpContent);
+    }
+
     public function testDumpBackupsFileIfExisting()
     {
         $tempDir = sys_get_temp_dir();
@@ -60,7 +75,7 @@ class ConcreteFileDumper extends FileDumper
 {
     protected function format(MessageCatalogue $messages, $domain)
     {
-        return '';
+        return serialize($messages->all());
     }
 
     protected function getExtension()

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,21 @@`
`16`	`16`
`17`	`17`	`class FileDumperTest extends \PHPUnit_Framework_TestCase`
`18`	`18`	`{`
	`19`	`+ public function testDumpWithSaveHandler()`
	`20`	`+ {`
	`21`	`+ $catalogue = new MessageCatalogue('en');`
	`22`	`+ $catalogue->add(array('foo' => 'bar'));`
	`23`	`+`
	`24`	`+ $dumper = new ConcreteFileDumper();`
	`25`	`+`
	`26`	`+ $dumpContent = '';`
	`27`	`+ $dumper->dump($catalogue, array('save_handler' => function ($content) use (&$dumpContent) {`
	`28`	`+ $dumpContent = $content;`
	`29`	`+ }));`
	`30`	`+`
	`31`	`+ $this->assertEquals(serialize($catalogue->all()), $dumpContent);`
	`32`	`+ }`
	`33`	`+`
`19`	`34`	`public function testDumpBackupsFileIfExisting()`
`20`	`35`	`{`
`21`	`36`	`$tempDir = sys_get_temp_dir();`
`@@ -60,7 +75,7 @@ class ConcreteFileDumper extends FileDumper`
`60`	`75`	`{`
`61`	`76`	`protected function format(MessageCatalogue $messages, $domain)`
`62`	`77`	`{`
`63`		`- return '';`
	`78`	`+ return serialize($messages->all());`
`64`	`79`	`}`
`65`	`80`
`66`	`81`	`protected function getExtension()`