userinput 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7931090fde842e07e7bb83ca88dcef175c348f0c
+  data.tar.gz: ce4cb1f5fc13933887acac8b53d300042bef9b05
+SHA512:
+  metadata.gz: f69f1f71afd3d61a7ec05578867d5c6ef731639a6b58c5a978cc2b68073c10c6781b740641c4414ccdfd80066a0691bd7b3327c120f353fc37f094696b6085fc
+  data.tar.gz: e519c52e115d34fa9711377911da156d2f5cc14570f3be3b17b7dba4946340bc95b038ee89e59bba5a3d1b8b57f0e8e3f306c5aaa455c44e3f2115f44687e5dc

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*.gem
+coverage/
+.coveralls.yml
+.bundle
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Encoding:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+notifications:
+  email: false
+  irc:
+    template:
+    - '%{repository}/%{branch}/%{build_number}: %{message} -- %{build_url}'
+    channels:
+      secure: OkVku3yPBdazEJyXtmrAZCNiR2ceuvFGwz1ap6vQDA/In/d5W4Nt58zxrSp8mCP2rDXjju4N+toZNt6nPA4RU7OiKlo6o4Wo5ARqNPDBPRui2cafBWGldW68gI6yAArcyMCt2iRiSy+GCGk5GwCDxKhQ1b3vR/MLopQUUYc3c9U=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Les Aker
+
+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,22 @@
+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)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+SHORT_DESCRIPTION
+
+## Usage
+
+## Installation
+
+    gem install userinput
+
+## License
+
+userinput is released under the MIT License. See the bundled LICENSE file for details.
+

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task default: [:spec, :rubocop, :build, :install]

data/lib/userinput.rb

@@ -0,0 +1,96 @@
+##
+# User input library
+module UserInput
+  class << self
+    ##
+    # Insert a helper .new() method for creating a new Prompt object
+
+    def new(*args, &block)
+      self::Prompt.new(*args, &block)
+    end
+  end
+
+  ##
+  # Prompt object
+  class Prompt
+    ##
+    # Build new prompt object and set defaults
+    def initialize(params = {}, &block)
+      @attempts = params[:attempts]
+      @message = params[:message] || ''
+      @default = params[:default]
+      @secret = params[:secret] || false
+      @validation = block || params[:validation]
+    end
+
+    ##
+    # Request user input
+    def ask
+      print "#{@message}? #{@default.nil? ? '' : "[#{@default}] "}"
+      disable_echo if @secret
+
+      input = _ask
+      return input if valid(input)
+
+      check_counter
+      ask
+    ensure
+      enable_echo if @secret
+    end
+
+    ##
+    # Validate user input
+    def valid(input)
+      case @validation
+      when Proc
+        return @validation.call input
+      when Regexp
+        return @validation.match input
+      when NilClass
+        return true
+      else
+        fail "Supported validation type not provided #{@validation.class}"
+      end
+    end
+
+    private
+
+    ##
+    # Parse user input
+    def _ask
+      input = STDIN.gets.chomp
+      input = @default if input.empty? && !@default.nil?
+      input
+    end
+
+    ##
+    # Track attempt counter
+    def check_counter
+      unless @attempts.nil?
+        @attempts -= 1
+        fail ArgumentError, 'No valid input provided' if @attempts == 0
+      end
+    end
+
+    ##
+    # Disable terminal display of user input
+    def disable_echo
+      toggle_echo false
+    end
+
+    ##
+    # Enable terminal display of user input
+    def enable_echo
+      toggle_echo true
+    end
+
+    ##
+    # Toggle terminal display of user input
+    def toggle_echo(state)
+      setting = state ? '' : '-'
+      `stty #{setting}echo`
+    rescue
+      nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'userinput'

data/spec/userinput_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe UserInput do
+  describe '#new' do
+    it 'creates Prompt objects' do
+      expect(UserInput.new).to be_an_instance_of UserInput::Prompt
+    end
+  end
+
+  describe UserInput::Prompt do
+    let(:subject) do
+      UserInput::Prompt.new(
+        attempts: 2,
+        message: '_msg',
+        default: '_default'
+      )
+    end
+
+    describe '#new' do
+      it 'makes a new Prompt object' do
+        expect(subject).to be_an_instance_of UserInput::Prompt
+      end
+    end
+
+    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(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(subject.ask).to eql '_default'
+      end
+
+      context 'when provided a Regexp' do
+        it 'validates input' do
+          prompt = UserInput::Prompt.new(
+            message: '_msg',
+            validation: /[0-9]+/
+          )
+          allow(STDIN).to receive(:gets).and_return("_str\n", "29\n")
+          expect(prompt).to receive(:print).with('_msg? ').twice
+          expect(prompt.ask).to eql '29'
+        end
+      end
+      context 'when provided a code block' 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(prompt.ask).to eql 'correct'
+        end
+      end
+
+      it 'raises an error if max attempts is reached' do
+        prompt = UserInput::Prompt.new(attempts: 2) { |x| false }
+        allow(STDIN).to receive(:gets).and_return("_str\n", "_foo\n")
+        expect(prompt).to receive(:print).with('? ').twice
+        expect { prompt.ask }.to raise_error ArgumentError
+      end
+    end
+  end
+end

data/userinput.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'userinput'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime("%Y-%m-%d")
+
+  s.summary     = ''
+  s.description = ""
+  s.authors     = ['Les Aker']
+  s.email       = 'me@lesaker.org'
+  s.homepage    = 'https://github.com/akerl/userinput'
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split
+  s.test_files  = `git ls-files spec/*`.split
+
+  s.add_development_dependency 'rubocop', '~> 0.19.0'
+  s.add_development_dependency 'rake', '~> 10.2.1'
+  s.add_development_dependency 'coveralls', '~> 0.7.0'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'fuubar', '~> 1.3.2'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: userinput
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Les Aker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.2.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: ''
+email: me@lesaker.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/userinput.rb
+- spec/spec_helper.rb
+- spec/userinput_spec.rb
+- userinput.gemspec
+homepage: https://github.com/akerl/userinput
+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.0.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/userinput_spec.rb