ruql 0.0.2 → 0.0.4

data/bin/ruql

@@ -4,17 +4,18 @@ require 'ruql'
 require 'getopt/long'
 
 def usage
-  name = $0.gsub( Regexp.new '^[^/]+/', '')
+  name = File.basename $0
   STDERR.puts <<eos
 Usage: #{name} filename.rb renderer [options]
 filename.rb contains questions expressed in RuQL
 
 renderer choices are:
-  Html5   - HTML 5 suitable for Web display/printing
-  EdXml   - XML for OpenEdX platform in-course questions
-  AutoQCM - LaTeX for use with AutoQCM (http://home.gna.org/auto-qcm)
-  Coursera- [obsolete] Coursera HTML/XML format for online auto-grading
-  JSON    - [partially implemented] JSON format
+  Html5    - HTML 5 suitable for Web display/printing
+  HtmlForm - HTML forms
+  EdXml    - XML for OpenEdX platform in-course questions
+  AutoQCM  - LaTeX for use with AutoQCM (http://home.gna.org/auto-qcm)
+  Coursera - [obsolete] Coursera HTML/XML format for online auto-grading
+  JSON     - [partially implemented] JSON format
 
 Global options:
   -l <loglevel>, --log=<loglevel>
@@ -35,9 +36,11 @@ The EdXML renderer supports these options:
   NOTE: The 'points' and 'randomize' attributes of questions are not honored by
      some systems.
 
-The HTML5 renderer supports these options:
+The HTML5 and HTML Forms renderers supports these options:
   -c <href>, --css=<href>
       embed <href> for stylesheet into generated HTML5
+  -j <src>, --js=<src>
+      embed <src> for JavaScrips
   -t <file.html.erb>, --template=<file.html.erb>
       Use file.html.erb as HTML template rather than generating our own file.
       file.html.erb should have <%= yield %> where questions should go.
@@ -72,6 +75,7 @@ def main
   raise "Unknown renderer '#{renderer}'" unless Quiz.get_renderer(renderer)
   opts = Getopt::Long.getopts(
     ['-c', '--css', Getopt::REQUIRED],
+    ['-j', '--js', Getopt::REQUIRED],
     ['-t', '--template', Getopt::REQUIRED],
     ['-s', '--solutions', Getopt::BOOLEAN],
     ['-n', '--name', Getopt::REQUIRED],

data/lib/ruql.rb

@@ -7,6 +7,7 @@ $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__)))
 # renderers
 require 'ruql/renderers/xml_renderer'
 require 'ruql/renderers/html5_renderer'
+require 'ruql/renderers/html_form_renderer'
 require 'ruql/renderers/edxml_renderer'
 require 'ruql/renderers/auto_qcm_renderer'
 require 'ruql/renderers/json_renderer'

data/lib/ruql/renderers/html5_renderer.rb

@@ -68,7 +68,7 @@ class Html5Renderer
       @h.ol :class => 'answers' do
         answers.each do |answer|
           if @show_solutions
-            render_answer_for_solutions(answer, q.raw?)
+            render_answer_for_solutions(answer, q.raw?, q.class == TrueFalse)
           else
             if q.raw? then @h.li { |l| l << answer.answer_text } else @h.li answer.answer_text end
           end
@@ -104,8 +104,12 @@ class Html5Renderer
     end
   end
 
-  def render_answer_for_solutions(answer,raw)
+  def render_answer_for_solutions(answer,raw,is_true_false = nil)
     args = {:class => (answer.correct? ? 'correct' : 'incorrect')}
+    if is_true_false 
+      answer.answer_text.prepend(
+        answer.correct? ? "CORRECT: " : "INCORRECT: ")
+    end
     @h.li(args) do
       if raw then @h.p { |p| p << answer.answer_text } else @h.p answer.answer_text  end
       if answer.has_explanation?

data/lib/ruql/renderers/html_form_renderer.rb

@@ -0,0 +1,198 @@
+class HtmlFormRenderer
+  require 'builder'
+  require 'erb'
+  
+  attr_reader :output
+
+  def initialize(quiz,options={})
+    @css = options.delete('c') || options.delete('css')
+    @js = options.delete('j') || options.delete('js')
+    @show_solutions = options.delete('s') || options.delete('solutions')
+    @template = options.delete('t') ||
+      options.delete('template') #||
+      #File.join(Gem.loaded_specs['ruql'].full_gem_path, 'templates/htmlform.html.erb')
+    @output = ''
+    @quiz = quiz
+    @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
+  end
+
+  def render_quiz
+    if @template
+      render_with_template do
+        render_questions
+        @output
+      end
+    else
+      @h.html do
+        @h.head do
+          @h.title @quiz.title
+          @h.link(:rel => 'stylesheet', :type =>'text/css', :href =>@css) if @css
+          @h.script(:type => 'text/javascript', :src => @js) do
+          end if @js
+        end
+        @h.body do
+          render_questions
+        end
+      end
+    end
+    self
+  end
+
+  def render_with_template
+    # local variables that should be in scope in the template 
+    quiz = @quiz
+    title = "Quiz" unless @title
+    # the ERB template includes 'yield' where questions should go:
+    output = ERB.new(IO.read(File.expand_path @template)).result(binding)
+    @output = output
+  end
+    
+  def render_questions
+    render_random_seed
+    @h.form do
+      @h.ol :class => 'questions' do
+        @quiz.questions.each_with_index do |q,i|
+          case q
+          when SelectMultiple then render_select_multiple(q,i)
+          when MultipleChoice, TrueFalse then render_multiple_choice(q,i)
+          when FillIn then render_fill_in(q, i)
+          else
+            raise "Unknown question type: #{q}"
+          end
+        end
+      end
+      @h.input(:type => 'submit', :value => 'Enviar')
+    end
+  end
+
+
+  def render_multiple_choice(q,index)
+    render_question_text(q, index) do
+      answers =
+        if q.class == TrueFalse then q.answers.sort.reverse # True always first
+        elsif q.randomize then q.answers.sort_by { rand }
+        else q.answers
+        end
+      @h.ol :class => 'answers' do
+        answers.each do |answer|
+          if @show_solutions
+            render_answer_for_solutions(answer, q.raw?)
+          else
+            #if q.raw? then @h.li { |l| l << answer.answer_text } else @h.li answer.answer_text end
+            @h.input(:type => 'radio', :name => 'a', :class => 'select') { |p| 
+              p << answer.answer_text
+              p << '</br>'
+            }
+          end
+        end
+      end
+    end
+    self
+  end
+
+  def render_select_multiple(q,index)
+    render_question_text(q, index) do
+      answers =
+        if q.randomize then q.answers.sort_by { rand }
+    else q.answers
+    end
+    @h.ol :class => 'answers' do
+      answers.each do |answer|
+        if @show_solutions
+          render_answer_for_solutions(answer, q.raw?)
+        else
+          #if q.raw? then @h.li { |l| l << answer.answer_text } else @h.li answer.answer_text end
+          @h.input(:type => 'checkbox', :name => 'b', :class => 'check') { |p| 
+            p << answer.answer_text
+            p << '</br>'
+          }
+        end
+      end
+    end
+  end
+  self
+  end
+  
+  def render_fill_in(q, idx)
+    render_question_text(q, idx) do
+      if @show_solutions
+        answer = q.answers[0]
+        if answer.has_explanation?
+          if q.raw? then @h.p(:class => 'explanation') { |p| p << answer.explanation }
+          else @h.p(answer.explanation, :class => 'explanation') end
+        end
+        answers = (answer.answer_text.kind_of?(Array) ? answer.answer_text : [answer.answer_text])
+        @h.ol :class => 'answers' do
+          answers.each do |answer|
+            if answer.kind_of?(Regexp)
+              answer = answer.inspect
+              if !q.case_sensitive
+                answer += 'i'
+              end
+            end
+            @h.li do
+              if q.raw? then @h.p { |p| p << answer } else @h.p answer end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def render_answer_for_solutions(answer,raw)
+    args = {:class => (answer.correct? ? 'correct' : 'incorrect')}
+    @h.li(args) do
+      if raw then @h.p { |p| p << answer.answer_text } else @h.p answer.answer_text  end
+      if answer.has_explanation?
+        if raw then @h.p(:class => 'explanation') { |p| p << answer.explanation }
+        else @h.p(answer.explanation, :class => 'explanation') end
+      end
+    end
+  end
+
+  def render_question_text(question,index)
+    html_args = {
+      :id => "question-#{index}",
+      :class => ['question', question.class.to_s.downcase, (question.multiple ? 'multiple' : '')]
+        .join(' ')
+    }
+    @h.li html_args  do
+      @h.div :class => 'text' do
+        qtext = "[#{question.points} point#{'s' if question.points>1}] " <<
+          ('Select ALL that apply: ' if question.multiple).to_s <<
+          if question.class == FillIn then question.question_text.gsub(/\-+/, '')
+          else question.question_text
+          end
+        #if question.raw?
+        #  @h.p { |p| p << qtext }
+        #else
+          qtext.each_line do |p|
+            @h.p do |par|
+              par << p # preserves HTML markup
+              @h.input(:type => 'text', :class => 'fillin') if (question.class == FillIn)
+            end
+          end
+        #end
+      end
+      yield # render answers
+    end
+    self
+  end
+
+  def quiz_header
+    @h.div(:id => 'student-name') do
+      @h.p 'Name:'
+      @h.p 'Student ID:'
+    end
+    if @quiz.options[:instructions]
+      @h.div :id => 'instructions' do
+        @quiz.options[:instructions].each_line { |p| @h.p p }
+      end
+    end
+    self
+  end
+
+  def render_random_seed
+    @h.comment! "Seed: #{@quiz.seed}"
+  end
+end

data/templates/html5.html.erb

@@ -6,13 +6,11 @@
     .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.question { page-break-inside: avoid; border-bottom: 1px solid grey;  }
     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 }
+    .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; }

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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruql
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -63,10 +63,12 @@ files:
 - 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/xml_renderer.rb
 - templates/autoqcm.tex.erb
 - templates/html5.html.erb
+- templates/htmlform.html.erb
 - bin/ruql
 homepage: http://github.com/saasbook/ruql
 licenses: