Truncate strings with multibyte chars and ansi codes
- No monkey-patching String class
- Supports multibyte character encodings such as UTF-8, EUC-JP
- Handles languages without white-spaces between words (like Chinese and Japanese)
- Supports ANSI escape codes
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install strings-truncation
truncate to shorten string to 30 characters by default:
Strings::Truncate.truncate("It is not down on any map; true places never are.") # => "It is not down on any map; tr…""
You can specify custom omission string:
Strings::Truncation.truncate("It is not down on any map; true places never are.", 40, omission: "...(continued)") # => "It is not down on any map;...(continued)"
It supports truncation of multibyte characters. For example, truncating Japanese sentence:
Strings::Truncation.truncate("太丸ゴシック体", 8) # => "太丸ゴ…"
It supports truncation of ANSI escape codes as well:
Strings::Truncation.truncate("I try \e[34mall things\e[0m, I achieve what I can", 18) # => "I try \e[34mall things\e[0m…"
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/strings-truncation. 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.
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Strings::Truncation project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Copyright (c) 2019 Piotr Murach. See LICENSE for further details.