inquirer.rb 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d0c59415e69c915f7f8e20f566a096e2218d5b9
-  data.tar.gz: c702cf48d146f65dd677b39b10eba81b176bc1f9
+  metadata.gz: 2660e6433f7e913796819045ad9a22920a626bde
+  data.tar.gz: 409454f61b1bbc915e5f8684f0cd0136c918a9c6
 SHA512:
-  metadata.gz: 27fef9a176a7c1d0f7359c0a4381831f70f8b552db4a8a7bba90d7af4f7f44435b9eb81560fdb415f69e5c9b20cee0c43cd9b9fd011c440e8306dba33772b16f
-  data.tar.gz: 82c9bdffd2f961f23a7b924cffc2e8311799a13db1dc1d64fde751ddea4d1d96de359bc91d42cf2bd94fc7e2117ce8944538b986c8d5f03ea74d08426eed7168
+  metadata.gz: b4c143a8915d1ff0ccc20d310fd5311ec448ee421e1f4f70e1f418273daef0eb887b4d0600a24ba4f06d67f6579d88653e2a56d31edaf149fe9deb06fa8a3663
+  data.tar.gz: 0267f36718cacf9eb9e2272a40fcab8190377c27c4b5ec6f6df4c792d2829c2cfcf41f9ffde4be46af9c40b46537f99cab01e7e8b7cb4e341b3a6e84f0ffd49e

data/lib/inquirer.rb

@@ -1,9 +1,11 @@
 require 'inquirer/version'
 require 'inquirer/utils/iohelper'
 require 'inquirer/prompts/checkbox'
+require 'inquirer/prompts/checkbox_filterable'
 require 'inquirer/prompts/confirm'
 require 'inquirer/prompts/input'
 require 'inquirer/prompts/list'
+require 'inquirer/prompts/list_filterable'
 require 'inquirer/prompts/password'
 
 module Inquirer
@@ -52,7 +54,7 @@ module Inquirer
           repeat_counter: repeat_counter,
         )
 
-        object = Kernel.const_get(prompt[:type].to_s.capitalize)
+        object = Kernel.const_get(prompt[:type].to_s.split('_').collect(&:capitalize).join)
         answer = object.prompt(type_parameter)
 
         if prompt[:filter] && prompt[:filter].is_a?(Proc)

data/lib/inquirer/prompts/checkbox.rb

@@ -90,11 +90,7 @@ module Checkbox
         render_prompt
 
         # we are done if the user hits return
-        if @error_message or key != 'return'
-          true
-        else
-          false
-        end
+        @error_message || key != 'return'
       end
     end
 

data/lib/inquirer/prompts/checkbox_filterable.rb

@@ -0,0 +1,255 @@
+require 'inquirer/utils/paginator'
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/style/checkbox_filterable'
+
+module CheckboxFilterable
+
+  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|
+
+      if choice[:when].is_a?(Proc)
+
+        when_parameter = opts.merge(
+          choice: choice,
+        )
+
+        ask_choice = choice[:when].call( when_parameter )
+
+        next if !ask_choice
+      elsif [true, false].include? choice[:when]
+        next if !choice[:when]
+      end
+
+      choice[:value] ||= choice[:name]
+
+      if !choice[:checked] && opts[:default].is_a?(Array)
+        choice[:checked] = opts[:default].include?( choice[:value] )
+      end
+
+      @choices.push(choice)
+    }
+
+    question_backup = @question
+    @question      += ' '
+    @question      += Inquirer::Style::CheckboxFilterable.selection_help
+
+    @filter           = ''
+    cursor_position   = 0
+    @choices_filtered = @choices
+    @question         = question_backup
+
+    render_prompt
+
+    # 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'
+        if !@choices_filtered.empty?
+          @position = (@position - 1) % @choices_filtered.length
+        else
+          check_no_match
+        end
+      when 'down'
+        if !@choices_filtered.empty?
+          @position = (@position + 1) % @choices_filtered.length
+        else
+          check_no_match
+        end
+      when 'space'
+        if !@choices_filtered.empty?
+          @choices_filtered[@position][:checked] = !@choices_filtered[@position][:checked]
+
+          choice = @choices_filtered[@position]
+
+          @choices.map! {|possible_choice|
+
+            if choice[:name] == possible_choice[:name]
+              possible_choice = choice
+            end
+
+            possible_choice
+          }
+        end
+      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::CheckboxFilterable.error_message_invalid_value
+          elsif validation_result && validation_result.is_a?(String)
+            @error_message = validation_result
+          end
+        end
+
+        if !@error_message
+          check_no_match
+        end
+      when 'backspace'
+
+        index = @filter.size - cursor_position - 1
+
+        if index >= 0
+          # remove char at current index
+          @filter[index] = ''
+        end
+
+        filter_choices
+      when 'left'
+        if cursor_position < @filter.length
+          cursor_position += 1
+        end
+
+        check_no_match
+      when 'right'
+        if cursor_position > 0
+          cursor_position -= 1
+        end
+
+        check_no_match
+      else
+        @filter = @filter.insert(@filter.length - cursor_position, char)
+
+        filter_choices
+      end
+
+      IOHelper.clear
+
+      render_prompt
+
+      update_cursor_position(cursor_position)
+
+      # we are done if the user hits return
+      @error_message || key != 'return'
+    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::CheckboxFilterable.question % @question
+
+    prompt += IOChar.newline
+
+    # render the list
+    prompt += @choices_filtered.map.with_index(0) do |choice, position|
+
+      choice_prompt = ''
+
+      if position == @position
+        choice_prompt += Inquirer::Style::CheckboxFilterable.selector
+      else
+        choice_prompt += ' '
+      end
+
+      if choice[:checked]
+        choice_prompt += Inquirer::Style::CheckboxFilterable.checkbox_on
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::CheckboxFilterable.checked_item % choice[:name]
+      else
+        choice_prompt += Inquirer::Style::CheckboxFilterable.checkbox_off
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::CheckboxFilterable.item % choice[:name]
+      end
+
+      choice_prompt
+    end.join('')
+
+    paginated_prompt = @paginator.paginate(prompt, @position)
+
+    # render error message
+    if @error_message
+      paginated_prompt += Inquirer::Style::CheckboxFilterable.error_message % @error_message
+    end
+
+    paginated_prompt += IOChar.newline
+
+    paginated_prompt += Inquirer::Style::CheckboxFilterable.filter_prefix
+
+    paginated_prompt += Inquirer::Style::CheckboxFilterable.filter % @filter
+
+    IOHelper.render( paginated_prompt )
+  end
+
+  def render_result
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    # render the question
+    result += Inquirer::Style::CheckboxFilterable.question % @question
+
+    selected_choices = @choices.reject { |choice|
+      !choice[:checked]
+    }.collect { |choice|
+      choice[:short] || choice[:name]
+    }.join(', ')
+
+    if !selected_choices.empty?
+      result += Inquirer::Style::CheckboxFilterable.response % selected_choices
+    end
+
+    result += IOChar.newline
+
+    IOHelper.clear
+
+    IOHelper.render( result )
+  end
+
+  def update_cursor_position(cursor_position)
+    print IOChar.cursor_left * cursor_position
+  end
+
+  def filter_choices
+    @position         = 0
+    @choices_filtered = []
+
+    @choices.each { |choice|
+
+      next if !choice[:name].gsub(/\s/, '').downcase.index(@filter.gsub(/\s/, '').downcase)
+
+      @choices_filtered.push(choice)
+    }
+
+    check_no_match
+  end
+
+  def check_no_match
+    return if !@choices_filtered.empty?
+
+    @error_message = 'No matching choice found'
+  end
+end

data/lib/inquirer/prompts/confirm.rb

@@ -23,7 +23,7 @@ module Confirm
       elsif key.casecmp( Inquirer::Style::Confirm.option_false[0] ) == 0
         @value = false
         false
-      elsif key == 'return' and !@default.nil?
+      elsif key == 'return' && !@default.nil?
         @value = @default
         false
       else
@@ -64,19 +64,21 @@ module Confirm
 
   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
+    response = nil
+    if !@value.nil?
+      if @value
+        response = Inquirer::Style::Confirm.option_true
+      else
+        response = Inquirer::Style::Confirm.option_false
+      end
+
+      result += Inquirer::Style::Confirm.response % response
+    end
 
     result += IOChar.newline
 

data/lib/inquirer/prompts/list_filterable.rb

@@ -0,0 +1,209 @@
+require 'inquirer/utils/iochar'
+require 'inquirer/utils/iohelper'
+require 'inquirer/utils/paginator'
+require 'inquirer/style/list_filterable'
+
+module ListFilterable
+
+  extend self
+
+  def prompt opts = {}
+    @question = opts[:message]
+    default   = opts[:default] || 0
+
+    @position  = 0
+    @paginator = Paginator.new
+
+    @choices = []
+    opts[:choices].each { |choice|
+
+      if choice[:when].is_a?(Proc)
+
+        when_parameter = opts.merge(
+          choice: choice,
+        )
+
+        ask_choice = choice[:when].call( when_parameter )
+
+        next if !ask_choice
+      elsif [true, false].include? choice[:when]
+        next if !choice[:when]
+      end
+
+      choice[:value] ||= choice[:name]
+
+      @choices.push(choice)
+    }
+
+    return nil if Array(@choices).empty?
+
+    return @choices[0][:value] if @choices.size == 1
+
+    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
+
+
+    question_backup = @question
+    @question      += ' '
+    @question      += Inquirer::Style::ListFilterable.selection_help
+
+    @filter           = ''
+    cursor_position   = 0
+    @choices_filtered = @choices
+    @question         = question_backup
+
+    render_prompt
+
+    IOHelper.read_char do |char|
+
+      key = IOChar.char_to_key(char)
+
+      if @error_message
+        @error_message = nil
+      end
+
+      case key
+      when 'up'
+        if !@choices_filtered.empty?
+          @position = (@position - 1) % @choices_filtered.length
+        else
+          check_no_match
+        end
+      when 'down'
+        if !@choices_filtered.empty?
+          @position = (@position + 1) % @choices_filtered.length
+        else
+          check_no_match
+        end
+      when 'backspace'
+
+        index = @filter.size - cursor_position - 1
+
+        if index >= 0
+          # remove char at current index
+          @filter[index] = ''
+        end
+
+        filter_choices
+      when 'left'
+        if cursor_position < @filter.length
+          cursor_position += 1
+        end
+
+        check_no_match
+      when 'right'
+        if cursor_position > 0
+          cursor_position -= 1
+        end
+
+        check_no_match
+      else
+
+        if !['return'].include?(key)
+          @filter = @filter.insert(@filter.length - cursor_position, char)
+          filter_choices
+        end
+      end
+
+      IOHelper.clear
+
+      render_prompt
+
+      update_cursor_position(cursor_position)
+
+      key != 'return' || @choices_filtered.empty?
+    end
+
+    IOHelper.clear
+
+    render_result
+
+    @choices_filtered[@position][:value]
+  end
+
+  def render_prompt
+    # start with the question prefix
+    prompt = Inquirer::Style.question_prefix
+
+    prompt += Inquirer::Style::ListFilterable.question % @question
+
+    prompt += IOChar.newline
+
+    prompt += @choices_filtered.map.with_index(0) do |choice, position|
+
+      choice_prompt = ''
+
+      if position == @position
+        choice_prompt += Inquirer::Style::ListFilterable.selector
+        choice_prompt += ' '
+        choice_prompt += Inquirer::Style::ListFilterable.selected_item % choice[:name]
+      else
+        choice_prompt += '  '
+        choice_prompt += Inquirer::Style::ListFilterable.item % choice[:name]
+      end
+
+      choice_prompt
+    end.join('')
+
+    paginated_prompt = @paginator.paginate(prompt, @position)
+
+    # render error message
+    if @error_message
+      paginated_prompt += Inquirer::Style::ListFilterable.error_message % @error_message
+    end
+
+    paginated_prompt += IOChar.newline
+
+    paginated_prompt += Inquirer::Style::ListFilterable.filter_prefix
+
+    paginated_prompt += Inquirer::Style::ListFilterable.filter % @filter
+
+    IOHelper.render( paginated_prompt )
+  end
+
+  def render_result
+
+    # start with the question prefix
+    result = Inquirer::Style.question_prefix
+
+    result += Inquirer::Style::ListFilterable.question % @question
+
+    display_value = @choices_filtered[@position][:short] || @choices_filtered[@position][:name]
+
+    result += Inquirer::Style::ListFilterable.response % display_value
+
+    result += IOChar.newline
+
+    IOHelper.render( result )
+  end
+
+  def update_cursor_position(cursor_position)
+    print IOChar.cursor_left * cursor_position
+  end
+
+  def filter_choices
+    @position         = 0
+    @choices_filtered = []
+
+    @choices.each { |choice|
+
+      next if !choice[:name].gsub(/\s/, '').downcase.index(@filter.gsub(/\s/, '').downcase)
+
+      @choices_filtered.push(choice)
+    }
+
+    check_no_match
+  end
+
+  def check_no_match
+    return if !@choices_filtered.empty?
+
+    @error_message = 'No matching choice found'
+  end
+end