Project

clir

0.0
No release in over a year
Command Line Interface for Ruby applications, a lot of usefull methods
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

Runtime

 Project Readme

Clir

A lot of usefull methods to deal with CLI application and more. Its my Swizerland's Knife.

Installation

Add this line to your application's Gemfile:

gem 'clir'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install clir

Usage

String extensions

Only some of them below.

puts "Some texte in red".red

puts <<~EOT
This text is white.
#{'color follows'.yellow_} This text is also in yellow thanks
to the '_' after de color name.
EOT

Test state

# Use it in test_helper.rb ou spec_helper.rb

require 'clir'

CLI.set_tests_on_with_marker
# => universal test marker. Whereever you call the app, test?
# will be true

# Don't forget to use :
CLI.unset_tests_on_with_marker
# … to remove test on

Mode test with interactive mode for TTY

When tests are ON, TTY::(My)Prompt toggle in inputs_mode so tests can send it the fake-user inputs. Sometimes though, tests use Osascript to run real live test (like if an user stokes real keys). In this case, TTY::Prompt must stay in interactive mode. To do so, tests have to call these methods:

TTY::MyPrompt.set_mode_interactive
# => TTY:MyPrompt toggles in interactive mode during the tests

TTY::MyPrompt.set_mode_inputs
# => TTY::MyPrompt toggles in inputs mode during the tests (or not…)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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/[USERNAME]/clir.