question 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3a0d376bc7b786a49fd2def503783d20b3faba4
-  data.tar.gz: b5c4c650182334f747a56f2afac3edf8af9825d4
+  metadata.gz: 663229bc3195354972ced413cb6299ab39dcd242
+  data.tar.gz: e75dda15df55b7f7455525fb8d4b024241ac6227
 SHA512:
-  metadata.gz: 57062767899bae46121b0c5c6d96f1b711fc3084c0fbd75a1be1f4fff8e873b308bd7aa5fe845642a07be83b858e7bafe284979c7bcb3b9fc0b5e21f81d7867d
-  data.tar.gz: 8ae38cbddfffb390264432f21af1bbc4872c642927abde1a4a5a230046816295486d2ccfcfd36f84871ce170118e54f187554fda399a081989ebb0d73ad2938e
+  metadata.gz: e49c381bae23ff13be2a3cc506f4b6e973b29ddff3103038c8f09310097f17238f3091f34c15d9b01a07ab319b2a577bb3d3f5529305ece15c08b59f4476f248
+  data.tar.gz: c37c13bfce998409f1617aa8bc3595c66019e70e8e54ee514fc41b3656c9332982a988ab12d3c6aee4592d6a40ac7ebc1385c3a245c991fca151848d6f3ce5dd

data/README.md

@@ -1,5 +1,21 @@
 # Question
 
+Inspired by [Inquirer.js](https://github.com/SBoudrias/Inquirer.js/)
+
+### Checkbox List
+
+![http://cl.ly/image/3h1G1a1S3X0A/Image%202015-01-14%20at%2012.51.16%20PM.png](http://cl.ly/image/3h1G1a1S3X0A/Image%202015-01-14%20at%2012.51.16%20PM.png)
+
+### List
+![http://cl.ly/image/0s1E0S2f0c3M/Image%202015-01-14%20at%2012.51.45%20PM.png](http://cl.ly/image/0s1E0S2f0c3M/Image%202015-01-14%20at%2012.51.45%20PM.png)
+
+### Input
+![http://cl.ly/image/1c3i2d3e3z2v/Image%202015-01-14%20at%2012.52.01%20PM.png](http://cl.ly/image/1c3i2d3e3z2v/Image%202015-01-14%20at%2012.52.01%20PM.png)
+
+### Confirm
+![http://cl.ly/image/2H0e101H1q3W/Image%202015-01-14%20at%2012.52.26%20PM.png](http://cl.ly/image/2H0e101H1q3W/Image%202015-01-14%20at%2012.52.26%20PM.png)
+
+### End Result
 ![https://s3.amazonaws.com/f.cl.ly/items/2K3w1Y0F2T2o1505191J/Image%202015-01-14%20at%2012.35.04%20PM.png](https://s3.amazonaws.com/f.cl.ly/items/2K3w1Y0F2T2o1505191J/Image%202015-01-14%20at%2012.35.04%20PM.png)
 
 ## Installation

data/examples/example.rb

@@ -1,24 +1,16 @@
-require "pp"
+$:.unshift File.expand_path("../../lib", __FILE__)
 
+require "pp"
 require "question"
 
 choices = [
   { label: "red", value: {r: 255, g: 0, b: 0} },
   { label: "blue", value: "#0000FF" },
-  { label: "green", value: "green" }
+  "green" # You can also just pass a String or Number
 ]
 
-question = Question::CheckboxList.new("What colors do you like", choices, default: choices[1..-1])
-pp question.ask
-
-question = Question::List.new("What is your FAVORITE color", choices)
-pp question.ask
-
-question = Question::Input.new("What is your name?", default: ENV["USER"])
-pp question.ask
-
-question = Question::Password.new("Enter something secret")
-pp question.ask
-
-question = Question::Confirm.new("Do you understand")
-pp question.ask
+pp Question.checkbox_list("What colors do you like", choices, default: choices[1..-1])
+pp Question.list("What is your FAVORITE color", choices)
+pp Question.input("What is your name?", default: ENV["USER"])
+pp Question.password("Enter something secret")
+pp Question.confirm("Do you understand")

data/lib/question/checkbox_list.rb

@@ -1,12 +1,24 @@
 module Question
   class CheckboxList
-    def initialize(question, choices, default: nil)
+    def initialize(question, choices, default: [])
       @question = question
       @choices = choices
       @active_index = 0
-      @selected_choices = default || []
       @finished = false
       @modified = false
+
+      default_values = default.map { |choice| value_for_choice(choice) }
+      @selected_choices = choices.select do |choice|
+        default_values.include? value_for_choice(choice)
+      end
+    end
+
+    def label_for_choice(choice)
+      choice.is_a?(Hash) ? choice[:label] : choice
+    end
+
+    def value_for_choice(choice)
+      choice.is_a?(Hash) ? choice[:value] : choice
     end
 
     def ask
@@ -18,19 +30,20 @@ module Question
         render # render the results a final time and clear the screen
       end
 
-      @selected_choices
+      @selected_choices.map { |choice| value_for_choice(choice) }
     end
 
     def handle_input
-      case TTY.input
+      input = TTY.input
+      case input
       when TTY::CODE::SIGINT
         exit 130
       when TTY::CODE::RETURN
         @finished = true
-      when TTY::CODE::DOWN
+      when TTY::CODE::DOWN, TTY::CODE::CTRL_J, TTY::CODE::CTRL_N
         @active_index += 1
         @active_index = 0 if @active_index >= @choices.length
-      when TTY::CODE::UP
+      when TTY::CODE::UP, TTY::CODE::CTRL_K, TTY::CODE::CTRL_P
         @active_index -= 1
         @active_index = @choices.length - 1 if @active_index < 0
       when TTY::CODE::SPACE
@@ -50,15 +63,15 @@ module Question
 
     def render
       TTY.clear
-      print "? ".colorize(:cyan)
+      print "? ".cyan
       print @question
       print ": "
       if @finished
-        print @selected_choices.map { |choice| choice[:label] }.join(", ").colorize(:green)
+        print @selected_choices.map { |choice| label_for_choice(choice) }.join(", ").green
       elsif @modified
-        print @selected_choices.map { |choice| choice[:label] }.join(", ")
+        print @selected_choices.map { |choice| label_for_choice(choice) }.join(", ")
       else
-        print instructions.colorize(:light_white)
+        print instructions.light_white
       end
       print "\n"
 
@@ -67,12 +80,12 @@ module Question
           print index == @active_index ? TTY::UI::SELECTED : TTY::UI::UNSELECTED
           print " "
           if @selected_choices.include?(choice)
-            print TTY::UI::CHECKBOX_CHECKED.colorize(:green)
+            print TTY::UI::CHECKBOX_CHECKED.green
           else
-            print TTY::UI::CHECKBOX_UNCHECKED.colorize(:red)
+            print TTY::UI::CHECKBOX_UNCHECKED.red
           end
           print "  "
-          print choice[:label]
+          print label_for_choice(choice)
           print "\n"
         end
       end

data/lib/question/confirm.rb

@@ -11,9 +11,9 @@ module Question
       print TTY::CODE::SAVE
       question = colorized_question
       if @default
-        question += "(Y/n) ".colorize(:light_white)
+        question += "(Y/n) ".light_white
       else
-        question += "(y/N) ".colorize(:light_white)
+        question += "(y/N) ".light_white
       end
 
       # Use readline so keyboard shortcuts like alt-backspace work
@@ -36,12 +36,12 @@ module Question
     def render
       TTY.clear
       print colorized_question
-      print (@answer ? "Yes" : "No").colorize(:blue)
+      print (@answer ? "Yes" : "No").green
       print "\n"
     end
 
     def colorized_question
-      colorized_question = "? ".colorize(:cyan)
+      colorized_question = "? ".cyan
       colorized_question += @question
       colorized_question += ": "
     end

data/lib/question/input.rb

@@ -10,7 +10,7 @@ module Question
     def ask
       print TTY::CODE::SAVE
       question = colorized_question
-      question += "(#{@default}) ".colorize(:light_white) if @default
+      question += "(#{@default}) ".light_white if @default
 
       # Use readline so keyboard shortcuts like alt-backspace work
       @answer = Readline.readline(question, true)
@@ -25,12 +25,12 @@ module Question
     def render
       TTY.clear
       print colorized_question
-      print @answer.colorize(:blue)
+      print @answer.green
       print "\n"
     end
 
     def colorized_question
-      colorized_question = "? ".colorize(:cyan)
+      colorized_question = "? ".cyan
       colorized_question += @question
       colorized_question += ": "
     end

data/lib/question/list.rb

@@ -7,16 +7,24 @@ module Question
       @finished = false
     end
 
+    def label_for_choice(choice)
+      choice.is_a?(Hash) ? choice[:label] : choice
+    end
+
+    def value_for_choice(choice)
+      choice.is_a?(Hash) ? choice[:value] : choice
+    end
+
     def ask
       TTY.interactive do
         while !@finished
           render
           handle_input
         end
-        render # render the results a final time and clear the screen
+        render
       end
 
-      @choices[@active_index]
+      value_for_choice(@choices[@active_index])
     end
 
     def handle_input
@@ -35,26 +43,30 @@ module Question
     end
 
     def instructions
-      "(Press <enter> when to make selection)"
+      "(Press <enter> to select item)"
     end
 
     def render
       TTY.clear
-      print "? ".colorize(:cyan)
+      print "? ".cyan
       print @question
       print ": "
       if @finished
-        print @choices[@active_index][:label].colorize(:green)
+        print label_for_choice(@choices[@active_index]).green
       else
-        print instructions.colorize(:light_white)
+        print instructions.light_black
       end
       print "\n"
 
       unless @finished
         @choices.each_with_index do |choice, index|
-          print index == @active_index ? TTY::UI::SELECTED : TTY::UI::UNSELECTED
+          print index == @active_index ? TTY::UI::SELECTED.green : TTY::UI::UNSELECTED
           print " "
-          print choice[:label]
+          if index == @active_index
+            print label_for_choice(choice).green
+          else
+            print label_for_choice(choice)
+          end
           print "\n"
         end
       end

data/lib/question/password.rb

@@ -35,10 +35,10 @@ module Question
     def render
       obscured_password = TTY::UI::SECURE * @answer.length
       TTY.clear
-      print "? ".colorize(:cyan)
+      print "? ".cyan
       print @question
       print ": "
-      print @finished ? obscured_password.colorize(:blue) : obscured_password
+      print @finished ? obscured_password.green : obscured_password
       print "\n"
     end
   end

data/lib/question/tty.rb

@@ -12,7 +12,12 @@ module Question
       LEFT = "\e[D"
       BACKSPACE = "\b"
       DELETE = "\e[3"
-      SIGINT = "\003"
+
+      CTRL_J = "\x0A"
+      CTRL_N = "\x0E"
+      CTRL_K = "\x0B"
+      CTRL_P = "\x10"
+      SIGINT = "\x03"
 
       HIDE = "\e[?25l"
       SHOW = "\e[?25h"

data/lib/question/version.rb

@@ -1,3 +1,3 @@
 module Question
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/question.rb

@@ -14,4 +14,23 @@ require "question/password"
 require "question/confirm"
 
 module Question
+  def self.checkbox_list(*args)
+    CheckboxList.new(*args).ask
+  end
+
+  def self.list(*args)
+    List.new(*args).ask
+  end
+
+  def self.input(*args)
+    Input.new(*args).ask
+  end
+
+  def self.password(*args)
+    Password.new(*args).ask
+  end
+
+  def self.confirm(*args)
+    Confirm.new(*args).ask
+  end
 end

data/test/minitest_helper.rb

@@ -2,3 +2,10 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'question'
 
 require 'minitest/autorun'
+
+def fake_input(input, &block)
+  input_proc = proc { input.shift }
+  $stdin.stub :getch, input_proc do
+    block.call
+  end
+end

data/test/test_question.rb

@@ -3,33 +3,47 @@ require 'minitest_helper'
 describe Question do
   describe "CheckboxList" do
     it "returns checked choices" do
-
       message = "How are you feeling"
       choices = [
         { label: "good", value: {sub: 1} },
         { label: "neutral", value: 0 },
-        { label: "horrible", value: [1,2,3] }
+        "horrible"
       ]
 
-      # Fake input
       input = [
         Question::TTY::CODE::UP,
         Question::TTY::CODE::SPACE,
         Question::TTY::CODE::DOWN,
         Question::TTY::CODE::SPACE,
+        Question::TTY::CODE::DOWN,
+        Question::TTY::CODE::SPACE,
         Question::TTY::CODE::RETURN
       ]
-      input_proc = Proc.new { input.shift }
-
-      result = $stdin.stub :getch, input_proc do
-        question = Question::CheckboxList.new(message, choices)
-        question.ask()
-      end
+      result = fake_input(input) { Question.checkbox_list(message, choices, default: [0]) }
 
       assert_equal result, [
-        { label: "horrible", value: [1,2,3] },
-        { label: "good", value: {sub: 1} }
+        "horrible",
+        {sub: 1}
       ]
     end
   end
+
+  describe "List" do
+    it "returns checked choices" do
+
+      message = "How are you feeling"
+      choices = [
+        { label: "good", value: {sub: 1} },
+        { label: "neutral", value: 0 },
+        "horrible"
+      ]
+
+      choices.each_with_index do |choice, index|
+        input = [Question::TTY::CODE::RETURN]
+        index.times { input.unshift Question::TTY::CODE::DOWN }
+        result = fake_input(input) { Question.list(message, choices) }
+        assert_equal result, choice.is_a?(Hash) ? choice[:value] : choice
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: question
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - probablycorey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler