Skip to content
Truncate strings with multibyte chars and ansi codes
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bin
lib
spec
tasks
.gitignore
.rspec
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
appveyor.yml
strings-truncation.gemspec

README.md

Strings::Truncation

Gem Version Build Status Build status Maintainability Coverage Status Inline docs

Truncate strings with multibyte chars and ansi codes

Features

  • 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

Installation

Add this line to your application's Gemfile:

gem 'strings-truncation'

And then execute:

$ bundle

Or install it yourself as:

$ gem install strings-truncation

Usage

Use 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…"

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

License

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

Copyright (c) 2019 Piotr Murach. See LICENSE for further details.

You can’t perform that action at this time.