qanda 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6b1fdeb78b7c55eafd6212ffa7ce2ac939b88e5
+  data.tar.gz: cac1aa19f4c1ca1fd44066b78a3c06086d9f3874
+SHA512:
+  metadata.gz: 9b5ba4e407117a11cc2a4a61786e9eb47618c0d251c5504d258dfd9eb098b2e25777b3907263b3475982eec60e05d0a9de19df28e00c1ffcadd5ee2cba42c03b
+  data.tar.gz: da1d64ccfafd5e3985a73f7625fe12f560b48462e3a44d427ac6f7ed694814ac1a0f70d6352e2da0127150205872b1a4f4b5766b3deb58811e79bec59830253d

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+test_scripts

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    qanda (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  qanda!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Wesley Boynton
+
+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,8 @@
+# QandA
+
+QandA is a cute little gem for quickly gathering answers to questions that require user-submitted data. Useful for setup and install scripts, command line shells, and other fun stuff.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/qanda.rb

@@ -0,0 +1,9 @@
+require 'qanda/version'
+
+require 'question/question'
+require 'question/text'
+require 'question/multiple_choice'
+require 'question/boolean'
+
+require 'questionnaire'
+require 'qanda_exceptions'

data/lib/qanda/version.rb

@@ -0,0 +1,3 @@
+module Qanda
+  VERSION = "0.2.0"
+end

data/lib/qanda_exceptions.rb

@@ -0,0 +1,13 @@
+module QandA
+  class Error < StandardError
+    def initialize(msg)
+      @msg = msg
+    end
+  end
+
+  class InvalidQuestionError
+    def message
+      puts @msg
+    end
+  end
+end

data/lib/question/boolean.rb

@@ -0,0 +1,24 @@
+module QandA
+  module Question
+    class Boolean < Question
+      TRUES  = ['yes', 'y', 'true', 't']
+      FALSES = ['no', 'n', 'false', 'f']
+
+      def initialize(message = '', default = nil)
+        message = "#{message} (y/n)"
+        super(message: message, default: default)
+        @validation = Proc.new do |answer|
+          answer = answer.downcase.strip
+          TRUES.include?(answer) || FALSES.include?(answer)
+        end
+      end
+
+      def ask
+        super
+        @answer = answer.downcase.strip
+        @answer = true if TRUES.include?(@answer)
+        @answer = false if FALSES.include?(@answer)
+      end
+    end
+  end
+end

data/lib/question/multiple_choice.rb

@@ -0,0 +1,70 @@
+module QandA
+  module Question
+    class MultipleChoice < Question
+      NOT_ENOUGH_OPTIONS_ERR = 'A multiple-choice question must have an array with at least two elements.'
+      DEFAULT_IS_INTEGER_ERR = 'A multiple-choice default must be a valid index for its array of choices.'
+      MINIMUM_NO_ZERO_ERR    = 'A multiple-choice minimum cannot be zero, negative, or greater than the choice count.'
+      MAXIMUM_NO_ZERO_ERR    = 'A multiple-choice maximum cannot be zero, negative, or greater than/equal to the choice count.'
+      MIN_GREATER_THAN_MAX   = 'A multiple-choice minimum cannot be greater than the maximum.'
+
+      def initialize(choices, message = '', default = nil, minimum = 1, maximum = nil)
+        @maximum = maximum.nil? ? minimum : maximum
+        @minimum = minimum
+        @choices    = choices
+        raise InvalidQuestionError.new(NOT_ENOUGH_OPTIONS_ERR) unless choices.is_a?(Array) && choices.size > 1
+        raise InvalidQuestionError.new(DEFAULT_IS_INTEGER_ERR) unless default.nil? || answer_string_is_valid?(default)
+        raise InvalidQuestionError.new(@MAXIMUM_NO_ZERO_ERR) unless @minimum > 0 && @maximum <= choices.size
+        raise InvalidQuestionError.new(@MINIMUM_NO_ZERO_ERR) unless @maximum > 0 && @minimum <= choices.size - 1
+        raise InvalidQuestionError.new(MIN_GREATER_THAN_MAX) unless @maximum >= @minimum
+        super(message: message, default: default)
+        @validation = Proc.new { |answer| answer_string_is_valid?(answer) }
+      end
+
+      def answer_string_is_valid?(answer)
+        answer = answer.to_s.split(',').map { |i| i.strip }
+        valid  = true
+        valid  = false if answer.length > @maximum
+        valid  = false if answer.length < @minimum
+        if valid
+          answer.each do |answer|
+            unless answer.to_i.to_s == answer && @choices.size > answer.to_i - 1
+              valid = false
+              break
+            end
+          end
+        end
+        valid
+      end
+
+      def prompt
+        puts "\n"
+        if @maximum == 1
+          puts "Select only one answer:"
+        elsif @maximum == @minimum
+          puts "Select exactly #{@maximum} answers, separated by commas:"
+        else
+          puts "Select between #{@minimum} and #{@maximum} answers, separated by commas:"
+        end
+      end
+
+      def ask
+        super do
+          prompt
+          @choices.each_with_index do |c, i|
+            puts "[#{i+1}] #{c}"
+          end
+        end
+        @answer = [*@answer.to_s.split(',').map { |i| i.strip.to_i - 1 }]
+      end
+
+      def answer
+        arr = []
+        @answer.each do |i|
+          arr << @choices[i].to_s
+        end
+        arr
+      end
+
+    end
+  end
+end

data/lib/question/question.rb

@@ -0,0 +1,31 @@
+module QandA
+  module Question
+    class Question
+      def initialize(message: '', default: nil, &validation)
+        @msg        = message
+        @default    = default
+        @validation ||= validation ? validation : nil
+        @answer     = nil
+      end
+
+      def ask(&block)
+        yield if block_given?
+        str = "#{@msg}"
+        str << " [#{@default}]" if @default
+        str << ': '
+        while @answer == nil do
+          print str
+          a       = $stdin.gets.chomp
+          a       = @default if @default && a.empty?
+          @answer = a unless @validation
+          @answer = a if @validation && instance_exec(a, &@validation)
+          puts "Invalid answer, try again" unless @answer
+        end
+      end
+
+      def answer
+        @answer
+      end
+    end
+  end
+end

data/lib/question/text.rb

@@ -0,0 +1,13 @@
+module QandA
+  module Question
+    class Text < Question
+      def initialize(message = '', text = '', default = nil)
+        super(message: message, default: default)
+      end
+
+      def answer
+        @answer.to_s
+      end
+    end
+  end
+end

data/lib/questionnaire.rb

@@ -0,0 +1,33 @@
+module QandA
+  class Questionnaire
+    TYPE_REGISTER = {
+        text:            QandA::Question::Text,
+        multiple_choice: QandA::Question::MultipleChoice,
+        boolean:         QandA::Question::Boolean,
+
+    }
+
+    def initialize
+      @questions = {}
+    end
+
+    def add_question(key, type, *args)
+      type = type.to_sym
+      unless TYPE_REGISTER.has_key?(type)
+        raise NoSuchQuestionTypeError.new("No such question type '#{type}'")
+      end
+      @questions[key.to_sym] = TYPE_REGISTER[type].new(*args)
+    end
+
+    def run
+      @questions.each do |key, q|
+        q.ask
+      end
+    end
+
+    def answers
+      Hash[@questions.map { |key, q| [key, q.answer] }]
+    end
+
+  end
+end

data/qanda.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qanda/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qanda"
+  spec.version       = Qanda::VERSION
+  spec.authors       = ["Wesley Boynton"]
+  spec.email         = ["wes@boynton.io"]
+
+  spec.summary       = %q{A cute little library for quickly gathering answers to questions requiring user input.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: qanda
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Wesley Boynton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- wes@boynton.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/qanda.rb
+- lib/qanda/version.rb
+- lib/qanda_exceptions.rb
+- lib/question/boolean.rb
+- lib/question/multiple_choice.rb
+- lib/question/question.rb
+- lib/question/text.rb
+- lib/questionnaire.rb
+- qanda.gemspec
+homepage: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A cute little library for quickly gathering answers to questions requiring
+  user input.
+test_files: []