robut-quiz 0.1.0 → 0.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 source :rubygems
 
-gem 'robut'
+gem 'robut', :git => 'git://github.com/substantial/robut.git', 
+  :ref => '37de65af7c42ea691f3e76e8952a5821b8170be0'
 
 group :test do
   gem 'rspec'

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.2.0 / 2011-10-26
+
+* Changed the question syntax
+* Added a range question (1..5)
+
 === 0.1.0 / 2011-10-23
 
 * Initial Release

data/lib/polar.rb

@@ -32,8 +32,8 @@ class Robut::Plugin::Quiz::Polar
     "#{yes_votes} YES vote#{yes_votes != 1 ? 's' : ''} and #{no_votes} NO vote#{no_votes != 1 ? 's' : ''}"
   end
   
-  def captured_results
-    @captured_results ||= {}
+  def ask
+    "@all Question '#{@question}' (yes/no)"
   end
   
   def store_positive_response_for sender_nick

data/lib/question.rb

@@ -2,38 +2,63 @@
 
 module Robut::Plugin::Quiz::Question
   
-  # @see ask%20%3F(choice%7Cpolar%7Cscale)%3F%20(%3F%3Aquestion%20)%3F'(%5B%5E'%5D%2B)'%5B%5Cs%2C%5D*((%3F%3A'%5B%5E'%5D%2B'%5B%5Cs%2C%5D*)*)%2B(%3F%3A(%3F%3Afor%20)%3F(%5Cd%2B)%20minutes%3F)%3F
-  # 
-  # 1st: question type - choice, polar, scale
-  # 2nd: question
-  # 3rd: choices
-  #
-  QUESTION_REGEX = /^ask ?(choice|polar|scale)? (?:question )?['"]([^'"]+)['"][\s,]*((?:['"][^'"]+['"][\s,]*)*)*(?:(?:for )?(\d+) minutes?)?$/
-  
   # This regex will find all the questions and parameters specified with the question 
   GROUP_REGEX = /['"]([^'"]+)['"]/ 
   
-  def initialize(sender,request)
+  #
+  # Initialize the question with the asker of the question and the details about
+  # question that is being asked.
+  # 
+  # @param [String] sender the name of the person asking the question.
+  # @param [String] question_with_parameters this is the remaining question and
+  #   parameters left on the question posed to the chat room.
+  # 
+  def initialize(sender,question_with_parameters)
     @sender = sender
-    process_question(request)
+    process_question(question_with_parameters)
   end
   
-  def process_question(request)
+  #
+  # This is used internally to process the the question and parameters that sent
+  # to the question.
+  # 
+  # @param [String] question_with_parameters this is the remaining question and
+  #   parameters left on the question posed to the chat room.
+  #
+  def process_question(question_with_parameters)
     
-    request =~ QUESTION_REGEX
-    @question = Regexp.last_match(2)
+    parsed_elements = question_with_parameters.scan(GROUP_REGEX)
+    
+    @question = parsed_elements.first.first
     # After the target, question type, question, and answer length has been determined
     # look at all the single quoted items to find the list of parameters if there are any
-    @parameters = request.scan(GROUP_REGEX)[1..-1].flatten
+    @parameters = Array(parsed_elements[1..-1].flatten)
     
   end
   
+  #
+  # @return [String] the question that is being asked.
   def to_s
     @question
   end
   
+  #
+  # Ask the question that has been proposed.
+  # 
+  # @return [String] a string that asks the question in the chat room.
   def ask
     "@all Question '#{@question}'"
   end
   
+  #
+  # Maintains a list of the results that have been captured for the question.
+  # The hash that is maintained would be used with the user's nickname as the
+  # key and the value as a response to the question.
+  # 
+  # @return [Hash] used for storing responses from the various senders.
+  # 
+  def captured_results
+    @captured_results ||= {}
+  end
+  
 end

data/lib/quiz.rb

@@ -4,12 +4,23 @@ require 'robut'
 class Robut::Plugin::Quiz
   include Robut::Plugin
   
+  #
+  # @return [Array<String>] contains the various types of responses that are 
+  #   valid usage examples that would be returned by the Help Plugin
+  # 
   def usage
     [ 
-      "#{at_nick} ask polar 'Should I continue the presentation?' for 3 minutes",
+      "#{at_nick} ask 'Should we break for lunch?'",
+      "#{at_nick} ask for 3 minutes 'Should I continue the presentation?'",
+      "#{at_nick} answer yes"
     ]
   end
   
+  #
+  # @param [Time] time at which the message has arrived
+  # @param [String] sender_nick the sender
+  # @param [String] message the message that was sent
+  #
   def handle(time, sender_nick, message)
     
     # check to see if the user is asking the bot a question
@@ -29,7 +40,7 @@ class Robut::Plugin::Quiz
     
   end
   
-  QUESTION_REGEX = /^ask ?(choice|polar|scale)? (?:question )?.+(?:(?:for )?(\d+) minutes?)$/
+  QUESTION_REGEX = /^ask ?(choice|polar|range)? (?:question )?(?:(?:for )?(\d+) minutes?)?(.+)$/
   
   def is_a_valid_question? message
     QUESTION_REGEX =~ message
@@ -45,8 +56,15 @@ class Robut::Plugin::Quiz
     (store["quiz::question::queue"] ||= []) << [sender,question]
   end
   
+  #
+  # Return a new thread which will pop questions in the queue of questions
+  # 
   def quizmaster
-    @@quizmaster ||= Thread.new { pop_the_question until there_are_no_more_questions_to_pop }
+    if not defined?(@@quizmaster) or @@quizmaster.nil? or !@@quizmaster.alive?
+      @@quizmaster = Thread.new { pop_the_question until there_are_no_more_questions_to_pop }
+    end
+    
+    @@quizmaster
   end
   
   def pop_the_question
@@ -63,13 +81,17 @@ class Robut::Plugin::Quiz
     defined? @@current_question and @@current_question
   end
   
+  #
+  # @param [String] sender the user proposing the question
+  # @param [String] request the data related to the asking and the question data itself.
+  #
   def process_the_question(sender,request)
-    
     request =~ QUESTION_REGEX
     type = Regexp.last_match(1) || 'polar'
-    question_length = Regexp.last_match(2) || '2' 
+    question_length = Regexp.last_match(2) || '2'
+    question_data = Regexp.last_match(3)
     
-    set_current_question create_the_question_based_on_type(type,sender,request), question_length
+    set_current_question create_the_question_based_on_type(type,sender,question_data), question_length
   end
   
   #
@@ -95,6 +117,9 @@ class Robut::Plugin::Quiz
     reply "The results are in for '#{question}':"
     reply question.results
     
+    # allow some time between the results and asking the next question
+    sleep 10
+    
   end
   
   def start_accepting_responses_for_this_question(question)
@@ -105,8 +130,13 @@ class Robut::Plugin::Quiz
     @@current_question = nil
   end
   
-  def process_response_for_active_question(sender_nick, request)
-    if @@current_question.handle_response sender_nick, request
+  #
+  # @param [String] sender_nick the name of the person that is responding to
+  #   the question.
+  # @param [String] response is the answer to the question proposed.
+  #
+  def process_response_for_active_question(sender_nick, response)
+    if @@current_question.handle_response sender_nick, response[/^answer (.+)$/,1]
       reply "Thank you, @#{sender_nick}, I have recorded your response."
     else
       reply "Sorry, @#{sender_nick}, I was unable to record that answer"
@@ -117,4 +147,5 @@ end
 
 
 require_relative 'question'
-require_relative 'polar'
+require_relative 'polar'
+require_relative 'range'

data/lib/range.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+class Robut::Plugin::Quiz::Range
+  include Robut::Plugin::Quiz::Question
+  
+  RANGE_VALUES = /(\d+)(?:-|\.\.)(\d+)/
+  
+  def handle_response(sender_nick,response)
+    
+    if within_range? response
+      store_range_response_for sender_nick, response
+      true
+    else
+      false
+    end
+    
+  end
+  
+  def start_value
+    if Array(@parameters).first.to_s =~ RANGE_VALUES
+      Regexp.last_match(1).to_i
+    else
+      1
+    end
+  end
+  
+  def highest_value
+    if Array(@parameters).first.to_s =~ RANGE_VALUES
+      Regexp.last_match(2).to_i
+    else
+      5
+    end
+  end
+  
+  def within_range?(value)
+    value.to_i >= start_value and value.to_i <= highest_value
+  end
+  
+  def ask
+    "@all Question '#{@question}' (#{start_value}..#{highest_value})"
+  end
+  
+  def results
+    return "I'm sorry, not enough votes were cast to be create a summary." if captured_results.length == 0
+    
+    result_values = captured_results.values.extend Robut::Plugin::Quiz::Range::Averages
+    "#{result_values.length} votes with a mean of #{result_values.mean}"
+  end
+  
+  def store_range_response_for(sender_nick,value)
+    captured_results[sender_nick] = value.to_i
+  end
+  
+  
+  module Averages
+    
+    def sum
+      inject(:+)
+    end
+    
+    def mean
+      return 0 if length == 0
+      sum.to_f / length.to_f
+    end
+    
+    def mode
+      frequency = inject(Hash.new(0)) { |hash,value| hash[value] += 1; hash }
+      sort_by {|value| frequency[value] }.last
+    end
+    
+  end
+  
+end

data/lib/robut_quiz.rb

@@ -3,7 +3,7 @@
 require 'robut'
 
 class Robut::Plugin::Quiz
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end
 
 require_relative 'quiz'

data/spec/polar_spec.rb

@@ -3,7 +3,7 @@ require_relative 'spec_helper'
 describe Robut::Plugin::Quiz::Polar do
   
   subject do
-    Robut::Plugin::Quiz::Polar.new 'person',"ask polar 'Should I continue the presentation?' for 3 minutes"
+    Robut::Plugin::Quiz::Polar.new 'person',"'Should I continue the presentation?'"
   end
   
   let(:time) { Time.now }

data/spec/question_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Robut::Plugin::Quiz::Question do
+  
+  class TestQuestion
+    include Robut::Plugin::Quiz::Question
+    
+    attr_accessor :question, :parameters, :captured_results
+    
+  end
+  
+  let(:question) { "Do you like questions?" }
+  let(:question_with_params) { "'#{question}', 'yes', 'no' 'maybe'" }
+  
+  subject { TestQuestion.new "sender", question_with_params }
+  
+  describe "#to_s" do
+    
+    it "should be the question that was asked" do
+      subject.to_s.should == question
+    end
+    
+  end
+  
+  describe "#ask" do
+    
+    it "should be the default statement to ask question" do
+      subject.ask.should == "@all Question '#{question}'"
+    end
+    
+  end
+  
+  describe "#process_question" do
+    
+    context "when a question with parameters" do
+      
+      it "should find the question" do
+        subject.process_question question_with_params
+        subject.question.should == question
+      end
+      
+      it "should find the parameters" do
+        subject.process_question question_with_params
+        subject.parameters.should == [ 'yes', 'no', 'maybe' ]
+      end
+      
+    end
+    
+    context "when only a question has been provided" do
+      
+      it "should find the question" do
+        subject.process_question "'Ask more questions?'"
+        subject.question.should == 'Ask more questions?'
+      end
+      
+    end
+    
+  end
+  
+  describe "subject" do
+    
+  end
+  
+end

data/spec/quiz_spec.rb

@@ -15,11 +15,11 @@ describe Robut::Plugin::Quiz do
   let(:time) { Time.now }
   
   [ 
-    "ask choice 'What do you want for lunch?', 'pizza', 'sandwich', 'salad' for 1 minute",
-    "ask polar 'Should I continue the presentation?' for 3 minutes",
-    "ask scale question 'how much did you like the presentation?', '1..5' for 10 minutes",
-    "ask 'Should I continue the presentation?', 'y|yes', 'n|no' for 1 minutes",
-    "ask polar 'Should I continue the presentation?' for 3 minutes"
+    "ask 'Should I continue the presentation?'",
+    "ask for 3 minutes 'Should I continue the presentation?'",
+    "ask polar for 3 minutes 'Should I continue the presentation?'",
+    "ask choice 1 minute 'What do you want for lunch?', 'pizza', 'sandwich', 'salad'",
+    "ask scale question for 10 minutes 'how much did you like the presentation?', '1..5'"
     
   ].each do |question|
   
@@ -55,7 +55,7 @@ describe Robut::Plugin::Quiz do
 
           subject.should_not_receive(:process_response_for_active_question)
           
-          subject.handle time,'person',"@quizmaster ask polar 'Should I continue the presentation?' for 3 minutes"
+          subject.handle time,'person',"@quizmaster ask polar for 3 minutes 'Should I continue the presentation?'"
           
         end
         
@@ -70,7 +70,7 @@ describe Robut::Plugin::Quiz do
 
           subject.should_receive(:process_response_for_active_question)
           
-          subject.handle time,'person',"@quizmaster ask polar 'Should I continue the presentation?' for 3 minutes"
+          subject.handle time,'person',"@quizmaster ask polar for 3 minutes 'Should I continue the presentation?'"
           
         end
         
@@ -93,7 +93,7 @@ describe Robut::Plugin::Quiz do
         subject.should_receive(:create_the_question_based_on_type).and_return(expected_question)
         
         subject.should_receive(:set_current_question).with(expected_question,'3')
-        subject.process_the_question 'person',"ask polar 'Should I continue the presentation?' for 3 minutes"
+        subject.process_the_question 'person',"ask polar for 3 minutes 'Should I continue the presentation?'"
         
       end
       
@@ -109,7 +109,7 @@ describe Robut::Plugin::Quiz do
     end
     
     let(:question) do
-      Robut::Plugin::Quiz::Polar.new 'person',"ask polar 'Should I continue the presentation?' for 3 minutes"
+      Robut::Plugin::Quiz::Polar.new 'person',"'Should I continue the presentation?'"
     end
     
     it "should place robut in the mode where it is asking a question" do

data/spec/range_spec.rb

@@ -0,0 +1,100 @@
+require_relative 'spec_helper'
+
+describe Robut::Plugin::Quiz::Range do
+  
+  subject do
+    Robut::Plugin::Quiz::Range.new 'person',"ask range for 3 minutes 'Should I continue the presentation?'"
+  end
+  
+  describe "#start_value" do
+    
+    context "when no range has been specified" do
+      
+      it "should default to the value 1" do
+        subject.start_value.should == 1
+      end
+      
+    end
+    
+  end
+  
+  describe "#highest_value" do
+    
+    context "when no range has been specified" do
+
+      it "should default to the value of 5" do
+        subject.highest_value.should == 5
+      end
+      
+    end
+    
+  end
+  
+  describe "#within_range?" do
+    
+    context "when the value is within range" do
+    
+      it "should respond with true" do
+        subject.within_range?(3).should be_true
+      end
+        
+    end
+    
+    context "when the value is not within range" do
+      
+      it "should respond with false" do
+        subject.within_range?(6).should be_false
+      end
+      
+    end
+    
+  end
+  
+  describe "#handle_response" do
+    
+    context "with a valid response" do
+      
+      it "should return true" do
+        subject.should_receive(:store_range_response_for).with("sender","1")
+        subject.handle_response("sender","1").should be_true
+      end
+      
+    end
+    
+  end
+  
+  describe Robut::Plugin::Quiz::Range::Averages do
+    
+    subject do
+      array = [1,1,2,2,2,3,4,5]
+      array.extend Robut::Plugin::Quiz::Range::Averages
+    end
+    
+    
+    describe "#sum" do
+      
+      it "should return the correct value" do
+        subject.sum.should == 20
+      end
+      
+    end
+    
+    describe "#mean" do
+      
+      it "should return the correct value" do
+        subject.mean.should == 2.5
+      end
+      
+    end
+    
+    describe "#mode" do
+      
+      it "should return the correct value" do
+        subject.mode.should == 2
+      end
+      
+    end
+    
+  end
+  
+end

metadata

@@ -2,7 +2,7 @@
 name: robut-quiz
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Franklin Webber
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-23 00:00:00 Z
+date: 2011-10-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: robut
@@ -40,16 +40,19 @@ files:
 - lib/polar.rb
 - lib/question.rb
 - lib/quiz.rb
+- lib/range.rb
 - lib/robut_quiz.rb
 - robut-quiz.gemspec
 - spec/polar_spec.rb
+- spec/question_spec.rb
 - spec/quiz_spec.rb
+- spec/range_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/burtlo/robut-quiz
 licenses: []
 
 post_install_message: "\n\
-  --------------------------------------------------------------------------------\n    ___\n  !(O-0)! ~ Thank you for installing robut-quiz 0.1.0 / 2011-10-23\n >==[ ]==<\n    @ @\n\n  Changes:\n    \n  * Initial Release\n  * User is able to ask polar question\n\n\
+  --------------------------------------------------------------------------------\n    ___\n  !(O-0)! ~ Thank you for installing robut-quiz 0.2.0 / 2011-10-26\n >==[ ]==<\n    @ @\n\n  Changes:\n    \n  * Changed the question syntax\n  * Added a range question (1..5)\n  \n\n\
   --------------------------------------------------------------------------------"
 rdoc_options: 
 - --charset=UTF-8