Scriptify

Transforms a text/string into a reasonably accurate uppercase representation.

"hello".superscript

Results in:

"ʰᵉˡˡᵒ"

Installation

Add this line to your application's Gemfile:

gem 'scriptify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install scriptify

Usage

class String
  include Scriptify
end

And then

"abc".superscript

Opts

• fallback_lower - bool, default false, determines if we should try to get a lowercase representation of that letter. Consider that lowercase superscripts are more common than uppercase
• replace_unknown - char/bool, default false, determines what to replace unknown (i.e. not found) characters with. If falsey, then the characters will be kept in the string. If you want to remove not-found characters, simply pass an empty string

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/xnt/scriptify. 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.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

License

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

Code of Conduct

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