question 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3a0d376bc7b786a49fd2def503783d20b3faba4
+  data.tar.gz: b5c4c650182334f747a56f2afac3edf8af9825d4
+SHA512:
+  metadata.gz: 57062767899bae46121b0c5c6d96f1b711fc3084c0fbd75a1be1f4fff8e873b308bd7aa5fe845642a07be83b858e7bafe284979c7bcb3b9fc0b5e21f81d7867d
+  data.tar.gz: 8ae38cbddfffb390264432f21af1bbc4872c642927abde1a4a5a230046816295486d2ccfcfd36f84871ce170118e54f187554fda399a081989ebb0d73ad2938e

data/.gitignore

@@ -0,0 +1 @@
+/vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in question.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 probablycorey
+
+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,23 @@
+# Question
+
+![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
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'question'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install question
+
+## Usage
+
+See `examples/example.rb`

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test
+

data/examples/example.rb

@@ -0,0 +1,24 @@
+require "pp"
+
+require "question"
+
+choices = [
+  { label: "red", value: {r: 255, g: 0, b: 0} },
+  { label: "blue", value: "#0000FF" },
+  { label: "green", value: "green" }
+]
+
+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

data/lib/question/checkbox_list.rb

@@ -0,0 +1,81 @@
+module Question
+  class CheckboxList
+    def initialize(question, choices, default: nil)
+      @question = question
+      @choices = choices
+      @active_index = 0
+      @selected_choices = default || []
+      @finished = false
+      @modified = false
+    end
+
+    def ask
+      TTY.interactive do
+        while !@finished
+          render
+          handle_input
+        end
+        render # render the results a final time and clear the screen
+      end
+
+      @selected_choices
+    end
+
+    def handle_input
+      case TTY.input
+      when TTY::CODE::SIGINT
+        exit 130
+      when TTY::CODE::RETURN
+        @finished = true
+      when TTY::CODE::DOWN
+        @active_index += 1
+        @active_index = 0 if @active_index >= @choices.length
+      when TTY::CODE::UP
+        @active_index -= 1
+        @active_index = @choices.length - 1 if @active_index < 0
+      when TTY::CODE::SPACE
+        @modified = true
+        active_choice = @choices[@active_index]
+        if @selected_choices.include? active_choice
+          @selected_choices.delete(active_choice)
+        else
+          @selected_choices.push(active_choice)
+        end
+      end
+    end
+
+    def instructions
+      "(Use <space>, <up>, <down> – Press <enter> when finished)"
+    end
+
+    def render
+      TTY.clear
+      print "? ".colorize(:cyan)
+      print @question
+      print ": "
+      if @finished
+        print @selected_choices.map { |choice| choice[:label] }.join(", ").colorize(:green)
+      elsif @modified
+        print @selected_choices.map { |choice| choice[:label] }.join(", ")
+      else
+        print instructions.colorize(:light_white)
+      end
+      print "\n"
+
+      unless @finished
+        @choices.each_with_index do |choice, index|
+          print index == @active_index ? TTY::UI::SELECTED : TTY::UI::UNSELECTED
+          print " "
+          if @selected_choices.include?(choice)
+            print TTY::UI::CHECKBOX_CHECKED.colorize(:green)
+          else
+            print TTY::UI::CHECKBOX_UNCHECKED.colorize(:red)
+          end
+          print "  "
+          print choice[:label]
+          print "\n"
+        end
+      end
+    end
+  end
+end

data/lib/question/confirm.rb

@@ -0,0 +1,49 @@
+module Question
+  class Confirm
+    def initialize(question, default:true)
+      @question = question
+      @finished = false
+      @default = default
+      @answer = nil
+    end
+
+    def ask
+      print TTY::CODE::SAVE
+      question = colorized_question
+      if @default
+        question += "(Y/n) ".colorize(:light_white)
+      else
+        question += "(y/N) ".colorize(:light_white)
+      end
+
+      # Use readline so keyboard shortcuts like alt-backspace work
+      @answer = Readline.readline(question, true)
+      @answer = if @answer =~ /^y/i
+        true
+      elsif @answer =~ /^n/i
+        false
+      else
+        @default
+      end
+
+      render
+
+      @answer
+    rescue Interrupt
+      exit 1
+    end
+
+    def render
+      TTY.clear
+      print colorized_question
+      print (@answer ? "Yes" : "No").colorize(:blue)
+      print "\n"
+    end
+
+    def colorized_question
+      colorized_question = "? ".colorize(:cyan)
+      colorized_question += @question
+      colorized_question += ": "
+    end
+  end
+end

data/lib/question/input.rb

@@ -0,0 +1,38 @@
+module Question
+  class Input
+    def initialize(question, default:nil)
+      @question = question
+      @finished = false
+      @default = default
+      @answer = nil
+    end
+
+    def ask
+      print TTY::CODE::SAVE
+      question = colorized_question
+      question += "(#{@default}) ".colorize(:light_white) if @default
+
+      # Use readline so keyboard shortcuts like alt-backspace work
+      @answer = Readline.readline(question, true)
+      @answer = @default if @default && @answer.length == 0
+
+      render
+      @answer
+    rescue Interrupt
+      exit 1
+    end
+
+    def render
+      TTY.clear
+      print colorized_question
+      print @answer.colorize(:blue)
+      print "\n"
+    end
+
+    def colorized_question
+      colorized_question = "? ".colorize(:cyan)
+      colorized_question += @question
+      colorized_question += ": "
+    end
+  end
+end

data/lib/question/list.rb

@@ -0,0 +1,63 @@
+module Question
+  class List
+    def initialize(question, choices)
+      @question = question
+      @choices = choices
+      @active_index = 0
+      @finished = false
+    end
+
+    def ask
+      TTY.interactive do
+        while !@finished
+          render
+          handle_input
+        end
+        render # render the results a final time and clear the screen
+      end
+
+      @choices[@active_index]
+    end
+
+    def handle_input
+      case TTY.input
+      when TTY::CODE::SIGINT
+        exit 130
+      when TTY::CODE::RETURN, TTY::CODE::SPACE
+        @finished = true
+      when TTY::CODE::DOWN
+        @active_index += 1
+        @active_index = 0 if @active_index >= @choices.length
+      when TTY::CODE::UP
+        @active_index -= 1
+        @active_index = @choices.length - 1 if @active_index < 0
+      end
+    end
+
+    def instructions
+      "(Press <enter> when to make selection)"
+    end
+
+    def render
+      TTY.clear
+      print "? ".colorize(:cyan)
+      print @question
+      print ": "
+      if @finished
+        print @choices[@active_index][:label].colorize(:green)
+      else
+        print instructions.colorize(:light_white)
+      end
+      print "\n"
+
+      unless @finished
+        @choices.each_with_index do |choice, index|
+          print index == @active_index ? TTY::UI::SELECTED : TTY::UI::UNSELECTED
+          print " "
+          print choice[:label]
+          print "\n"
+        end
+      end
+    end
+  end
+end

data/lib/question/password.rb

@@ -0,0 +1,45 @@
+module Question
+  class Password
+    def initialize(question)
+      @question = question
+      @finished = false
+      @finished = false
+      @answer = ""
+    end
+
+    def ask
+      TTY.interactive do
+        while !@finished
+          render
+          handle_input
+        end
+      end
+      render
+
+      @answer
+    end
+
+    def handle_input
+      case input = TTY.input
+      when TTY::CODE::SIGINT
+        exit 130
+      when TTY::CODE::RETURN
+        @finished = true
+      when TTY::CODE::BACKSPACE, TTY::CODE::DELETE
+        @answer.chop! unless @answer.length == 0
+      when /^[^\e]/
+        @answer += input
+      end
+    end
+
+    def render
+      obscured_password = TTY::UI::SECURE * @answer.length
+      TTY.clear
+      print "? ".colorize(:cyan)
+      print @question
+      print ": "
+      print @finished ? obscured_password.colorize(:blue) : obscured_password
+      print "\n"
+    end
+  end
+end

data/lib/question/tty.rb

@@ -0,0 +1,63 @@
+module Question
+  class TTY
+    module CODE
+      SPACE = " "
+      TAB = "\t"
+      RETURN = "\r"
+      LINEFEED = "\n"
+      ESCAPE = "\e"
+      UP = "\e[A"
+      DOWN = "\e[B"
+      RIGHT = "\e[C"
+      LEFT = "\e[D"
+      BACKSPACE = "\b"
+      DELETE = "\e[3"
+      SIGINT = "\003"
+
+      HIDE = "\e[?25l"
+      SHOW = "\e[?25h"
+      CLEAR_DOWN = "\e[0J"
+      SAVE = "\e7"
+      RESTORE = "\e8"
+    end
+
+    module UI
+      SECURE = "•"
+      SELECTED = "‣"
+      UNSELECTED = " "
+      CHECKBOX_CHECKED = "⬢"
+      CHECKBOX_UNCHECKED = "⬡"
+    end
+
+    def self.interactive(&block)
+      begin
+        print TTY::CODE::SAVE
+        sync_value = $stdout.sync
+        $stdout.sync = true
+        print TTY::CODE::HIDE
+        block.call
+      ensure
+        print TTY::CODE::SHOW
+        $stdout.sync = sync_value
+      end
+    end
+
+    def self.clear
+      print TTY::CODE::RESTORE
+      print TTY::CODE::CLEAR_DOWN
+    end
+
+    def self.input
+      input = $stdin.getch
+      return input unless input == "\e"
+      begin
+        Timeout.timeout(0.01) do
+          input += $stdin.getch
+          input += $stdin.getch
+        end
+      rescue Timeout::Error
+      end
+      input
+    end
+  end
+end

data/lib/question/version.rb

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

data/lib/question.rb

@@ -0,0 +1,17 @@
+require "io/console"
+require "pp"
+require "readline"
+require "timeout"
+
+require "colorize"
+
+require "question/version"
+require "question/tty"
+require "question/checkbox_list"
+require "question/list"
+require "question/input"
+require "question/password"
+require "question/confirm"
+
+module Question
+end

data/question.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'question/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "question"
+  spec.version       = Question::VERSION
+  spec.authors       = ["probablycorey"]
+  spec.email         = ["probablycorey@gmail.com"]
+  spec.summary       = %q{Interactive command line UI.}
+  spec.description   = %q{Inspired by Inquirer.js}
+  spec.homepage      = "https://github.com/probablycorey/question"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 1.1"
+
+  spec.add_runtime_dependency('colorize', '~> 0.7')
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'question'
+
+require 'minitest/autorun'

data/test/test_question.rb

@@ -0,0 +1,35 @@
+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] }
+      ]
+
+      # Fake input
+      input = [
+        Question::TTY::CODE::UP,
+        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
+
+      assert_equal result, [
+        { label: "horrible", value: [1,2,3] },
+        { label: "good", value: {sub: 1} }
+      ]
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: question
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- probablycorey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Inspired by Inquirer.js
+email:
+- probablycorey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/question.rb
+- lib/question/checkbox_list.rb
+- lib/question/confirm.rb
+- lib/question/input.rb
+- lib/question/list.rb
+- lib/question/password.rb
+- lib/question/tty.rb
+- lib/question/version.rb
+- question.gemspec
+- test/minitest_helper.rb
+- test/test_question.rb
+homepage: https://github.com/probablycorey/question
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Interactive command line UI.
+test_files:
+- test/minitest_helper.rb
+- test/test_question.rb