userinput 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7931090fde842e07e7bb83ca88dcef175c348f0c
-  data.tar.gz: ce4cb1f5fc13933887acac8b53d300042bef9b05
+  metadata.gz: 1c1149e9754ddf19bb5d121000a9022a88464096
+  data.tar.gz: 6dae20c6c1bcd14207c548311c82da96a78eacf0
 SHA512:
-  metadata.gz: f69f1f71afd3d61a7ec05578867d5c6ef731639a6b58c5a978cc2b68073c10c6781b740641c4414ccdfd80066a0691bd7b3327c120f353fc37f094696b6085fc
-  data.tar.gz: e519c52e115d34fa9711377911da156d2f5cc14570f3be3b17b7dba4946340bc95b038ee89e59bba5a3d1b8b57f0e8e3f306c5aaa455c44e3f2115f44687e5dc
+  metadata.gz: 160c87160ef2843da4bdc7813ae1f827d20b6b85875400953c537cfd56a2672a8ea54da40c93d67739de8f69ca8815b9b7930e8c7beac92879d905c99dd7ab96
+  data.tar.gz: 55c032fbcc1daea95606db9389485c88661eec605c8c186c02f25fdc17bec0d261ff342bc3251d60748d4cf2e441a519730535b7ea8b5d9b3d8a9616f528b777

data/README.md

@@ -8,10 +8,83 @@ userinput
 [![Build Status](https://img.shields.io/travis/akerl/userinput.svg)](https://travis-ci.org/akerl/userinput)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
-SHORT_DESCRIPTION
+A simple user input library
 
 ## Usage
 
+User interaction is handled by the `UserInput::Prompt` object. As a convenience, this can be created using the `UserInput.new` method:
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(message: 'Username')
+=> #<UserInput::Prompt:0x007fdfba1681f8 @attempts=nil, @message="Username", @default=nil, @secret=false, @validation=nil>
+> prompt.ask
+Username? leet_dude
+=> "leet_dude"
+```
+
+You can optionally provide a default:
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(default: '_other')
+=> #<UserInput::Prompt:0x007fb7eb163f00 @attempts=nil, @message="", @default="_other", @secret=false, @validation=nil>
+> prompt.ask
+? [_other] answer
+=> "answer"
+> prompt.ask
+? [_other]
+=> "_other"
+```
+
+If you provide a validation Regexp or a code block, the input will be validated using that:
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(validation: /[0-9]+/)
+=> #<UserInput::Prompt:0x007f99909637b0 @attempts=nil, @message="", @default=nil, @secret=false, @validation=/[0-9]+/>
+> prompt.ask
+? _str
+? 23
+=> "23"
+> other_prompt = UserInput.new { |x| x == '_correct' }
+=> #<UserInput::Prompt:0x007f9990920eb0 @attempts=nil, @message="", @default=nil, @secret=false, @validation=#<Proc:0x007f99909211d0@(irb):4>>
+> other_prompt.ask
+? _wrong
+? 23
+? _correct
+=> "_correct"
+```
+
+Providing a number of attempts will cause an ArgumentError to be raised after that many failed inputs:
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(attempts: 3, validation: /[0-9]+/)
+=> #<UserInput::Prompt:0x007f9f6a950270 @attempts=3, @message="", @default=nil, @secret=false, @validation=/[0-9]+/>
+> prompt.ask
+? _str
+? _other
+? _attempt
+ArgumentError: No valid input provided
+```
+
+For sensitive input, pass the `secret` parameter, which will try to disable terminal printing of the user's input:
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(message: 'Password', secret: true)
+=> #<UserInput::Prompt:0x007fb8ab9220a0 @attempts=nil, @message="Password", @default=nil, @secret=true, @validation=nil>
+> prompt.ask
+Password?
+=> "_password"
+```
+
 ## Installation
 
     gem install userinput

data/lib/userinput.rb

@@ -60,6 +60,7 @@ module UserInput
     def _ask
       input = STDIN.gets.chomp
       input = @default if input.empty? && !@default.nil?
+      puts if @secret
       input
     end
 

data/spec/userinput_spec.rb

@@ -54,6 +54,14 @@ describe UserInput do
           expect(prompt.ask).to eql 'correct'
         end
       end
+      context 'when provided an unsupported validation method' do
+        it 'raises a RuntimeError' do
+          prompt = UserInput::Prompt.new(validation: 28)
+          allow(STDIN).to receive(:gets).and_return("_str\n")
+          expect(prompt).to receive(:print).with('? ')
+          expect { prompt.ask }.to raise_error RuntimeError
+        end
+      end
 
       it 'raises an error if max attempts is reached' do
         prompt = UserInput::Prompt.new(attempts: 2) { |x| false }
@@ -62,5 +70,12 @@ describe UserInput do
         expect { prompt.ask }.to raise_error ArgumentError
       end
     end
+
+    it 'disables echo for secret input' do
+      prompt = UserInput::Prompt.new(secret: true)
+      allow(STDIN).to receive(:gets).and_return("_str\n")
+      expect(prompt).to receive(:print).with('? ')
+      expect(prompt.ask).to eql '_str'
+    end
   end
 end

data/userinput.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'userinput'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
-  s.summary     = ''
-  s.description = ""
+  s.summary     = 'Simple user input library'
+  s.description = 'Provides a prompt object for requesting user input'
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/userinput'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userinput
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-29 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,7 +80,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.2
-description: ''
+description: Provides a prompt object for requesting user input
 email: me@lesaker.org
 executables: []
 extensions: []
@@ -121,7 +121,7 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Simple user input library
 test_files:
 - spec/spec_helper.rb
 - spec/userinput_spec.rb