feature #31249 [Translator] Set sources when extracting strings from php files (Stadly)

fabpot · fabpot · commit b2f5b8a1e2e7 · 2019-05-07T13:11:03.000+02:00
This PR was squashed before being merged into the 4.3-dev branch (closes #31249). Discussion ---------- [Translator] Set sources when extracting strings from php files | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | Set metadata about filenames and line numbers when extracting translatable strings from php files. This PR complements #30909 and #31248, as those PRs implement support for dumping the filenames and line numbers to Po and Qt file formats. Commits ------- f05d4e4 [Translator] Set sources when extracting strings from php files
diff --git a/src/Symfony/Component/Translation/Extractor/PhpExtractor.php b/src/Symfony/Component/Translation/Extractor/PhpExtractor.php
@@ -81,7 +81,7 @@ public function extract($resource, MessageCatalogue $catalog)
     {
         $files = $this->extractFiles($resource);
         foreach ($files as $file) {
-            $this->parseTokens(token_get_all(file_get_contents($file)), $catalog);
+            $this->parseTokens(token_get_all(file_get_contents($file)), $catalog, $file);
 
             gc_mem_caches();
         }
@@ -197,9 +197,15 @@ private function getValue(\Iterator $tokenIterator)
      *
      * @param array            $tokens
      * @param MessageCatalogue $catalog
+     * @param string           $filename
      */
-    protected function parseTokens($tokens, MessageCatalogue $catalog)
+    protected function parseTokens($tokens, MessageCatalogue $catalog/*, string $filename*/)
     {
+        if (\func_num_args() < 3 && __CLASS__ !== \get_class($this) && __CLASS__ !== (new \ReflectionMethod($this, __FUNCTION__))->getDeclaringClass()->getName() && !$this instanceof \PHPUnit\Framework\MockObject\MockObject && !$this instanceof \Prophecy\Prophecy\ProphecySubjectInterface) {
+            @trigger_error(sprintf('The "%s()" method will have a new "string $filename" argument in version 5.0, not defining it is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);
+        }
+        $filename = 2 < \func_num_args() ? \func_get_arg(2) : '';
+
         $tokenIterator = new \ArrayIterator($tokens);
 
         for ($key = 0; $key < $tokenIterator->count(); ++$key) {
@@ -236,6 +242,10 @@ protected function parseTokens($tokens, MessageCatalogue $catalog)
 
                 if ($message) {
                     $catalog->set($message, $this->prefix.$message, $domain);
+                    $metadata = $catalog->getMetadata($message, $domain) ?? [];
+                    $normalizedFilename = preg_replace('{[\\\\/]+}', '/', $filename);
+                    $metadata['sources'][] = $normalizedFilename.':'.$tokens[$key][2];
+                    $catalog->setMetadata($message, $metadata, $domain);
                     break;
                 }
             }
diff --git a/src/Symfony/Component/Translation/Tests/Extractor/PhpExtractorTest.php b/src/Symfony/Component/Translation/Tests/Extractor/PhpExtractorTest.php
@@ -69,6 +69,10 @@ public function testExtraction($resource)
         $actualCatalogue = $catalogue->all();
 
         $this->assertEquals($expectedCatalogue, $actualCatalogue);
+
+        $filename = __DIR__.'/../fixtures/extractor/translation.html.php';
+        $this->assertEquals(['sources' => [$filename.':2']], $catalogue->getMetadata('single-quoted key'));
+        $this->assertEquals(['sources' => [$filename.':43']], $catalogue->getMetadata('other-domain-test-no-params-short-array', 'not_messages'));
     }
 
     public function resourcesProvider()

Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function extract($resource, MessageCatalogue $catalog)`
`81`	`81`	`{`
`82`	`82`	`$files = $this->extractFiles($resource);`
`83`	`83`	`foreach ($files as $file) {`
`84`		`- $this->parseTokens(token_get_all(file_get_contents($file)), $catalog);`
	`84`	`+ $this->parseTokens(token_get_all(file_get_contents($file)), $catalog, $file);`
`85`	`85`
`86`	`86`	`gc_mem_caches();`
`87`	`87`	`}`
`@@ -197,9 +197,15 @@ private function getValue(\Iterator $tokenIterator)`
`197`	`197`	`*`
`198`	`198`	`* @param array $tokens`
`199`	`199`	`* @param MessageCatalogue $catalog`
	`200`	`+ * @param string $filename`
`200`	`201`	`*/`
`201`		`- protected function parseTokens($tokens, MessageCatalogue $catalog)`
	`202`	`+ protected function parseTokens($tokens, MessageCatalogue $catalog/, string $filename/)`
`202`	`203`	`{`
	`204`	`+ if (\func_num_args() < 3 && __CLASS__ !== \get_class($this) && __CLASS__ !== (new \ReflectionMethod($this, __FUNCTION__))->getDeclaringClass()->getName() && !$this instanceof \PHPUnit\Framework\MockObject\MockObject && !$this instanceof \Prophecy\Prophecy\ProphecySubjectInterface) {`
	`205`	`+ @trigger_error(sprintf('The "%s()" method will have a new "string $filename" argument in version 5.0, not defining it is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);`
	`206`	`+ }`
	`207`	`+ $filename = 2 < \func_num_args() ? \func_get_arg(2) : '';`
	`208`	`+`
`203`	`209`	`$tokenIterator = new \ArrayIterator($tokens);`
`204`	`210`
`205`	`211`	`for ($key = 0; $key < $tokenIterator->count(); ++$key) {`
`@@ -236,6 +242,10 @@ protected function parseTokens($tokens, MessageCatalogue $catalog)`
`236`	`242`
`237`	`243`	`if ($message) {`
`238`	`244`	`$catalog->set($message, $this->prefix.$message, $domain);`
	`245`	`+ $metadata = $catalog->getMetadata($message, $domain) ?? [];`
	`246`	`+ $normalizedFilename = preg_replace('{[\\\\/]+}', '/', $filename);`
	`247`	`+ $metadata['sources'][] = $normalizedFilename.':'.$tokens[$key][2];`
	`248`	`+ $catalog->setMetadata($message, $metadata, $domain);`
`239`	`249`	`break;`
`240`	`250`	`}`
`241`	`251`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,10 @@ public function testExtraction($resource)`
`69`	`69`	`$actualCatalogue = $catalogue->all();`
`70`	`70`
`71`	`71`	`$this->assertEquals($expectedCatalogue, $actualCatalogue);`
	`72`	`+`
	`73`	`+ $filename = __DIR__.'/../fixtures/extractor/translation.html.php';`
	`74`	`+ $this->assertEquals(['sources' => [$filename.':2']], $catalogue->getMetadata('single-quoted key'));`
	`75`	`+ $this->assertEquals(['sources' => [$filename.':43']], $catalogue->getMetadata('other-domain-test-no-params-short-array', 'not_messages'));`
`72`	`76`	`}`
`73`	`77`
`74`	`78`	`public function resourcesProvider()`