mirror of https://github.com/typeable/inflections-hs.git synced 2024-08-16 01:20:23 +03:00

Rails-like inflections for Haskell

Go to file

Justin Leitgeb 2c22ed5daa First commit		2014-02-25 00:00:52 -05:00
test	First commit	2014-02-25 00:00:52 -05:00
Text	First commit	2014-02-25 00:00:52 -05:00
inflections.cabal	First commit	2014-02-25 00:00:52 -05:00
LICENSE	First commit	2014-02-25 00:00:52 -05:00
README.md	First commit	2014-02-25 00:00:52 -05:00
Setup.hs	First commit	2014-02-25 00:00:52 -05:00

README.md

String Inflections for Haskell

This library is a partial port of the String Inflector from Ruby on Rails. Specifically, it implements the parameterize and dasherize functions from the Inflector.

Usage

The most common usage of this library at this point is to parameterize a URL. This is accomplished as follows:

λ: parameterize defaultTransliterations "¡Feliz año nuevo!"
"feliz-ano-nuevo"

Customization

Part of parameterizing strings is approximating all characters in the input encoding to ASCII characters. This library copies the character approximation table from the Ruby i18n library. This data structure is provided as defaultCharacterTransliterations. You can provide your own transliteration map by passing a Map structure (from Data.Map) to the parameterize function.

TODO

I'd like this library to implement other functions found in the Rails inflections library. If you need one of those functions, please submit a pull request!

Author

Justin Leitgeb justin@stackbuilders.com

Contributing

You may submit pull requests to this repository on GitHub. Please add property tests for any functional changes that you make to this library.

License

MIT - see the LICENSE file.