console-glitter 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: baf523bf1aeebc54f79df59d20d85caf0562e5a3
-  data.tar.gz: 519b75adaec42c3ac17b6d51a48998e50944a8cb
+  metadata.gz: 96c51391b27aac84317c5e5cb026fb15a7ffc980
+  data.tar.gz: 462d17ab7b25eb8ccd3dd478f9492bf22e77b9f8
 SHA512:
-  metadata.gz: b95ffb8053587a36bfb8f7924beafe4b6684ace0886ad7e42e712d45cfc4a056ebb79c6c87f8fa2e9c8bdc42d0504d50ef664b713942251baf038fd73dbc0cb8
-  data.tar.gz: 8b7e398bf8389fecf839b885d67fb13128abb153a6a4f7afb298d542c3b67808ab17f5cd43f80bc217fc59a0b00b172915b9dba48906c20ac3d60d736c94ffb9
+  metadata.gz: 37b65808e6c64222d1b7007be17159e5b951f5f2be40be24d799b5c94d9ab2c79eec145500fa68cf85f723e135833aee9ccd1a8445a1af3bbc04888e217d1e8b
+  data.tar.gz: ebec9efc7368e6f5edffaf742f867876b08e11e10fcf42bbf7774e2c43eb7baed8193ed907529ebcfe04b5e5ad87ffce8c130f4859bed20c402bc45fad47e8aa

data/lib/console-glitter.rb

@@ -1,5 +1,6 @@
 require 'console-glitter/version'
 require 'console-glitter/ansi'
+require 'readline'
 require 'io/console'
 
 module ConsoleGlitter
@@ -23,20 +24,23 @@ module ConsoleGlitter
     #                              specified above).  Valid responses may be
     #                              any class with a match method such as
     #                              Strings or Regexps.
+    # wordlist - Array of words to be used for input auto-completion.
+    #            (default: [])
+    # block    - Lambda which will override the default autocompletion lambda
+    #            as defined in autocomplete_lambda if present.  (default: nil)
     #
     # Returns a String containing the answer provided by the user.
-    def prompt(question, options = {})
+    def prompt(question, options = {}, wordlist = [], block = nil)
       default = options[:default_answer].to_s
       allow_empty = options[:allow_empty]
       valid = regexify_answers(options[:valid_answers])
 
       default_display = " [#{default.strip}]" unless default.empty?
-      question.strip!
+      question = "#{question.strip}#{default_display}> "
 
       answer = nil
       while answer.nil?
-        print "#{question}#{default_display}> "
-        answer = $stdin.readline.strip
+        answer = user_prompt(question, wordlist, block)
         answer = default if answer.empty?
 
         if answer.empty?
@@ -89,6 +93,36 @@ module ConsoleGlitter
       puts
     end
 
+    # Public: Wrap Console#prompt, specifically targeting filesystem paths.
+    #
+    # question - Query to be presented to the user.
+    # options  - Hash containing arguments defining acceptable responses.
+    #            (default: {}):
+    #            :default_answer - String containing the default answer.  If
+    #                              this is nil, a non-empty answer MUST be
+    #                              given.
+    #            :allow_empty    - Whether or not to allow empty responses.
+    #                              Unless explicitly allowed, empty answers
+    #                              will be rejected.
+    #            :valid_answers  - An Array containing all valid responses.  If
+    #                              this is empty, any answer will be accepted
+    #                              (unless empty answers are disallowed as
+    #                              specified above).  Valid responses may be
+    #                              any class with a match method such as
+    #                              Strings or Regexps.
+    #
+    # Returns a String containing the answer provided by the user.
+    def filesystem_prompt(question, args = {})
+      fs_lambda = lambda { |d| Dir[d + '*'].grep(/^#{Regexp.escape(d)}/) }
+      old_append = Readline.completion_append_character
+
+      Readline.completion_append_character = ''
+      response = prompt(question, args, [], fs_lambda)
+      Readline.completion_append_character = old_append
+
+      response
+    end
+
     # Public: Render a "spinner" on the command line and yield to a block,
     # reporting success if nothing is raised, or else reporting failure.
     #
@@ -176,6 +210,39 @@ module ConsoleGlitter
 
     private
 
+    # Internal: Promp user for input via Readline, handling automatic setting
+    # and restoring of Readline's autocompletion proc, avoiding trampling over
+    # other uses.
+    #
+    # question - String containing a question to be displayed to the user.
+    # wordlist - Array containing Strings which are considered valid answers
+    #            for autocompletion.
+    # block    - Lambda which will override the default autocompletion lambda
+    #            as defined in autocomplete_lambda if present.  (default: nil)
+    #
+    # Returns a String.
+    def user_prompt(question, wordlist, block = nil)
+      block = autocomplete_lambda(wordlist) if block.nil?
+      old_completion_proc = Readline.completion_proc
+
+      Readline.completion_proc = block
+      response = Readline.readline(question)
+      Readline.completion_proc = old_completion_proc
+
+      response.to_s
+    end
+
+    # Internal: Generate a lambda which retuns an array of autocompletion
+    # candidates.
+    #
+    # wordlist - Array containing Strings which are considered valid answers
+    #            for autocompletion.
+    #
+    # Returns a lambda which returns an Array.
+    def autocomplete_lambda(wordlist)
+      lambda { |s| wordlist.grep(/^#{Regexp.escape(s)}/) }
+    end
+
     # Internal: Generate Regexps for any String in an array to be used in order
     # to match against user input.  Strings are expected to indicate exact
     # matches desired.

data/lib/console-glitter/version.rb

@@ -1,3 +1,3 @@
 module ConsoleGlitter
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console-glitter
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Wuest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies: []
 description: Tools for building nice looking CLI applications
 email: chris@chriswuest.com
@@ -19,7 +19,7 @@ files:
 - lib/console-glitter.rb
 - lib/console-glitter/ansi.rb
 - lib/console-glitter/version.rb
-homepage: http://github.com/cwuest/console-glitter
+homepage: https://gitlab.com/wuest/console-glitter
 licenses:
 - MIT
 metadata: {}
@@ -39,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Tools for prettier CLI apps