inflector's Introduction

Inflectorex

Inflectorex pluralizes and singularizes English nouns.

Usage

Inflectorex.singularize("workers") # will give "worker"

Inflectorex.pluralize("secret") # will give "secrets"

Extending the regex lists

Currently the application has 4 regex lists. You can extend these lists using the config block. To extend each of the lists the keys are as follows -

@plural_regexps - plural
@singular_regexps - singular
@singular_uninflected - singular_uninflected
@plural_uninflected - plural_uninflected

_{Note - right is the key}

Example config

config  :inflectorex, plural: [
    {~r/developer/ , "developers"},
    {~r/elixir/, "elixirs"}
]

Todo

Credits

CakePHP's inflector
degex/inflector

License

MIT

inflector's People

Contributors

Stargazers

Watchers

inflector's Issues

Make singular/plural definitions extendable

This is important as you'll never be able to cover all possible cases, especially when it comes to jargon and other words that reside around any particular domain.

Here are a few different ways you could do this, I'll let you decide.

Simple additions to the regex: Add a ++ Application.get_env(:inflextorex, :singlular_uninflected, []) to each regex. The user could build a config/inflections.exs which could be imported inside config/config.exs
Make a DSL. Allow the user to do a use on a DSL module you create and then make a macro to add additional definitions. The user would then likely use this new module you've helped them build in order to interface with your package. It may be best to only store in this module the additions and build it to fall back to your current implementation.
A mix of the above two, build a wrapper around Mix.Config which exposes a DSL to add new inflections. Make a mix task to create the config/inflections.exs with some examples and comments and append an import to config/config.exs. Your macro for adding new inflections expands to simple mix config settings.