input_reader 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Noack
+
+MIT License
+
+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,29 @@
+# InputReader
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'input_reader'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install input_reader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/input_reader.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/input_reader/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alessandro Berardi, Michael Noack"]
+  gem.email         = ["support@travellink.com.au"]
+  gem.description   = %q{Command line helpers to read input of various types, confirm, etc.}
+  gem.summary       = %q{Command line helpers to read input, etc.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "input_reader"
+  gem.require_paths = ["lib"]
+  gem.version       = InputReader::VERSION
+end

data/lib/input_reader.rb

@@ -0,0 +1,159 @@
+require "input_reader/version"
+
+module InputReader
+  require 'input_reader/input_reader'
+
+  class << self
+    def get_input(options = nil)
+      InputReader::Builder.new(options).get_input
+    end
+
+
+    def get_string(options = nil)
+      self.get_input_with_exception_handling(options)
+    end
+
+
+    def get_boolean(options = nil)
+      options ||= {}
+      true_values = %w{y t true 1}
+      false_values = %w{n f false 0}
+      all_values = true_values + false_values
+      options[:validators] = [{:message => "Invalid input given. Valid values are #{all_values.join(', ')}",
+          :validator => lambda { |input| all_values.include?(input.to_s.downcase) } }]
+      options[:prompt] ||= "(Y/N)?"
+      input = self.get_input(options)
+      true_values.include?(input.to_s.downcase)
+    end
+
+
+    def get_int(options = nil)
+      self.get_and_parse_input(:to_i, options)
+    end
+
+
+    def get_date(options = nil)
+      self.get_and_parse_input(:to_date, options)
+    end
+
+
+    def get_datetime(options = nil)
+      self.get_and_parse_input(:to_datetime, options)
+    end
+
+
+    def get_array(options = nil)
+      options ||= {}
+      array = []
+      input_options = options.merge(:allow_blank => true)
+      while input = self.get_input_with_exception_handling(input_options)
+        array << input
+      end
+      array
+    end
+
+
+    def get_array_of_ints(options = nil)
+      self.get_and_parse_array(:to_i, options)
+    end
+
+
+    def get_array_of_dates(options = nil)
+      self.get_and_parse_array(:to_date, options)
+    end
+
+
+    def get_array_of_datetimes(options = nil)
+      self.get_and_parse_array(:to_datetime, options)
+    end
+
+
+    def get_and_parse_array(parsers, options = nil)
+      options ||= {}
+      options[:parsers] = Array.wrap(options[:parsers]) + Array.wrap(parsers)
+      get_array(options)
+    end
+
+
+    def get_and_parse_input(parsers, options = nil)
+      options ||= {}
+      options[:parsers] = Array.wrap(options[:parsers]) + Array.wrap(parsers)
+      self.get_input_with_exception_handling(options)
+    end
+
+
+    def get_input_with_exception_handling(options = nil)
+      options ||= {}
+      valid_input = false
+      while !valid_input
+        begin
+          input = self.get_input(options)
+          valid_input = true
+        rescue Exception => e
+          raise e if e.is_a?(Interrupt)
+          puts e.message
+        end
+      end
+      input
+    end
+
+
+    def select_item(items, options = nil)
+      options ||= {}
+      prompt_choices(items, options[:selection_attribute])
+      input = get_int({
+        :valid_values => (1..items.size).to_a,
+        :allow_blank => options[:allow_blank],
+        :prompt => options[:prompt] || "Choice: "
+      })
+      input && items[input - 1]
+    end
+
+
+    def select_items(items, options = nil)
+      options ||= {}
+      prompt_choices(items, options[:selection_attribute])
+      puts "#{items.size + 1}. All"
+      input = get_input({
+        :parsers => [lambda { |input|
+            choices = input.strip.gsub(/\s*,\s*/, ",").split(',').map(&:to_i)
+            if choices.include?(items.size + 1)
+              choices = (1..items.size).to_a
+            end
+            choices
+          }],
+        :validators => [lambda { |input| input.all? { |i| i > 0 && i <= items.size} }],
+        :allow_blank => options[:allow_blank],
+        :prompt => options[:prompt] || "Choices (separate with comma): "
+      })
+      input && input.map { |c| items[c - 1] }
+    end
+
+
+    def confirmation_required(messages = '')
+      puts ""
+      puts "-" * 110
+      puts "[Messages]"
+      puts messages
+      puts "-" * 110
+      puts ""
+      print "Are you sure you want to do this? (Y/N): "
+      user_answer = STDIN.gets.chomp.upcase
+
+      if user_answer != 'Y' && user_answer != 'N'
+        puts "Please enter a valid response. Operation aborted. #{user_answer}"
+      else
+        if user_answer == 'Y'
+          puts
+          yield
+
+          puts "----------------------"
+          puts "Operation completed!!"
+          puts "----------------------"
+        else
+          puts "Operation aborted on user prompt"
+        end
+      end
+    end
+  end
+end

data/lib/input_reader/input_reader.rb

@@ -0,0 +1,140 @@
+module InputReader
+class Builder
+
+  attr_reader :input
+
+  def initialize(options = nil)
+    options ||= {}
+    @prompt = options[:prompt]
+    @allow_blank = options[:allow_blank]
+    @default_value = options[:default_value]
+    @valid_values = Array.wrap(options[:valid_values])
+    @validators = Array.wrap(options[:validators])
+    @pre_validators = Array.wrap(options[:pre_validators])
+    @post_validators = Array.wrap(options[:post_validators])
+    @parsers = Array.wrap(options[:parsers])
+  end
+
+
+  def get_input
+    begin
+      print "#{@prompt} "
+      flush
+    rescue Exception => e
+      puts e.message + e.class.inspect
+      exit
+    end while !valid_input?
+    @input
+  end
+
+
+  private
+
+
+  def read
+    $stdin.gets.chomp
+  end
+
+
+  def flush
+    $stdout.flush
+  end
+
+
+  def self.prompt_choices(items, selection_attribute = nil)
+    items.each.with_index do |item,i|
+      option = if selection_attribute.is_a?(String) || selection_attribute.is_a?(Symbol)
+        item.send(selection_attribute)
+      elsif selection_attribute.is_a?(Proc)
+        selection_attribute.call(item)
+      else
+        item
+      end
+      puts "#{i + 1}. #{option}"
+    end
+  end
+  
+  
+  def valid_input?
+    @input = read
+    @input = @default_value if @input.blank?
+    pre_validate(@input) && (@input.blank? || post_validate(@input = parse(@input)))
+  end
+
+
+  def pre_validate(input)
+    pre_validators = [
+      {
+        :validator => lambda { |input| @allow_blank || !input.blank? },
+        :message => "No input given"
+      },
+    ] + @pre_validators
+    validate(input, pre_validators)
+  end
+
+
+  def post_validate(input)
+    post_validators = [
+      {
+        :validator => lambda { |input| @valid_values.blank? || @valid_values.include?(input) },
+        :message => "Invalid input given. Valid values are #{@valid_values.join(', ')}"
+      }
+    ] + @post_validators + @validators
+    validate(input, post_validators)
+  end
+
+
+  def validate(input,validators)
+
+    validators.each do |validator|
+
+      validator_proc = if validator.is_a?(Proc)
+        validator
+      elsif validator.is_a?(Hash)
+        validator[:validator]
+      end
+
+      error_message = if validator.is_a?(Hash) && validator[:message]
+        validator[:message]
+      else
+        "Invalid input"
+      end
+
+      valid = if validator_proc.is_a?(Proc)
+        validator_proc.call(input)
+      elsif validator_proc.is_a?(String) || validator_proc.is_a?(Symbol)
+        input.send(validator_proc)
+      elsif validator_proc.blank?
+        true
+      else
+        false
+      end
+
+      if !valid
+        puts error_message
+        return false
+      end
+
+    end
+
+    true
+
+  end
+
+
+  def parse(input)
+
+    @parsers.each do |parser|
+      if parser.is_a?(Proc)
+        input = parser.call(input)
+      elsif parser.is_a?(String) || parser.is_a?(Symbol)
+        input = input.send(parser)
+      end
+    end
+
+    input
+
+  end
+
+end
+end

data/lib/input_reader/version.rb

@@ -0,0 +1,3 @@
+module InputReader
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: input_reader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alessandro Berardi, Michael Noack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Command line helpers to read input of various types, confirm, etc.
+email:
+- support@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- input_reader.gemspec
+- lib/input_reader.rb
+- lib/input_reader/input_reader.rb
+- lib/input_reader/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Command line helpers to read input, etc.
+test_files: []