Skip to content

Add Inflector component (from StringUtil of PropertyAccess) #18260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
226 changes: 226 additions & 0 deletions src/Symfony/Component/Inflector/Inflector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Inflector;

/**
* Converts words between singular and plural forms.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @internal
*/
final class Inflector
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It it's a new component, we should probably introduce an interface, an mark it @internal until we add at least a pluralize method.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably mark the whole component as @internal for now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we mark this as @internal, what's the migration path for existing applications using StringUtil::singularize?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As StringUtil is part of Symfony, it can use the internal class. There is no problem here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are deprecating StringUtil::singularify, aren't we? Since it was a public method, what should users switch to when they upgrade? Or do we just say it's going to be removed and you're on your own now? Can we do that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. To avoid the problem with an incomplete interface, maybe can we introduce a PluralizerInterface (and later we'll add a SingularizerInterface).

That way, there is no need to mark the component @internal.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not add an interface yet, until we figure out what are the real needs for these interfaces

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stof what do you think of this use case: #18260 (comment) (just asking, I don't need that for now)

{
/**
* 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.
*/
private function __construct()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ins't it the good time to remove the static interface?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That means we'll need to construct the Inflector and inject it where it's needed. What's the expected benefit?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not necessary to inject it. You can construct it in a constructor for instance. The benefit is extensibility. Thanks to the interface you can replace the built in inflector with a custom one.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another immediate benefit: the ability to use custom inflectors supporting non-english languages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to decide on the scope of this component.

{
}

/**
* Returns the singular form of a word.
*
* If the method can't determine the form with certainty, an array of the
* possible singulars is returned.
*
* @param string $plural A word in plural form
*
* @return string|array The singular form or an array of possible singular
* forms
*
* @internal
*/
public static function singularize($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);
}

// Assume that plural and singular is identical
return $plural;
}
}
19 changes: 19 additions & 0 deletions src/Symfony/Component/Inflector/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2012-2016 Fabien Potencier
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The year is 2012 based on 7837f50


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
19 changes: 19 additions & 0 deletions src/Symfony/Component/Inflector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Inflector Component
===================

Inflector converts words between their singular and plural forms (English only).

Disclaimer
----------

This component is currently marked as internal. Do not use it in your own code.
Breaking changes may be introduced in the next minor version of Symfony, or the
component itself might even be removed completely.

Resources
---------

* [Contributing](https://symfony.com/doc/current/contributing/index.html)
* [Report issues](https://github.com/symfony/symfony/issues) and
[send Pull Requests](https://github.com/symfony/symfony/pulls)
in the [main Symfony repository](https://github.com/symfony/symfony)
Loading