test | ||
Text | ||
.travis.yml | ||
inflections.cabal | ||
LICENSE | ||
README.md | ||
Setup.hs |
String Inflections for Haskell
This library is a partial port of the String Inflector from Ruby on Rails. It currently
implements methods such as parameterize
, transliterate
, camelize
,
underscore
and dasherize
. Please see the haddock documentation for a complete list of the functions implemented by this library.
Unlike the ActiveSupport (Rails) and Ember implementations of inflections, this
library uses a parser to verify the input to functions like camelize
. This is
done to ensure that the output strings adhere to the syntax that they are supposed to generate.
Usage
The following examples demonstrate usage of the parameterize
and transliterate
functions:
λ: parameterize "Hola. ¿Cómo estás?"
"hola-como-estas"
λ: transliterate "Hola. ¿Cómo estás?"
"Hola. ?Como estas?"
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 parameterizeCustom
function.
If you want to specify a custom default replacement or approximation table for the transliterate
function, you should instead call the transliterateCustom
function which accepts a String for replacements and a Map for substitution.
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. Tests are appreciated with your contribution.
License
MIT - see the LICENSE file.