questions 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41e385aa0a2fa87149846bfa99223235a5910887
-  data.tar.gz: 5aa6e4a359aad4dc0bfa7232b79daabc4a746934
+  metadata.gz: 5d41564d3b29b1c64399a5f86e375254943bdc87
+  data.tar.gz: c0cd3511a6de5d9e36969a7e68093344672aa63e
 SHA512:
-  metadata.gz: c1056f0f6f023509511d95659796f301be00924d129e2c2a38cdffed01df1899b2adf275367c1e662c5dfc959bd2c874a323fce5ce66a2dae997ee013b145d08
-  data.tar.gz: c74a6eca07e5d9a80327b2df544bae4bd9adfe042479a37eb9e1d109266d1b781a2d10022842d990a69866a7e6674bd2db36a9be8f96b2d11cbc3eea60ddddfa
+  metadata.gz: cb923ed4048e62eb3e7ec943033d5a4fbe2d3b3004d76ed07c3e62c2acec75fb6b04e430b0d12c2bbb109be70b2954abc0897fd3f9363b3c3edb1ba29daef970
+  data.tar.gz: 82f7f2b6ddb1543148030a9dd4ebcbf933f364775cb39a56f5be6bc44b70799c1e8abf877b72bcdb89273703b47a49395c20f38f3ff2ff3da1b916f63ff4190c

data/.rspec

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

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/lib/questions/answer.rb

@@ -1,6 +1,14 @@
 # encoding: utf-8
 
 module Questions
+  # Represents an answer.
+  #
+  # An answer has an indicator which will be used to detect which answer is selected by user. Indicators are the first
+  # few letters of its instruction. User can identify an
+  # indicator by its surrounded square brackets. After that the rest of the instruction will be displayed.
+  #
+  # Answers can be active or inactive. Only active ansers will be displayed, inactive ones will be hidden.
+  # Answers can be special, then the indicator is in uppercase letters set.
   class Answer
     SPECIAL_ENDINGS = [:all]
 
@@ -121,6 +129,7 @@ module Questions
     #   Answer.new(overwrite: false).to_s #=> ""
     def to_s
       return nil if inactive?
+      indicator = indicator()
       instruction_without_indicator = instruction.to_s[indicator.length..-1]
       humanized = instruction_without_indicator.gsub("_", " ")
       "[#{indicator}]#{humanized}"

data/lib/questions/answers.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 module Questions
+  # Answers manages many answers. Each item is a Answer object in this collection.
   class Answers < Array
     # Instantiates a new Answers object.
     #
@@ -78,7 +79,7 @@ module Questions
       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
+        self << AnswersHelper.convert_hash_to_answers(AnswersHelper.select_symbols(arg)) # call as Array
       end
       self
     end
@@ -108,9 +109,9 @@ module Questions
     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)
+      each_with_index do |answer, num|
+        other_indicators = first(num).map(&:indicator)
+        answer.indicator = AnswersHelper.free_indicator_of(answer, used_indicators: other_indicators)
       end
     end
 
@@ -135,6 +136,7 @@ module Questions
     #   answers.indicators #=> [:a, :A, :ab]
     #   answers.has_unique_indicators? #=> true
     def has_unique_indicators?
+      indicators = indicators()
       indicators == indicators.uniq
     end
 
@@ -151,46 +153,5 @@ module Questions
       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

@@ -65,8 +65,9 @@ module Questions
     #
     # @return [Symbol] selected answer
     def ask
+      answers = answers()
       raise "You have to set answers" if answers.empty?
-      answer = gets "#{@question} #{answers}"
+      answer = UserInput.get "#{@question} #{answers}"
       answers[answer.to_sym].instruction || ask
     end
 
@@ -91,14 +92,5 @@ module Questions
       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.rb

@@ -1,3 +1,6 @@
+require "util/user_input"
+require "util/answers_helper"
+
 require "questions/version"
 require "questions/answer"
 require "questions/answers"

data/lib/util/answers_helper.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module AnswersHelper
+  # {"abc" => true, abort: true, overwrite: false} => {abort: true}
+  def self.select_symbols(args)
+    args.select { |inst, value| inst.is_a?(Symbol) }
+  end
+
+  # {abort: true} => [Answer.new(:abort => true)]
+  def self.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 self.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 self.free_indicator_of answer, opts={}
+    opts = {:used_indicators => []}.merge(opts)
+    used_indicators = opts[:used_indicators]
+
+    first_chars = 1
+    loop do
+      indicator = answer.indicator(first_chars)
+      if used_indicators.include? indicator
+        first_chars += 1
+        redo # next try
+      else
+        return indicator
+      end
+    end
+  end
+end

data/lib/util/user_input.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module UserInput
+  # Prints `msg` and reads user input
+  def self.get msg
+    STDOUT.print("#{msg} ")
+    STDOUT.flush
+    STDIN.gets.chomp
+  end
+end

data/spec/questions/answers_spec.rb

@@ -184,72 +184,4 @@ describe Answers do
       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

@@ -29,7 +29,7 @@ describe Question do
     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")
+        UserInput.should_receive(:get).with("#{question_msg} [o]verwrite, [a]bort").and_return("o")
       end
       its(:ask) { should == :overwrite }
     end
@@ -39,34 +39,23 @@ describe Question 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")
+        UserInput.should_receive(:get).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")
+        UserInput.should_receive(:get).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")
+        UserInput.should_receive(:get).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/util/answers_helper_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe AnswersHelper do
+  let(:abort) { Answer.new(:abort) }
+
+  describe "#select_symbols" do
+    let(:hash) { {"abc" => true, abort: true, overwrite: false} }
+    it "should return {abort: true, overwrite: false}" do
+      AnswersHelper.select_symbols(hash).should == { abort: true, overwrite: false }
+    end
+  end
+
+  describe "#convert_hash_to_answers" do
+    let(:hash) { {abort: true, overwrite: false} }
+    subject do
+      AnswersHelper.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
+      AnswersHelper.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
+        AnswersHelper.free_indicator_of(abort, :used_indicators => [:b]).should == :a
+      end
+
+      it "should return :a if :used_indicators is empty" do
+        AnswersHelper.free_indicator_of(abort, :used_indicators => []).should == :a
+      end
+
+      it "should return :a if no :used_indicators is set" do
+        AnswersHelper.free_indicator_of(abort).should == :a
+      end
+
+      it "should reuturn :ab if :a is used" do
+        AnswersHelper.free_indicator_of(abort, :used_indicators => [:a]).should == :ab
+      end
+
+      it "should return :ab if :a and :A is used" do
+        AnswersHelper.free_indicator_of(abort, :used_indicators => [:a, :A]).should == :ab
+      end
+    end
+  end
+end

data/spec/util/user_input_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe UserInput do
+  describe "#get" do
+    let(:msg) { "What?" }
+    before do
+      STDOUT.should_receive(:print).with(msg + " ")
+      STDOUT.should_receive(:flush)
+      STDIN.should_receive(:gets).and_return("y\n")
+    end
+    it { subject.send(:get, msg).should == "y" }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questions
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - DSIW
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,11 +127,15 @@ files:
 - lib/questions/answers.rb
 - lib/questions/question.rb
 - lib/questions/version.rb
+- lib/util/answers_helper.rb
+- lib/util/user_input.rb
 - questions.gemspec
 - spec/questions/answer_spec.rb
 - spec/questions/answers_spec.rb
 - spec/questions/question_spec.rb
 - spec/spec_helper.rb
+- spec/util/answers_helper_spec.rb
+- spec/util/user_input_spec.rb
 homepage: https://github.com/DSIW/questions
 licenses:
 - MIT
@@ -161,4 +165,6 @@ test_files:
 - spec/questions/answers_spec.rb
 - spec/questions/question_spec.rb
 - spec/spec_helper.rb
+- spec/util/answers_helper_spec.rb
+- spec/util/user_input_spec.rb
 has_rdoc: