Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Handles every aspect (that I could think of) of dealing with ANSI escape sequences.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .document
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.rdoc
Octocat-spinner-32 Rakefile
Octocat-spinner-32 VERSION
Octocat-spinner-32 sc-ansi.gemspec
README.rdoc

sc-ansi

Handles every aspect (that I could think of) of dealing with ANSI escape sequences. You can produce ANSI codes easily enough:

require 'sc-ansi'                              # or just require 'ansi' if you prefer.

"a string!".red                                #=> a red string!
"a string!".blue                               #=> a blue string!
"a string!".red + "another string!".blue       #=> a red string and a blue string!

# or...
include ANSI

red  { "a string!" }                           #=> a red string!
blue { "a string!" }                           #=> a blue string!

red + "a string!" + blue + "another string!"   #=> a red string and a blue string!

Parsing ANSI Codes

The unique thing about sc-ansi is that it can also parse ANSI codes out of an input string. Useful if you're writing your own console application and you want to interpret, say, the UP arrow for history recall.

include ANSI                                   # for the escape codes

string = move_up + " hello " + move_down       #=> "\e[A hello \e[B"
string.ansi_sequences                          #=> [ ANSI::CURSOR_UP, ANSI::CURSOR_DOWN ]

string.replace_ansi do |sequence|              # sequence is an instance of ANSI::Match
  case sequence
    when ANSI::CURSOR_UP                       # or ANSI::CUU
      "(up)"
    when ANSI::CURSOR_DOWN                     # or ANSI::CUD
      "(down)" 
  end
end
#=> "(up) hello (down)"

Note on Patches/Pull Requests

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don't break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright © 2010 Colin MacKenzie IV. See LICENSE for details.

Something went wrong with that request. Please try again.