Prawn::Rtl::Support

This gem provide bidirectional text support for Prawn. It uses Unicode Bidirectional Algorithm for displaying text from TwitterCldr::Shared::Bidi and connect arabic letters using Arabic Letter Connector. Prawn patching is minimal, we patch only Prawn::Text::Formatted::Box#original_text.

Motivation

Ruby and Rails internally provide unicode string normalization and store normalized letters inside. But Prawn don't connect arabic glyphs back and don't suport mixet LTR and RTL string. This gem add this suport.

Acknowledgment

This gem use same code as Arabic Letter Connector by @staii and therefore based on Arabic-Prawn by Dynamix Solutions (Ahmed Nasser).

Installation

Add this line to your application's Gemfile:

gem 'prawn-rtl-support'

And that's all. Your Prawn is patched!

Or install it yourself as:

$ gem install prawn-rtl-support

Usage

prawn-rtl-support provide method Prawn::Rtl::Connector#fix_rtl(string) which reverse string and connect arabic letters. Prawn patching is minimal, we patch only Prawn::Text::Formatted::Box#original_text.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/cropio/prawn-rtl-support. 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.