{Build Status] {Build status] {Gem Version] {Code Climate] {Test Coverage] {Inline docs]
Welcome to HighLine.
HighLine was designed to ease the tedious tasks
of doing console input and
output with low-level methods like
gets
and puts
. HighLine provides a
robust system for requesting
data from a user, without needing to code all the
error checking and
validation rules and without needing to convert the typed
Strings into what
your program really needs. Just tell HighLine
what you're
after, and let it do all the work.
See: Rubydoc.info for HighLine. Specially HighLine and HighLine::Question.
require 'highline' # Basic usage cli = HighLine.new answer = cli.ask "What do you think?" puts "You have answered: #{answer}" # Default answer cli.ask("Company? ") { |q| q.default = "none" } # Validation cli.ask("Age? ", Integer) { |q| q.in = 0..105 } cli.ask("Name? (last, first) ") { |q| q.validate = /\A\w+, ?\w+\Z/ } # Type conversion for answers: cli.ask("Birthday? ", Date) cli.ask("Interests? (comma sep list) ", lambda { |str| str.split(/,\s*/) }) # Reading passwords: cli.ask("Enter your password: ") { |q| q.echo = false } cli.ask("Enter your password: ") { |q| q.echo = "x" } # ERb based output (with HighLine's ANSI color tools): cli.say("This should be <%= color('bold', BOLD) %>!") # Menus: cli.choose do |menu| menu.prompt = "Please choose your favorite programming language? " menu.choice(:ruby) { cli.say("Good choice!") } menu.choices(:python, :perl) { cli.say("Not from around here, are you?") } menu.default = :ruby end ## Using colored indices on Menus HighLine::Menu.index_color = :rgb_77bbff # set default index color cli.choose do |menu| menu.index_color = :rgb_999999 # override default color of index # you can also use constants like :blue menu.prompt = "Please choose your favorite programming language? " menu.choice(:ruby) { cli.say("Good choice!") } menu.choices(:python, :perl) { cli.say("Not from around here, are you?") } end
If you want to save some characters, you can inject/import HighLine methods on Kernel by doing the following. Just be sure to avoid name collisions in the top-level namespace.
require 'highline/import' say "Now you can use #say directly"
For more examples see the examples/ directory of this project.
HighLine from version >= 1.7.0 requires ruby >= 1.9.3
To install HighLine, use the following command:
$ gem install highline
(Add sudo
if you're installing under a POSIX system as
root)
If you're using Bundler, add this to your Gemfile:
source "https://rubygems.org" gem 'highline'
And then run:
$ bundle
If you want to build the gem locally, use the following command from the root of the sources:
$ rake package
You can also build and install directly:
$ rake install
Open an issue
Fork the repository
Clone it locally
clone git@github.com:YOUR-USERNAME/highline.git
Add the main HighLine repository as the upstream remote
highline
remote add upstream https://github.com/JEG2/highline
Keep your fork in sync with upstream
fetch upstream
checkout master
merge upstream/master
Create your feature branch
checkout -b your_branch
Hack the source code, run the tests and pronto
test
acceptance
run
Commit your changes
commit -am "Your commit message"
Push it
push
Open a pull request
Details on:
GitHub Guide to Contributing to Open Source - guides.github.com/activities/contributing-to-open-source/
GitHub issues - guides.github.com/features/issues/
Forking - help.github.com/articles/fork-a-repo/
Adding upstream - help.github.com/articles/configuring-a-remote-for-a-fork/
Syncing your fork - help.github.com/articles/syncing-a-fork/
Branching - git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging
Commiting - git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository
Pushing - git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes
James Edward Gray II - Author
Gregory Brown - Core contributor
Abinoam P. Marques Jr. - Core contributor
For a list of people who have contributed to the codebase, see GitHub’s list of contributors.