Add Inflector component (from StringUtil of PropertyAccess)

teohhanhui · teohhanhui · commit bd56ef70fa8e · 2016-03-31T15:36:48.000+08:00
diff --git a/PropertyAccessor.php b/PropertyAccessor.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\PropertyAccess;
 
+use Symfony\Component\Inflector\Inflector;
 use Symfony\Component\PropertyAccess\Exception\AccessException;
 use Symfony\Component\PropertyAccess\Exception\InvalidArgumentException;
 use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
@@ -680,7 +681,7 @@ private function getWriteAccessInfo($class, $property, $value)
             $reflClass = new \ReflectionClass($class);
             $access[self::ACCESS_HAS_PROPERTY] = $reflClass->hasProperty($property);
             $camelized = $this->camelize($property);
-            $singulars = (array) StringUtil::singularify($camelized);
+            $singulars = (array) Inflector::singularize($camelized);
 
             if (is_array($value) || $value instanceof \Traversable) {
                 $methods = $this->findAdderAndRemover($reflClass, $singulars);
diff --git a/StringUtil.php b/StringUtil.php
@@ -11,121 +11,17 @@
 
 namespace Symfony\Component\PropertyAccess;
 
+use Symfony\Component\Inflector\Inflector;
+
 /**
  * Creates singulars from plurals.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 3.1, to be removed in 4.0. Use {@see Symfony\Component\Inflector\Inflector} instead.
  */
 class StringUtil
 {
-    /**
-     * Map english plural to singular suffixes.
-     *
-     * @var array
-     *
-     * @see http://english-zone.com/spelling/plurals.html
-     * @see http://www.scribd.com/doc/3271143/List-of-100-Irregular-Plural-Nouns-in-English
-     */
-    private static $pluralMap = array(
-        // First entry: plural suffix, reversed
-        // Second entry: length of plural suffix
-        // Third entry: Whether the suffix may succeed a vocal
-        // Fourth entry: Whether the suffix may succeed a consonant
-        // Fifth entry: singular suffix, normal
-
-        // bacteria (bacterium), criteria (criterion), phenomena (phenomenon)
-        array('a', 1, true, true, array('on', 'um')),
-
-        // nebulae (nebula)
-        array('ea', 2, true, true, 'a'),
-
-        // services (service)
-        array('secivres', 8, true, true, 'service'),
-
-        // mice (mouse), lice (louse)
-        array('eci', 3, false, true, 'ouse'),
-
-        // geese (goose)
-        array('esee', 4, false, true, 'oose'),
-
-        // fungi (fungus), alumni (alumnus), syllabi (syllabus), radii (radius)
-        array('i', 1, true, true, 'us'),
-
-        // men (man), women (woman)
-        array('nem', 3, true, true, 'man'),
-
-        // children (child)
-        array('nerdlihc', 8, true, true, 'child'),
-
-        // oxen (ox)
-        array('nexo', 4, false, false, 'ox'),
-
-        // indices (index), appendices (appendix), prices (price)
-        array('seci', 4, false, true, array('ex', 'ix', 'ice')),
-
-        // selfies (selfie)
-        array('seifles', 7, true, true, 'selfie'),
-
-        // movies (movie)
-        array('seivom', 6, true, true, 'movie'),
-
-        // news (news)
-        array('swen', 4, true, true, 'news'),
-
-        // series (series)
-        array('seires', 6, true, true, 'series'),
-
-        // babies (baby)
-        array('sei', 3, false, true, 'y'),
-
-        // accesses (access), addresses (address), kisses (kiss)
-        array('sess', 4, true, false, 'ss'),
-
-        // analyses (analysis), ellipses (ellipsis), funguses (fungus),
-        // neuroses (neurosis), theses (thesis), emphases (emphasis),
-        // oases (oasis), crises (crisis), houses (house), bases (base),
-        // atlases (atlas)
-        array('ses', 3, true, true, array('s', 'se', 'sis')),
-
-        // objectives (objective), alternative (alternatives)
-        array('sevit', 5, true, true, 'tive'),
-
-        // drives (drive)
-        array('sevird', 6, false, true, 'drive'),
-
-        // lives (life), wives (wife)
-        array('sevi', 4, false, true, 'ife'),
-
-        // moves (move)
-        array('sevom', 5, true, true, 'move'),
-
-        // hooves (hoof), dwarves (dwarf), elves (elf), leaves (leaf), caves (cave), staves (staff)
-        array('sev', 3, true, true, array('f', 've', 'ff')),
-
-        // axes (axis), axes (ax), axes (axe)
-        array('sexa', 4, false, false, array('ax', 'axe', 'axis')),
-
-        // indexes (index), matrixes (matrix)
-        array('sex', 3, true, false, 'x'),
-
-        // quizzes (quiz)
-        array('sezz', 4, true, false, 'z'),
-
-        // bureaus (bureau)
-        array('suae', 4, false, true, 'eau'),
-
-        // roses (rose), garages (garage), cassettes (cassette),
-        // waltzes (waltz), heroes (hero), bushes (bush), arches (arch),
-        // shoes (shoe)
-        array('se', 2, true, true, array('', 'e')),
-
-        // tags (tag)
-        array('s', 1, true, true, ''),
-
-        // chateaux (chateau)
-        array('xuae', 4, false, true, 'eau'),
-    );
-
     /**
      * This class should not be instantiated.
      */
@@ -143,80 +39,13 @@ private function __construct()
      *
      * @return string|array The singular form or an array of possible singular
      *                      forms
+     *
+     * @deprecated Deprecated since version 3.1, to be removed in 4.0. Use {@see Symfony\Component\Inflector\Inflector::singularize} instead.
      */
     public static function singularify($plural)
     {
-        $pluralRev = strrev($plural);
-        $lowerPluralRev = strtolower($pluralRev);
-        $pluralLength = strlen($lowerPluralRev);
-
-        // The outer loop iterates over the entries of the plural table
-        // The inner loop $j iterates over the characters of the plural suffix
-        // in the plural table to compare them with the characters of the actual
-        // given plural suffix
-        foreach (self::$pluralMap as $map) {
-            $suffix = $map[0];
-            $suffixLength = $map[1];
-            $j = 0;
-
-            // Compare characters in the plural table and of the suffix of the
-            // given plural one by one
-            while ($suffix[$j] === $lowerPluralRev[$j]) {
-                // Let $j point to the next character
-                ++$j;
-
-                // Successfully compared the last character
-                // Add an entry with the singular suffix to the singular array
-                if ($j === $suffixLength) {
-                    // Is there any character preceding the suffix in the plural string?
-                    if ($j < $pluralLength) {
-                        $nextIsVocal = false !== strpos('aeiou', $lowerPluralRev[$j]);
-
-                        if (!$map[2] && $nextIsVocal) {
-                            // suffix may not succeed a vocal but next char is one
-                            break;
-                        }
-
-                        if (!$map[3] && !$nextIsVocal) {
-                            // suffix may not succeed a consonant but next char is one
-                            break;
-                        }
-                    }
-
-                    $newBase = substr($plural, 0, $pluralLength - $suffixLength);
-                    $newSuffix = $map[4];
-
-                    // Check whether the first character in the plural suffix
-                    // is uppercased. If yes, uppercase the first character in
-                    // the singular suffix too
-                    $firstUpper = ctype_upper($pluralRev[$j - 1]);
-
-                    if (is_array($newSuffix)) {
-                        $singulars = array();
-
-                        foreach ($newSuffix as $newSuffixEntry) {
-                            $singulars[] = $newBase.($firstUpper ? ucfirst($newSuffixEntry) : $newSuffixEntry);
-                        }
-
-                        return $singulars;
-                    }
-
-                    return $newBase.($firstUpper ? ucfirst($newSuffix) : $newSuffix);
-                }
-
-                // Suffix is longer than word
-                if ($j === $pluralLength) {
-                    break;
-                }
-            }
-        }
-
-        // Convert teeth to tooth, feet to foot
-        if (false !== ($pos = strpos($plural, 'ee')) && strlen($plural) > 3 && 'feedback' !== $plural) {
-            return substr_replace($plural, 'oo', $pos, 2);
-        }
+        @trigger_error('StringUtil::singularify() is deprecated since version 3.1 and will be removed in 4.0. Use Symfony\Component\Inflector\Inflector::singularize instead.', E_USER_DEPRECATED);
 
-        // Assume that plural and singular is identical
-        return $plural;
+        return Inflector::singularize($plural);
     }
 }
diff --git a/Tests/StringUtilTest.php b/Tests/StringUtilTest.php
@@ -13,141 +13,17 @@
 
 use Symfony\Component\PropertyAccess\StringUtil;
 
+/**
+ * @group legacy
+ */
 class StringUtilTest extends \PHPUnit_Framework_TestCase
 {
     public function singularifyProvider()
     {
-        // see http://english-zone.com/spelling/plurals.html
-        // see http://www.scribd.com/doc/3271143/List-of-100-Irregular-Plural-Nouns-in-English
+        // This is only a stub to make sure the BC layer works
+        // Actual tests are in the Symfony Inflector component
         return array(
-            array('accesses', 'access'),
-            array('addresses', 'address'),
-            array('agendas', 'agenda'),
-            array('alumnae', 'alumna'),
-            array('alumni', 'alumnus'),
-            array('analyses', array('analys', 'analyse', 'analysis')),
-            array('antennae', 'antenna'),
-            array('antennas', 'antenna'),
-            array('appendices', array('appendex', 'appendix', 'appendice')),
-            array('arches', array('arch', 'arche')),
-            array('atlases', array('atlas', 'atlase', 'atlasis')),
             array('axes', array('ax', 'axe', 'axis')),
-            array('babies', 'baby'),
-            array('bacteria', array('bacterion', 'bacterium')),
-            array('bases', array('bas', 'base', 'basis')),
-            array('batches', array('batch', 'batche')),
-            array('beaux', 'beau'),
-            array('bees', array('be', 'bee')),
-            array('boxes', 'box'),
-            array('boys', 'boy'),
-            array('bureaus', 'bureau'),
-            array('bureaux', 'bureau'),
-            array('buses', array('bus', 'buse', 'busis')),
-            array('bushes', array('bush', 'bushe')),
-            array('calves', array('calf', 'calve', 'calff')),
-            array('cars', 'car'),
-            array('cassettes', array('cassett', 'cassette')),
-            array('caves', array('caf', 'cave', 'caff')),
-            array('chateaux', 'chateau'),
-            array('cheeses', array('chees', 'cheese', 'cheesis')),
-            array('children', 'child'),
-            array('circuses', array('circus', 'circuse', 'circusis')),
-            array('cliffs', 'cliff'),
-            array('crises', array('cris', 'crise', 'crisis')),
-            array('criteria', array('criterion', 'criterium')),
-            array('cups', 'cup'),
-            array('data', array('daton', 'datum')),
-            array('days', 'day'),
-            array('discos', 'disco'),
-            array('devices', array('devex', 'devix', 'device')),
-            array('drives', 'drive'),
-            array('drivers', 'driver'),
-            array('dwarves', array('dwarf', 'dwarve', 'dwarff')),
-            array('echoes', array('echo', 'echoe')),
-            array('elves', array('elf', 'elve', 'elff')),
-            array('emphases', array('emphas', 'emphase', 'emphasis')),
-            array('faxes', 'fax'),
-            array('feet', 'foot'),
-            array('feedback', 'feedback'),
-            array('foci', 'focus'),
-            array('focuses', array('focus', 'focuse', 'focusis')),
-            array('formulae', 'formula'),
-            array('formulas', 'formula'),
-            array('fungi', 'fungus'),
-            array('funguses', array('fungus', 'funguse', 'fungusis')),
-            array('garages', array('garag', 'garage')),
-            array('geese', 'goose'),
-            array('halves', array('half', 'halve', 'halff')),
-            array('hats', 'hat'),
-            array('heroes', array('hero', 'heroe')),
-            array('hippopotamuses', array('hippopotamus', 'hippopotamuse', 'hippopotamusis')), //hippopotami
-            array('hoaxes', 'hoax'),
-            array('hooves', array('hoof', 'hoove', 'hooff')),
-            array('houses', array('hous', 'house', 'housis')),
-            array('indexes', 'index'),
-            array('indices', array('index', 'indix', 'indice')),
-            array('ions', 'ion'),
-            array('irises', array('iris', 'irise', 'irisis')),
-            array('kisses', 'kiss'),
-            array('knives', 'knife'),
-            array('lamps', 'lamp'),
-            array('leaves', array('leaf', 'leave', 'leaff')),
-            array('lice', 'louse'),
-            array('lives', 'life'),
-            array('matrices', array('matrex', 'matrix', 'matrice')),
-            array('matrixes', 'matrix'),
-            array('men', 'man'),
-            array('mice', 'mouse'),
-            array('moves', 'move'),
-            array('movies', 'movie'),
-            array('nebulae', 'nebula'),
-            array('neuroses', array('neuros', 'neurose', 'neurosis')),
-            array('news', 'news'),
-            array('oases', array('oas', 'oase', 'oasis')),
-            array('objectives', 'objective'),
-            array('oxen', 'ox'),
-            array('parties', 'party'),
-            array('phenomena', array('phenomenon', 'phenomenum')),
-            array('photos', 'photo'),
-            array('pianos', 'piano'),
-            array('plateaux', 'plateau'),
-            array('poppies', 'poppy'),
-            array('prices', array('prex', 'prix', 'price')),
-            array('quizzes', 'quiz'),
-            array('radii', 'radius'),
-            array('roofs', 'roof'),
-            array('roses', array('ros', 'rose', 'rosis')),
-            array('sandwiches', array('sandwich', 'sandwiche')),
-            array('scarves', array('scarf', 'scarve', 'scarff')),
-            array('schemas', 'schema'), //schemata
-            array('selfies', 'selfie'),
-            array('series', 'series'),
-            array('services', 'service'),
-            array('sheriffs', 'sheriff'),
-            array('shoes', array('sho', 'shoe')),
-            array('spies', 'spy'),
-            array('staves', array('staf', 'stave', 'staff')),
-            array('stories', 'story'),
-            array('strata', array('straton', 'stratum')),
-            array('suitcases', array('suitcas', 'suitcase', 'suitcasis')),
-            array('syllabi', 'syllabus'),
-            array('tags', 'tag'),
-            array('teeth', 'tooth'),
-            array('theses', array('thes', 'these', 'thesis')),
-            array('thieves', array('thief', 'thieve', 'thieff')),
-            array('trees', array('tre', 'tree')),
-            array('waltzes', array('waltz', 'waltze')),
-            array('wives', 'wife'),
-
-            // test casing: if the first letter was uppercase, it should remain so
-            array('Men', 'Man'),
-            array('GrandChildren', 'GrandChild'),
-            array('SubTrees', array('SubTre', 'SubTree')),
-
-            // Known issues
-            //array('insignia', 'insigne'),
-            //array('insignias', 'insigne'),
-            //array('rattles', 'rattle'),
         );
     }
 
diff --git a/composer.json b/composer.json
@@ -17,7 +17,8 @@
     ],
     "require": {
         "php": ">=5.5.9",
-        "symfony/polyfill-php70": "~1.0"
+        "symfony/polyfill-php70": "~1.0",
+        "symfony/inflector": "~3.1"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\PropertyAccess\\": "" },
