userinput 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa7fa580b2919ec587477758892ba2dcd9f0edee
-  data.tar.gz: 05400265239b2bd76e85f59b5ebf34700df15fcb
+  metadata.gz: fecaf095e207d7b834db8f0de396d80af8d87ff6
+  data.tar.gz: 9d4c5839e4836859e16ce401c913e408f70caa0d
 SHA512:
-  metadata.gz: 47f23a9a9d8d4c28cdb752f9d2ad854310ed2212a4e9a1792038f13b271192bbb2f31faaf81f459b5dedb1a850ef37785247f849fa930cff26c2429c05c57634
-  data.tar.gz: a8db81aebdeac9512fb7f4326bfeb3345c28c75ed0e6168175e654bfbfad0058b51a42b0b514d9eb0d5b3f4d1ef2d80aaf276d78adf0509b47550c94ca6286b8
+  metadata.gz: e0beb2540cbf3a317db9ebb5f4f292a7e8e39316acc20862cafed1349143bc97e1c22a2432a22dd048875613c3a82ea9fbf657d6fd34b790a246022bd3e0fd40
+  data.tar.gz: 1e27c605e1890342f2f795bc1674020e2d371757497db1b70243878cf356570ab43a9b4684d837de98dadbd12f92c4535596223bd9642e5231370df2fa19ea31

data/.circle-ruby

@@ -0,0 +1,4 @@
+2.4.0
+2.3.3
+2.2.6
+2.1.10

data/.rubocop.yml

@@ -1,2 +1,7 @@
 Encoding:
     Enabled: false
+Metrics/BlockLength:
+    Exclude:
+    - spec/**/*
+Style/FormatString:
+    EnforcedStyle: percent

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.3 / 2016-04-10
+
+* [ENHANCEMENT] Clean up module layout
+* [FEATURE] Add Boolean helper for yes/no questions
+
+# 1.0.2 / 2016-04-08
+
+* [FEATURE] Add support for Enumerables in :validation parameter
+* [ENHANCEMENT] Refactor validation support to be more extensible
+
 # 1.0.1 / 2016-02-13
 
 * [FEATURE] Support setting custom IO object as file descriptor for output

data/README.md

@@ -3,7 +3,7 @@ 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)
-[![Build Status](https://img.shields.io/circleci/project/akerl/userinput.svg)](https://circleci.com/gh/akerl/userinput)
+[![Build Status](https://img.shields.io/circleci/project/akerl/userinput/master.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)
@@ -39,7 +39,7 @@ You can optionally provide a default:
 => "_other"
 ```
 
-If you provide a validation Regexp or a code block, the input will be validated using that:
+If you provide a validation Regexp, Enumerable, or a code block, the input will be validated using that:
 
 ```
 > require 'userinput'
@@ -97,6 +97,19 @@ Password?
 => "_password"
 ```
 
+### Boolean helper
+
+UserInput::Boolean is a subclass of Prompt that is designed for asking yes/no questions.
+
+It valiates that answers match /(y|yes|n|no)/i, and returns the response as a boolean true/false rather than a string.
+
+To use it:
+
+```
+a = UserInput::Boolean.new(message: 'Do you like cats')
+response = a.ask
+```
+
 ## Installation
 
     gem install userinput

data/circle.yml

@@ -1,12 +1,7 @@
 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'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i gem update --system --no-doc || exit 1 ; done'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
 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'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'

data/lib/userinput.rb

@@ -1,6 +1,13 @@
 ##
 # User input library
 module UserInput
+  # Hash of validation strategies
+  VALIDATIONS = {
+    Proc => :call,
+    Regexp => :match,
+    Enumerable => :include?
+  }.freeze
+
   class << self
     ##
     # Insert a helper .new() method for creating a new Prompt object
@@ -9,89 +16,7 @@ module UserInput
       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
-      @fd = params[:fd] || STDOUT
-      @validation = block || params[:validation]
-    end
-
-    ##
-    # Request user input
-    def ask
-      @fd.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
-
-    private
-
-    ##
-    # 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
-        raise "Supported validation type not provided #{@validation.class}"
-      end
-    end
-
-    ##
-    # Parse user input
-    def _ask
-      input = STDIN.gets.chomp
-      input = @default if input.empty? && @default
-      @fd.puts if @secret
-      input
-    end
-
-    ##
-    # Track attempt counter
-    def check_counter
-      return if @attempts.nil?
-      @attempts -= 1
-      raise ArgumentError, 'No valid input provided' if @attempts == 0
-    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
+
+require 'userinput/prompt'
+require 'userinput/boolean'

data/lib/userinput/boolean.rb

@@ -0,0 +1,15 @@
+module UserInput
+  ##
+  # Helper class for asking yes/no questions
+  class Boolean < Prompt
+    def initialize(params = {})
+      super
+      @validation = /(y|yes|n|no)/i
+      @separator = ' [y/n]?' if @separator == '?'
+    end
+
+    def ask
+      super =~ /y/i ? true : false
+    end
+  end
+end

data/lib/userinput/prompt.rb

@@ -0,0 +1,91 @@
+module UserInput
+  MESSAGE_TEMPLATE = '%{message}%{separator} %{default}'.freeze
+
+  ##
+  # Prompt object
+  class Prompt
+    ##
+    # Build new prompt object and set defaults
+    def initialize(params = {}, &block)
+      @attempts = params[:attempts]
+      @message = params[:message] || ''
+      @separator = params[:separator] || '?'
+      @default = params[:default]
+      @secret = params[:secret] || false
+      @fd = params[:fd] || STDOUT
+      @validation = block || params[:validation]
+    end
+
+    ##
+    # Request user input
+    def ask
+      @fd.print full_message
+      disable_echo if @secret
+
+      input = _ask
+      return input if valid(input)
+
+      check_counter
+      ask
+    ensure
+      enable_echo if @secret
+    end
+
+    private
+
+    def full_message
+      MESSAGE_TEMPLATE % {
+        message: @message,
+        separator: @separator,
+        default: @default.nil? ? '' : "[#{@default}] "
+      }
+    end
+
+    ##
+    # Validate user input
+    def valid(input)
+      return true unless @validation
+      _, method = VALIDATIONS.find { |klass, _| @validation.is_a? klass }
+      return @validation.send(method, input) if method
+      raise "Supported validation type not provided #{@validation.class}"
+    end
+
+    ##
+    # Parse user input
+    def _ask
+      input = STDIN.gets.chomp
+      input = @default if input.empty? && @default
+      @fd.puts if @secret
+      input
+    end
+
+    ##
+    # Track attempt counter
+    def check_counter
+      return if @attempts.nil?
+      @attempts -= 1
+      raise ArgumentError, 'No valid input provided' if @attempts.zero?
+    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/userinput/prompt_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe UserInput do
+  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(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(STDOUT).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(STDOUT).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(STDOUT).to receive(:print).with('? ').twice
+          expect(prompt.ask).to eql 'correct'
+        end
+      end
+      context 'when provided an Enumerable' do
+        it 'validates input' do
+          prompt = UserInput::Prompt.new(
+            message: '_msg',
+            validation: %w(a b c)
+          )
+          allow(STDIN).to receive(:gets).and_return("_str\n", "a\n")
+          expect(STDOUT).to receive(:print).with('_msg? ').twice
+          expect(prompt.ask).to eql 'a'
+        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(STDOUT).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) { false }
+        allow(STDIN).to receive(:gets).and_return("_str\n", "_foo\n")
+        expect(STDOUT).to receive(:print).with('? ').twice
+        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(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
+end

data/spec/userinput_spec.rb

@@ -6,84 +6,4 @@ describe UserInput 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(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(STDOUT).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(STDOUT).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(STDOUT).to receive(:print).with('? ').twice
-          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(STDOUT).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) { false }
-        allow(STDIN).to receive(:gets).and_return("_str\n", "_foo\n")
-        expect(STDOUT).to receive(:print).with('? ').twice
-        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(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
 end

data/userinput.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'userinput'
-  s.version     = '1.0.1'
+  s.version     = '1.0.2'
   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.37.0'
-  s.add_development_dependency 'rake', '~> 10.5.0'
+  s.add_development_dependency 'rubocop', '~> 0.47.0'
+  s.add_development_dependency 'rake', '~> 12.0.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'
+  s.add_development_dependency 'rspec', '~> 3.5.0'
+  s.add_development_dependency 'fuubar', '~> 2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: userinput
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.47.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 12.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.5.0
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -58,34 +58,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
 description: Provides a prompt object for requesting user input
 email: me@lesaker.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circle-ruby"
 - ".gitignore"
 - ".prospectus"
 - ".rspec"
@@ -97,7 +98,10 @@ files:
 - Rakefile
 - circle.yml
 - lib/userinput.rb
+- lib/userinput/boolean.rb
+- lib/userinput/prompt.rb
 - spec/spec_helper.rb
+- spec/userinput/prompt_spec.rb
 - spec/userinput_spec.rb
 - userinput.gemspec
 homepage: https://github.com/akerl/userinput
@@ -120,10 +124,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple user input library
 test_files:
 - spec/spec_helper.rb
+- spec/userinput/prompt_spec.rb
 - spec/userinput_spec.rb