inflections

Inflections library for Haskell https://github.com/stackbuilders/inflections-hs

Version on this page:0.3.0.0
LTS Haskell 8.20:0.3.0.0
Stackage Nightly 2017-06-28:0.3.0.0
Latest on Hackage:0.3.0.0
MIT licensed and maintained by Justin Leitgeb

Module documentation for 0.3.0.0

String Inflections for Haskell

License MIT Hackage Stackage Nightly Stackage LTS Build Status

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. You can read more about the philosophy behind this library in the Haddock documentation.

Usage

The following examples demonstrate usage of the parameterize, transliterate and camelize functions:

λ: parameterize "Hola. ¿Cómo estás?"
"hola-como-estas"

λ: transliterate "Hola. ¿Cómo estás?"
"Hola. ?Como estas?"

λ: import Control.Monad (liftM)
λ: liftM camelize $ parseSnakeCase "hey_there"
"HeyThere"

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!

Further documentation

For more information, please see the the Haddock docs for this module.

Author

Justin Leitgeb

Contributing

You may submit pull requests to this repository on GitHub. Tests are appreciated with your contribution.

License

MIT - see the LICENSE file.

Changes

Inflections 0.3.0.0

  • A more type-safe API forbidding creation of invalid words.

  • Made the API use Text instead of String (which significally improved speed).

  • Switched to Megaparsec 5 for parsing.

  • Renamed defaultMap to defaultTransliterations.

  • Words now can contain digits (recognized by all parsers).

  • parseSnakeCase now is not confused when a word happens to have prefix coinciding with an acronym. This is harder to fix for parseCamelCase because acronym may contain capital letters, so old behavior is preserved for parseCamelCase for now.

  • parseCamelCase and parseSnakeCase take any instance of Foldable as a collection of acronyms, not just lists.

  • Added the CHANGELOG.md file.

  • Switched test suite to Hspec.

  • The toUnderscore, toDashed, and toCamelCased are not partial anymore. They return parse error in Left just like parsing functions, but this result can be lifted into any instance of MonadThrow with betterThrow helper.

  • Improved documentation.

Inflections 0.2.0.1

  • Support for GHC 8.0.

Inflections 0.2.0.0

  • Added other-modules to test suite.

Inflections 0.1.0.10

  • Support for GHC 7.10.

Inflections 0.1.0.9

  • Support for GHC 7.8.

Inflections 0.1.0.8

  • Fixed a typo in docs of humanize.

  • Added toUnderscore, toDashed, and toCamelCased.

Inflections 0.1.0.7

  • Support for base-4.7.

  • Improved documentation.

Inflections 0.1.0.6

  • Added titleize and humanize.

  • Improved documentation.

Inflections 0.1.0.5

  • Added module documentation for Text.Inflections.

Inflections 0.1.0.4

  • Reduced number of public modules to one: Text.Inflections.

  • Added ordinal and ordinalize.

  • Improved documentation.

Inflections 0.1.0.3

  • Added camelize, camelizeCustom, underscore, and underscoreCustom.

  • Made the word parser accept empty input.

  • Improved documentation.

Inflections 0.1.0.2

  • Added the transliterate and transliterateCustom functions.

Inflections 0.1.0.1

  • No changes.

Inflections 0.1.0.0

  • Initial release.
comments powered byDisqus