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

aitboudad · aitboudad · commit 78bfc07fb515 · 2015-09-21T10:16:40.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * deprecated FileDumper::format(), overwrite FileDumper::formatCatalogue() instead.
  * deprecated Translator::getMessages(), rely on TranslatorBagInterface::getCatalogue() instead.
+ * added `FileDumper::formatCatalogue` which allows format the catalogue without dumping it into file.
  * added option `json_encoding` to JsonFileDumper
  * added options `as_tree`, `inline` to YamlFileDumper
  * added support for XLIFF 2.0.
diff --git a/Dumper/CsvFileDumper.php b/Dumper/CsvFileDumper.php
@@ -36,7 +36,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $handle = fopen('php://memory', 'rb+');
 
diff --git a/Dumper/FileDumper.php b/Dumper/FileDumper.php
@@ -97,7 +97,7 @@ public function dump(MessageCatalogue $messages, $options = array())
      *
      * @return string representation
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         @trigger_error('The '.__METHOD__.' method will replace the format method in 3.0. You should overwritten it instead of overwriting format instead.', E_USER_DEPRECATED);
 
diff --git a/Dumper/IcuResFileDumper.php b/Dumper/IcuResFileDumper.php
@@ -38,7 +38,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $data = $indexes = $resources = '';
 
diff --git a/Dumper/IniFileDumper.php b/Dumper/IniFileDumper.php
@@ -33,7 +33,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $output = '';
 
diff --git a/Dumper/JsonFileDumper.php b/Dumper/JsonFileDumper.php
@@ -33,7 +33,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         if (isset($options['json_encoding'])) {
             $flags = $options['json_encoding'];
diff --git a/Dumper/MoFileDumper.php b/Dumper/MoFileDumper.php
@@ -34,7 +34,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $output = $sources = $targets = $sourceOffsets = $targetOffsets = '';
         $offsets = array();
diff --git a/Dumper/PhpFileDumper.php b/Dumper/PhpFileDumper.php
@@ -33,7 +33,7 @@ protected function format(MessageCatalogue $messages, $domain)
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $output = "<?php\n\nreturn ".var_export($messages->all($domain), true).";\n";
 
diff --git a/Dumper/PoFileDumper.php b/Dumper/PoFileDumper.php
@@ -33,7 +33,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $output = 'msgid ""'."\n";
         $output .= 'msgstr ""'."\n";
diff --git a/Dumper/QtFileDumper.php b/Dumper/QtFileDumper.php
@@ -33,7 +33,7 @@ public function format(MessageCatalogue $messages, $domain)
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $dom = new \DOMDocument('1.0', 'utf-8');
         $dom->formatOutput = true;
diff --git a/Dumper/XliffFileDumper.php b/Dumper/XliffFileDumper.php
@@ -23,7 +23,7 @@ class XliffFileDumper extends FileDumper
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         $xliffVersion = '1.2';
         if (array_key_exists('xliff_version', $options)) {
diff --git a/Dumper/YamlFileDumper.php b/Dumper/YamlFileDumper.php
@@ -25,7 +25,7 @@ class YamlFileDumper extends FileDumper
     /**
      * {@inheritdoc}
      */
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         if (!class_exists('Symfony\Component\Yaml\Yaml')) {
             throw new \LogicException('Dumping translations in the YAML format requires the Symfony Yaml component.');
diff --git a/Tests/Dumper/CsvFileDumperTest.php b/Tests/Dumper/CsvFileDumperTest.php
@@ -16,18 +16,14 @@
 
 class CsvFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar', 'bar' => 'foo
 foo', 'foo;foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new CsvFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/valid.csv'), file_get_contents($tempDir.'/messages.en.csv'));
-
-        unlink($tempDir.'/messages.en.csv');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/valid.csv', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/FileDumperTest.php b/Tests/Dumper/FileDumperTest.php
@@ -16,6 +16,19 @@
 
 class FileDumperTest extends \PHPUnit_Framework_TestCase
 {
+    public function testDump()
+    {
+        $tempDir = sys_get_temp_dir();
+
+        $catalogue = new MessageCatalogue('en');
+        $catalogue->add(array('foo' => 'bar'));
+
+        $dumper = new ConcreteFileDumper();
+        $dumper->dump($catalogue, array('path' => $tempDir));
+
+        $this->assertTrue(file_exists($tempDir.'/messages.en.concrete'));
+    }
+
     public function testDumpBackupsFileIfExisting()
     {
         $tempDir = sys_get_temp_dir();
@@ -58,7 +71,7 @@ public function testDumpCreatesNestedDirectoriesAndFile()
 
 class ConcreteFileDumper extends FileDumper
 {
-    protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
+    public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
     {
         return '';
     }
diff --git a/Tests/Dumper/IcuResFileDumperTest.php b/Tests/Dumper/IcuResFileDumperTest.php
@@ -16,7 +16,7 @@
 
 class IcuResFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         if (!function_exists('mb_convert_encoding')) {
             $this->markTestSkipped('This test requires mbstring to work.');
@@ -25,14 +25,8 @@ public function testDump()
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir().'/IcuResFileDumperTest';
         $dumper = new IcuResFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resourcebundle/res/en.res'), file_get_contents($tempDir.'/messages/en.res'));
-
-        @unlink($tempDir.'/messages/en.res');
-        @rmdir($tempDir.'/messages');
-        @rmdir($tempDir);
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resourcebundle/res/en.res', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/IniFileDumperTest.php b/Tests/Dumper/IniFileDumperTest.php
@@ -16,17 +16,13 @@
 
 class IniFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new IniFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.ini'), file_get_contents($tempDir.'/messages.en.ini'));
-
-        unlink($tempDir.'/messages.en.ini');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.ini', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/JsonFileDumperTest.php b/Tests/Dumper/JsonFileDumperTest.php
@@ -16,19 +16,7 @@
 
 class JsonFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    private $tempDir;
-
-    protected function setUp()
-    {
-        $this->tempDir = sys_get_temp_dir();
-    }
-
-    protected function tearDown()
-    {
-        unlink($this->tempDir.'/messages.en.json');
-    }
-
-    public function testDump()
+    public function testFormatCatalogue()
     {
         if (PHP_VERSION_ID < 50400) {
             $this->markTestIncomplete('PHP below 5.4 doesn\'t support JSON pretty printing');
@@ -38,9 +26,8 @@ public function testDump()
         $catalogue->add(array('foo' => 'bar'));
 
         $dumper = new JsonFileDumper();
-        $dumper->dump($catalogue, array('path' => $this->tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.json'), file_get_contents($this->tempDir.'/messages.en.json'));
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.json', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 
     public function testDumpWithCustomEncoding()
@@ -49,8 +36,7 @@ public function testDumpWithCustomEncoding()
         $catalogue->add(array('foo' => '"bar"'));
 
         $dumper = new JsonFileDumper();
-        $dumper->dump($catalogue, array('path' => $this->tempDir, 'json_encoding' => JSON_HEX_QUOT));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.dump.json'), file_get_contents($this->tempDir.'/messages.en.json'));
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.dump.json', $dumper->formatCatalogue($catalogue, 'messages', array('json_encoding' => JSON_HEX_QUOT)));
     }
 }
diff --git a/Tests/Dumper/MoFileDumperTest.php b/Tests/Dumper/MoFileDumperTest.php
@@ -16,16 +16,13 @@
 
 class MoFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new MoFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.mo'), file_get_contents($tempDir.'/messages.en.mo'));
 
-        unlink($tempDir.'/messages.en.mo');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.mo', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/PhpFileDumperTest.php b/Tests/Dumper/PhpFileDumperTest.php
@@ -16,17 +16,13 @@
 
 class PhpFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new PhpFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.php'), file_get_contents($tempDir.'/messages.en.php'));
-
-        unlink($tempDir.'/messages.en.php');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.php', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/PoFileDumperTest.php b/Tests/Dumper/PoFileDumperTest.php
@@ -16,16 +16,13 @@
 
 class PoFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'));
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new PoFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.po'), file_get_contents($tempDir.'/messages.en.po'));
 
-        unlink($tempDir.'/messages.en.po');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.po', $dumper->formatCatalogue($catalogue, 'messages'));
     }
 }
diff --git a/Tests/Dumper/QtFileDumperTest.php b/Tests/Dumper/QtFileDumperTest.php
@@ -16,17 +16,13 @@
 
 class QtFileDumperTest extends \PHPUnit_Framework_TestCase
 {
-    public function testDump()
+    public function testFormatCatalogue()
     {
         $catalogue = new MessageCatalogue('en');
         $catalogue->add(array('foo' => 'bar'), 'resources');
 
-        $tempDir = sys_get_temp_dir();
         $dumper = new QtFileDumper();
-        $dumper->dump($catalogue, array('path' => $tempDir));
 
-        $this->assertEquals(file_get_contents(__DIR__.'/../fixtures/resources.ts'), file_get_contents($tempDir.'/resources.en.ts'));
-
-        unlink($tempDir.'/resources.en.ts');
+        $this->assertStringEqualsFile(__DIR__.'/../fixtures/resources.ts', $dumper->formatCatalogue($catalogue, 'resources'));
     }
 }
diff --git a/Tests/Dumper/XliffFileDumperTest.php b/Tests/Dumper/XliffFileDumperTest.php
diff --git a/Tests/Dumper/YamlFileDumperTest.php b/Tests/Dumper/YamlFileDumperTest.php

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')`
`36`	`36`	`/**`
`37`	`37`	`* {@inheritdoc}`
`38`	`38`	`*/`
`39`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`39`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`40`	`40`	`{`
`41`	`41`	`$handle = fopen('php://memory', 'rb+');`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public function dump(MessageCatalogue $messages, $options = array())`
`97`	`97`	`*`
`98`	`98`	`* @return string representation`
`99`	`99`	`*/`
`100`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`100`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`101`	`101`	`{`
`102`	`102`	`@trigger_error('The '.__METHOD__.' method will replace the format method in 3.0. You should overwritten it instead of overwriting format instead.', E_USER_DEPRECATED);`
`103`	`103`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')`
`38`	`38`	`/**`
`39`	`39`	`* {@inheritdoc}`
`40`	`40`	`*/`
`41`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`41`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`42`	`42`	`{`
`43`	`43`	`$data = $indexes = $resources = '';`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')`
`33`	`33`	`/**`
`34`	`34`	`* {@inheritdoc}`
`35`	`35`	`*/`
`36`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`36`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`37`	`37`	`{`
`38`	`38`	`$output = '';`
`39`	`39`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function format(MessageCatalogue $messages, $domain = 'messages')`
`34`	`34`	`/**`
`35`	`35`	`* {@inheritdoc}`
`36`	`36`	`*/`
`37`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`37`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`38`	`38`	`{`
`39`	`39`	`$output = $sources = $targets = $sourceOffsets = $targetOffsets = '';`
`40`	`40`	`$offsets = array();`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ protected function format(MessageCatalogue $messages, $domain)`
`33`	`33`	`/**`
`34`	`34`	`* {@inheritdoc}`
`35`	`35`	`*/`
`36`		`- protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
	`36`	`+ public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())`
`37`	`37`	`{`
`38`	`38`	`$output = "<?php\n\nreturn ".var_export($messages->all($domain), true).";\n";`
`39`	`39`