ruqlcqb 0.0.0

data/lib/ruql/renderers/edxml_renderer.rb

@@ -0,0 +1,74 @@
+class EdXmlRenderer
+  require 'builder'
+
+  attr_reader :output
+  def initialize(quiz,options={})
+    @only_question = options.delete('n') || options.delete('name')
+    @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.
+    question_list = if @only_question
+                    then @quiz.questions.select { |q| q.name == @only_question }
+                    else @quiz.questions
+                    end
+    question_list.each { |question| render(question) }
+    @output
+  end
+
+  def render_fill_in(question)
+    raise "Not yet implemented for edXML"
+  end
+
+  def render_multiple_choice(question)
+    @b.problem do
+      # if question text has explicit newlines, use them to separate <p>'s
+      if question.raw?
+        @b.p { |p| p << question.question_text }
+      else
+        question.question_text.lines.map(&:chomp).each do |line|
+          if question.raw? then @b.p { |p| p << line } else @b.p(line) end
+        end
+      end
+      @b.multiplechoiceresponse do
+        @b.choicegroup :type => 'MultipleChoice' do
+          question.answers.each do |answer|
+            if question.raw?
+              @b.choice(:correct => answer.correct?) do |choice|
+                choice << answer.answer_text
+                choice << "\n"
+              end
+            else
+              @b.choice answer.answer_text, :correct => answer.correct?
+            end
+          end
+        end
+      end
+      @b.solution do
+        @b.div :class => 'detailed_solution' do
+          @b.p 'Explanation'
+          if question.raw?
+            @b.p { |p| p << question.correct_answer.explanation }
+          else
+            @b.p question.correct_answer.explanation
+          end
+        end
+      end
+    end
+  end
+
+end
+

data/lib/ruql/renderers/html5_renderer.rb

@@ -0,0 +1,166 @@
+class Html5Renderer
+  require 'builder'
+  require 'erb'
+  
+  attr_reader :output
+
+  def initialize(quiz,options={})
+    @css = options.delete('c') || options.delete('css')
+    @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/html5.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
+        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
+    # 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.ol :class => 'questions' do
+      @quiz.questions.each_with_index do |q,i|
+        case q
+        when MultipleChoice, SelectMultiple, TrueFalse then render_multiple_choice(q,i)
+        when FillIn then render_fill_in(q, i)
+        else
+          raise "Unknown question type: #{q}"
+        end
+      end
+    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?, q.class == TrueFalse)
+          else
+            if q.raw? then @h.li { |l| l << answer.answer_text } else @h.li answer.answer_text end
+          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,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?
+        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
+            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/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/lib/ruql/renderers/json_renderer.rb

@@ -0,0 +1,15 @@
+class JSONRenderer
+  require 'json'
+
+  attr_reader :output
+
+  def initialize(quiz,options={})
+    @output = ''
+    @json_array = []
+    @quiz = quiz
+  end
+
+  def render_quiz
+    @output = @quiz.questions.map {|question| JSON.pretty_generate(question.to_JSON)}
+  end
+end