inquirer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89669e4b2834eb47f0f7b2ba37267c25a47f9f79
-  data.tar.gz: 057e9314a40673692bf52237a93277c31ceb00af
+  metadata.gz: 97119771a6f5d25b26a8c9e46d21833da7916364
+  data.tar.gz: 85d97425f2efb04f5a1cbd9b7029d0c1f41b1fe2
 SHA512:
-  metadata.gz: 4f7a3fb070a89716e0a9ec572a88c94eff6341f1eb41c4d0555264645398834beb36734260eab862ea5cbeda291b03963bfa3bd100cd8aea86695ccbb33e234e
-  data.tar.gz: 2d9ac726f146f2451cc207c3278046c8acdee9c9487883b5a714ad839e0b63db8febaab71d8e960b031dcf046af6abfcfd8a072e7cc0fea16a125cb1f64e58f5
+  metadata.gz: 8322479e68acb817daa91c465302a45e35ea2798386ba367f948ebd93dbd22ef7be33bf6410ff21e0fc82d5cd33d7b0e8ef07f57a54b49aed71859b6886ec3c0
+  data.tar.gz: 60ae3b63e8ebd9738b755d485294605c751979102026d0cd0e976c25a7989b2c41ee6c26ea0a1598891b0f2e743e3248286486c43a1be6875826fa502d16a276

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0
+
+* feature: add user input prompt with support for default values
+* feature: add confirmation prompt with support for default values
+* feature: render response for all prompts if desired
+* improvement: hide the cursor in the list and checkbox prompts
+* bugfix: fix the clear method not clearing every line on the way up
+
 ## 0.1.1
 
 * feature: add (and verify) rubinius 2.1 + 2.2 support

data/README.md

@@ -4,7 +4,9 @@
 
 Interactive user prompts on CLI for ruby.
 
-## Examples
+## Prompt types
+
+### List
 
 ```ruby
 idx = Ask.list "Look behind you...", [
@@ -17,6 +19,8 @@ idx = Ask.list "Look behind you...", [
 
 ![List example](example/list.png)
 
+### Checkbox
+
 ```ruby
 idx = Ask.checkbox "Monkey see, monkey...", [
   "don't",
@@ -28,6 +32,54 @@ idx = Ask.checkbox "Monkey see, monkey...", [
 
 ![Checkbox example](example/checkbox.png)
 
+### Input
+
+Takes optional `default` property (`string`).
+
+```ruby
+firstname = Ask.input "What's your name"
+phone = Ask.input "What's your phone number", default: "123"
+# name and phone are the responses for each question
+```
+
+![Input example](example/input.png)
+
+### Confirm
+
+Takes optional `default` property (`true` or `false`). The default `default` value is true.
+
+```ruby
+value = Ask.confirm "Are you sure?"
+# value is a boolean
+
+Ask.confirm "Are you sure?", default: false
+# Default is false
+```
+
+![Input example](example/confirm.png)
+
+## Options
+
+### Method parameters
+
+- question: `string` The text to your are going to ask
+- elements: `array` Array of options to show. Only for `checkbox` and `list` types.
+
+### Rendering options
+
+You can pass this options as the lastest parameter
+
+- clear: `bool` [Default true] Clear the original question after pressing enter
+- response: `bool` [Default true] Whether to show the selected response
+
+```ruby
+# If you dont want any output use
+Ask.input "What's your name", response: false
+
+# If you don't want the response and you want to keep the question prompt
+Ask.input "What's your name", clear: false, response: false
+```
+
 ## Installation
 
     gem install inquirer
@@ -42,6 +94,12 @@ idx = Ask.checkbox "Monkey see, monkey...", [
 | Rubinius 2.2.1 | ✔     | ✔    | ✘       |
 | JRuby 1.7.x    | ✘     | ✘    | ✘       |
 
+## Contributors
+
+**Thank you for contributing!**
+
+* ![blackjid](https://avatars1.githubusercontent.com/u/228037?s=16) [blackjid](https://github.com/blackjid)
+
 ## Credit
 
 This is basically the wonderful [Inquirer.js](https://github.com/SBoudrias/Inquirer.js), just done for ruby. I was unable to find a good gem to handle user interaction in ruby as well as this module does in JS.
@@ -49,4 +107,4 @@ This is basically the wonderful [Inquirer.js](https://github.com/SBoudrias/Inqui
 ## License
 
 Apache v2
-Author: Dominik Richter
+Author: Dominik Richter

data/example/checkbox.rb

@@ -4,4 +4,9 @@ idx = Ask.checkbox "Monkey see, monkey...", [
   "eats Banana",
   "do"
 ]
+idx = Ask.checkbox "Monkey see, monkey...", [
+  "don't",
+  "eats Banana",
+  "do"
+]
 puts "you selected #{idx}"

data/example/confirm.rb

@@ -0,0 +1,5 @@
+require_relative '../lib/inquirer'
+
+value1 = Ask.confirm "Are you sure?"
+value2 = Ask.confirm "Are you really sure?", default: false
+puts "you chose #{value1} and #{value2}"

data/example/input.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/inquirer'
+
+name = Ask.input "What's your name", default: "Monkey"
+phone = Ask.input "What's your phone number"
+puts "name: #{name}"
+puts "phone: #{phone}"

data/example/list.rb

@@ -4,4 +4,9 @@ idx = Ask.list "Look behind you...", [
   "a pink pony",
   "Godzilla"
 ]
+idx = Ask.list "Look behind you...", [
+  "a three-headed monkey!",
+  "a pink pony",
+  "Godzilla"
+]
 puts "you selected #{idx}"

data/lib/inquirer.rb

@@ -2,6 +2,8 @@ require 'inquirer/version'
 require 'inquirer/utils/iohelper'
 require 'inquirer/prompts/list'
 require 'inquirer/prompts/checkbox'
+require 'inquirer/prompts/input'
+require 'inquirer/prompts/confirm'
 
 module Ask
   extend self
@@ -12,4 +14,10 @@ module Ask
   def checkbox *args
     Checkbox.ask *args
   end
+  def input *args
+    Input.ask *args
+  end
+  def confirm *args
+    Confirm.ask *args
+  end
 end

data/lib/inquirer/prompts/checkbox.rb

@@ -14,6 +14,13 @@ module CheckboxRenderer
     ( footer.nil? ? "" : @footer % footer )
   end
 
+  def renderResponse heading = nil, response = nil
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the footer
+    ( response.nil? ? "" : @response % response )
+  end
+
   private
 
   def render_item x
@@ -40,14 +47,25 @@ class CheckboxDefault
   end
 end
 
+# Default formatting for response
+class CheckboxResponseDefault
+  include CheckboxRenderer
+  C = Term::ANSIColor
+  def initialize( style = nil )
+    @heading = "%s: "
+    @response = C.cyan("%s") + "\n"
+  end
+end
+
 class Checkbox
-  def initialize question = nil, elements = [], renderer = nil
+  def initialize question = nil, elements = [], renderer = nil, responseRenderer = nil
     @elements = elements
     @question = question
     @pos = 0
     @active = elements.map{|i| false}
     @prompt = ""
     @renderer = renderer || CheckboxDefault.new( Inquirer::Style::Default )
+    @responseRenderer = responseRenderer = CheckboxResponseDefault.new()
   end
 
   def update_prompt
@@ -63,35 +81,55 @@ class Checkbox
     @prompt = @renderer.render(@question, e)
   end
 
+   def update_response
+    e = @elements
+      .map.with_index(0)
+      .select {|f, pos| @active[pos] }
+      .map {|f, pos| f }
+    @prompt = @responseRenderer.renderResponse(@question, e.join(", "))
+  end
+
   # Run the list selection, wait for the user to select an item and return
   # the selected index
   # Params:
   # +clear+:: +Bool+ whether to clear the selection prompt once this is done
   #   defaults to true; set it to false if you want the prompt to remain after
   #   the user is done with selecting
-  def run clear = true
+  # +response+:: +Bool+ whether show the rendered response when this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  def run clear, response
     # finish if there's nothing to do
     return @active if Array(@elements).empty?
-    # render the
-    IOHelper.render( update_prompt )
-    # loop through user input
-    IOHelper.read_key_while do |key|
-      @pos = (@pos - 1) % @elements.length if key == "up"
-      @pos = (@pos + 1) % @elements.length if key == "down"
-      @active[@pos] = !@active[@pos] if key == "space"
-      IOHelper.rerender( update_prompt )
-      # we are done if the user hits return
-      key != "return"
+
+    # hides the cursor while prompting
+    IOHelper.without_cursor do
+      # render the
+      IOHelper.render( update_prompt )
+      # loop through user input
+      IOHelper.read_key_while do |key|
+        @pos = (@pos - 1) % @elements.length if key == "up"
+        @pos = (@pos + 1) % @elements.length if key == "down"
+        @active[@pos] = !@active[@pos] if key == "space"
+        IOHelper.rerender( update_prompt )
+        # we are done if the user hits return
+        key != "return"
+      end
     end
+
     # clear the final prompt and the line
     IOHelper.clear if clear
+
+    # show the answer
+    IOHelper.render( update_response ) if response
+
     # return the index of the selected item
     @active
   end
 
-  def self.ask question = nil, elements = [], opts = { clear: true }
-    l = Checkbox.new question, elements, opts[:renderer]
-    l.run opts[:clear]
+  def self.ask question = nil, elements = [], opts = {}
+    l = Checkbox.new question, elements, opts[:renderer], opts[:rendererResponse]
+    l.run opts.fetch(:clear, true), opts.fetch(:response, true)
   end
 
 end

data/lib/inquirer/prompts/confirm.rb

@@ -0,0 +1,114 @@
+require 'term/ansicolor'
+
+# Base rendering for confirm
+module ConfirmRenderer
+  def render heading = nil, default = nil, footer = nil
+    options = ['y','n']
+    options[0].capitalize! if default == true
+    options[1].capitalize! if default == false
+
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the defaults
+    @default % options +
+    # render the footer
+    ( footer.nil? ? "" : @footer % footer )
+  end
+
+  def renderResponse heading = nil, response = nil
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the footer
+    ( response.nil? ? "" : @response % response )
+  end
+end
+
+# Default formatting for confirm rendering
+class ConfirmDefault
+  include ConfirmRenderer
+  C = Term::ANSIColor
+  def initialize( style )
+    @heading = "%s: "
+    @default = "(%s/%s)"
+    @footer = "%s"
+  end
+end
+
+# Default formatting for response
+class ConfirmResponseDefault
+  include ConfirmRenderer
+  C = Term::ANSIColor
+  def initialize( style = nil )
+    @heading = "%s: "
+    @response = C.cyan("%s") + "\n"
+  end
+end
+
+class Confirm
+  def initialize question = nil, default = nil, renderer = nil, responseRenderer = nil
+    @question = question
+    @value = ""
+    @default = default
+    @prompt = ""
+    @renderer = renderer || ConfirmDefault.new( Inquirer::Style::Default )
+    @responseRenderer = responseRenderer = ConfirmResponseDefault.new()
+  end
+
+  def update_prompt
+    # call the renderer
+    @prompt = @renderer.render(@question, @default)
+  end
+
+   def update_response
+    @prompt = @responseRenderer.renderResponse(@question, (@value)? 'Yes' : 'No')
+  end
+
+  # Run the list selection, wait for the user to select an item and return
+  # the selected index
+  # Params:
+  # +clear+:: +Bool+ whether to clear the selection prompt once this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  # +response+:: +Bool+ whether show the rendered response when this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  def run clear, response
+    # render the
+    IOHelper.render( update_prompt )
+    # loop through user confirm
+    # IOHelper.read_char
+    IOHelper.read_key_while true do |key|
+      raw  = IOHelper.char_to_raw(key)
+
+      case raw
+      when "y","Y"
+        @value = true
+        false
+      when "n","N"
+        @value = false
+        false
+      when "return"
+        @value = @default
+        false
+      else
+        true
+      end
+
+    end
+
+    # clear the final prompt and the line
+    IOHelper.clear if clear
+
+    # show the answer
+    IOHelper.render( update_response ) if response
+
+    # return the value
+    @value
+  end
+
+  def self.ask question = nil, opts = {}
+    l = Confirm.new question, opts.fetch(:default, true), opts[:renderer], opts[:rendererResponse]
+    l.run opts.fetch(:clear, true), opts.fetch(:response, true)
+  end
+
+end

data/lib/inquirer/prompts/input.rb

@@ -0,0 +1,130 @@
+require 'term/ansicolor'
+
+# Base rendering for input
+module InputRenderer
+  def render heading = nil, value = nil, default = nil, footer = nil
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the defaults
+    ( default.nil? ? "" : @default % default ) +
+    # render the list
+    ( value.nil? ? "" : @value % value ) +
+    # render the footer
+    ( footer.nil? ? "" : @footer % footer )
+  end
+
+  def renderResponse heading = nil, response = nil
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the footer
+    ( response.nil? ? "" : @response % response )
+  end
+end
+
+# Default formatting for list rendering
+class InputDefault
+  include InputRenderer
+  C = Term::ANSIColor
+  def initialize( style )
+    @heading = "%s: "
+    @default = "(%s) "
+    @value = "%s"
+    @footer = "%s"
+  end
+end
+
+# Default formatting for response
+class InputResponseDefault
+  include InputRenderer
+  C = Term::ANSIColor
+  def initialize( style = nil )
+    @heading = "%s: "
+    @response = C.cyan("%s") + "\n"
+  end
+end
+
+class Input
+  def initialize question = nil, default = nil, renderer = nil, responseRenderer = nil
+    @question = question
+    @value = ""
+    @default = default
+    @prompt = ""
+    @pos = 0
+    @renderer = renderer || InputDefault.new( Inquirer::Style::Default )
+    @responseRenderer = responseRenderer = InputResponseDefault.new()
+  end
+
+  def update_prompt
+    # call the renderer
+    @prompt = @renderer.render(@question, @value, @default)
+  end
+
+  def update_response
+    @prompt = @responseRenderer.renderResponse(@question, @value)
+  end
+
+  def update_cursor
+    print IOHelper.char_left * @pos
+  end
+
+  # Run the list selection, wait for the user to select an item and return
+  # the selected index
+  # Params:
+  # +clear+:: +Bool+ whether to clear the selection prompt once this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  # +response+:: +Bool+ whether show the rendered response when this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  def run clear, response
+    # render the
+    IOHelper.render( update_prompt )
+    # loop through user input
+    # IOHelper.read_char
+    IOHelper.read_key_while true do |key|
+      raw  = IOHelper.char_to_raw(key)
+
+      case raw
+      when "backspace"
+        @value = @value.chop
+        IOHelper.rerender( update_prompt )
+        update_cursor
+      when "left"
+        if @pos < @value.length
+          @pos = @pos + 1
+          print IOHelper.char_left
+        end
+      when "right"
+        if @pos > 0
+          @pos = @pos - 1
+          print IOHelper.char_right
+        end
+      when "return"
+        if not @default.nil? and @value == ""
+          @value = @default
+        end
+      else
+        unless ["up", "down"].include?(raw)
+          @value = @value.insert(@value.length - @pos, key)
+          IOHelper.rerender( update_prompt )
+          update_cursor
+        end
+      end
+      raw != "return"
+    end
+    # clear the final prompt and the line
+    IOHelper.clear if clear
+
+    # show the answer
+    IOHelper.render( update_response ) if response
+
+    # return the value
+    @value
+  end
+
+  def self.ask question = nil, opts = {}
+    l = Input.new question, opts[:default], opts[:renderer], opts[:rendererResponse]
+    l.run opts.fetch(:clear, true), opts.fetch(:response, true)
+  end
+
+end

data/lib/inquirer/prompts/list.rb

@@ -13,6 +13,13 @@ module ListRenderer
     ( footer.nil? ? "" : @footer % footer )
   end
 
+  def renderResponse heading = nil, response = nil
+    # render the heading
+    ( heading.nil? ? "" : @heading % heading ) +
+    # render the footer
+    ( response.nil? ? "" : @response % response )
+  end
+
   private
 
   def render_item x
@@ -34,13 +41,24 @@ class ListDefault
   end
 end
 
+# Default formatting for response
+class ListResponseDefault
+  include ListRenderer
+  C = Term::ANSIColor
+  def initialize( style = nil )
+    @heading = "%s: "
+    @response = C.cyan("%s") + "\n"
+  end
+end
+
 class List
-  def initialize question = nil, elements = [], renderer = nil
+  def initialize question = nil, elements = [], renderer = nil, responseRenderer = nil
     @elements = elements
     @question = question
     @pos = 0
     @prompt = ""
-    @renderer = renderer || ListDefault.new( Inquirer::Style::Default )
+    @renderer = renderer = ListDefault.new( Inquirer::Style::Default )
+    @responseRenderer = responseRenderer = ListResponseDefault.new()
   end
 
   def update_prompt
@@ -56,34 +74,50 @@ class List
     @prompt = @renderer.render(@question, e)
   end
 
+  def update_response
+    @prompt = @responseRenderer.renderResponse(@question, @elements[@pos])
+  end
+
   # Run the list selection, wait for the user to select an item and return
   # the selected index
   # Params:
   # +clear+:: +Bool+ whether to clear the selection prompt once this is done
   #   defaults to true; set it to false if you want the prompt to remain after
   #   the user is done with selecting
-  def run clear = true
+  # +response+:: +Bool+ whether show the rendered response when this is done
+  #   defaults to true; set it to false if you want the prompt to remain after
+  #   the user is done with selecting
+  def run clear, response
     # finish if there's nothing to do
     return nil if Array(@elements).empty?
-    # render the
-    IOHelper.render( update_prompt )
-    # loop through user input
-    IOHelper.read_key_while do |key|
-      @pos = (@pos - 1) % @elements.length if key == "up"
-      @pos = (@pos + 1) % @elements.length if key == "down"
-      IOHelper.rerender( update_prompt )
-      # we are done if the user hits return
-      key != "return"
+
+    # hides the cursor while prompting
+    IOHelper.without_cursor do
+      # render the
+      IOHelper.render( update_prompt )
+      # loop through user input
+      IOHelper.read_key_while do |key|
+        @pos = (@pos - 1) % @elements.length if key == "up"
+        @pos = (@pos + 1) % @elements.length if key == "down"
+        IOHelper.rerender( update_prompt )
+        # we are done if the user hits return
+        key != "return"
+      end
     end
+
     # clear the final prompt and the line
     IOHelper.clear if clear
+
+    # show the answer
+    IOHelper.render( update_response ) if response
+
     # return the index of the selected item
     @pos
   end
 
-  def self.ask question = nil, elements = [], opts = { clear: true }
-    l = List.new question, elements, opts[:renderer]
-    l.run opts[:clear]
+  def self.ask question = nil, elements = [], opts = {}
+    l = List.new question, elements, opts[:renderer], opts[:rendererResponse]
+    l.run opts.fetch(:clear, true), opts.fetch(:response, true)
   end
 
-end
+end

data/lib/inquirer/utils/iohelper.rb

@@ -56,21 +56,21 @@ module IOHelper
   # Params:
   # +with_exit_codes+:: +Bool+ whether to throw Interrupts when the user presses
   #   ctrl-c and ctrl-d. (true by default)
-  def read_key with_exit_codes = true
-    raw = read_key_raw
-    raise Interrupt if with_exit_codes and ( raw == "ctrl-c" or raw == "ctrl-d" )
-    raw
+  def read_key with_exit_codes = true, return_char = false
+    char = read_char
+    raise Interrupt if with_exit_codes and ( char == "\003" or char == "\004" )
+    if return_char then char else char_to_raw char end
   end
 
   # Get each key the user presses and hand it one by one to the block. Do this
   # as long as the block returns truthy
   # Params:
   # +&block+:: +Proc+ a block that receives a user key and returns truthy or falsy
-  def read_key_while &block
+  def read_key_while return_char = false, &block
     STDIN.noecho do
       # as long as the block doen't return falsy,
       # read the user input key and sned it to the block
-      while block.( IOHelper.read_key )
+      while block.( IOHelper.read_key true, return_char )
       end
     end
   end
@@ -100,21 +100,30 @@ module IOHelper
     # determine how many lines to move up
     n = @rendered.scan(/\n/).length
     # jump back to the first position and clear the line
-    print carriage_return + ( line_up * n ) + clear_line
+    print carriage_return + ( line_up + clear_line ) * n + clear_line
+  end
+
+  # hides the cursor and ensure the curso be visible at the end
+  def without_cursor
+    # tell the terminal to hide the cursor
+    print `tput civis`
+    begin
+      # run the block
+      yield
+    ensure
+      # tell the terminal to show the cursor
+      print `tput cnorm`
+    end
+  end
+
+  def char_to_raw char
+    KEYS.fetch char, char
   end
 
   def carriage_return;  "\r"    end
   def line_up;          "\e[A"  end
   def clear_line;       "\e[0K" end
-
-  private
-
-  def read_key_raw
-    c = read_char
-    # try to get the key name from the character
-    k = KEYS[c]
-    # return either the character or key name
-    ( k.nil? ) ? c : k
-  end
+  def char_left;        "\e[D" end
+  def char_right;       "\e[C" end
 
 end

data/lib/inquirer/version.rb

@@ -1,3 +1,3 @@
 module Inquirer
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/classes/checkbox_spec.rb

@@ -8,51 +8,61 @@ describe Checkbox do
   end
 
   it "finishes rendering with a clear" do
-    Checkbox.ask "select", ["one","two","three"]
+    Checkbox.ask "select", ["one","two","three"], response: false
     IOHelper.output.must_equal ""
   end
 
   it "doesn't render the dialog with 0 items" do
-    Checkbox.ask "select", [], clear: false
+    Checkbox.ask "select", [], clear: false, response: false
     IOHelper.output.must_equal ""
   end
 
   it "renders the dialog with 3 items" do
-    Checkbox.ask "select", ["one","two","three"], clear: false
+    Checkbox.ask "select", ["one","two","three"], clear: false, response: false
     IOHelper.output.must_equal "select:\n\e[36m‣\e[0m⬡ one\n ⬡ two\n ⬡ three\n"
   end
 
   it "it finishes selection on pressing enter" do
     IOHelper.keys = "enter"
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [false,false,false]
   end
 
   it "selects and renders other items correctly (press down, press up, space, cycle)" do
     IOHelper.keys = ["down","space","enter"]
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [false,true,false]
     IOHelper.output.must_equal "select:\n ⬡ one\n\e[36m‣\e[0m\e[36m⬢\e[0m two\n ⬡ three\n"
 
     IOHelper.keys = ["space","down","space","enter"]
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [true,true,false]
     IOHelper.output.must_equal "select:\n \e[36m⬢\e[0m one\n\e[36m‣\e[0m\e[36m⬢\e[0m two\n ⬡ three\n"
 
     IOHelper.keys = ["space","down","space","down","space","enter"]
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [true,true,true]
     IOHelper.output.must_equal "select:\n \e[36m⬢\e[0m one\n \e[36m⬢\e[0m two\n\e[36m‣\e[0m\e[36m⬢\e[0m three\n"
 
     IOHelper.keys = ["down","down","down","space","enter"]
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [true,false,false]
     IOHelper.output.must_equal "select:\n\e[36m‣\e[0m\e[36m⬢\e[0m one\n ⬡ two\n ⬡ three\n"
 
     IOHelper.keys = ["up","space","enter"]
-    Checkbox.ask( "select", ["one","two","three"], clear: false
+    Checkbox.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal [false,false,true]
     IOHelper.output.must_equal "select:\n ⬡ one\n ⬡ two\n\e[36m‣\e[0m\e[36m⬢\e[0m three\n"
   end
 
+  it "selects and renders response correctly" do
+    IOHelper.keys = ["down","space","enter"]
+    Checkbox.ask( "select", ["one","two","three"])
+    IOHelper.output.must_equal "select: \e[36mtwo\e[0m\n"
+
+    IOHelper.keys = ["space","down","space","enter"]
+    Checkbox.ask( "select", ["one","two","three"])
+    IOHelper.output.must_equal "select: \e[36mone, two\e[0m\n"
+  end
+
 end

data/test/classes/confirm_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+require 'minitest_helper'
+
+describe Confirm do
+  before :each do
+    IOHelper.output = ""
+  end
+
+  it "should return true for y and Y and enter when default" do
+    IOHelper.keys = "y"
+    Confirm.ask("Are you sure?").must_equal true
+    IOHelper.keys = "Y"
+    Confirm.ask("Are you sure?").must_equal true
+    IOHelper.keys = "\r"
+    Confirm.ask("Are you sure?", default: true).must_equal true
+  end
+
+  it "should return false for n and N and enter when default" do
+    IOHelper.keys = "n"
+    Confirm.ask("Are you sure?").must_equal false
+    IOHelper.keys = "N"
+    Confirm.ask("Are you sure?").must_equal false
+    IOHelper.keys = "\r"
+    Confirm.ask("Are you sure?", default: false).must_equal false
+  end
+
+  it "should return true if not default given" do
+    IOHelper.keys = "\r"
+    Confirm.ask("Are you sure?").must_equal true
+  end
+
+  it "accepts and renders response correctly" do
+    IOHelper.keys = "n"
+    Confirm.ask("Are you sure?")
+    IOHelper.output.must_equal "Are you sure?: \e[36mNo\e[0m\n"
+
+    IOHelper.keys = "N"
+    Confirm.ask("Are you sure?")
+    IOHelper.output.must_equal "Are you sure?: \e[36mNo\e[0m\n"
+
+    IOHelper.keys = "y"
+    Confirm.ask("Are you sure?")
+    IOHelper.output.must_equal "Are you sure?: \e[36mYes\e[0m\n"
+
+    IOHelper.keys = "y"
+    Confirm.ask("Are you sure?")
+    IOHelper.output.must_equal "Are you sure?: \e[36mYes\e[0m\n"
+  end
+
+end

data/test/classes/input_spec.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'minitest_helper'
+
+describe Input do
+  before :each do
+    IOHelper.output = ""
+    IOHelper.keys = ['t','y','p','e','d',' ','i','n','p','u','t',"\r"]
+  end
+
+  it "should use chars value from the user" do
+    Input.ask("please type input").must_equal "typed input"
+  end
+
+  it "accepts and renders response correctly" do
+    Input.ask("please type input")
+    IOHelper.output.must_equal "please type input: \e[36mtyped input\e[0m\n"
+  end
+
+  it "should return default value if given and there is no input" do
+    IOHelper.keys = "\r"
+    Confirm.ask("Are you sure?", default: "I'm default").must_equal "I'm default"
+  end
+
+end

data/test/classes/list_spec.rb

@@ -8,51 +8,61 @@ describe List do
   end
 
   it "finishes rendering with a clear" do
-    List.ask "select", ["one","two","three"]
+    List.ask "select", ["one","two","three"], response: false
     IOHelper.output.must_equal ""
   end
 
   it "doesn't render the dialog with 0 items" do
-    List.ask "select", [], clear: false
+    List.ask "select", [], clear: false, response: false
     IOHelper.output.must_equal ""
   end
 
   it "renders the dialog with 3 items" do
-    List.ask "select", ["one","two","three"], clear: false
+    List.ask "select", ["one","two","three"], clear: false, response: false
     IOHelper.output.must_equal "select:\n\e[36m‣\e[0m \e[36mone\e[0m\n  two\n  three\n"
   end
 
   it "it finishes selection on pressing enter" do
     IOHelper.keys = "enter"
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 0
   end
 
   it "selects and renders other items correctly (press down, press up, cycle)" do
     IOHelper.keys = ["down","enter"]
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 1
     IOHelper.output.must_equal "select:\n  one\n\e[36m‣\e[0m \e[36mtwo\e[0m\n  three\n"
 
     IOHelper.keys = ["down","down","enter"]
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 2
     IOHelper.output.must_equal "select:\n  one\n  two\n\e[36m‣\e[0m \e[36mthree\e[0m\n"
 
     IOHelper.keys = ["down","down","down","enter"]
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 0
     IOHelper.output.must_equal "select:\n\e[36m‣\e[0m \e[36mone\e[0m\n  two\n  three\n"
 
     IOHelper.keys = ["down","up","enter"]
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 0
     IOHelper.output.must_equal "select:\n\e[36m‣\e[0m \e[36mone\e[0m\n  two\n  three\n"
 
     IOHelper.keys = ["up","enter"]
-    List.ask( "select", ["one","two","three"], clear: false
+    List.ask( "select", ["one","two","three"], clear: false, response: false
       ).must_equal 2
     IOHelper.output.must_equal "select:\n  one\n  two\n\e[36m‣\e[0m \e[36mthree\e[0m\n"
   end
 
+  it "selects and renders response correctly" do
+    IOHelper.keys = ["down","enter"]
+    List.ask( "select", ["one","two","three"])
+    IOHelper.output.must_equal "select: \e[36mtwo\e[0m\n"
+
+    IOHelper.keys = ["down","down","enter"]
+    List.ask( "select", ["one","two","three"])
+    IOHelper.output.must_equal "select: \e[36mthree\e[0m\n"
+  end
+
 end

data/test/minitest_helper.rb

@@ -34,7 +34,9 @@ module IOHelper
   def rerender sth
     @output = sth
   end
-  def read_key_while &block
-    Array(@keys).each{|key| block.(key)}
+  def read_key_while return_char = false, &block
+    Array(@keys).each do |key|
+      break unless block.(key)
+    end
   end
-end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: inquirer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dominik Richter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-24 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
 description: Interactive user prompts on CLI for ruby.
@@ -30,7 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -38,16 +38,24 @@ files:
 - Rakefile
 - example/checkbox.png
 - example/checkbox.rb
+- example/confirm.png
+- example/confirm.rb
+- example/input.png
+- example/input.rb
 - example/list.png
 - example/list.rb
 - inquirer.gemspec
 - lib/inquirer.rb
 - lib/inquirer/prompts/checkbox.rb
+- lib/inquirer/prompts/confirm.rb
+- lib/inquirer/prompts/input.rb
 - lib/inquirer/prompts/list.rb
 - lib/inquirer/style.rb
 - lib/inquirer/utils/iohelper.rb
 - lib/inquirer/version.rb
 - test/classes/checkbox_spec.rb
+- test/classes/confirm_spec.rb
+- test/classes/input_spec.rb
 - test/classes/list_spec.rb
 - test/minitest_helper.rb
 homepage: https://github.com/arlimus/inquirer.rb
@@ -60,19 +68,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Interactive user prompts on CLI for ruby.
 test_files: []
-has_rdoc: