withIrregulars method for InflectorFactory

Author: cesarep

lib/Doctrine/Inflector/GenericLanguageInflectorFactory.php

@@ -5,6 +5,11 @@
 namespace Doctrine\Inflector;
 
 use Doctrine\Inflector\Rules\Ruleset;
+use Doctrine\Inflector\Rules\Word;
+use Doctrine\Inflector\Rules\Patterns;
+use Doctrine\Inflector\Rules\Substitution;
+use Doctrine\Inflector\Rules\Substitutions;
+use Doctrine\Inflector\Rules\Transformations;
 
 use function array_unshift;
 
@@ -60,6 +65,31 @@ final public function withPluralRules(?Ruleset $pluralRules, bool $reset = false
         return $this;
     }
 
+    final public function withIrregulars(array $irregulars, bool $reset = false): LanguageInflectorFactory
+    {
+        if ($reset) {
+            $this->pluralRulesets = [];
+            $this->singularRulesets = [];
+        }
+
+        $newIrregulars = array();
+        foreach ($irregulars as $irregular) {
+            $newIrregulars[] = new Substitution(new Word($irregular[0]), new Word($irregular[1]));
+        }
+
+        $transf = new Transformations();
+        $patterns = new Patterns();
+        $substs = new Substitutions(...$newIrregulars);
+
+        $plural = new Ruleset($transf, $patterns, $substs);
+        $singular = new Ruleset($transf, $patterns, $substs->getFlippedSubstitutions());
+
+        array_unshift($this->pluralRulesets, $plural);
+        array_unshift($this->singularRulesets, $singular);
+
+        return $this;
+    }
+
     abstract protected function getSingularRuleset(): Ruleset;
 
     abstract protected function getPluralRuleset(): Ruleset;

lib/Doctrine/Inflector/LanguageInflectorFactory.php

@@ -26,6 +26,15 @@ public function withSingularRules(?Ruleset $singularRules, bool $reset = false):
      */
     public function withPluralRules(?Ruleset $pluralRules, bool $reset = false): self;
 
+    /**
+     * Applies custom rules for irregular words
+     *
+     * @param bool $reset If true, will unset default inflections for all new rules
+     *
+     * @return $this
+     */
+    public function withIrregulars(array $irregulars, bool $reset = false): self;
+
     /**
      * Builds the inflector instance with all applicable rules
      */

tests/Doctrine/Tests/Inflector/InflectorWithIrregularsTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\Inflector;
+
+use Doctrine\Inflector\Inflector;
+use Doctrine\Inflector\InflectorFactory;
+use PHPUnit\Framework\TestCase;
+
+class InflectorWithIrregularsTest extends TestCase
+{
+    /** @var Inflector */
+    private $inflector;
+
+    /**
+     * @dataProvider dataIrregulars
+     */
+    public function testIrregulars(string $word, string $expected): void
+    {
+        self::assertSame($expected, $this->inflector->pluralize($word));
+        self::assertSame($word, $this->inflector->singularize($expected));
+    }
+    /**
+     * @dataProvider dataRegulars
+     */
+    public function testRegulars(string $word, string $expected): void
+    {
+        self::assertSame($expected, $this->inflector->pluralize($word));
+        self::assertSame($word, $this->inflector->singularize($expected));
+    }
+
+    /**
+     * Strings which are used for testTableize.
+     *
+     * @return string[][]
+     */
+    public function dataRegulars(): array
+    {
+        // In the format array('word', 'expected')
+        return [
+            ['address', 'addresses'],
+            ['advice', 'advice'],
+            ['agency', 'agencies'],
+            ['aircraft', 'aircraft'],
+            ['alias', 'aliases'],
+        ];
+    }
+
+    /**
+     * Strings which are used for testIrregulars.
+     *
+     * @return string[][]
+     */
+    public function dataIrregulars(): array
+    {
+        // In the format array('word', 'expected')
+        return [
+            ['foobar', 'barfoo'],
+            ['test', 'testz']
+        ];
+    }
+
+    protected function setUp(): void
+    {        
+        $this->inflector = InflectorFactory::create()->withIrregulars($this->dataIrregulars())->build();
+    }
+}