termcontroller

Termcontroller

A very basic Controller (in the MVC sense) for Ruby terminal applications. This was pulled out of my text editor, Re.

YOU ALMOST CERTAINLY DO NOT YET WANT TO USE THIS FOR YOUR OWN CODE

I do intend to clean it up and make it usable for others, but it's not there yet - if you think it'd be useful for you, feel free to drop me a message.

Installation

Add this line to your application's Gemfile:

gem 'termcontroller'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install termcontroller

Usage

require 'termcontroller'

class Target
  def initialize
    # Second argument is a keyboard mapping.
    @ctrl = Termcontroller::Controller.new(self, {
      :f1 => :help
    })
  end

  def help
    puts "This is a help text"
  end

  def run
    loop do
      p @ctrl.handle_input
      print "\r"
    end
  end

  def ctrl_c; exit; end
end

puts "Ctrl+c to quit"
Target.new.run

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

License

The gem is available as open source under the terms of the MIT License.