questions 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41e385aa0a2fa87149846bfa99223235a5910887
+  data.tar.gz: 5aa6e4a359aad4dc0bfa7232b79daabc4a746934
+SHA512:
+  metadata.gz: c1056f0f6f023509511d95659796f301be00924d129e2c2a38cdffed01df1899b2adf275367c1e662c5dfc959bd2c874a323fce5ce66a2dae997ee013b145d08
+  data.tar.gz: c74a6eca07e5d9a80327b2df544bae4bd9adfe042479a37eb9e1d109266d1b781a2d10022842d990a69866a7e6674bd2db36a9be8f96b2d11cbc3eea60ddddfa

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/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 DSIW
+
+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,62 @@
+# Question
+
+Ask human a question. She or he has to select one answer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'questions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install questions
+
+## Usage
+
+### Preamble
+``` ruby
+require "questions"
+include Questions
+```
+
+### Long way
+``` ruby
+q = Question.new("File does exist, what should be done?")
+q.answers = [:skip, :overwrite, :abort]
+answer = q.ask
+# SHELL:
+# $ File does exist, what should be done? [s]kip, [o]verwrite, [a]bort
+# s<enter>
+answer #=> :skip
+```
+
+### Short way
+``` ruby
+answer = Question.ask "File does exist, what should be done?", [:skip, :overwrite, :abort]
+# SHELL:
+# $ File does exist, what should be done? [s]kip, [o]verwrite, [a]bort
+# s<enter>
+answer #=> :skip
+```
+
+### Hashish way
+``` ruby
+answer = Question.ask "File does exist, what should be done?", skip: true, overwrite: false, abort: true
+# SHELL:
+# $ File does exist, what should be done? [s]kip, [a]bort
+# s<enter>
+answer #=> :skip
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require "bundler/gem_tasks"
+
+require 'rake/clean'
+require 'rake/version_task'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
+end
+
+Rake::VersionTask.new
+
+task :doc => [ 'doc:clean', 'doc:api' ]
+
+CLOBBER << "doc"
+CLEAN << "doc"
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new(:api) do |t|
+    t.files = ['lib/**/*.rb']
+    t.options = [
+      '--output-dir', 'doc/api',
+      '--markup', 'markdown'
+    ]
+  end
+
+  desc 'Remove YARD Documentation'
+  task :clean do
+    system("rm -rf #{File.dirname(__FILE__)}/doc/api")
+  end
+end
+
+task :default => [:spec]

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/questions/answer.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+
+module Questions
+  class Answer
+    SPECIAL_ENDINGS = [:all]
+
+    # Instantiates new Answer object.
+    #
+    # Only the first key value pair will be used.
+    #
+    # @param [Hash] answer_hash Key (instruction); value (activeness) is `true` or `false`.
+    #
+    # @example Hash with one item
+    #   Answer.new({:overwrite => true}) #=> [o]verwrite
+    #   Answer.new(:overwrite => true) #=> [o]verwrite
+    #   Answer.new(:overwrite) #=> [o]verwrite
+    #   Answer.new({:overwrite => false}) #=> ""
+    #   Answer.new(:overwrite => false) #=> ""
+    #   Answer.new({:overwrite => nil}) #=> ""
+    #
+    # @example Items of hash with more than one item will be ignored
+    #   Answer.new({:overwrite => true, :overwrite_all => false}) #=> [o]verwrite
+    #   Answer.new({:overwrite => true, :overwrite_all => true}) #=> [o]verwrite
+    def initialize(*answer_hash)
+      hash = answer_hash.first
+      hash = {hash => true} if hash.is_a? Symbol
+
+      unless [Hash, Symbol].any? { |class_name| hash.is_a? class_name }
+        raise ArgumentError, "Parameter has to be a key-value-pair or a symbol"
+      end
+
+      array        = hash.first
+      @instruction = array[0]
+      @active      = array[1]
+    end
+
+    # Gets instruction
+    #
+    # @example Hash with one item
+    #   Answer.new(overwrite: true).instruction #=> :overwrite
+    #   Answer.new(overwrite: false).instruction #=> :overwrite
+    attr_reader :instruction
+
+    # Is answer active?
+    #
+    # @example Hash with one item
+    #   Answer.new(overwrite: true).active? #=> true
+    #   Answer.new(overwrite: false).active? #=> false
+    #
+    # @see {true?}
+    def active?
+      @active
+    end
+    alias :true? :active?
+
+    # Is answer inactive?
+    #
+    # @example Hash with one item
+    #   Answer.new(overwrite: true).inactive? #=> false
+    #   Answer.new(overwrite: false).inactive? #=> true
+    #
+    # @see {false?}
+    def inactive?
+      !active?
+    end
+    alias :false? :inactive?
+
+    # Sets indicator
+    #
+    # @example Hash with one item
+    #   answer = Answer.new(overwrite: true)
+    #   answer.indicator = :ov
+    #   answer.indicator #=> :ov
+    attr_writer :indicator
+
+    # Gets indicator
+    #
+    # @example with true answer
+    #   a = Answer.new(overwrite: true)
+    #   a.indicator #=> :o
+    #   a.indicator(2) #=> :ov
+    #
+    # @example with special true answer
+    #   Answer.new(overwrite_all: true).indicator(2) #=> :OV
+    #
+    # @example with inactive answer
+    #   Answer.new(overwrite: false).indicator #=> nil
+    #
+    # @example set indicator
+    #   a = Answer.new(overwrite: true)
+    #   a.indicator #=> :o
+    #   a.indicator = :ov
+    #   a.indicator #=> :ov
+    def indicator(first_chars=1)
+      return nil if inactive?
+      return @indicator if @indicator
+      indicator = instruction.to_s[0...first_chars]
+      indicator.upcase! if special?
+      indicator.to_sym
+    end
+
+    # Returns `true` if answer is special. Special answers are answers which ends with one of the {SPECIAL_ENDINGS}, `false` otherwise.
+    def special?
+      SPECIAL_ENDINGS.any? { |ending| instruction.to_s =~ /#{ending}$/ }
+    end
+
+    # Gets indicator hash
+    #
+    # @example Hash with one item
+    #   Answer.new(overwrite: true).indicator_hash #=> {:o => :overwrite}
+    #   Answer.new(overwrite: false).indicator_hash #=> nil
+    def indicator_hash
+      return nil if inactive?
+      {indicator => instruction}
+    end
+
+    # Gets string representation
+    #
+    # @example Hash with one item
+    #   Answer.new(overwrite: true).to_s #=> "[o]verwrite"
+    #   Answer.new(overwrite: false).to_s #=> ""
+    def to_s
+      return nil if inactive?
+      instruction_without_indicator = instruction.to_s[indicator.length..-1]
+      humanized = instruction_without_indicator.gsub("_", " ")
+      "[#{indicator}]#{humanized}"
+    end
+  end
+end

data/lib/questions/answers.rb

@@ -0,0 +1,196 @@
+# encoding: utf-8
+
+module Questions
+  class Answers < Array
+    # Instantiates a new Answers object.
+    #
+    # @param args [Answer, Symbol, Array, Hash] Initial answers
+    #
+    # Each parameter will be send to {#<<}.
+    #
+    # @example parameter as Answer
+    #   answers = Answers.new Answer.new(:abort)
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #
+    # @example parameter as Symbol
+    #   answers = Answers.new :abort
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #
+    # @example parameter as Array
+    #   answers = Answers.new [:abort, Answer.new(:overwrite)]
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #   answers.last.instruction #=> :overwrite
+    #   answers.last.active #=> true
+    #
+    # @example parameter as Hash
+    #   answers = Answers.new({abort: true, overwrite: false, "non-symbol" => "ignored"})
+    #   answers.size #=> 2
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #   answers.last.instruction #=> :overwrite
+    #   answers.last.active #=> false
+    def initialize(*args)
+      args.each { |arg| self << arg }
+    end
+
+    # Adds answer. Answer can be an instance of {Answer}, {Symbol}, a {Hash} or an {Array}. Chaining is
+    # supported.
+    #
+    # @example parameter as Answer
+    #   answers = Answers.new
+    #   answers << Answer.new(:abort)
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #
+    # @example parameter as Symbol
+    #   answers = Answers.new
+    #   answers << :abort << :overwrite
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #   answers.last.instruction #=> :overwrite
+    #   answers.last.active #=> true
+    #
+    # @example parameter as Array
+    #   answers = Answers.new
+    #   answers << [:abort, Answer.new(:overwrite)]
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #   answers.last.instruction #=> :overwrite
+    #   answers.last.active #=> true
+    #
+    # @example parameter as Hash
+    #   answers = Answers.new
+    #   answers << {abort: true, overwrite: false, "non-symbol" => "ignored"}
+    #   answers.size #=> 2
+    #   answers.first.instruction #=> :abort
+    #   answers.first.active #=> true
+    #   answers.last.instruction #=> :overwrite
+    #   answers.last.active #=> false
+    #
+    # @return [Answers] self
+    def <<(arg)
+      case arg
+      when Answer then super arg
+      when Symbol then super Answer.new(arg)
+      when Array
+        arg.each { |arg| self << arg } # call as Answer or Symbol
+      when Hash
+        self << convert_hash_to_answers(select_symbols(arg)) # call as Array
+      end
+      self
+    end
+
+    # Gets answer by indicator.
+    #
+    # @example
+    #   answers = Answers.new [:abort, :overwrite]
+    #   answers[:a].instruction #=> :abort
+    #   answers[:o].instruction #=> :overwrite
+    #
+    # @return [Answer]
+    def [](indicator)
+      update_indicators_for_uniqueness!
+      select { |answer| answer.indicator == indicator }.first
+    end
+
+    # Updates indicators to get all unique.
+    #
+    # @example
+    #   answers = Answers.new [:abort, :abort_all, :abc]
+    #   answers.indicators #=> [:a, :A, :a]
+    #   answers.has_unique_indicators? #=> false
+    #   answers.update_indicators_for_uniqueness!
+    #   answers.indicators #=> [:a, :A, :ab]
+    #   answers.has_unique_indicators? #=> true
+    def update_indicators_for_uniqueness!
+      return if has_unique_indicators?
+
+      each_with_index do |answer, i|
+        other_indicators = first(i).map(&:indicator)
+        answer.indicator = free_indicator_of(answer, used_indicators: other_indicators)
+      end
+    end
+
+    # Gets all indicators of answers.
+    #
+    # @example
+    #   answers = Answers.new [:abort, :abort_all, :abc]
+    #   answers.indicators #=> [:a, :A, :a]
+    #   answers.update_indicators_for_uniqueness!
+    #   answers.indicators #=> [:a, :A, :ab]
+    def indicators
+      map(&:indicator)
+    end
+
+    # Returns true if indicators are unique, false otherwise.
+    #
+    # @example
+    #   answers = Answers.new [:abort, :abort_all, :abc]
+    #   answers.indicators #=> [:a, :A, :a]
+    #   answers.has_unique_indicators? #=> false
+    #   answers.update_indicators_for_uniqueness!
+    #   answers.indicators #=> [:a, :A, :ab]
+    #   answers.has_unique_indicators? #=> true
+    def has_unique_indicators?
+      indicators == indicators.uniq
+    end
+
+    # Returns all answers as choice string.
+    #
+    # @example with only true answers
+    #   answers = Answers.new [:abort, :abort_all, :abc]
+    #   answers.choice_string #=> "[a]bort, [A]bort all, [ab]c"
+    #
+    # @example with false answer
+    #   answers = Answers.new {abort: true, abort_all: false, abc: true}
+    #   answers.choice_string #=> "[a]bort, [ab]c"
+    def to_s
+      update_indicators_for_uniqueness!
+      map(&:to_s).compact.join(", ")
+    end
+
+    private
+
+    # {"abc" => true, abort: true, overwrite: false} => {abort: true}
+    def select_symbols(args)
+      args.select { |inst, value| inst.is_a?(Symbol) }
+    end
+
+    # {abort: true} => [Answer.new(:abort => true)]
+    def convert_hash_to_answers(answers)
+      answers.reduce([]) { |array, (inst, value)| array << Answer.new({inst => value}) }
+    end
+
+    # :symbol => Answer.new(:symbol)
+    # Answer.new(:symbol) => Answer.new(:symbol)
+    # "string" => raise ArgumentError
+    def convert_symbol_to_answer_or_send_through(arg)
+      case arg
+      when Answer then arg
+      when Symbol then Answer.new(arg)
+      else
+        raise ArgumentError
+      end
+    end
+
+    # Gets first free indicator for `answer` which isn't used by `used_indicators`.
+    def free_indicator_of answer, opts={}
+      opts = {:used_indicators => []}.merge(opts)
+      used_indicators = opts[:used_indicators]
+
+      i = 1
+      loop do
+        indicator = answer.indicator(i)
+        if used_indicators.include? indicator
+          i+=1
+          redo # next try
+        else
+          return indicator
+        end
+      end
+    end
+  end
+end

data/lib/questions/question.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module Questions
+  # You can ask a question with answers for selection. User can select one answer.
+  #
+  # @example Long way
+  #   q = Question.new("File does exist, what should be done?")
+  #   q.answers = [:skip, :overwrite, :abort]
+  #   answer = q.ask
+  #   # SHELL:
+  #   # $ File does exist, what should be done? [s]kip, [o]verwrite, [a]bort
+  #   # s<enter>
+  #   answer #=> :skip
+  #
+  # @example Short way
+  #   answer = Question.ask "File does exist, what should be done?", [:skip, :overwrite, :abort]
+  #   # SHELL:
+  #   # $ File does exist, what should be done? [s]kip, [o]verwrite, [a]bort
+  #   # s<enter>
+  #   answer #=> :skip
+  #
+  # It's also possible to specify answers as an Hash:
+  #
+  # @example Hashish way
+  #   answer = Question.ask "File does exist, what should be done?", skip: true, overwrite: false, abort: true
+  #   # SHELL:
+  #   # $ File does exist, what should be done? [s]kip, [a]bort
+  #   # s<enter>
+  #   answer #=> :skip
+  class Question
+    attr_reader :question
+    attr_reader :answers
+
+    # Instantiates a new Question object.
+    #
+    # @param question [String] This message will be printed
+    def initialize(question)
+      @question = question
+      @answers = Answers.new
+    end
+
+    # Sets answers
+    #
+    # @example
+    #   q = Question.new("File does exist, what should be done?")
+    #   q.answers = [:yes, :no]
+    #   q.answers.size #=> 2
+    #   q.answers.map(&:instruction) #=> [:yes, :no]
+    #
+    def answers=(*args)
+      @answers.clear
+      args.each { |arg| @answers << arg }
+    end
+
+    # Asks question to user. If user typed wrong indicator, then it will be asked again.
+    #
+    # @example without answers
+    #   q = Question.new("What?")
+    #   q.ask #=> raise Error
+    #
+    # @example with answers
+    #   q = Question.new("What?")
+    #   q.answers = [:yes, :no]
+    #   q.ask #=> :yes if user typed 'y'
+    #
+    # @return [Symbol] selected answer
+    def ask
+      raise "You have to set answers" if answers.empty?
+      answer = gets "#{@question} #{answers}"
+      answers[answer.to_sym].instruction || ask
+    end
+
+    # Asks question.
+    #
+    # @param question [String] Message that will be printed
+    # @param answers [Array, Hash] Answers that are displayed for selection
+    #
+    # @example
+    #   Question.ask("What are you doing?", [:nothing, :cleaning_up])
+    #   # SHELL:
+    #   # $ What are you doing? [n]othing, [c]leaning up
+    #   # n<enter>
+    #   # => :nothing
+    #
+    # @example Question with answers as hash.
+    #   ask("Do you have a problem?", :yes => true, :no => true)
+    #
+    # @return [Symbol] selected answer
+    def self.ask(question, answers)
+      question = Question.new(question)
+      question.answers = answers
+      question.ask
+    end
+
+    private
+
+    # Prints `msg` and reads user input
+    def gets msg
+      STDOUT.print("#{msg} ")
+      STDOUT.flush
+      STDIN.gets.chomp
+    end
+  end
+end

data/lib/questions/version.rb

@@ -0,0 +1,3 @@
+module Questions
+  VERSION = File.read(File.absolute_path("../../../VERSION", __FILE__))
+end

data/lib/questions.rb

@@ -0,0 +1,4 @@
+require "questions/version"
+require "questions/answer"
+require "questions/answers"
+require "questions/question"

data/questions.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'questions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "questions"
+  spec.version       = Questions::VERSION
+  spec.authors       = ["DSIW"]
+  spec.email         = ["dsiw@dsiw-it.de"]
+  spec.description   = %q{Ask human}
+  spec.summary       = %q{Ask human}
+  spec.homepage      = "https://github.com/DSIW/questions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "version"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "pry"
+end

data/spec/questions/answer_spec.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe :Answer do
+  shared_examples_for 'a true answer' do
+    its(:active?) { should be_true }
+    its(:inactive?) { should be_false }
+    its(:true?) { should be_true }
+    its(:false?) { should be_false }
+    its(:indicator) { should_not be_nil }
+    its(:instruction) { should_not == "" }
+  end
+
+  shared_examples_for 'a true normal answer' do
+    it_should_behave_like 'a true answer'
+    its(:instruction) { should == :overwrite }
+    its(:indicator_hash) { should == {:o => :overwrite} }
+    its(:to_s) { should == "[o]verwrite" }
+    its(:special?) { should be_false }
+
+    its(:indicator) { should == :o }
+    describe "indicator" do
+      it "#indicator(2) == :ov" do
+        subject.indicator(2) == :ov
+      end
+      it "#indicator(3) == :ove" do
+        subject.indicator(3) == :ove
+      end
+    end
+  end
+
+  shared_examples_for 'a true special answer' do
+    it_should_behave_like 'a true answer'
+    its(:instruction) { should == :overwrite_all }
+    its(:indicator_hash) { should == {:O => :overwrite_all} }
+    its(:to_s) { should == "[O]verwrite all" }
+    its(:special?) { should be_true }
+
+    its(:indicator) { should == :O }
+    describe "indicator" do
+      it "#indicator(2) == :OV" do
+        subject.indicator(2) == :OV
+      end
+      it "#indicator(3) == :OVE" do
+        subject.indicator(3) == :OVE
+      end
+    end
+  end
+
+  shared_examples_for 'a false answer' do
+    its(:active?) { should be_false }
+    its(:inactive?) { should be_true }
+    its(:true?) { should be_false }
+    its(:false?) { should be_true }
+    its(:indicator) { should be_nil }
+    its(:instruction) { should == :overwrite }
+    its(:indicator_hash) { should be_nil }
+    its(:to_s) { should == nil }
+  end
+
+  describe "#initialize" do
+    # true normal
+    context "with true as value" do
+      context "with braces" do
+        subject { Answer.new({:overwrite => true}) }
+        it_should_behave_like 'a true normal answer'
+      end
+      context "without braces" do
+        subject { Answer.new(:overwrite => true) }
+        it_should_behave_like 'a true normal answer'
+      end
+    end
+    context "as symbol" do
+      subject { Answer.new(:overwrite) }
+      it_should_behave_like 'a true normal answer'
+    end
+
+    # true special
+    context "with true as value" do
+      context "with braces" do
+        subject { Answer.new({:overwrite_all => true}) }
+        it_should_behave_like 'a true special answer'
+      end
+      context "without braces" do
+        subject { Answer.new(:overwrite_all => true) }
+        it_should_behave_like 'a true special answer'
+      end
+    end
+    context "as symbol" do
+      subject { Answer.new(:overwrite_all) }
+      it_should_behave_like 'a true special answer'
+    end
+
+    # false
+    context "with false as value" do
+      context "with braces" do
+        subject { Answer.new({:overwrite => false}) }
+        it_should_behave_like 'a false answer'
+      end
+      context "without braces" do
+        subject { Answer.new(:overwrite => false) }
+        it_should_behave_like 'a false answer'
+      end
+    end
+    context "with nil as value" do
+      subject { Answer.new(:overwrite => nil) }
+      it_should_behave_like 'a false answer'
+    end
+  end
+
+  describe "#indicator=" do
+    subject { Answer.new(:overwrite) }
+    its(:indicator) { should == :o }
+    it "should set indicator" do
+      subject.indicator = :ov
+      subject.indicator.should == :ov
+    end
+  end
+end

data/spec/questions/answers_spec.rb

@@ -0,0 +1,255 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Answers do
+  let(:overwrite) { Answer.new(:overwrite) }
+  let(:no_overwrite) { Answer.new(:overwrite => false) }
+
+  let(:abort) { Answer.new(:abort) }
+  let(:no_abort) { Answer.new(:abort => false) }
+
+  let(:answers_array) { [overwrite, abort] }
+  let(:answers_array_with_false) { [overwrite, no_abort] }
+
+  let(:answers_hash) { {overwrite: true, abort: true} }
+  let(:answers_hash_with_false) { {overwrite: true, abort: false} }
+
+  shared_examples_for "one answer" do
+    its(:size) { should == 1 }
+    its(:first) { should == abort }
+  end
+
+  shared_examples_for "one symbol" do
+    its(:size) { should == 1 }
+    its(:first) { should be_kind_of Answer }
+    its("first.instruction") { should == :abort }
+  end
+
+  shared_examples_for "two answers" do
+    its(:size) { should == 2 }
+    it "each answer should be kind of Answer" do
+      subject.all? { |answer| answer.kind_of? Answer }
+    end
+    its("first.instruction") { should == :overwrite }
+    its("last.instruction") { should == :abort }
+  end
+
+  shared_examples_for "hash with two true items" do
+    its(:size) { should == 2 }
+    it "each answer should be kind of Answer" do
+      subject.all? { |answer| answer.kind_of? Answer }
+    end
+    it "should be :overwrite and :abort" do
+      subject.map(&:instruction).should == [:overwrite, :abort]
+    end
+    it "each answer should be true" do
+      subject.map(&:true?).should == [true, true]
+    end
+  end
+
+  shared_examples_for "hash with one true and one false item" do
+    its(:size) { should == 2 }
+    it "each answer should be kind of Answer" do
+      subject.all? { |answer| answer.kind_of? Answer }
+    end
+    it "should be :overwrite and :abort" do
+      subject.map(&:instruction).should == [:overwrite, :abort]
+    end
+    it "should be true and false" do
+      subject.map(&:true?).should == [true, false]
+    end
+  end
+
+  describe "#init" do
+    context "when parameter is Answer" do
+      subject { Answers.new(abort) }
+      include_examples "one answer"
+    end
+    context "when parameter is Symbol" do
+      subject { Answers.new(:abort) }
+      include_examples "one symbol"
+    end
+
+    context "when parameter is array" do
+      subject { Answers.new(answers_array) }
+      include_examples "two answers"
+    end
+    context "when parameter is array filled with symbols" do
+      subject { Answers.new([:overwrite, :abort]) }
+      include_examples "two answers"
+    end
+    context "mixed array filled with symbols and answers" do
+      subject { Answers.new([:overwrite, abort]) }
+      include_examples "two answers"
+    end
+
+    context "when parameter is Hash with true values" do
+      subject { Answers.new(answers_hash) }
+      include_examples "hash with two true items"
+    end
+    context "when parameter is Hash with value false" do
+      subject { Answers.new(answers_hash_with_false) }
+      include_examples "hash with one true and one false item"
+    end
+  end
+
+  describe "#<<" do
+    subject { Answers.new }
+
+    context "when parameter is Answer" do
+      before { subject << abort }
+      include_examples "one answer"
+    end
+    context "when parameters are Answers with chaining" do
+      before { subject << overwrite << abort }
+      include_examples "two answers"
+    end
+    context "when parameter is Symbol" do
+      before { subject << :abort }
+      include_examples "one symbol"
+    end
+
+    context "when parameter is array" do
+      before { subject << answers_array }
+      include_examples "two answers"
+    end
+    context "when parameter is array filled with symbols" do
+      before { subject << [:overwrite, :abort] }
+      include_examples "two answers"
+    end
+    context "mixed array filled with symbols and answers" do
+      before { subject << [:overwrite, abort] }
+      include_examples "two answers"
+    end
+
+    context "when parameter is Hash with true values" do
+      before { subject << answers_hash }
+      include_examples "hash with two true items"
+    end
+    context "when parameter is Hash with value false" do
+      before { subject << answers_hash_with_false }
+      include_examples "hash with one true and one false item"
+    end
+  end
+
+  describe "#update_indicators_for_uniqueness!" do
+    before { subject << [:abort, :abort_all, :abc] }
+    before { subject.send(:update_indicators_for_uniqueness!) }
+    let(:indicators) { subject.map(&:indicator) }
+    it "indicators should == [:a, :A, :ab]" do
+      indicators.should == [:a, :A, :ab]
+    end
+    it "indicators should only exist unique answers" do
+      indicators.should == indicators.uniq
+    end
+  end
+
+  describe "#[]" do
+    before { subject << [:abort, :abort_all, :abc] }
+    it "should select answer by indicator" do
+      subject[:a].indicator.should == :a
+      subject[:a].instruction.should == :abort
+
+      subject[:A].indicator.should == :A
+      subject[:A].instruction.should == :abort_all
+    end
+  end
+
+  describe "#have_unique_indicators?" do
+    before { subject << [:abort, :abort_all, :abc] }
+    it { should_not have_unique_indicators }
+    context "after updating indicators for uniqueness" do
+      before { subject.update_indicators_for_uniqueness! }
+      it { should have_unique_indicators }
+    end
+  end
+
+  describe "#indicators" do
+    before { subject << [:abort, :abort_all, :abc] }
+    its(:indicators) { should == [:a, :A, :a] }
+    context "after updating indicators for uniqueness" do
+      before { subject.update_indicators_for_uniqueness! }
+      its(:indicators) { should == [:a, :A, :ab] }
+    end
+  end
+
+  describe "#to_s" do
+    context "all true" do
+      before { subject << [:abort, :abort_all, :abc] }
+      its(:to_s) { should == "[a]bort, [A]bort all, [ab]c" }
+    end
+    context "with false value" do
+      before { subject << {abort: true, abort_all: false, abc: true} }
+      its(:to_s) { should == "[a]bort, [ab]c" }
+    end
+  end
+
+  describe "Private:" do
+    describe "#select_symbols" do
+      let(:hash) { {"abc" => true, abort: true, overwrite: false} }
+      it "should return {abort: true, overwrite: false}" do
+        subject.send(:select_symbols, hash).should == { abort: true, overwrite: false }
+      end
+    end
+
+    describe "#convert_hash_to_answers" do
+      let(:hash) { {abort: true, overwrite: false} }
+      subject do
+        Answers.new.send(:convert_hash_to_answers, hash)
+      end
+      it "each entry should be kind of Answer" do
+        subject.all? { |answer| answer.kind_of? Answer }
+      end
+      its("first.instruction") { should == :abort }
+      its("first.true?") { should be_true }
+      its("last.instruction") { should == :overwrite }
+      its("last.true?") { should be_false }
+    end
+
+    describe "#convert_symbol_to_answer_or_send_through" do
+      subject do
+        Answers.new.send(:convert_symbol_to_answer_or_send_through, parameter)
+      end
+      context "when parameter is a Symbol" do
+        let(:parameter) { :abort }
+        it { should be_kind_of Answer }
+        its(:instruction) { should == :abort }
+      end
+      context "when parameter is an answer" do
+        let(:parameter) { abort }
+        it { should == abort }
+      end
+      context "when parameter is an other object" do
+        let(:parameter) { "string" }
+        it "should raise an ArgumentError" do
+          expect { subject }.to raise_error ArgumentError
+        end
+      end
+    end
+
+    describe "#free_indicator_of" do
+      context ":abc" do
+        it "should return :a if it isn't already used" do
+          subject.send(:free_indicator_of, abort, :used_indicators => [:b]).should == :a
+        end
+
+        it "should return :a if :used_indicators is empty" do
+          subject.send(:free_indicator_of, abort, :used_indicators => []).should == :a
+        end
+
+        it "should return :a if no :used_indicators is set" do
+          subject.send(:free_indicator_of, abort).should == :a
+        end
+
+        it "should reuturn :ab if :a is used" do
+          subject.send(:free_indicator_of, abort, :used_indicators => [:a]).should == :ab
+        end
+
+        it "should return :ab if :a and :A is used" do
+          subject.send(:free_indicator_of, abort, :used_indicators => [:a, :A]).should == :ab
+        end
+      end
+    end
+  end
+end

data/spec/questions/question_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Question do
+  let(:answers_array) { [Answer.new(:overwrite), Answer.new(:abort)] }
+
+  let(:question_msg) { "What to do?" }
+  let(:question) { Question.new(question_msg) }
+  subject { question }
+
+  describe "#init" do
+    its(:answers) { should be_kind_of Answers }
+    its("answers.size") { should == 0  }
+    its(:question) { should == question_msg }
+  end
+
+  describe "#answers=" do
+    before { subject.answers = [:abort, :overwrite] }
+    its(:answers) { should be_kind_of Answers }
+    its("answers.size") { should == 2  }
+  end
+
+  describe "#ask" do
+    it "should raise an error without answers" do
+      expect { subject.ask }.to raise_error /have to set answers/
+    end
+
+    context "with answers" do
+      before { subject.answers = answers_array }
+      before do
+        subject.should_receive(:gets).with("#{question_msg} [o]verwrite, [a]bort").and_return("o")
+      end
+      its(:ask) { should == :overwrite }
+    end
+  end
+
+  describe "::ask" do
+    context "with answers as array" do
+      subject { Question.ask(question_msg, [:all, :nothing]) }
+      before do
+        Question.any_instance.should_receive(:gets).with("#{question_msg} [A]ll, [n]othing").and_return("A")
+      end
+      it { should == :all }
+    end
+    context "with answers as hash" do
+      subject { Question.ask(question_msg, all: true, nothing: true) }
+      before do
+        Question.any_instance.should_receive(:gets).with("#{question_msg} [A]ll, [n]othing").and_return("A")
+      end
+      it { should == :all }
+    end
+    context "with answers as hash with false value" do
+      subject { Question.ask(question_msg, all: true, not: false, nothing: true) }
+      before do
+        Question.any_instance.should_receive(:gets).with("#{question_msg} [A]ll, [n]othing").and_return("A")
+      end
+      it { should == :all }
+    end
+  end
+
+  describe "Privates:" do
+    describe "#gets" do
+      before do
+        STDOUT.should_receive(:print).with(question_msg + " ")
+        STDOUT.should_receive(:flush)
+        STDIN.should_receive(:gets).and_return("y\n")
+      end
+      it { subject.send(:gets, question_msg).should == "y" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'questions'
+
+RSpec.configure do |config|
+  include Questions
+
+  config.mock_with :rspec
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: questions
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- DSIW
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ask human
+email:
+- dsiw@dsiw-it.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/questions.rb
+- lib/questions/answer.rb
+- lib/questions/answers.rb
+- lib/questions/question.rb
+- lib/questions/version.rb
+- questions.gemspec
+- spec/questions/answer_spec.rb
+- spec/questions/answers_spec.rb
+- spec/questions/question_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/DSIW/questions
+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.0
+signing_key: 
+specification_version: 4
+summary: Ask human
+test_files:
+- spec/questions/answer_spec.rb
+- spec/questions/answers_spec.rb
+- spec/questions/question_spec.rb
+- spec/spec_helper.rb
+has_rdoc: