Add factory methods to Japan Prefecture

Author: tanigami

composer.json

@@ -12,6 +12,7 @@
         }
     ],
     "require": {
+        "php": ">=7.0",
         "symfony/intl": "^3.3"
     },
     "require-dev": {

src/Geo/Japan/Prefecture.php

@@ -3,6 +3,7 @@
 namespace Tanigami\ValueObjects\Geo\Japan;
 
 use BadMethodCallException;
+use InvalidArgumentException;
 
 /**
  * @method static Prefecture hokkaido
@@ -180,6 +181,60 @@ public static function __callStatic(string $name, array $arguments): self
         );
     }
 
+    /**
+     * @param string $kanjiName
+     * @return Prefecture
+     */
+    public static function ofKanjiName(string $kanjiName): self
+    {
+        $filteredData = array_filter(self::DATA, function (array $prefecture) use ($kanjiName) {
+            return $kanjiName === strtolower($prefecture['kanjiName']);
+        });
+        if ([] === $filteredData) {
+            throw new InvalidArgumentException(sprintf('There is no prefecture of kanji name: %s', $kanjiName));
+        }
+        $datum = array_shift($filteredData);
+        $suffixFactoryMethod = $datum['suffix'];
+        $regionFactoryMethod = $datum['region'];
+
+        return new self (
+            $datum['isoCode'],
+            $datum['name'],
+            $datum['kanjiName'],
+            PrefectureSuffix::$suffixFactoryMethod(),
+            Region::$regionFactoryMethod()
+        );
+    }
+
+    /**
+     * @param string $suffixedKanjiName
+     * @return Prefecture
+     */
+    public static function ofSuffixedKanjiName(string $suffixedKanjiName): self
+    {
+        $filteredData = array_filter(self::DATA, function (array $prefecture) use ($suffixedKanjiName) {
+            $suffixFactoryMethod = $prefecture['suffix'];
+
+            return $suffixedKanjiName === $prefecture['kanjiName'] . PrefectureSuffix::$suffixFactoryMethod()->kanjiName();
+        });
+        if ([] === $filteredData) {
+            throw new InvalidArgumentException(
+                sprintf('There is no prefecture of suffixed kanji name: %s', $suffixedKanjiName)
+            );
+        }
+        $datum = array_shift($filteredData);
+        $suffixFactoryMethod = $datum['suffix'];
+        $regionFactoryMethod = $datum['region'];
+
+        return new self (
+            $datum['isoCode'],
+            $datum['name'],
+            $datum['kanjiName'],
+            PrefectureSuffix::$suffixFactoryMethod(),
+            Region::$regionFactoryMethod()
+        );
+    }
+
     /**
      * @return string
      */

tests/Geo/Japan/PrefectureTest.php

@@ -252,4 +252,38 @@ public function testInvalidFactoryMethod()
     {
         Prefecture::sato();
     }
+
+    public function testCreationFromKanjiName()
+    {
+        $this->assertSame('JP-47', Prefecture::ofKanjiName('沖縄')->isoCode());
+        $this->assertSame('Okinawa-ken', Prefecture::ofKanjiName('沖縄')->suffixedName());
+        $this->assertSame('沖縄県', Prefecture::ofKanjiName('沖縄')->suffixedKanjiName());
+        $this->assertTrue(Prefecture::ofKanjiName('沖縄')->region()->equals(Region::okinawa()));
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage There is no prefecture of kanji name: 東都
+     */
+    public function testCreationFromInvalidKanjiName()
+    {
+        Prefecture::ofKanjiName('東都');
+    }
+
+    public function testCreationFromSuffixedKanjiName()
+    {
+        $this->assertSame('JP-47', Prefecture::ofSuffixedKanjiName('沖縄県')->isoCode());
+        $this->assertSame('Okinawa-ken', Prefecture::ofSuffixedKanjiName('沖縄県')->suffixedName());
+        $this->assertSame('沖縄県', Prefecture::ofSuffixedKanjiName('沖縄県')->suffixedKanjiName());
+        $this->assertTrue(Prefecture::ofSuffixedKanjiName('沖縄県')->region()->equals(Region::okinawa()));
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage There is no prefecture of suffixed kanji name: 大阪都
+     */
+    public function testCreationFromInvalidSuffixedKanjiName()
+    {
+        Prefecture::ofSuffixedKanjiName('大阪都');
+    }
 }