Strings::ANSI

Handle ANSI escape codes in strings.

Strings::ANSI provides ANSI handling component for Strings.

Installation

Add this line to your application's Gemfile:

gem 'strings-ansi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install strings-ansi

1. Usage
2. API
3. Extending String class

Usage

The Strings::ANSI is a module that can check if a string has ANSI escape codes:

Strings::ANSI.ansi?("\e[32mHello\e[0m")
# => true

It can also check if a string consists of only ANSI codes:

Strings::ANSI.only_ansi?("\e[32mHello\e[0m")
# => false

Finally, you can remove any ANSI codes from a string:

Strings::ANSI.sanitize("\e[32mHello\e[0m")
# => "Hello"

2. API

2.1 ansi?

To check if a string includes ANSI escape codes use ansi? like so:

Strings::ANSI.ansi?("\e[33;44mfoo\e[0m")
# => true

2.2 only_ansi?

To check if a string includes only ANSI escape codes use only_ansi?:

Strings::ANSI.only_ansi?("\e[33;44mfoo\e[0m")
# => false

2.3 sanitize

To remove ANSI codes from a string use sanitize:

Strings::ANSI.sanitize("\e[0;33;49mHello\e[0m")
# => Hello

3. Extending String class

Though it is highly discouraged to pollute core Ruby classes, you can add the required methods to String class by using refinements.

For example, if you wish to only extend strings with sanitize method do:

module MyStringExt
  refine String do
    def sanitize
      Strings::ANSI.sanitize(self)
    end
  end
end

This will make sanitize method available for any strings where refinement is applied:

using MyStringExt

string.sanitize("\e[32mHello\e[0m")
# => Hello

Alternatively, if you want to include all the Strings::ANSI methods:

require 'strings/ansi/extensions'

using Strings::ANSI::Extensions

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-ansi. 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::ANSI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

tiegz/strings-ansi