EF 6: Pluralization Service ahora es un servicio público

Esta ‘pequeña feature’ era algo que tenía en mente hacer desde hace tiempo, después de otros pull request con features y pequeños arreglos, he podido sacar un rato y realizar la implementación del mismo como podéis ver en este change set. La idea es básicamente poder tunear el servicio que se encarga de realizar la singularización y pluralización de nuestras entidades, por ejemplo para decidir por convención el nombre de una tabla. En realidad, este servicio es utilizado principalmente por PluralizingTableNameConvention y PluralizingEntitySetNameConvention para realizar su trabajo. Hasta ahora, es clase no era pública y su uso estaba fijado por las convenciones anteriores, no teniendo ninguna forma de cambiar la implementación del mismo. A lo largo de las siguientes líneas os contaré los cambios realizados y lo que podremos hacer en la siguiente versión de EF.

Haciendo el servicio público

Lo primero es crear el contrato para este servicio, que como podéis ver a continuación es tan sencillo como lo siguiente:

    <span class="kwrd">public</span> <span class="kwrd">interface</span> IPluralizationService
    {
        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Check if a word is plural.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;word&quot;&gt;The word to check.&lt;/param&gt;</span>
        <span class="rem">/// &lt;returns&gt;True if word is plural; false otherwise..&lt;/returns&gt;</span>
        <span class="kwrd">bool</span> IsPlural(<span class="kwrd">string</span> word);

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Check if a word is singular.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;word&quot;&gt;The word to check.&lt;/param&gt;</span>
        <span class="rem">/// &lt;returns&gt;True if word is singular; false otherwise.&lt;/returns&gt;</span>
        <span class="kwrd">bool</span> IsSingular(<span class="kwrd">string</span> word);

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Pluralize a word using the service.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;word&quot;&gt;The word to pluralize.&lt;/param&gt;</span>
        <span class="rem">/// &lt;returns&gt;The pluralized word &lt;/returns&gt;</span>
        <span class="kwrd">string</span> Pluralize(<span class="kwrd">string</span> word);

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Singularize a word using the service.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;word&quot;&gt;The word to singularize.&lt;/param&gt;</span>
        <span class="rem">/// &lt;returns&gt;The singularized word.&lt;/returns&gt;</span>
        <span class="kwrd">string</span> Singularize(<span class="kwrd">string</span> word);
    }

public interface IPluralizationService

{

/// <summary>

/// Check if a word is plural.

/// </summary>

/// <param name="word">The word to check.</param>

/// <returns>True if word is plural; false otherwise..</returns>

bool IsPlural(string word);

/// <summary>

/// Check if a word is singular.

/// </summary>

/// <param name="word">The word to check.</param>

/// <returns>True if word is singular; false otherwise.</returns>

bool IsSingular(string word);

/// <summary>

/// Pluralize a word using the service.

/// </summary>

/// <param name="word">The word to pluralize.</param>

/// <returns>The pluralized word </returns>

string Pluralize(string word);

/// <summary>

/// Singularize a word using the service.

/// </summary>

/// <param name="word">The word to singularize.</param>

/// <returns>The singularized word.</returns>

string Singularize(string word);

}

Este servicio, por defecto, tendrá una implementación basada en lengua inglesa, llamado EnglishPluralizationService, que no es más que la adaptación a este contrato del servicio anterior, por compatibilidad. Para registrar la implementación que queramos usar se ha incluido un nuevo método en DbConfiguration llamado SetPluralizationService, gracias al cuál podremos establecer esta implementación, si es que queremos cambiar la existente. A continuación podemos ver un ejemplo de esto:

    <span class="kwrd">public</span> <span class="kwrd">class</span> OrderContextDbConfiguration
        : DbConfiguration
    {
        <span class="kwrd">public</span> OrderContextDbConfiguration()
        {
            SetPluralizationService(<span class="kwrd">new</span> SpanishPluralizationService());
        }
    }

public class OrderContextDbConfiguration

: DbConfiguration

{

public OrderContextDbConfiguration()

{

SetPluralizationService(new SpanishPluralizationService());

}

Un pequeño añadido aprovechando la coyuntura..

Ya metidos en faena, hay una pequeña cosa que podíamos hacer para no obligar a nadie a crear un servicio de pluralización si alguna de las reglas del existente no le convenía o quisiera ‘customizar’ este trabajo. La idea es básicamente permitir al usuario incluir en el servicio de pluralización la definición de una entrada de diccionario, con los correspondientes Singular y Plural, como podemos ver en el siguiente fragmento.

    <span class="kwrd">public</span> <span class="kwrd">class</span> CustomPluralizationEntry
    {
        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Get the singular.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">string</span> Singular { get; <span class="kwrd">private</span> set; }

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Get the plural.</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="kwrd">public</span> <span class="kwrd">string</span> Plural { get; <span class="kwrd">private</span> set; }

        <span class="rem">/// &lt;summary&gt;</span>
        <span class="rem">///     Create a new instance</span>
        <span class="rem">/// &lt;/summary&gt;</span>
        <span class="rem">/// &lt;param name=&quot;singular&quot;&gt;A non null or empty string representing the singular.&lt;/param&gt;</span>
        <span class="rem">/// &lt;param name=&quot;plural&quot;&gt;A non null or empty string representing the plural.&lt;/param&gt;</span>
        <span class="kwrd">public</span> CustomPluralizationEntry(<span class="kwrd">string</span> singular, <span class="kwrd">string</span> plural)
        {
            Check.NotEmpty(singular, <span class="str">&quot;singular&quot;</span>);
            Check.NotEmpty(plural, <span class="str">&quot;plural&quot;</span>);

            Singular = singular;
            Plural = plural;
        }
    }

public class CustomPluralizationEntry

{

/// <summary>

/// Get the singular.

/// </summary>

public string Singular { get; private set; }

/// <summary>

/// Get the plural.

/// </summary>

public string Plural { get; private set; }

/// <summary>

/// Create a new instance

/// </summary>

/// <param name="singular">A non null or empty string representing the singular.</param>

/// <param name="plural">A non null or empty string representing the plural.</param>

public CustomPluralizationEntry(string singular, string plural)

{

Check.NotEmpty(singular, "singular");

Check.NotEmpty(plural, "plural");

Singular = singular;

Plural = plural;

}

Estas entradas de diccionario se pueden establecer en el constructor del servicio de pluralización antes de registrarlo, por ejemplo, ahora utilizando un IDbDependencyResolver, como vemos:

    <span class="kwrd">public</span> <span class="kwrd">class</span> UnityDependencyResolver
        : IDbDependencyResolver
    {
        IUnityContainer _container;

        <span class="kwrd">public</span> UnityDependencyResolver()
        {
            _container = <span class="kwrd">new</span> UnityContainer();

            _container.RegisterType&lt;IPluralizationService&gt;(<span class="kwrd">new</span> InjectionFactory((c) =&gt;
            {
                var pluralizationService = <span class="kwrd">new</span> EnglishPluralizationService(<span class="kwrd">new</span> CustomPluralizationEntry[]
                {
                    <span class="kwrd">new</span> CustomPluralizationEntry(<span class="str">&quot;Producto&quot;</span>,<span class="str">&quot;Productos&quot;</span>)
                });

                <span class="kwrd">return</span> pluralizationService;
            }));
        }

        <span class="kwrd">public</span> <span class="kwrd">object</span> GetService(Type type, <span class="kwrd">object</span> key)
        {
            <span class="kwrd">if</span> (_container.IsRegistered(type))
                <span class="kwrd">return</span> _container.Resolve(type, (<span class="kwrd">string</span>)key);

            <span class="kwrd">return</span> <span class="kwrd">null</span>;
        }
    }

public class UnityDependencyResolver

: IDbDependencyResolver

{

IUnityContainer _container;

public UnityDependencyResolver()

{

_container = new UnityContainer();

_container.RegisterType<IPluralizationService>(new InjectionFactory((c) =>

{

var pluralizationService = new EnglishPluralizationService(new CustomPluralizationEntry[]

{

new CustomPluralizationEntry("Producto","Productos")

});

return pluralizationService;

}));

}

public object GetService(Type type, object key)

{

if (_container.IsRegistered(type))

return _container.Resolve(type, (string)key);

return null;

}

Bonus

Bien, una vez hecho público el servicio lo mejor era dar un ejemplo de implementación, por eso, otra de las cosas que he estado haciendo estas vacaciones ha sido la creación de este servicio de pluralización en castellano, aunque por ahora no lo he hecho público puesto que estoy mirando la mejor manera de hacerlo…en cuanto esté os comentaré como podréis utilizarlo….

Espero que os gustara la entrada y, como no, os invito a pasaros por el la página del proyecto en CodePlex y a contribuir de las muchas formas en las que se puede…

Saludos

Unai

EF 6: Pluralization Service ahora es un servicio público

Haciendo el servicio público

Un pequeño añadido aprovechando la coyuntura..

Bonus

Un comentario sobre “EF 6: Pluralization Service ahora es un servicio público”

Responder a anonymous Cancelar respuesta