fancy_gets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa82413ae8f11a2c6a6760a5d15d951d6cb77f12
+  data.tar.gz: 1e5e1b10db12c9b5452ff6e3996ec8fc6cac6d13
+SHA512:
+  metadata.gz: 34acd4801dec89245f9f96c09bcebc00d177c788d1f0daa0f2ce757c8a2dd7055303961caa3ca8ea6b44c1c45090379dd44648306957463f408c3f6bb72bfd1f
+  data.tar.gz: 119b5775cbc26f3b67d1ca224fc052f6317640e2f1ca7b7c9d0cc33ce87469a1096a8e02cdf65b1f6ee484fd497b233adcf3072d041b0aa00041996c950a134c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lorint@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lorin Thwaits
+
+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,117 @@
+# FancyGets
+
+This gem exists to banish crusty UX that our users endure at the command line.
+
+For far too long we've been stuck with just gets and getc.  When prompting the
+user with a list of choices, wouldn't it be nice to have the feel of a <select>
+in HTML?  Or to auto-suggest options as they type?  Or perhaps offer a password
+entry with asterisks instead of just sitting silent, which confuses many users?
+
+Read on.
+
+## Installation
+
+Very straightforward ... this simple entry in the Gemfile, after which make sure to run "bundle":
+
+```ruby
+gem 'fancy_gets'
+```
+
+Or have it end up in your /usr/lib/ruby/gems/... folder with:
+
+    $ gem install fancy_gets
+
+And at the top of any CLI app do the require and include:
+
+```ruby
+require 'fancy_gets'
+include FancyGets
+```
+
+And then you can impress all manner of people accustomed to the stark limitations
+of command line apps.  Heck, this even makes them fun again.
+
+## gets_list
+
+Imagine you have this cool array of beach things.  Have the user pick one.
+
+```ruby
+toys = ["Skimboard", "Volleyball", "Kite", "Beach Ball", "Water Gun", "Frisbee"]
+picked_toy = gets_list(toys)
+puts "\nBringing a #{picked_toy} sounds like loads of fun at the beach."
+```
+
+And perhaps a little later you'd like to ask again what they'd like, plus
+give a default of what they had picked before.
+
+```ruby
+new_toy = gets_list(toys, picked_toy)
+puts "\nCool!  This time you've brought a #{new_toy}."
+```
+
+If you don't prefer the default > Toy Name < prompts, feel free to have your own
+prefix and suffix applied to choices as the user arrows up and down, and supply
+your own prompt text if you like.  This is the full syntax for gets_list, and
+the false indicates it's not doing multiple choice.
+
+```ruby
+another_toy = gets_list(toys, false, nil, "==>", "<== PARTY TIME!", "Use arrows to pick something awesome.")
+puts "\nSo much to love about #{another_toy}."
+```
+
+Another cool thing this allows is to change the color of selected items.  You may want
+to check out Michał Kalbarczyk's [colorize gem](https://github.com/fazibear/colorize "Michał loves all things \033") for more info.
+
+```ruby
+another_toy = gets_list(toys, false, nil, "==>", "<== PARTY TIME!", "Use arrows to pick something awesome.")
+puts "\nSo much to love about #{another_toy}."
+```
+
+Easy to have multiple choices, and bring back an array.  In this case it already
+has chosen the kite and water gun.
+
+```ruby
+picked_toys = gets_list(toys, true, ["Kite", "Water Gun"])
+puts "\nYou've picked #{picked_toys.join(", ")}."
+```
+
+## gets_auto_suggest
+
+Still using the same cool array of things, let's have the user see auto-suggest text
+as they type.  As soon as the proper term appears, they can hit ENTER and the full
+string for that item is returned.  The search is case and color insensitive.
+
+```ruby
+toys = ["Skimboard", "Volleyball", "Kite", "Beach Ball", "Water Gun", "Frisbee"]
+picked_toy = gets_auto_suggest(toys)
+puts "\nYou chose #{picked_toy}."
+```
+
+And as above, you can offer a default choice.  This can be set with a full or partial
+string.
+
+```ruby
+new_toy = gets_auto_suggest(toys, picked_toy[0..2])
+puts "\nChanging it up for #{new_toy}."
+```
+
+## gets_password
+
+The final bit of coolness is a simple guarded password entry.  All variables used
+by the gem are local, so after returning a response any plain text which was entered
+does not stick around past a garbage collection.
+
+```ruby
+pwd = gets_password
+puts "\nI think I heard you whisper, \"#{pwd}\"."
+```
+
+This also allows default text to be provided, although I can't easily think of a
+circumstance in which that's useful.  But perhaps to you it could be.
+
+Bug reports and pull requests are welcome: https://github.com/lorint/fancy_gets.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fancy_gets"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fancy_gets.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fancy_gets/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fancy_gets"
+  spec.version       = FancyGets::VERSION
+  spec.authors       = ["Lorin Thwaits"]
+  spec.email         = ["lorint@gmail.com"]
+
+  spec.summary       = %q{Enhanced gets with listbox, auto-complete, and password support}
+  spec.description   = %q{This gem exists to banish crusty UX that our users endure at the command line.
+
+For far too long we've been stuck with just gets and getc.  When prompting the
+user with a list of choices, wouldn't it be nice to have the feel of a <select>
+in HTML?  Or to auto-suggest options as they type?  Or perhaps offer a password
+entry with asterisks instead of just sitting silent, which confuses many users?
+
+It's all here.  Enjoy!}
+  spec.homepage      = "http://polangeles.com/gems/fancy_gets"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fancy_gets/version.rb

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

data/lib/fancy_gets.rb

@@ -0,0 +1,242 @@
+require "fancy_gets/version"
+require 'io/console'
+
+module FancyGets
+  def gets_auto_suggest(words = nil, default = "")
+    FancyGets.gets_internal_core(false, false, words, default)
+  end
+
+  def gets_password(default = "")
+    FancyGets.gets_internal_core(false, true, nil, default)
+  end
+
+  # Show a list of stuff, potentially some highlighted, and allow people to up-down arrow around and pick stuff
+  def gets_list(words, is_multiple = false, chosen = [], prefix = "> ", postfix = " <", info = nil)
+    # Trying to supply parameters but left out a "true" for is_multiple?
+    if is_multiple.is_a?(Array)
+      chosen = is_multiple
+      is_multiple = true
+    end
+    if is_multiple.is_a?(String) || is_multiple.is_a?(Fixnum)
+      chosen = is_multiple
+      is_multiple = false
+    end
+    is_multiple = true if chosen.is_a?(Array) && chosen.length > 1
+    FancyGets.gets_internal_core(true, is_multiple, words, chosen, prefix, postfix, info)
+  end
+
+  # The internal routine that makes all the magic happen
+  def self.gets_internal_core(is_list, is_password, words = nil, chosen = [], prefix = "> ", postfix = " <", info = nil)
+    # OK -- second parameter, is_password, means is_multiple when is_list is true
+    is_multiple = is_list & is_password
+    words.sort! unless words.nil? || is_list
+    string = chosen if chosen.is_a?(String)
+    position = 0
+    sugg = ""
+    prev_sugg = ""
+
+    # gsub causes any color changes to not offset spacing
+    uncolor = lambda { |word| word.gsub(/\033\[[0-9;]+m/, "") }
+
+    write_sugg = lambda do
+      # Find first word that case-insensitive matches what they've typed
+      if string.blank?
+        sugg = ""
+      else
+        sugg = words.select { |word| uncolor.call(word).downcase.start_with? string.downcase }.first || ""
+      end
+      extra_spaces = uncolor.call(prev_sugg).length - uncolor.call(sugg).length
+      extra_spaces = 0 if extra_spaces < 0
+      " - #{sugg}#{" " * extra_spaces} #{"\b" * ((uncolor.call(sugg).length + 4 + extra_spaces) + string.length - position)}"
+    end
+
+    pre_post_length = uncolor.call(prefix + postfix).length
+
+    # Used for dropdown select / deselect
+    clear_dropdown_info = lambda do
+      print "\b" * (uncolor.call(words[position]).length + pre_post_length)
+      print (27.chr + 91.chr + 66.chr) * (words.length - position)
+      info_length = uncolor.call(info).length
+      print " " * info_length + "\b" * info_length
+    end
+    make_select = lambda do |is_select, is_go_to_front = false, is_end_at_front = false|
+      word = words[position]
+      print "\b" * (uncolor.call(word).length + pre_post_length) if is_go_to_front
+      if is_select
+        print "#{prefix}#{word}#{postfix}"
+      else
+        print "#{" " * uncolor.call(prefix).length}#{word}#{" " * uncolor.call(postfix).length}"
+      end
+      print "\b" * (uncolor.call(word).length + pre_post_length) if is_end_at_front
+    end
+
+    if is_list
+      # Maybe confirm the height is adequate by checking out IO.console.winsize
+      case chosen.class.name
+      when "Fixnum"
+        chosen = [words[chosen]]
+      when "String"
+        if words.include?(chosen)
+          chosen = [chosen]
+        else
+          chosen = []
+        end
+      end
+      chosen ||= []
+      chosen = [words[0]] if chosen == [] && !is_multiple
+      position = words.index(chosen.first) if chosen.length > 0
+      words.each { |word| puts chosen.include?(word) ? "#{prefix}#{word}#{postfix}" : "#{" " * uncolor.call(prefix).length}#{word}" }
+      info ||= "Use arrow keys#{is_multiple ? ", spacebar to toggle, and ENTER to save" : " and ENTER to make a choice"}"
+      print info + (27.chr + 91.chr + 65.chr) * (words.length - position)
+      # To end of text on starting line
+      info_length = uncolor.call(info).length
+      word_length = uncolor.call(words[position]).length + pre_post_length
+      print (info_length > word_length ? "\b" : (27.chr + 91.chr + 67.chr)) * (info_length - word_length).abs
+    else
+      position = string.length
+      if is_password
+        print "*" * string.length
+      else
+        print string + write_sugg.call
+      end
+    end
+    loop do
+      ch = STDIN.getch
+      code = ch.ord
+      case code
+      when 3 # CTRL-C
+        clear_dropdown_info.call if is_list
+        exit
+      when 13 # ENTER
+        if is_list
+          clear_dropdown_info.call
+        else
+          print "\n"
+        end
+        break
+      when 27  # ESC -- which means lots of special stuff
+        case ch = STDIN.getch.ord
+        when 79  # Function keys
+          # puts "ESC 79"
+          case ch = STDIN.getch.ord
+          when 80 #F1
+            # puts "F1"
+          when 81 #F2
+          when 82 #F3
+          when 83 #F4
+          when 84 #F5
+          when 85 #F6
+          when 86 #F7
+          when 87 #F8
+          when 88 #F9
+          when 89 #F10
+          when 90 #F11
+          when 91 #F12
+            # puts "F12"
+          when 92 #F13
+          end
+        when 91 # Arrow keys
+          case ch = STDIN.getch.ord
+          when 68 # Arrow left
+            if position > 0
+              print "\b" # 27.chr + 91.chr + 68.chr
+              position -= 1
+            end
+          when 67 # Arrow right
+            if position < string.length
+              print 27.chr + 91.chr + 67.chr
+              position += 1
+            end
+          when 66 # - down
+            if is_list && position < words.length - 1
+              make_select.call(false, true, true) unless is_multiple
+              w1 = uncolor.call(words[position]).length
+              position += 1
+              print 27.chr + 91.chr + 66.chr
+              if is_multiple
+                w2 = uncolor.call(words[position]).length
+                print (w1 > w2 ? "\b" : (27.chr + 91.chr + 67.chr)) * (w1 - w2).abs
+              else
+                make_select.call(true)
+              end
+            end
+          when 65 # - up
+            if is_list && position > 0
+              make_select.call(false, true, true) unless is_multiple
+              w1 = uncolor.call(words[position]).length
+              position -= 1
+              print 27.chr + 91.chr + 65.chr
+              if is_multiple
+                w2 = uncolor.call(words[position]).length
+                print (w1 > w2 ? "\b" : (27.chr + 91.chr + 67.chr)) * (w1 - w2).abs
+              else
+                make_select.call(true)
+              end
+            end
+          when 51 # - Delete forwards?
+          else
+            # puts "ESC 91 #{ch}"
+          end
+        else
+          # Something wacky?
+          # puts "code #{ch} #{STDIN.getch.ord} #{STDIN.getch.ord} #{STDIN.getch.ord} #{STDIN.getch.ord}"
+        end
+      when 127 # Backspace
+        if !is_list && position > 0
+          string = string[0...position - 1] + string[position..-1]
+          if words.nil?
+            position -= 1
+            print "\b#{is_password ? "*" * (string.length - position) : string[position..-1]} #{"\b" * (string.length - position + 1)}"
+          else
+            prev_sugg = sugg
+            position -= 1
+            print "\b#{string[position..-1]}#{write_sugg.call}"
+          end
+        end
+      when 126 # Delete (forwards)
+        if !is_list && position < string.length
+          string = string[0...position] + string[position + 1..-1]
+          if words.nil?
+            print "#{is_password ? "*" * (string.length - position) : string[position..-1]} #{"\b" * (string.length - position + 1)}"
+          else
+            prev_sugg = sugg
+            print "#{string[position..-1]}#{write_sugg.call}"
+          end
+        end
+      else # Insert character
+        if is_list
+          if is_multiple && ch == " "
+            # Toggle this entry
+            word = words[position]
+            does_include = chosen.include?(word)
+            if does_include
+              chosen -= [word]
+            else
+              chosen += [word]
+            end
+            make_select.call(!does_include, true)
+          end
+        else
+          string = string[0...position] + ch + string[position..-1]
+          if words.nil?
+            ch = "*" if is_password
+            position += 1
+            print "#{ch}#{is_password ? "*" * (string.length - position) : string[position..-1]}#{"\b" * (string.length - position)}"
+          else
+            prev_sugg = sugg
+            position += 1
+            print "#{ch}#{string[position..-1]}#{write_sugg.call}"
+          end
+        end
+      end
+    end
+
+    if is_list
+      # Put chosen stuff in same order as it's listed in the words array
+      chosen = words.select { |word| chosen.include?(word) }
+      is_multiple ? chosen : words[position]
+    else
+      sugg.empty? ? string : sugg
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: fancy_gets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lorin Thwaits
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  This gem exists to banish crusty UX that our users endure at the command line.
+
+  For far too long we've been stuck with just gets and getc.  When prompting the
+  user with a list of choices, wouldn't it be nice to have the feel of a <select>
+  in HTML?  Or to auto-suggest options as they type?  Or perhaps offer a password
+  entry with asterisks instead of just sitting silent, which confuses many users?
+
+  It's all here.  Enjoy!
+email:
+- lorint@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fancy_gets.gemspec
+- lib/fancy_gets.rb
+- lib/fancy_gets/version.rb
+homepage: http://polangeles.com/gems/fancy_gets
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Enhanced gets with listbox, auto-complete, and password support
+test_files: []