No commit activity in last 3 years
No release in over 3 years
Accurately counts the number of letters in a given Uthmani string.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 5.0
~> 13.0
 Project Readme

UthmaniTextSize

Accurately counts the number of letters in a given uthmani text. In Ruby, if you call #size on an arabic string with puncuation marks it will count each mark as a seperate letter.

This gem monkey patches String to provide a #uthmani_size method that filters out all the extra marks and returns an accurate count of the letters.

As an example:

"بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ".size returns 38, whereas " بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ".uthmani_size returns 19.

Installation

Add this line to your application's Gemfile:

gem 'uthmani_text_size'

And then execute:

$ bundle

Or install it yourself as:

$ gem install uthmani_text_size

Usage

"ٱلرَّحْمَٰنِ".uthmani_size, which would return 6.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/AbuMareBear/uthmani_text_size. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the UthmaniTextSize project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.