ruql 0.1.5 → 1.0.1

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

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

data/lib/ruql/stats.rb

@@ -0,0 +1,18 @@
+module Ruql
+  class Stats
+    attr_reader :output, :quiz
+    # a pseudo-renderer that just prints stats about the quiz
+    def initialize(quiz, options={})
+      @quiz = quiz
+      @output = []
+    end
+    def render_quiz
+      @output << "%3d questions" % quiz.questions.length
+      @output << "    %3d (%d points) in no group" % [quiz.ungrouped_questions.length, quiz.ungrouped_points]
+      @output << "    %3d (%d points) in %d groups" % [quiz.grouped_questions.length, quiz.grouped_points, quiz.groups.length]
+      @output << "%3d effective questions on quiz" % quiz.num_questions
+      @output << "%3d max points possible" % quiz.points
+      @output.join("\n")
+    end
+  end
+end

data/lib/ruql/true_false.rb

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

data/lib/ruql/version.rb

@@ -0,0 +1,3 @@
+module Ruql
+  VERSION = '1.0.1'
+end

data/ruql.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ruql/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ruql'
+  s.version     = Ruql::VERSION
+  s.summary     = "Ruby question language"
+  s.description = "Ruby-embedded DSL for creating short-answer quiz questions"
+  s.authors     = ["Armando Fox"]
+  s.email       = 'fox@berkeley.edu'
+  s.homepage    = 'http://github.com/saasbook/ruql'
+  s.license       = 'CC By-SA'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if s.respond_to?(:metadata)
+    s.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    s.metadata["homepage_uri"] = s.homepage
+    s.metadata["source_code_uri"] = s.homepage
+    #s.metadata["changelog_uri"] = ''
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  s.executables << 'ruql'
+
+  s.require_paths= ['lib']
+
+  s.add_development_dependency "bundler", "~> 1.17"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec_its"
+end

metadata

@@ -1,79 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: ruql
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.17'
+  type: :development
   prerelease: false
-  name: builder
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
+        version: '1.17'
 - !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '10.0'
+  type: :development
   prerelease: false
-  name: getopt
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '10.0'
 - !ruby/object:Gem::Dependency
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
+  type: :development
   prerelease: false
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
+  type: :development
   prerelease: false
-  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  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: fox@cs.berkeley.edu
+email: fox@berkeley.edu
 executables:
 - ruql
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
 - bin/ruql
+- bin/setup
+- examples/estilo.css
+- examples/example.rb
+- examples/file.html
+- examples/help.txt
+- examples/preguntas-TFG-20140224-0050.txt
+- examples/preguntas-TFG-20140224-0050.xml
+- examples/prueba.js
 - lib/ruql.rb
 - lib/ruql/answer.rb
 - lib/ruql/dropdown.rb
@@ -93,33 +122,36 @@ 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/stats.rb
 - lib/ruql/tex_output.rb
 - lib/ruql/true_false.rb
-- templates/autoqcm.tex.erb
-- templates/html5.html.erb
-- templates/htmlform.html.erb
+- lib/ruql/version.rb
+- ruql.gemspec
 homepage: http://github.com/saasbook/ruql
 licenses:
-- MIT
-metadata: {}
+- CC By-SA
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/saasbook/ruql
+  source_code_uri: http://github.com/saasbook/ruql
 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.2.5
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby question language

data/templates/autoqcm.tex.erb

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

data/templates/html5.html.erb

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