Update the Generator::getFormatter to support extensions (#267)

Nyholm · web-flow · commit cc07063a064c · 2021-08-08T08:11:27.000+02:00
diff --git a/src/Faker/Generator.php b/src/Faker/Generator.php
@@ -617,31 +617,44 @@ public function seed($seed = null)
         }
     }
 
-    public function format($formatter, $arguments = [])
+    public function format($format, $arguments = [])
     {
-        return call_user_func_array($this->getFormatter($formatter), $arguments);
+        return call_user_func_array($this->getFormatter($format), $arguments);
     }
 
     /**
-     * @param string $formatter
+     * @param string $format
      *
      * @return callable
      */
-    public function getFormatter($formatter)
+    public function getFormatter($format)
     {
-        if (isset($this->formatters[$formatter])) {
-            return $this->formatters[$formatter];
+        if (isset($this->formatters[$format])) {
+            return $this->formatters[$format];
+        }
+
+        if (method_exists($this, $format)) {
+            $this->formatters[$format] = [$this, $format];
+
+            return $this->formatters[$format];
+        }
+
+        // "Faker\Core\Barcode->ean13"
+        if (preg_match('|^([a-zA-Z0-9\\\]+)->([a-zA-Z0-9]+)$|', $format, $matches)) {
+            $this->formatters[$format] = [$this->ext($matches[1]), $matches[2]];
+
+            return $this->formatters[$format];
         }
 
         foreach ($this->providers as $provider) {
-            if (method_exists($provider, $formatter)) {
-                $this->formatters[$formatter] = [$provider, $formatter];
+            if (method_exists($provider, $format)) {
+                $this->formatters[$format] = [$provider, $format];
 
-                return $this->formatters[$formatter];
+                return $this->formatters[$format];
             }
         }
 
-        throw new \InvalidArgumentException(sprintf('Unknown formatter "%s"', $formatter));
+        throw new \InvalidArgumentException(sprintf('Unknown format "%s"', $format));
     }
 
     /**
@@ -653,7 +666,11 @@ public function getFormatter($formatter)
      */
     public function parse($string)
     {
-        return preg_replace_callback('/\{\{\s?(\w+)\s?\}\}/u', [$this, 'callFormatWithMatches'], $string);
+        $callback = function ($matches) {
+            return $this->format($matches[1]);
+        };
+
+        return preg_replace_callback('/\{\{\s?(\w+)\s?\}\}/u', $callback, $string);
     }
 
     /**
@@ -839,8 +856,13 @@ public function semver(bool $preRelease = false, bool $build = false): string
         return $this->ext(Extension\VersionExtension::class)->semver($preRelease, $build);
     }
 
+    /**
+     * @deprecated
+     */
     protected function callFormatWithMatches($matches)
     {
+        trigger_deprecation('fakerphp/faker', '1.14', 'Protected method "callFormatWithMatches()" is deprecated and will be removed.');
+
         return $this->format($matches[1]);
     }
 
diff --git a/test/Faker/GeneratorTest.php b/test/Faker/GeneratorTest.php
@@ -2,8 +2,11 @@
 
 namespace Faker\Test;
 
+use Faker\Core\Blood;
 use Faker\Core\File;
+use Faker\Extension\BloodExtension;
 use Faker\Extension\Container;
+use Faker\Extension\ContainerBuilder;
 use Faker\Extension\ExtensionNotFound;
 use Faker\Extension\FileExtension;
 use Faker\Generator;
@@ -111,6 +114,26 @@ public function testFormatTransfersArgumentsToFormatter()
         self::assertEquals('bazfoo', $this->faker->format('fooFormatterWithArguments', ['foo']));
     }
 
+    public function testFormatterCallsGenerator()
+    {
+        $builder = new ContainerBuilder();
+        $builder->add(Blood::class, BloodExtension::class);
+        $faker = new Generator($builder->build());
+
+        $output = $faker->format('bloodType');
+        self::assertTrue(in_array($output, ['A', 'AB', 'B', '0'], true));
+    }
+
+    public function testFormatterCallsExtension()
+    {
+        $builder = new ContainerBuilder();
+        $builder->add(Blood::class);
+        $faker = new Generator($builder->build());
+
+        $output = $faker->format('Faker\Core\Blood->bloodType');
+        self::assertTrue(in_array($output, ['A', 'AB', 'B', '0'], true));
+    }
+
     public function testParseReturnsSameStringWhenItContainsNoCurlyBraces()
     {
         self::assertEquals('fooBar#?', $this->faker->parse('fooBar#?'));

Original file line number	Diff line number	Diff line change
`@@ -617,31 +617,44 @@ public function seed($seed = null)`
`617`	`617`	`}`
`618`	`618`	`}`
`619`	`619`
`620`		`- public function format($formatter, $arguments = [])`
	`620`	`+ public function format($format, $arguments = [])`
`621`	`621`	`{`
`622`		`- return call_user_func_array($this->getFormatter($formatter), $arguments);`
	`622`	`+ return call_user_func_array($this->getFormatter($format), $arguments);`
`623`	`623`	`}`
`624`	`624`
`625`	`625`	`/**`
`626`		`- * @param string $formatter`
	`626`	`+ * @param string $format`
`627`	`627`	`*`
`628`	`628`	`* @return callable`
`629`	`629`	`*/`
`630`		`- public function getFormatter($formatter)`
	`630`	`+ public function getFormatter($format)`
`631`	`631`	`{`
`632`		`- if (isset($this->formatters[$formatter])) {`
`633`		`- return $this->formatters[$formatter];`
	`632`	`+ if (isset($this->formatters[$format])) {`
	`633`	`+ return $this->formatters[$format];`
	`634`	`+ }`
	`635`	`+`
	`636`	`+ if (method_exists($this, $format)) {`
	`637`	`+ $this->formatters[$format] = [$this, $format];`
	`638`	`+`
	`639`	`+ return $this->formatters[$format];`
	`640`	`+ }`
	`641`	`+`
	`642`	`+ // "Faker\Core\Barcode->ean13"`
	`643`	`+ if (preg_match('\|^([a-zA-Z0-9\\\]+)->([a-zA-Z0-9]+)$\|', $format, $matches)) {`
	`644`	`+ $this->formatters[$format] = [$this->ext($matches[1]), $matches[2]];`
	`645`	`+`
	`646`	`+ return $this->formatters[$format];`
`634`	`647`	`}`
`635`	`648`
`636`	`649`	`foreach ($this->providers as $provider) {`
`637`		`- if (method_exists($provider, $formatter)) {`
`638`		`- $this->formatters[$formatter] = [$provider, $formatter];`
	`650`	`+ if (method_exists($provider, $format)) {`
	`651`	`+ $this->formatters[$format] = [$provider, $format];`
`639`	`652`
`640`		`- return $this->formatters[$formatter];`
	`653`	`+ return $this->formatters[$format];`
`641`	`654`	`}`
`642`	`655`	`}`
`643`	`656`
`644`		`- throw new \InvalidArgumentException(sprintf('Unknown formatter "%s"', $formatter));`
	`657`	`+ throw new \InvalidArgumentException(sprintf('Unknown format "%s"', $format));`
`645`	`658`	`}`
`646`	`659`
`647`	`660`	`/**`
`@@ -653,7 +666,11 @@ public function getFormatter($formatter)`
`653`	`666`	`*/`
`654`	`667`	`public function parse($string)`
`655`	`668`	`{`
`656`		`- return preg_replace_callback('/\{\{\s?(\w+)\s?\}\}/u', [$this, 'callFormatWithMatches'], $string);`
	`669`	`+ $callback = function ($matches) {`
	`670`	`+ return $this->format($matches[1]);`
	`671`	`+ };`
	`672`	`+`
	`673`	`+ return preg_replace_callback('/\{\{\s?(\w+)\s?\}\}/u', $callback, $string);`
`657`	`674`	`}`
`658`	`675`
`659`	`676`	`/**`
`@@ -839,8 +856,13 @@ public function semver(bool $preRelease = false, bool $build = false): string`
`839`	`856`	`return $this->ext(Extension\VersionExtension::class)->semver($preRelease, $build);`
`840`	`857`	`}`
`841`	`858`
	`859`	`+ /**`
	`860`	`+ * @deprecated`
	`861`	`+ */`
`842`	`862`	`protected function callFormatWithMatches($matches)`
`843`	`863`	`{`
	`864`	`+ trigger_deprecation('fakerphp/faker', '1.14', 'Protected method "callFormatWithMatches()" is deprecated and will be removed.');`
	`865`	`+`
`844`	`866`	`return $this->format($matches[1]);`
`845`	`867`	`}`
`846`	`868`