ruql 0.0.8 → 1.0.1

data/lib/ruql/quiz.rb

@@ -2,24 +2,8 @@ class Quiz
   @@quizzes = []
   @@yaml_file = nil
   @quiz_yaml = {}
+  @@options = {}
   def self.quizzes ; @@quizzes ;  end
-  @@default_options =
-    {
-    :open_time => Time.now,
-    :soft_close_time => Time.now + 24*60*60,
-    :hard_close_time => Time.now + 24*60*60,
-    :maximum_submissions => 1,
-    :duration => 3600,
-    :retry_delay => 600,
-    :parameters =>  {
-      :show_explanations => {
-        :question => 'before_soft_close_time',
-        :option => 'before_soft_close_time',
-        :score => 'before_soft_close_time',
-      }
-    },
-    :maximum_score => 1,
-  }
 
   attr_reader :renderer
   attr_reader :questions
@@ -29,36 +13,56 @@ class Quiz
   attr_reader :logger
   attr_accessor :title
 
-  def initialize(title, yaml, options={})
+  def initialize(title, options={})
     @output = ''
     @questions = options[:questions] || []
     @title = title
-    @options = @@default_options.merge(options)
+    @options = @@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
-  end
-
-  def self.get_renderer(renderer)
-    Object.const_get(renderer.to_s + 'Renderer') rescue nil
+    @logger.level = (@options['-V'] || @options['--verbose']) ? Logger::INFO : Logger::WARN
+    #@quiz_yaml = yaml
   end
 
   def render_with(renderer,options={})
     srand @seed
-    @renderer = Quiz.get_renderer(renderer).send(:new,self,options)
+    @renderer = renderer.send(:new,self,options)
     @renderer.render_quiz
     @output = @renderer.output
   end
 
-  def self.set_yaml_file(file)
-    @@yaml_file = file &&  YAML::load_file(file)
+  def self.set_options(options)
+    @@options = options
+  end
+
+  def ungrouped_questions
+    questions.filter { |q| q.question_group.to_s == '' }
+  end
+
+  def grouped_questions
+    questions.filter { |q| q.question_group.to_s != '' }.sort_by(&:question_group)
+  end
+
+  def groups ; questions.map(&:question_group).uniq.reject { |g| g.to_s == '' } ; end
+
+  def ungrouped_points
+    ungrouped_questions.map(&:points).sum
   end
 
-  def points ; questions.map(&:points).inject { |sum,points| sum + points } ; end
+  def grouped_points
+    gq = grouped_questions
+    groups.sum do |g|
+      gq.detect { |q| q.question_group == g }.points
+    end
+  end
 
-  def num_questions ; questions.length ; end
+  def points
+    ungrouped_points + grouped_points
+  end
+  
+  def num_questions
+    groups.length + ungrouped_questions.length
+  end
 
   def random_seed(num)
     @seed = num.to_i
@@ -129,8 +133,8 @@ class Quiz
     @questions << q
   end
 
-  def self.quiz(*args, &block)
-    quiz = Quiz.new(*args, (@@yaml_file.shift if @@yaml_file))
+  def self.quiz(title, args={}, &block)
+    quiz = Quiz.new(title, args)
     quiz.instance_eval(&block)
     @@quizzes << quiz
   end

data/lib/ruql/renderers/html5_renderer.rb

@@ -7,14 +7,47 @@ class Html5Renderer
   def initialize(quiz,options={})
     @css = options.delete('c') || options.delete('css')
     @show_solutions = options.delete('s') || options.delete('solutions')
+    @show_tags = options.delete('T') || options.delete('show-tags')
     @template = options.delete('t') ||
       options.delete('template') ||
-      File.join(Gem.loaded_specs['ruql'].full_gem_path, 'templates/html5.html.erb')
+      File.join((Gem.loaded_specs['ruql'].full_gem_path rescue '.'), 'templates/html5.html.erb')
     @output = ''
     @quiz = quiz
     @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
   end
 
+  def allowed_options
+    opts = [
+      ['-c', '--css', Getopt::REQUIRED],
+      ['-t', '--template', Getopt::REQUIRED],
+      ['-s', '--solutions', Getopt::BOOLEAN],
+      ['-T', '--show-tags', Getopt::BOOLEAN]
+    ]
+    help = <<eos
+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.
+      An example is in the templates/ directory of RuQL.
+      The following local variables will be replaced with their values in
+      the template:
+        <%= quiz.title %> - the quiz title
+        <%= quiz.num_questions %> - total number of questions
+        <%= quiz.points %> - total number of points for whole quiz
+  -T, --show-tags
+      Show the tag(s) associated with a question within an element <div class="tags">.
+  -s, --solutions
+      generate solutions (showing correct answers and explanations)
+  NOTE: If there is more than one quiz (collection of questions) in the file,
+      a complete <html>...</html> block is produced in the output for EACH quiz.
+eos
+    return(
+
+
   def render_quiz
     if @template
       render_with_template do
@@ -132,6 +165,11 @@ class Html5Renderer
           if question.class == FillIn then question.question_text.gsub(/\-+/, '_____________________________')
           else question.question_text
           end
+        if @show_tags
+          @h.div(:class => 'text') do
+            question.tags.join(',')
+          end
+        end
         if question.raw?
           @h.p { |p| p << qtext }
         else

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/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,51 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: ruql
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.1
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 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: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+  type: :development
   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: rspec_its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '0'
+  type: :development
   prerelease: false
-  name: getopt
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :runtime
+        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
@@ -67,32 +124,34 @@ files:
 - 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:
 - CC By-SA
-metadata: {}
+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>

data/templates/htmlform.html.erb

@@ -1,44 +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; 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>