ruql 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a6637987324f5db32e7387b7183ea4591957817
-  data.tar.gz: 05dc9bbffafb43de71688bbbd1a0b70302d51665
+  metadata.gz: c4e1dbaefe63c93236938687254c7eb6dcaf0bc3
+  data.tar.gz: 8dfd7eaac4c4f363ed8bf83be5f72d1c428a117e
 SHA512:
-  metadata.gz: bd17352a49b61a9b0844cb0d043093c3ba8fe33ba302ac83aac60cb602a4f534074f7c02c4dd0f0772d301232dd360c57d997ddd6fd67ac171172983b0e8c93b
-  data.tar.gz: 2f34ee1cd6b63f9f81ccd6bafecc7864143d4512d127d1a5740e035f73d9cf5c83abd68bd0eda6b232837bb1a68e60223977ca38920c9a8926b1d167779fd25d
+  metadata.gz: d859ea182e95f44111181c4e61c4cdb69320cde8ae30af8bdd446bc7f3c89d797cbdcc9e36628976f2c1d8f5a8f6a6a9aea67a19db2aecc47a01896325d0ce46
+  data.tar.gz: 35f46ed721d7987109cc7f187b3ca531ebe953736576c6dbf9607a793ace9d72d0c8b151bed950ad960415f2fe79c12a51260d24e58c1c8eabd74ee40f348bc8

data/bin/ruql

@@ -19,14 +19,27 @@ renderer choices are:
   Qualtrics -[partially implemented] Qualtrics survey (txt) format
 
 Global options:
+  -r <file>, --report=<file>
+     Write to <file> a 4-line report of #points, #questions, and first and last
+     question#. Especially useful in conjunction with the -a/--start option.
+  -a <first>, --start=<first>
+      Sets the starting ordinal value (1=first) for question numbering. Default 1.
+      If a filename is given, looks for a line of the form "last NN" and
+      starts at the number following NN.
   -l <loglevel>, --log=<loglevel>
      In increasing verbosity, they are 'error' (nonfatal), 'warn', 'info',
      'debug'; default is 'warn'
-  -p <penalty>, --penalty <penalty>
-     The penalty for WRONG answers, as a fraction of the penalty for
-     RIGHT answers.  For a 2-point question, penalty=0.25 means 1/2 point
-     (0.25 * 2) deducted for WRONG answer.  Default is 0.  Not all
-     output formats are able to do something useful with this.
+  -p <points>, --points-threshold <points>
+     If a question's point value is more than <points> (default: 0), include
+     the string "[N points]" at the beginning of the question text.  Make this a
+     large number to avoid any points info being printed.
+  -P <points-string>, --points-string <points-string>  
+     String for formatting the points description prepended to the question text,
+     with %d as a placeholder for the point value and %s as a placeholder for
+     pluralizing the word 'points' or whatever.  Default is "[%d point%s]".
+  -R, --no-randomize
+     Present the answer choices in the order they appear in the RuQL file(s),
+     even for questions that have :randomize => true.
 
 The EdXML renderer supports these options:
   -n <name>, --name=<name>
@@ -42,10 +55,8 @@ The EdXML renderer supports these options:
 
 The HTML5 and HTML Forms renderers supports these options:
   -o <type>, --list-type=<type>
-  -a <first>, --list-start=<first>
-      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.
+      Sets the type of HTML list to use for answer choices: 'u' for unordered
+      (<ul>) or 'o' for ordered (<ol>).  Default is 'o'.
   -j <src>, --js=<src>
       embed <src> for JavaScript
   -t <file.html.erb>, --template=<file.html.erb>
@@ -74,7 +85,7 @@ The JSON renderer currently supports no options
 
 The Qualtrics renderer supports these options:
   -t <file.txt.erb>, --template=<file.txt.erb>
-  The file should have <%= yield %> where questions should go. Since this just creates survey questions, grading information is ignored.Currently supports the same type of questions as the AutoQCM renderer.
+  The file should have <%= yield %> where questions should go. Since this just creates survey questions, grading information is ignored. Currently supports the same type of questions as the AutoQCM renderer.
 
 eos
   exit
@@ -88,13 +99,17 @@ def main
 
   opts = Getopt::Long.getopts(
     ['-o', '--list-type', Getopt::REQUIRED],
-    ['-a', '--list-start', Getopt::REQUIRED],
+    ['-r', '--report', Getopt::REQUIRED],
+    ['-a', '--start', Getopt::REQUIRED],
     ['-c', '--css', Getopt::REQUIRED],
     ['-j', '--js', Getopt::REQUIRED],
     ['-t', '--template', Getopt::REQUIRED],
     ['-s', '--solutions', Getopt::BOOLEAN],
     ['-n', '--name', Getopt::REQUIRED],
     ['-l', '--log', Getopt::REQUIRED],
+    ['-P', '--points-string', Getopt::REQUIRED],
+    ['-p', '--points-threshold', Getopt::REQUIRED],
+    ['-R', '--no-randomize', Getopt::BOOLEAN],
     ['-y', '--yaml', Getopt::REQUIRED]
   )
   Quiz.instance_eval "#{IO.read(filename)}"

data/lib/ruql/quiz.rb

@@ -22,12 +22,17 @@ class Quiz
 
   attr_reader :renderer
   attr_reader :questions
+  attr_reader :first_question_number
   attr_reader :options
   attr_reader :output
+  attr_reader :suppress_random
   attr_reader :seed
   attr_reader :logger
+  attr_reader :points_threshold
+  attr_reader :points_string
   attr_accessor :title, :quizzes
 
+
   def initialize(title, options={})
     @output = ''
     @questions = options.delete(:questions) || []
@@ -42,14 +47,41 @@ class Quiz
     end
   end
 
+  def get_first_question_number(spec)
+    return 1 if spec.nil?
+    return $1.to_i if spec =~ /^(\d+)$/
+    # file?
+    begin
+      File.readlines(spec).each do |f|
+        return 1 + $1.to_i if f =~ /^last\s+(\d+)/
+      end
+      return 1
+    rescue StandardError => e
+      warn "Warning: starting question numbering at 1, cannot read #{spec}: #{e.message}"
+      return 1
+    end
+  end
+
   def self.get_renderer(renderer)
     Object.const_get(renderer.to_s + 'Renderer') rescue nil
   end
 
   def render_with(renderer,options={})
     srand @seed
+    @first_question_number = get_first_question_number(options.delete('a'))
+    @points_threshold = (options.delete('p') || 0).to_i
+    @points_string = options.delete('P') || "[%d point%s]"
+    @suppress_random = !!options['R']
     @renderer = Quiz.get_renderer(renderer).send(:new,self,options)
     @renderer.render_quiz
+    if (report = options.delete('r'))
+      File.open(report, "w") do |f|
+        f.puts "questions #{num_questions}"
+        f.puts "first #{first_question_number}"
+        f.puts "last #{first_question_number + num_questions - 1}"
+        f.puts "points #{self.points}"
+      end
+    end
     @output = @renderer.output
   end
 
@@ -57,6 +89,12 @@ class Quiz
 
   def num_questions ; questions.length ; end
 
+  def point_string(points)
+    points >= points_threshold ?
+    sprintf(points_string.to_s, points, (points > 1 ? 's' : '')) :
+      ''
+  end
+
   def random_seed(num)
     @seed = num.to_i
   end

data/lib/ruql/renderers/html5_renderer.rb

@@ -10,8 +10,8 @@ class Html5Renderer
       options.delete('template') ||
       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'
+    @list_type = (options.delete('o') || options.delete('list-type') || 'o')[0] + "l"
+    @list_start = quiz.first_question_number
     @quiz = quiz
     @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
   end
@@ -34,7 +34,7 @@ class Html5Renderer
     
   def render_questions
     render_random_seed
-    @h.ol :class => 'questions', :type => @list_type, :start => @list_start do
+    @h.ol :class => 'questions', :start => @list_start do
       @quiz.questions.each_with_index do |q,i|
         case q
         when MultipleChoice, SelectMultiple, TrueFalse then render_multiple_choice(q,i)
@@ -51,10 +51,10 @@ class Html5Renderer
     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 }
+        elsif q.randomize && !@quiz.suppress_random then q.answers.sort_by { rand }
         else q.answers
         end
-      @h.ol :class => 'answers' do
+      @h.__send__(@list_type, :class => 'answers') do
         answers.each do |answer|
           if @show_solutions
             render_answer_for_solutions(answer, q.raw?, q.class == TrueFalse)
@@ -123,8 +123,8 @@ class Html5Renderer
         @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 <<
+        qtext = @quiz.point_string(question.points) << ' ' <<
+          ('Select <b>all</b> that apply: ' if question.multiple).to_s <<
           if question.class == FillIn then question.question_text.gsub(/\-+/, '_____________________________')
           else question.question_text
           end

metadata

@@ -1,85 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: ruql
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+  type: :runtime
   prerelease: false
-  name: builder
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: getopt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+  type: :runtime
   prerelease: false
-  name: getopt
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+  type: :development
   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
+  requirement: !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
+        version: '4.0'
 description: Ruby-embedded DSL for creating short-answer quiz questions
 email: fox@cs.berkeley.edu
 executables:
@@ -115,7 +101,7 @@ files:
 - templates/htmlform.html.erb
 homepage: http://github.com/saasbook/ruql
 licenses:
-- CC By-SA
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -123,17 +109,17 @@ 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: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby question language