ruql 0.0.9 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4efcebefa4b89ca759cce170acace5355feaeefd
-  data.tar.gz: d7ab50a7a43b935ec9fbba0919f039b00c843b3d
+  metadata.gz: 8a6637987324f5db32e7387b7183ea4591957817
+  data.tar.gz: 05dc9bbffafb43de71688bbbd1a0b70302d51665
 SHA512:
-  metadata.gz: 149a8f650812e0d3e6be26670448d4d56388c0847cbfc3a901504ee91af388dc349e47fb7aef116da0634a64d11ca2803674f400814f223c8ed07d5f85cdd164
-  data.tar.gz: efb47e061b140a3bca3f1cc8001631e2bf08b5c342c5225a663455b62922e6e05e41f74ca2e388fcc6f37ea25de3561c383851206647ea9d68958c0db7dfa40c
+  metadata.gz: bd17352a49b61a9b0844cb0d043093c3ba8fe33ba302ac83aac60cb602a4f534074f7c02c4dd0f0772d301232dd360c57d997ddd6fd67ac171172983b0e8c93b
+  data.tar.gz: 2f34ee1cd6b63f9f81ccd6bafecc7864143d4512d127d1a5740e035f73d9cf5c83abd68bd0eda6b232837bb1a68e60223977ca38920c9a8926b1d167779fd25d

data/bin/ruql

@@ -15,7 +15,6 @@ renderer choices are:
   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
   Qualtrics -[partially implemented] Qualtrics survey (txt) format
 
@@ -39,7 +38,7 @@ The EdXML renderer supports these options:
      some systems.
 
   -y <file.yml>, --yaml=<file.yml>
-      Render the questions with a specific yaml file.
+      Render open-assessment questions using info in given Yaml file.
 
 The HTML5 and HTML Forms renderers supports these options:
   -o <type>, --list-type=<type>
@@ -47,14 +46,13 @@ The HTML5 and HTML Forms renderers supports these options:
       Sets the values of the 'start' and 'type' attributes for the HTML <ol>
       element.  Type should be one of 1,a,A,i,I.  Start should always be
       a number indicating the ordinal value (starting from 1) of first item.
-  -c <href>, --css=<href>
-      embed <href> for stylesheet into generated HTML5
   -j <src>, --js=<src>
       embed <src> for JavaScript
   -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.
-      An example is in the templates/ directory of RuQL.
+      The default template in the templates/ directory of RuQL will be used
+      if this option is not given.
       The following local variables will be replaced with their values in
       the template:
         <%= quiz.title %> - the quiz title
@@ -99,11 +97,9 @@ def main
     ['-l', '--log', Getopt::REQUIRED],
     ['-y', '--yaml', Getopt::REQUIRED]
   )
-  Quiz.set_yaml_file opts.delete("y") || opts.delete("yaml")
   Quiz.instance_eval "#{IO.read(filename)}"
   Quiz.quizzes.each { |quiz| puts quiz.render_with(renderer, opts)  }
 end
 
 usage if ARGV.length < 2
 main
-

data/lib/ruql/answer.rb

@@ -1,6 +1,6 @@
 class Answer
   include Comparable
-  attr_accessor :answer_text, :explanation
+  attr_accessor :answer_text, :explanation, :correct
   attr_reader :correct
   attr_reader :builder
   attr_reader :question
@@ -8,9 +8,21 @@ class Answer
   def <=>(other) ; self.answer_text <=> other.answer_text ; end
   def correct? ; !!correct ; end
   def has_explanation? ; !!explanation ; end
-  def initialize(answer_text, correct, explanation=nil)
+  def initialize(answer_text = '', correct = false, explanation=nil)
     @answer_text = answer_text
     @correct = !!correct # ensure boolean
     @explanation = explanation
   end
+  
+  def to_JSON
+    Hash[instance_variables.collect { |var| [var.to_s.delete('@'), instance_variable_get(var)] }]
+  end
+
+  def self.from_JSON(hash)
+    answer = Answer.new
+    hash.each do |key, value|
+      answer.send((key + '=').to_sym, value)
+    end
+    answer
+  end
 end

data/lib/ruql/multiple_choice.rb

@@ -1,10 +1,10 @@
 class MultipleChoice < Question
-
   attr_accessor :multiple
   
   def initialize(text='', opts={})
     super
     self.question_text = text
+    
     self.multiple =  !!opts[:multiple]
     self.randomize = !!opts[:randomize]  
   end

data/lib/ruql/open_assessment/open_assessment.rb

@@ -115,7 +115,7 @@ class OpenAssessment
   # Adds fields for a simple_open_assessment question
   def add_simple_question
     criterion = Criterion.new
-    criterion.name("How'd you do?")
+    criterion.name("How'd you do?") # "
     criterion.label("Scoring Rubric")
 
     raise "Must have answer for question" if @question_answer.nil?

data/lib/ruql/question.rb

@@ -1,24 +1,40 @@
 class Question
-  attr_accessor :question_text, :answers, :randomize, :points, :name, :question_tags, :question_comment
-
+  attr_accessor :question_text, 
+                :answers, 
+                :question_image,
+                :randomize, 
+                :points, 
+                :name, 
+                :question_tags, 
+                :question_uid, 
+                :question_comment, 
+                :raw
+  
   def initialize(*args)
     options = if args[-1].kind_of?(Hash) then args[-1] else {} end
     @answers = options[:answers] || []
     @points = [options[:points].to_i, 1].max
     @raw = options[:raw]
     @name = options[:name]
+    @question_image = options[:image]
     @question_tags = []
+    @question_uid = (options.delete(:uid) || SecureRandom.uuid).to_s
     @question_comment = ''
   end
-
   def raw? ; !!@raw ; end
-
+  
+  def uid(u) ; @question_uid = u ; end
+  
   def text(s) ; @question_text = s ; end
 
   def explanation(text)
     @answers.each { |answer| answer.explanation ||= text }
   end
 
+  def image(url)
+    @question_image = url
+  end
+  
   def answer(text, opts={})
     @answers << Answer.new(text, correct=true, opts[:explanation])
   end
@@ -44,4 +60,30 @@ class Question
 
   def correct_answers ;  @answers.collect(&:correct?) ; end
 
+  def answer_helper(obj)
+    if obj.is_a? Array and obj.size and obj[0].is_a? Answer
+      return obj.map {|answer| answer.to_JSON}
+    end
+    obj
+  end
+
+  #creates a JSON hash of the object with its object name. we should convert this to a mixin for answer and question. aaron
+  def to_JSON
+      h = Hash[instance_variables.collect { |var| [var.to_s.delete('@'), answer_helper(instance_variable_get(var))] }]
+      h['question_type'] = self.class.to_s
+      return h
+  end
+
+  #factory method to return correct type of question
+  def self.from_JSON(hash_str)
+    hash = JSON.parse(hash_str)
+    #create the appropriate class of the object from the hash's class name
+    question = Object.const_get(hash.fetch('question_type')).new()
+    hash.reject{|key| key == 'answers' or key == 'question_type'}.each do |key, value|
+      question.send((key + '=').to_sym, value)
+    end
+    question.answers = hash['answers'].map{|answer_hash| Answer.from_JSON(answer_hash)}
+    question
+  end
+
 end

data/lib/ruql/quiz.rb

@@ -1,6 +1,5 @@
 class Quiz
   @@quizzes = []
-  @@yaml_file = nil
   @quiz_yaml = {}
   def self.quizzes ; @@quizzes ;  end
   @@default_options =
@@ -27,18 +26,20 @@ class Quiz
   attr_reader :output
   attr_reader :seed
   attr_reader :logger
-  attr_accessor :title
+  attr_accessor :title, :quizzes
 
-  def initialize(title, yaml, options={})
+  def initialize(title, options={})
     @output = ''
-    @questions = options[:questions] || []
+    @questions = options.delete(:questions) || []
     @title = title
     @options = @@default_options.merge(options)
     @seed = srand
     @logger = Logger.new(STDERR)
     @logger.level = Logger.const_get (options.delete('l') ||
                                       options.delete('log') || 'warn').upcase
-    @quiz_yaml = yaml
+    if (yaml = options.delete(:yaml))
+      @quiz_yaml = YAML::load(IO.read yaml)
+    end
   end
 
   def self.get_renderer(renderer)
@@ -52,10 +53,6 @@ class Quiz
     @output = @renderer.output
   end
 
-  def self.set_yaml_file(file)
-    @@yaml_file = file &&  YAML::load_file(file)
-  end
-
   def points ; questions.map(&:points).inject { |sum,points| sum + points } ; end
 
   def num_questions ; questions.length ; end
@@ -130,7 +127,7 @@ class Quiz
   end
 
   def self.quiz(*args, &block)
-    quiz = Quiz.new(*args, (@@yaml_file.shift if @@yaml_file))
+    quiz = Quiz.new(*args)
     quiz.instance_eval(&block)
     @@quizzes << quiz
   end

data/lib/ruql/renderers/edxml_renderer.rb

@@ -4,7 +4,7 @@ require 'yaml'
 class EdXmlRenderer
 
   attr_reader :output
-  attr_accessor :file, :yaml_file
+  attr_accessor :file
   def initialize(quiz,options={})
     @only_question = options.delete('n') || options.delete('name')
     @output = ''

data/lib/ruql/renderers/html5_renderer.rb

@@ -5,11 +5,10 @@ class Html5Renderer
   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')
+      File.join(File.dirname(__FILE__), '../../../templates/html5.html.erb')
     @output = ''
     @list_type = options.delete('o') || options.delete('list-type') || '1'
     @list_start = options.delete('a') || options.delete('list-start') || '1'
@@ -18,21 +17,9 @@ class Html5Renderer
   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
+    render_with_template do
+      render_questions
+      @output
     end
     self
   end
@@ -124,10 +111,17 @@ class Html5Renderer
   def render_question_text(question,index)
     html_args = {
       :id => "question-#{index}",
-      :class => ['question', question.class.to_s.downcase, (question.multiple ? 'multiple' : '')]
-        .join(' ')
+      :'data-uid' => question.question_uid,
+      :class => ['question', question.class.to_s.downcase, (question.multiple ? 'multiple' : '')].join(' ')
     }
+    if question.question_image           # add CSS class to both <li> and <img>
+      html_args[:class] << 'question-with-image'
+    end
     @h.li html_args  do
+      # if there's an image, render it first
+      if question.question_image
+        @h.img :src => question.question_image, :class => 'question-image'
+      end
       @h.div :class => 'text' do
         qtext = "[#{question.points} point#{'s' if question.points>1}] " <<
           ('Select ALL that apply: ' if question.multiple).to_s <<

data/lib/ruql/renderers/json_renderer.rb

@@ -10,40 +10,6 @@ class JSONRenderer
   end
 
   def render_quiz
-    @quiz.questions.each do |question|
-      case question
-      when MultipleChoice, SelectMultiple, TrueFalse then render_multiple_choice(question)
-      when FillIn then render_fill_in(question) # not currently supported
-      else
-        raise "Unknown question type: #{question}"
-      end
-    end
-    @output = JSON.pretty_generate(@json_array)
+    @output = @quiz.questions.map {|question| JSON.pretty_generate(question.to_JSON)}
   end
-
-  def render_multiple_choice(question)
-    question_hash = {
-      "text" => question.question_text,
-      "answers" => answers_to_json_array(question.answers)
-    }
-    @json_array.push(question_hash)
-  end
-
-  def answers_to_json_array(answers)
-    answers_array = []
-    answers.each do |answer|
-      answer_json = {
-        "text" => answer.answer_text,
-        "explanation" => answer.explanation,
-        "correct" => answer.correct
-      }
-      answers_array.push(answer_json)
-    end
-    answers_array
-  end
-
-  def render_fill_in(q)
-    # fill-in-the-blank questions not currently supported
-  end
-
 end

data/lib/ruql/select_multiple.rb

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

data/lib/ruql/true_false.rb

@@ -1,6 +1,6 @@
 class TrueFalse < Question
 
-  def initialize(text, correct_answer, opts=nil)
+  def initialize(text='', correct_answer=false, opts=nil)
     super
     opts ||= {}
     opts[:explanation] ||= ''

data/lib/ruql.rb

@@ -6,13 +6,7 @@ require 'date'
 $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'
-require 'ruql/renderers/qualtrics_renderer'
+Dir[File.join(File.dirname(__FILE__),'ruql/renderers/*.rb')].each { |file| require file }
 
 # question types
 require 'ruql/quiz'

metadata

@@ -1,43 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ruql
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.3
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   prerelease: false
   name: builder
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.0'
   prerelease: false
   name: getopt
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.0'
   type: :runtime
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  prerelease: false
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  prerelease: false
+  name: activesupport
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: byebug
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
 description: Ruby-embedded DSL for creating short-answer quiz questions
 email: fox@cs.berkeley.edu
 executables:
@@ -65,7 +107,6 @@ files:
 - 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

data/lib/ruql/renderers/xml_renderer.rb

@@ -1,148 +0,0 @@
-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
-