userinput 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2703a01f7bc5d319b7c41edd4d8d3a56692afd46
-  data.tar.gz: dd3c9fb388e87dfa20f58bbf513377fbc0f03d1c
+  metadata.gz: fa7fa580b2919ec587477758892ba2dcd9f0edee
+  data.tar.gz: 05400265239b2bd76e85f59b5ebf34700df15fcb
 SHA512:
-  metadata.gz: cf6e415b42beef180b7f6f458e2060442c42a8e38b2081a28fe48a17b0d98f1db28e2a050b4c02f4328f66fe112f87ff525e8698a9489a722e28c8be03a1f1d0
-  data.tar.gz: c9ab8b806ff243e3f6f7ef4624d6f0b7a597cbe41c2f49281f783b00124106ce2be67ca31152759268154ead51fb3f9008ba1e35fec4776163d9a805ba6736f0
+  metadata.gz: 47f23a9a9d8d4c28cdb752f9d2ad854310ed2212a4e9a1792038f13b271192bbb2f31faaf81f459b5dedb1a850ef37785247f849fa930cff26c2429c05c57634
+  data.tar.gz: a8db81aebdeac9512fb7f4326bfeb3345c28c75ed0e6168175e654bfbfad0058b51a42b0b514d9eb0d5b3f4d1ef2d80aaf276d78adf0509b47550c94ca6286b8

data/.prospectus

@@ -0,0 +1,11 @@
+item do
+  expected do
+    static
+    set 'green'
+  end
+
+  actual do
+    gemnasium
+    slug 'akerl/userinput'
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.1 / 2016-02-13
+
+* [FEATURE] Support setting custom IO object as file descriptor for output
+
 # 1.0.0 / 2015-01-19
 
 * [ENHANCEMENT] Stabilized API

data/README.md

@@ -3,9 +3,9 @@ userinput
 
 [![Gem Version](https://img.shields.io/gem/v/userinput.svg)](https://rubygems.org/gems/userinput)
 [![Dependency Status](https://img.shields.io/gemnasium/akerl/userinput.svg)](https://gemnasium.com/akerl/userinput)
-[![Code Climate](https://img.shields.io/codeclimate/github/akerl/userinput.svg)](https://codeclimate.com/github/akerl/userinput)
-[![Coverage Status](https://img.shields.io/coveralls/akerl/userinput.svg)](https://coveralls.io/r/akerl/userinput)
-[![Build Status](https://img.shields.io/travis/akerl/userinput.svg)](https://travis-ci.org/akerl/userinput)
+[![Build Status](https://img.shields.io/circleci/project/akerl/userinput.svg)](https://circleci.com/gh/akerl/userinput)
+[![Coverage Status](https://img.shields.io/codecov/c/github/akerl/userinput.svg)](https://codecov.io/github/akerl/userinput)
+[![Code Quality](https://img.shields.io/codacy/fbda4046154e4ac38a47f2c6627d57c8.svg)](https://www.codacy.com/app/akerl/userinput)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
 A simple user input library
@@ -85,6 +85,18 @@ Password?
 => "_password"
 ```
 
+Setting the file descriptor lets you control where output is sent (for instance, use this to print messages on STDERR or to a custom IO object):
+
+```
+> require 'userinput'
+=> true
+> prompt = UserInput.new(message: 'Password', secret: true, fd: STDERR)
+=> #<UserInput::Prompt:0x007f888110a138 @attempts=nil, @message="Password", @default=nil, @secret=true, @fd=#<IO:<STDERR>>, @validation=nil>
+> prompt.ask
+Password?
+=> "_password"
+```
+
 ## Installation
 
     gem install userinput

data/circle.yml

@@ -0,0 +1,12 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle install'
+    - 'rvm-exec 2.0.0-p645 bundle install'
+    - 'rvm-exec 2.1.6 bundle install'
+    - 'rvm-exec 2.2.2 bundle install'
+test:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle exec rake'
+    - 'rvm-exec 2.0.0-p645 bundle exec rake'
+    - 'rvm-exec 2.1.6 bundle exec rake'
+    - 'rvm-exec 2.2.2 bundle exec rake'

data/lib/userinput.rb

@@ -20,13 +20,14 @@ module UserInput
       @message = params[:message] || ''
       @default = params[:default]
       @secret = params[:secret] || false
+      @fd = params[:fd] || STDOUT
       @validation = block || params[:validation]
     end
 
     ##
     # Request user input
     def ask
-      print "#{@message}? #{@default.nil? ? '' : "[#{@default}] "}"
+      @fd.print "#{@message}? #{@default.nil? ? '' : "[#{@default}] "}"
       disable_echo if @secret
 
       input = _ask
@@ -51,7 +52,7 @@ module UserInput
       when NilClass
         return true
       else
-        fail "Supported validation type not provided #{@validation.class}"
+        raise "Supported validation type not provided #{@validation.class}"
       end
     end
 
@@ -60,7 +61,7 @@ module UserInput
     def _ask
       input = STDIN.gets.chomp
       input = @default if input.empty? && @default
-      puts if @secret
+      @fd.puts if @secret
       input
     end
 
@@ -69,7 +70,7 @@ module UserInput
     def check_counter
       return if @attempts.nil?
       @attempts -= 1
-      fail ArgumentError, 'No valid input provided' if @attempts == 0
+      raise ArgumentError, 'No valid input provided' if @attempts == 0
     end
 
     ##

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-SimpleCov.start do
-  add_filter '/spec/'
+if ENV['CI'] == 'true'
+  require 'simplecov'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
 end
 
 require 'rspec'

data/spec/userinput_spec.rb

@@ -25,13 +25,13 @@ describe UserInput do
     describe '#ask' do
       it 'prompts for user input' do
         allow(STDIN).to receive(:gets) { "_answer\n" }
-        expect(subject).to receive(:print).with('_msg? [_default] ')
+        expect(STDOUT).to receive(:print).with('_msg? [_default] ')
         expect(subject.ask).to eql '_answer'
       end
 
       it 'returns the default if available' do
         allow(STDIN).to receive(:gets) { "\n" }
-        expect(subject).to receive(:print).with('_msg? [_default] ')
+        expect(STDOUT).to receive(:print).with('_msg? [_default] ')
         expect(subject.ask).to eql '_default'
       end
 
@@ -42,7 +42,7 @@ describe UserInput do
             validation: /[0-9]+/
           )
           allow(STDIN).to receive(:gets).and_return("_str\n", "29\n")
-          expect(prompt).to receive(:print).with('_msg? ').twice
+          expect(STDOUT).to receive(:print).with('_msg? ').twice
           expect(prompt.ask).to eql '29'
         end
       end
@@ -50,7 +50,7 @@ describe UserInput do
         it 'validates input' do
           prompt = UserInput::Prompt.new { |x| x == 'correct' }
           allow(STDIN).to receive(:gets).and_return("_str\n", "correct\n")
-          expect(prompt).to receive(:print).with('? ').twice
+          expect(STDOUT).to receive(:print).with('? ').twice
           expect(prompt.ask).to eql 'correct'
         end
       end
@@ -58,7 +58,7 @@ describe UserInput 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(STDOUT).to receive(:print).with('? ')
           expect { prompt.ask }.to raise_error RuntimeError
         end
       end
@@ -66,7 +66,7 @@ describe UserInput do
       it 'raises an error if max attempts is reached' do
         prompt = UserInput::Prompt.new(attempts: 2) { false }
         allow(STDIN).to receive(:gets).and_return("_str\n", "_foo\n")
-        expect(prompt).to receive(:print).with('? ').twice
+        expect(STDOUT).to receive(:print).with('? ').twice
         expect { prompt.ask }.to raise_error ArgumentError
       end
     end
@@ -74,7 +74,15 @@ describe UserInput do
     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(STDOUT).to receive(:print).with('? ')
+      expect(prompt.ask).to eql '_str'
+    end
+
+    it 'accepts an alternate file descriptor for output' do
+      target = StringIO.new
+      prompt = UserInput::Prompt.new(fd: target)
+      allow(STDIN).to receive(:gets).and_return("_str\n")
+      expect(target).to receive(:print).with('? ')
       expect(prompt.ask).to eql '_str'
     end
   end

data/userinput.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'userinput'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'Simple user input library'
@@ -13,9 +13,9 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split
   s.test_files  = `git ls-files spec/*`.split
 
-  s.add_development_dependency 'rubocop', '~> 0.28.0'
-  s.add_development_dependency 'rake', '~> 10.4.0'
-  s.add_development_dependency 'coveralls', '~> 0.7.1'
-  s.add_development_dependency 'rspec', '~> 3.1.0'
+  s.add_development_dependency 'rubocop', '~> 0.37.0'
+  s.add_development_dependency 'rake', '~> 10.5.0'
+  s.add_development_dependency 'codecov', '~> 0.1.1'
+  s.add_development_dependency 'rspec', '~> 3.4.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userinput
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.0
+        version: 0.37.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 10.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +87,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- circle.yml
 - lib/userinput.rb
 - spec/spec_helper.rb
 - spec/userinput_spec.rb
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple user input library

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-rvm:
-- 2.2.0
-- 2.1.5
-- 2.0.0-p598
-- 1.9.3-p551
-notifications:
-  email: false
-  irc:
-    template:
-    - '%{repository}/%{branch}/%{build_number}: %{message} -- %{build_url}'
-    channels:
-    - irc.oftc.net#akerl