inquirer.rb 0.0.1

data/lib/inquirer/prompts/checkbox.rb

@@ -0,0 +1,165 @@
+require 'inquirer/utils/paginator'
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/style/checkbox'
+
+module Checkbox
+
+  extend self
+
+  def prompt opts = {}
+
+    # finish if there's nothing to do
+    return opts[:default] if Array(opts[:choices]).empty?
+
+    @question  = opts[:message]
+    @position  = 0
+    @paginator = Paginator.new
+    @choices   = []
+    opts[:choices].each { |choice|
+
+      choice[:value] ||= choice[:name]
+
+      if !choice[:checked] && opts[:default].is_a?(Array)
+        choice[:checked] = opts[:default].include?( choice[:value] )
+      end
+
+      @choices.push(choice)
+    }
+
+    IOHelper.without_cursor do
+
+      question_backup = @question
+      @question      += ' '
+      @question      += Inquirer::Style::Checkbox.selection_help
+
+      render_prompt
+
+      @question = question_backup
+
+      # loop through user input
+      IOHelper.read_char do |char|
+
+        key = IOChar.char_to_key(char)
+
+        if @error_message
+          @error_message = nil
+        end
+
+        case key
+        when 'up'
+          @position = (@position - 1) % @choices.length
+        when 'down'
+          @position = (@position + 1) % @choices.length
+        when 'space'
+          @choices[@position][:checked] = !@choices[@position][:checked]
+        when 'return'
+          if opts[:validate] and opts[:validate].is_a?(Proc)
+
+            value = @choices.reject { |choice|
+              !choice[:checked]
+            }.collect { |choice|
+              choice[:value]
+            }
+
+            validation_result = opts[:validate].call( value )
+
+            if !validation_result
+              @error_message = Inquirer::Style::Checkbox.error_message_invalid_value
+            elsif validation_result && validation_result.is_a?(String)
+              @error_message = validation_result
+            end
+          end
+        end
+
+        IOHelper.clear
+
+        render_prompt
+
+        # we are done if the user hits return
+        if @error_message or key != 'return'
+          true
+        else
+          false
+        end
+      end
+    end
+
+    render_result
+
+    @choices.reject { |choice|
+      !choice[:checked]
+    }.collect { |choice|
+      choice[:value]
+    }
+  end
+
+  def render_prompt
+    # start with the question prefix
+    prompt = Inquirer::Style.question_prefix
+
+    # render the question
+    prompt += Inquirer::Style::Checkbox.question % @question
+
+    prompt += IOChar.newline
+
+    # render the list
+    prompt += @choices.map.with_index(0) do |choice, position|
+
+      choice_prompt = ''
+
+      if position == @position
+        choice_prompt += Inquirer::Style::Checkbox.selector
+      else
+        choice_prompt += ' '
+      end
+
+      if choice[:checked]
+        choice_prompt += Inquirer::Style::Checkbox.checkbox_on
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::Checkbox.checked_item % choice[:name]
+      else
+        choice_prompt += Inquirer::Style::Checkbox.checkbox_off
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::Checkbox.item % choice[:name]
+      end
+
+      choice_prompt
+    end.join('')
+
+    paginated_prompt = @paginator.paginate(prompt, @position)
+
+    # render error message
+    if @error_message
+      paginated_prompt += Inquirer::Style::Checkbox.error_message % @error_message
+    end
+
+    paginated_prompt += IOChar.carriage_return
+
+    IOHelper.render( paginated_prompt )
+  end
+
+  def render_result
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    # render the question
+    result += Inquirer::Style::Checkbox.question % @question
+
+    selected_choices = @choices.reject { |choice|
+      !choice[:checked]
+    }.collect { |choice|
+      choice[:short] || choice[:name]
+    }.join(', ')
+
+    if !selected_choices.empty?
+      result += Inquirer::Style::Checkbox.response % selected_choices
+    end
+
+    result += IOChar.newline
+
+    IOHelper.clear
+
+    IOHelper.render( result )
+  end
+end

data/lib/inquirer/prompts/confirm.rb

@@ -0,0 +1,89 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/style/confirm'
+
+module Confirm
+
+  extend self
+
+  def prompt opts = {}
+    @question = opts[:message]
+    @default  = opts[:default]
+    @value    = nil
+
+    render_prompt
+
+    IOHelper.read_char do |char|
+
+      key = IOChar.char_to_key(char)
+
+      if key.casecmp( Inquirer::Style::Confirm.option_true[0] ) == 0
+        @value = true
+        false
+      elsif key.casecmp( Inquirer::Style::Confirm.option_false[0] ) == 0
+        @value = false
+        false
+      elsif key == 'return' and !@default.nil?
+        @value = @default
+        false
+      else
+        true
+      end
+    end
+
+    render_result
+
+    @value
+  end
+
+  def render_prompt
+
+    options = [
+      Inquirer::Style::Confirm.option_true[0].downcase,
+      Inquirer::Style::Confirm.option_false[0].downcase
+    ]
+    if !@default.nil?
+      if @default
+        options[0].capitalize!
+      else
+        options[1].capitalize!
+      end
+    end
+
+    # start with the question prefix
+    prompt = Inquirer::Style.question_prefix
+
+    prompt += Inquirer::Style::Confirm.question % @question
+
+    prompt += Inquirer::Style::Confirm.options % options
+
+    prompt += ' '
+
+    IOHelper.render( prompt )
+  end
+
+  def render_result
+
+    response = nil
+    if @value
+      response = Inquirer::Style::Confirm.option_true
+    else
+      response = Inquirer::Style::Confirm.option_false
+    end
+
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    result += Inquirer::Style::Confirm.question % @question
+
+    result += Inquirer::Style::Confirm.response % response
+
+    result += IOChar.newline
+
+    # flush previous data
+    IOHelper.clear
+
+    # rerender result
+    IOHelper.render( result )
+  end
+end

data/lib/inquirer/prompts/input.rb

@@ -0,0 +1,138 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/style/input'
+
+module Input
+
+  extend self
+
+  def prompt opts = {}
+    @question = opts[:message]
+    @default  = opts[:default]
+    @value    = ''
+
+    render_prompt
+
+    cursor_position = 0
+
+    IOHelper.read_char do |char|
+
+      key = IOChar.char_to_key(char)
+
+      @error_message = nil
+
+      case key
+      when 'backspace'
+
+        index = @value.size - cursor_position - 1
+
+        if index >= 0
+          # remove char at current index
+          @value[index] = ''
+        end
+      when 'left'
+        if cursor_position < @value.length
+          cursor_position += 1
+        end
+      when 'right'
+        if cursor_position > 0
+          cursor_position -= 1
+        end
+      when 'return'
+        if not @default.nil? and @value == ''
+          @value = @default.dup
+        end
+
+        if opts[:validate] and opts[:validate].is_a?(Proc)
+
+          validation_result = opts[:validate].call( @value )
+
+          if !validation_result
+            @error_message = Inquirer::Style::Input.error_message_invalid_value
+          elsif validation_result && validation_result.is_a?(String)
+            @error_message = validation_result
+          end
+        end
+      else
+        if !['up', 'down'].include?(key)
+
+          @value = @value.insert(@value.length - cursor_position, char)
+        end
+      end
+
+      # flush previous data
+      IOHelper.clear
+
+      render_prompt
+
+      update_cursor_position(cursor_position)
+
+      if @error_message or key != 'return'
+        true
+      else
+        false
+      end
+    end
+
+    render_result
+
+    # return the value
+    @value
+  end
+
+  def render_prompt
+
+    prompt = Inquirer::Style.question_prefix
+
+    prompt += Inquirer::Style::Input.question % @question
+
+    # render the default value
+    if @default
+      prompt += Inquirer::Style::Input.default % @default
+    end
+
+    # render the input
+    prompt += Inquirer::Style::Input.value % display_value
+
+    # render error message
+    bottom_line = nil
+    if @error_message
+      bottom_line = Inquirer::Style::Input.error_message % @error_message
+    end
+
+    # rerender new prompt
+    IOHelper.render( prompt, bottom_line )
+  end
+
+  def render_result
+
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    # render the question
+    result += Inquirer::Style::Input.question % @question
+
+    # render the input
+    result += Inquirer::Style::Input.response % display_value
+
+    # finish up
+    result += IOChar.clear_line + IOChar.newline
+
+    # flush previous data
+    IOHelper.clear
+
+    # rerender result
+    IOHelper.render( result )
+  end
+
+  def update_cursor_position(cursor_position)
+    print IOChar.cursor_left * cursor_position
+  end
+
+  # this function is necessary to reduce code
+  # duplication of the password promt engine
+  # to a minimum
+  def display_value
+    @value
+  end
+end

data/lib/inquirer/prompts/list.rb

@@ -0,0 +1,116 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/utils/paginator'
+require 'inquirer/style/list'
+
+module List
+
+  extend self
+
+  def prompt opts = {}
+    @question = opts[:message]
+    default   = opts[:default] || 0
+
+    @position  = 0
+    @paginator = Paginator.new
+
+    @choices = []
+    opts[:choices].each { |choice|
+
+      choice[:value] ||= choice[:name]
+
+      @choices.push(choice)
+    }
+
+    return nil if Array(@choices).empty?
+
+    if default.is_a?(String) || default.is_a?(Symbol)
+      @position   = @choices.find_index { |choice| choice[:value] == default }
+      @position ||= 0
+    elsif default.is_a?(Integer) && default < @choices.size
+      @position = default
+    else
+      @position = 0
+    end
+
+    IOHelper.without_cursor do
+
+      question_backup = @question
+      @question      += ' '
+      @question      += Inquirer::Style::List.selection_help
+
+      render_prompt
+
+      @question = question_backup
+
+      IOHelper.read_char do |char|
+
+        key = IOChar.char_to_key(char)
+
+        case key
+        when 'up'
+          @position = (@position - 1) % @choices.length
+        when 'down'
+          @position = (@position + 1) % @choices.length
+        end
+
+        IOHelper.clear
+
+        render_prompt
+
+        key != 'return'
+      end
+    end
+
+    IOHelper.clear
+
+    render_result
+
+    @choices[@position][:value]
+  end
+
+  def render_prompt
+    # start with the question prefix
+    prompt = Inquirer::Style.question_prefix
+
+    prompt += Inquirer::Style::List.question % @question
+
+    prompt += IOChar.newline
+
+    prompt += @choices.map.with_index(0) do |choice, position|
+
+      choice_prompt = ''
+
+      if position == @position
+        choice_prompt += Inquirer::Style::List.selector
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::List.selected_item % choice[:name]
+      else
+        choice_prompt += '  '
+        choice_prompt += Inquirer::Style::List.item % choice[:name]
+      end
+
+      choice_prompt
+    end.join('')
+
+    paginated_promt = @paginator.paginate(prompt, @position)
+
+    IOHelper.render( paginated_promt )
+  end
+
+  def render_result
+
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    result += Inquirer::Style::List.question % @question
+
+    display_value = @choices[@position][:short] || @choices[@position][:name]
+
+    result += Inquirer::Style::List.response % display_value
+
+    result += IOChar.newline
+
+    IOHelper.render( result )
+  end
+end