tty-prompt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74106ace23d50cc8593146b1b90c3b19ceca9914
+  data.tar.gz: d1719d051b15c93a321df9192315c8e4633b9e4d
+SHA512:
+  metadata.gz: 6a5d268782541918e2f59b3e5c260c25fcd015e14004a1233ae69d5163ac8d76ffda6467ad29a2750efe561575639e355593403b426dd6fcbfb0aeda83fa4d77
+  data.tar.gz: df72ebf11ee221b0d9a49c9c4e8d6398afe161e4db3f48fed012aebf9f3a15dfe11caab3bb46def1837baddf864ff8d2291e522df4bb63ab49532ed1651f0f63

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--warnings

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+bundler_args: --without yard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+matrix:
+  include:
+    - rvm: jruby-19mode
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+    - rvm: jruby-head
+    - rvm: rbx-2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-20mode
+    - rvm: jruby-21mode
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake',  '~> 10.4.2'
+  gem 'rspec', '~> 3.3.0'
+  gem 'yard',  '~> 0.8.7'
+  gem 'benchmark-ips', '~> 2.0.0'
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.8.2'
+  gem 'simplecov', '~> 0.10.0'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Piotr Murach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# TTY::Prompt
+[![Gem Version](https://badge.fury.io/rb/tty-prompt.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/peter-murach/tty-prompt.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/peter-murach/tty-prompt/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/peter-murach/tty-prompt/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/peter-murach/tty-prompt.svg?branch=master)][inchpages]
+
+[gem]: http://badge.fury.io/rb/tty-prompt
+[travis]: http://travis-ci.org/peter-murach/tty-prompt
+[codeclimate]: https://codeclimate.com/github/peter-murach/tty-prompt
+[coverage]: https://coveralls.io/r/peter-murach/tty-prompt
+[inchpages]: http://inch-ci.org/github/peter-murach/tty-prompt
+
+> A beautiful and powerful interactive command line prompt.
+
+**TTY::Prompt** provides independent prompt component for [TTY](https://github.com/peter-murach/tty) toolkit.
+
+## Features
+
+* A robust API for getting and validating complex inputs
+* Number of coercion methods for converting response into Ruby types
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-prompt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-prompt
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1 ask](#21-ask)
+  * [2.2 read](#22-read)
+  * [2.3 say](#23-say)
+  * [2.4 suggest](#24-suggest)
+
+
+## 1. Usage
+
+In order to start asking questions on the command line, create prompt:
+
+```ruby
+prompt = TTY::Prompt.new
+```
+
+and then call `ask` with the question message:
+
+```ruby
+question = prompt.ask('Do you like Ruby?')
+```
+
+Finally, read and convert answer back to Ruby built-in type:
+
+```ruby
+answer = question.read_bool
+```
+
+## 2. Interface
+
+### 2.1 ask
+
+In order to ask a basic question and parse an answer do:
+
+```ruby
+answer = prompt.ask("What is your name?").read_string
+```
+
+The **TTY::Prompt** provides small DSL to help with parsing and asking precise questions
+
+```ruby
+argument   # :required or :optional
+char       # turn character based input, otherwise line (default: false)
+clean      # reset question
+default    # default value used if none is provided
+echo       # turn echo on and off (default: true)
+mask       # mask characters i.e '****' (default: false)
+modify     # apply answer modification :upcase, :downcase, :trim, :chomp etc..
+in         # specify range '0-9', '0..9', '0...9' or negative '-1..-9'
+validate   # regex against which stdin input is checked
+valid      # a list of expected valid options
+```
+
+You can chain question methods or configure them inside a block:
+
+```ruby
+prompt.ask("What is your name?").argument(:required).default('Piotr').validate(/\w+\s\w+/).read_string
+
+prompt.ask "What is your name?" do
+  argument :required
+  default  'Piotr'
+  validate /\w+\s\w+/
+  valid    ['Piotr', 'Piotrek']
+  modify   :capitalize
+end.read_string
+```
+
+### 2.2 read
+
+To start reading the input from stdin simply call `read` method:
+
+```ruby
+prompt.read
+```
+
+However, there will be cases when your codebase expects answer to be of certain type. **TTY::Prompt** allows reading of answers and converting them into required types with custom readers:
+
+```ruby
+read_bool       # return true or false for strings such as "Yes", "No"
+read_char       # return first character
+read_date       # return date type
+read_datetime   # return datetime type
+read_email      # validate answer against email regex
+read_file       # return a File object
+read_float      # return decimal or error if cannot convert
+read_int        # return integer or error if cannot convert
+read_multiple   # return multiple line string
+read_password   # return string with echo turned off
+read_range      # return range type
+read_regex      # return regex expression
+read_string     # return string
+read_symbol     # return symbol
+read_text       # return multiline string
+read_keypress   # return the key pressed
+```
+
+For example, if we wanted to ask a user for a single digit in given range
+
+```ruby
+ask("Provide number in range: 0-9").in('0-9') do
+  on_error :retry
+end.read_int
+```
+
+on the other hand, if we are interested in range answer then
+
+```ruby
+ask("Provide range of numbers?").read_range
+```
+
+### 2.3 say
+
+To simply print message out to stdout use `say` like so:
+
+```ruby
+prompt.say(...)          # print message to stdout
+```
+
+**TTY::Prompt** provides more specific versions of `say` method to better express intenation behind the message:
+
+```ruby
+prompt.confirm      # print message(s) in green
+prompt.warn         # print message(s) in yellow
+prompt.error        # print message(s) in red
+```
+
+### 2.4 suggest
+
+To suggest possible matches for the user input use `suggest` method like so:
+
+```ruby
+prompt.suggest('sta', ['stage', 'stash', 'commit', 'branch'])
+# =>
+Did you mean one of these?
+        stage
+        stash
+```
+
+To cusomize query text presented pass `:single_text` and `:plural_text` options to respectively change the message when one match is found or many.
+
+```ruby
+possible = %w(status stage stash commit branch blame)
+prompt.suggest('b', possible, indent: 4, single_text: 'Perhaps you meant?')
+# =>
+Perhaps you meant?
+    blame
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/peter-murach/tty-prompt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright (c) 2015 Piotr Murach. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each(&method(:import))
+
+desc 'Run all specs'
+task ci: %w[ spec ]

data/lib/tty-prompt.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'necromancer'
+require 'pastel'
+require 'tty-platform'
+
+require 'tty/prompt'
+require 'tty/prompt/mode'
+require 'tty/prompt/question'
+require 'tty/prompt/reader'
+require 'tty/prompt/response'
+require 'tty/prompt/statement'
+require 'tty/prompt/suggestion'
+require 'tty/prompt/utils'
+require 'tty/prompt/version'

data/lib/tty/prompt.rb

@@ -0,0 +1,206 @@
+# encoding: utf-8
+
+module TTY
+  class Prompt
+    # Raised when the passed in validation argument is of wrong type
+    class ValidationCoercion < TypeError; end
+
+    # Raised when the required argument is not supplied
+    class ArgumentRequired < ArgumentError; end
+
+    # Raised when the argument validation fails
+    class ArgumentValidation < ArgumentError; end
+
+    # Raised when the argument is not expected
+    class InvalidArgument < ArgumentError; end
+
+    # @api private
+    attr_reader :input
+
+    # @api private
+    attr_reader :output
+
+    # Shell prompt prefix
+    #
+    # @api private
+    attr_reader :prefix
+
+    # Initialize a Shell
+    #
+    # @api public
+    def initialize(input = stdin, output = stdout, options = {})
+      @input  = input
+      @output = output
+      @prefix = options.fetch(:prefix) { '' }
+    end
+
+    # Ask a question.
+    #
+    # @example
+    #   shell = TTY::Shell.new
+    #   shell.ask("What is your name?")
+    #
+    # @param [String] statement
+    #   string question to be asked
+    #
+    # @yieldparam [TTY::Question] question
+    #   further configure the question
+    #
+    # @yield [question]
+    #
+    # @return [TTY::Question]
+    #
+    # @api public
+    def ask(statement, *args, &block)
+      options = Utils.extract_options!(args)
+
+      question = Question.new self, options
+      question.instance_eval(&block) if block_given?
+      question.prompt(statement)
+    end
+
+    # A shortcut method to ask the user positive question and return
+    # true for 'yes' reply.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def yes?(statement, *args, &block)
+      ask(statement, *args, &block).read_bool
+    end
+
+    # A shortcut method to ask the user negative question and return
+    # true for 'no' reply.
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def no?(statement, *args, &block)
+      !yes?(statement, *args, &block)
+    end
+
+    # Print statement out. If the supplied message ends with a space or
+    # tab character, a new line will not be appended.
+    #
+    # @example
+    #   say("Simple things.")
+    #
+    # @param [String] message
+    #
+    # @return [String]
+    #
+    # @api public
+    def say(message = '', options = {})
+      message = message.to_str
+      return unless message.length > 0
+
+      statement = Statement.new(self, options)
+      statement.declare message
+    end
+
+    # Print statement(s) out in red green.
+    #
+    # @example
+    #   shell.confirm "Are you sure?"
+    #   shell.confirm "All is fine!", "This is fine too."
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def confirm(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(color: :green) }
+    end
+
+    # Print statement(s) out in yellow color.
+    #
+    # @example
+    #   shell.warn "This action can have dire consequences"
+    #   shell.warn "Carefull young apprentice", "This is potentially dangerous"
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def warn(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(color: :yellow) }
+    end
+
+    # Print statement(s) out in red color.
+    #
+    # @example
+    #   shell.error "Shutting down all systems!"
+    #   shell.error "Nothing is fine!", "All is broken!"
+    #
+    # @param [Array] messages
+    #
+    # @return [Array] messages
+    #
+    # @api public
+    def error(*args)
+      options = Utils.extract_options!(args)
+      args.each { |message| say message, options.merge(color: :red) }
+    end
+
+    # Takes the string provided by the user and compare it with other possible
+    # matches to suggest an unambigous string
+    #
+    # @example
+    #   shell.suggest('sta', ['status', 'stage', 'commit', 'branch'])
+    #   # => "status, stage"
+    #
+    # @param [String] message
+    #
+    # @param [Array] possibilities
+    #
+    # @param [Hash] options
+    # @option options [String] :indent
+    #   The number of spaces for indentation
+    # @option options [String] :single_text
+    #   The text for a single suggestion
+    # @option options [String] :plural_text
+    #   The text for multiple suggestions
+    #
+    # @return [String]
+    #
+    # @api public
+    def suggest(message, possibilities, options = {})
+      suggestion = Suggestion.new(options)
+      say(suggestion.suggest(message, possibilities))
+    end
+
+    # Check if outputing to shell
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def tty?
+      stdout.tty?
+    end
+
+    # Return standard in
+    #
+    # @api private
+    def stdin
+      $stdin
+    end
+
+    # Return standard out
+    #
+    # @api private
+    def stdout
+      $stdout
+    end
+
+    # Return standard error
+    #
+    # @api private
+    def stderr
+      $stderr
+    end
+  end # Prompt
+end # TTY