/diacritics

Support diacritics

Primary LanguageRubyMIT LicenseMIT

Diacritics

Gem Version Build Status Dependency Status Coverage Status Stories in Ready

Diacritics is a gem which support downcase, upcase and permanent link with diacritical characters.

Installation

Add this line to your application's Gemfile:

gem 'diacritics'

And then execute:

$ bundle

Or install it yourself as:

$ gem install diacritics

Usage

You can include methods into String class:

String.send(:include, Diacritics::String)

and use

"ŁoreM Ìpsum Ðolór. Šit Ämet".downcase #=> "łorem ìpsum ðolór. šit ämet"
"łorem ìpsum ðolÓr. šit ämet".upcase #=> "ŁOREM ÌPSUM ÐOLÓR. ŠIT ÄMET"
"Łorem ìpsum ÐolÓr. Šit ämet".permanent #=> "lorem-ipsum-dolor-sit-aemet"
'lorem-ipsum-dolor-sit-aemet'.permanent? #=> true
'łorem ìpsum ðolór. šit ämet'.permanent? #=> false
'lorem-ipsum-dolor-sit-aemet'.slug? #=> true
'lorem@ipsum-dolor-sit-aemet'.slug? #=> false

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Please remember about tests. Before you add new characters add test first and check that this test doesn't pass. Many of characters are the same in different languages.