ruql_cqb 0.0.0

data/lib/ruql/renderers/qualtrics_renderer.rb

@@ -0,0 +1,63 @@
+class QualtricsRenderer
+
+  attr_reader :output
+  
+  def initialize(quiz, options={})
+    @output = ''
+    @quiz = quiz
+    @template = options.delete('t') || options.delete('template')
+  end
+
+  def render_quiz
+    quiz = @quiz                # make quiz object available in template's scope
+    with_erb_template(IO.read(File.expand_path @template)) do
+      output = ''
+      @quiz.questions.each_with_index do |q,i|
+        next_question = render_question q,i
+        output << next_question
+      end
+      output
+    end
+  end
+
+  def with_erb_template(template)
+    # template will 'yield' back to render_quiz to render the questions
+    @output = ERB.new(template).result(binding)
+  end
+
+  def render_question(q,index)
+    case q
+    when SelectMultiple,TrueFalse then render(q, index, 'Multiple') # These are subclasses of MultipleChoice, should go first
+    when MultipleChoice then render(q, index, 'Single')
+    else
+      @quiz.logger.error "Question #{index} (#{q.question_text[0,15]}...): Only written to handle multiple_choice, truefalse, or select_multiple questions at this time."
+      ''
+    end
+  end
+  
+  def render(question, index, type='')    
+    output = ''
+    output << "[[Question:MC:#{type}Answer]]\n"
+    output << "[[ID:#{index}]]\n"
+    if type == 'Multiple'
+      question.question_text = "Select ALL that apply. " + question.question_text
+    elsif type == 'Single'
+      question.question_text = "Choose ONE answer. " + question.question_text
+    end
+    output << question.question_text << "\n"
+
+    # answers - ignore randomization
+
+    output << "[[AdvancedChoices]]\n"
+    question.answers.each do |answer|
+      output << "[[Choice]]\n"
+      output << "#{answer.answer_text}\n"
+    end
+    if type == 'Multiple'
+      output << "[[Choice]]\n"
+      output << "<i>None of these answers are correct.</i>\n"
+    end
+    output
+  end
+
+end

data/lib/ruql/renderers/xml_renderer.rb

@@ -0,0 +1,148 @@
+class XMLRenderer
+  require 'builder'
+
+  attr_reader :output
+  def initialize(quiz,options={})
+    @output = ''
+    @b = Builder::XmlMarkup.new(:target => @output, :indent => 2)
+    @quiz = quiz
+  end
+
+  def render(thing)
+    case thing
+    when MultipleChoice,SelectMultiple,TrueFalse then render_multiple_choice(thing)
+    when FillIn then render_fill_in(thing)
+    else
+      raise "Unknown question type: #{thing}"
+    end
+  end
+  
+  def render_quiz
+    # entire quiz can be in one question group, as long as we specify
+    # that ALL question from the group must be used to make the quiz.
+    xml_quiz do
+      # after preamble...
+      @b.question_groups do
+        @b.question_group(:select => @quiz.questions.length) do
+          @quiz.questions.each do |question|
+            self.render(question)
+          end
+        end
+      end
+    end
+    @output
+  end
+
+  def render_fill_in(question)
+    @b.question :type => 'GS_Short_Answer_Question_Simple', :id => question.object_id.to_s(16) do
+      @b.metadata {
+        @b.parameters {
+          @b.rescale_score question.points
+          @b.type 'regexp'
+        }
+      }
+      # since we want all the options to appear, we create N option
+      # groups each containig 1 option, and specify that option to
+      # always be selected for inclusion in the quiz.  If the original
+      # question specified 'random', use the 'randomize' attribute on
+      # option_groups to scramble the order in which displayed;
+      # otherwise, display in same order as answers appear in source.
+      @b.data {
+        @b.text { @b.cdata!(question.question_text) }
+        @b.option_groups(:randomize => !!question.randomize) {
+          @b.option_group(:select => 'all') {
+            question.answers.each do |answer|
+              option_args = {}
+              option_args['selected_score'] = answer.correct? ? 1 : 0
+              option_args['unselected_score'] =
+                question.multiple ? 1 - option_args['selected_score'] : 0
+              option_args['id'] = answer.object_id.to_s(16)
+              @b.option(option_args) do
+                answer_text = answer.answer_text
+                if answer_text.kind_of?(Regexp)
+                  answer_text = answer_text.inspect
+                  if !question.case_sensitive
+                    answer_text += 'i'
+                  end
+                end
+                @b.text { @b.cdata!(answer_text) }
+                @b.explanation { @b.cdata!(answer.explanation) } if answer.has_explanation?
+              end
+            end
+          }
+        }
+      }
+    end
+  end
+
+  def render_multiple_choice(question)
+    @b.question :type => 'GS_Choice_Answer_Question', :id => question.object_id.to_s(16) do
+      @b.metadata {
+        @b.parameters {
+          @b.rescale_score question.points
+          @b.choice_type (question.multiple ? 'checkbox' : 'radio')
+        }
+      }
+      # since we want all the options to appear, we create N option
+      # groups each containig 1 option, and specify that option to
+      # always be selected for inclusion in the quiz.  If the original
+      # question specified 'random', use the 'randomize' attribute on
+      # option_groups to scramble the order in which displayed;
+      # otherwise, display in same order as answers appear in source.
+      @b.data {
+        @b.text { @b.cdata!(question.question_text) }
+        @b.option_groups(:randomize => !!question.randomize) {
+          question.answers.each do |a|
+            @b.option_group(:select => 'all') {
+              self.render_multiple_choice_answer a, question.multiple
+            }
+          end
+        }
+      }
+    end
+  end
+  alias :render_true_false :render_multiple_choice
+
+  def render_multiple_choice_answer(answer, multiple_allowed)
+    option_args = {}
+    option_args['selected_score'] = answer.correct? ? 1 : 0
+    option_args['unselected_score'] =
+      multiple_allowed ? 1 - option_args['selected_score'] : 0
+    option_args['id'] = answer.object_id.to_s(16)
+    @b.option(option_args) do
+      @b.text { @b.cdata!(answer.answer_text) }
+      @b.explanation { @b.cdata!(answer.explanation) } if answer.has_explanation?
+    end
+  end
+
+  private
+
+  def options_to_xml(h)
+    h.each_pair do |k,v|
+      if v.is_a?(Hash)
+        @b.__send__(k.to_sym) do
+          options_to_xml v
+        end
+      else
+        @b.__send__(k.to_sym, v)
+      end
+    end
+  end
+  
+
+  def xml_quiz
+    @b.quiz do
+      @b.metadata do
+        @b.type 'quiz'
+        @b.title @quiz.title
+        options_to_xml @quiz.options
+      end
+      @b.preamble
+      @b.data do 
+        yield
+      end
+    end
+  end
+
+end
+

data/lib/ruql/select_multiple.rb

@@ -0,0 +1,7 @@
+class SelectMultiple < MultipleChoice
+  def initialize(text='', opts={})
+    super
+    self.multiple = true
+  end
+
+end

data/lib/ruql/tex_output.rb

@@ -0,0 +1,27 @@
+module TexOutput
+
+  def add_newlines(str)
+    str.gsub(Regexp.new('<pre>(.*?)</pre>', Regexp::MULTILINE | Regexp::IGNORECASE) ) do |code_section|
+      code_section.gsub!("\n"){"\\\\"}
+      code_section.gsub!("  "){"\\hspace*{2em}"}      
+    end
+  end
+  
+  @@tex_replace = {
+    /_/ => '\textunderscore{}',
+    Regexp.new('<tt>([^<]+)</tt>', Regexp::IGNORECASE) => "\\texttt{\\1}",
+    Regexp.new('<pre>(.*?)</pre>', Regexp::MULTILINE | Regexp::IGNORECASE) => "\\texttt{\\1}",
+  }
+
+  @@tex_escape = Regexp.new '\$|&|%|#|\{|\}'
+
+  def to_tex(str)
+    str = str.gsub(@@tex_escape) { |match| "\\#{match}" }
+    str = add_newlines(str)
+    
+    @@tex_replace.each_pair do |match, replace|
+      str = str.gsub(match, replace)
+    end
+    str
+  end
+end

data/lib/ruql/true_false.rb

@@ -0,0 +1,17 @@
+class TrueFalse < Question
+
+  def initialize(text, correct_answer, opts=nil)
+    super
+    opts ||= {}
+    opts[:explanation] ||= ''
+    correct_answer = !!correct_answer # ensure 'true' or 'false' only
+    self.question_text = "True or False: #{text}"
+    self.answer correct_answer.to_s.capitalize
+    self.distractor (!correct_answer).to_s.capitalize, :explanation => opts[:explanation]
+  end
+
+  def multiple ; false ; end
+  def incorrect_answer ; self.answers.reject(&:correct).first ; end
+  def explanation ; incorrect_answer.explanation ; end
+    
+end

data/templates/autoqcm.tex.erb

@@ -0,0 +1 @@
+<%= yield %>

data/templates/html5.html.erb

@@ -0,0 +1,42 @@
+<html>
+  <head>
+    <title><%= quiz.title %></title>
+    <style type="text/css" media="all">
+    body { font-family: Times, serif; }
+    .header { text-align: right; font-weight: bold; padding-right: 30%; line-height: 300%; }
+    h1 { text-align: center; }
+    ol.questions { list-style-type: number; }
+    li.question { page-break-inside: avoid; border-bottom: 1px solid grey;  }
+    li.multiplechoice  ol.answers { list-style-type: lower-alpha; }
+    li.selectmultiple  ol.answers { vertical-align: center; list-style-type: none; list-style-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUAQMAAAC3R49OAAAABlBMVEUAAAD///+l2Z/dAAAAEklEQVQImWNgAIL6/w+ogoEAAKI4Kp2NVIeDAAAAAElFTkSuQmCC');  }
+    li.truefalse ol.answers { list-style-type: none; }
+    .correct { color: green; font-weight: bold; border: 1px solid black; padding: 0.2ex; }
+    .incorrect { color: red }
+    .explanation { font-style: italic }
+    .instructions { clear: both; border: 1px solid black; align: center; padding: 2ex; margin: 2ex; }
+    </style>
+  </head>
+  <body>
+    <div class="header">
+      <div id="name">Name:</div>
+      <div id="sid">SID:</div>
+    </div>
+    <h1><%= quiz.title %></h1>
+    <div class="instructions">
+      <ul>
+        <li>No books, notes, or electronic devices allowed.  </li>
+        <li>Time limit is 30 minutes.</li>
+        <li><%= quiz.num_questions %> multiple-choice questions, points indicated per question,
+          <%= quiz.points %> points total.  Points per question are intended 
+          to reflect approximate times they should take, at about 1 point per minute.</li>
+        <li>For 'select all that apply' questions worth N points,
+          you get 1/N of the points for each RIGHT answer that you check, plus
+          1/N of the points for each WRONG answer that you correctly
+          leave unchecked.  That is, equal weight is given to deciding
+          whether each choice is part of the right answer or not.</li> 
+      </ul>
+      <b>Good skill!</b>
+    </div>
+    <%= yield %>
+  </body>
+</html>

data/templates/htmlform.html.erb

@@ -0,0 +1,44 @@
+<html>
+  <head>
+    <title><%= quiz.title %></title>
+    <style type="text/css" media="all">
+    body { font-family: Times, serif; }
+    .header { text-align: right; font-weight: bold; padding-right: 30%; line-height: 300%; }
+    h1 { text-align: center; }
+    ol.questions { list-style-type: number; }
+    li.question { page-break-inside: avoid; border-bottom: 1px solid grey; padding-bottom: 2ex; }
+    li.multiplechoice  ol.answers { list-style-type: lower-alpha; }
+    li.multiplechoice  ol.answers li { padding-bottom: 0.5ex; }
+    li.selectmultiple  ol.answers { vertical-align: center; list-style-type: none; list-style-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUAQMAAAC3R49OAAAABlBMVEUAAAD///+l2Z/dAAAAEklEQVQImWNgAIL6/w+ogoEAAKI4Kp2NVIeDAAAAAElFTkSuQmCC');  }
+    li.truefalse ol.answers { list-style-type: none; }
+    li.truefalse ol.answers li { width: 15%; display: inline-block; }
+    .correct { color: green }
+    .incorrect { color: red }
+    .explanation { font-style: italic }
+    .instructions { clear: both; border: 1px solid black; align: center; padding: 2ex; margin: 2ex; }
+    </style>
+  </head>
+  <body>
+    <div class="header">
+      <div id="name">Name:</div>
+      <div id="sid">SID:</div>
+    </div>
+    <h1><%= quiz.title %></h1>
+    <div class="instructions">
+      <ul>
+        <li>No books, notes, or electronic devices allowed.  </li>
+        <li>Time limit is 30 minutes.</li>
+        <li><%= quiz.num_questions %> multiple-choice questions, points indicated per question,
+          <%= quiz.points %> points total.  Points per question are intended 
+          to reflect approximate times they should take, at about 1 point per minute.</li>
+        <li>For 'select all that apply' questions worth N points,
+          you get 1/N of the points for each RIGHT answer that you check, plus
+          1/N of the points for each WRONG answer that you correctly
+          leave unchecked.  That is, equal weight is given to deciding
+          whether each choice is part of the right answer or not.</li> 
+      </ul>
+      <b>Good skill!</b>
+    </div>
+    <%= yield %>
+  </body>
+</html>

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ruql_cqb
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Armando Fox
+- Aaron Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: getopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby-embedded DSL for creating short-answer quiz questions
+email: aaron.zhang@berkeley.edu
+executables:
+- ruql
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ruql
+- lib/ruql.rb
+- lib/ruql/answer.rb
+- lib/ruql/fill_in.rb
+- lib/ruql/multiple_choice.rb
+- lib/ruql/question.rb
+- lib/ruql/quiz.rb
+- lib/ruql/renderer.rb
+- lib/ruql/renderers/auto_qcm_renderer.rb
+- lib/ruql/renderers/edxml_renderer.rb
+- lib/ruql/renderers/html5_renderer.rb
+- lib/ruql/renderers/html_form_renderer.rb
+- lib/ruql/renderers/json_renderer.rb
+- lib/ruql/renderers/qualtrics_renderer.rb
+- lib/ruql/renderers/xml_renderer.rb
+- lib/ruql/select_multiple.rb
+- lib/ruql/tex_output.rb
+- lib/ruql/true_false.rb
+- templates/autoqcm.tex.erb
+- templates/html5.html.erb
+- templates/htmlform.html.erb
+homepage: http://github.com/saasbook/ruql
+licenses:
+- CC By-SA
+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
+signing_key: 
+specification_version: 4
+summary: Ruby question language
+test_files: []