ruql-html 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 609d2fd3609ed8e40a791c88a23617e4a49e9dd1cf7b5ee6125f200fab5c33fb
+  data.tar.gz: 077f63c28b10ad3003b9e1b56f7553db001e782ffd425cc511507b4b484ea045
+SHA512:
+  metadata.gz: 30148cdcda674a872e46ec12e4fd6ffd707ca286faa663e7e809b79d66dd347946672b4917c7b5ea6ec5a74a0cea1e00b21d51e3573cd0dfd7bd842ab1f819f0
+  data.tar.gz: 2e7017afa3eed0f302b42acfb78c22dd187807ecbde09ab91e4736df162b811735bfa811637984156a78ea8d355517302b01df1015970b3d77400d83727e7c7b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fox@cs.berkeley.edu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruql-html.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+# Ruql::Html
+
+This formatter requires [ruql](https://github.com/saasbook/ruql) and
+allows formatting RuQL quizzes as HTML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruql-html'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruql-html
+
+## Usage
+
+The simplest usage is `ruql html quizfile.rb > output.html`.
+`ruql html -h` shows options that let you specify a different HTML/CSS
+template, among other things.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruql-html. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Ruql::Html project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruql-html/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruql/html"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ruql/html.rb

@@ -0,0 +1,3 @@
+require "ruql/html/version"
+require "ruql/html/html"
+

data/lib/ruql/html/html.rb

@@ -0,0 +1,184 @@
+module Ruql
+  class Html
+    require 'builder'
+    require 'erb'
+    
+    attr_reader :output
+
+    def initialize(quiz,options={})
+      @gem_root = Gem.loaded_specs['ruql-html'].full_gem_path rescue '.'
+      @show_solutions = options.delete('--solutions')
+      @show_tags = options.delete('--html-tags') || options.delete('--show-tags')
+      @template = options.delete('--html-template') ||
+        File.join(@gem_root, 'templates/simple.html.erb')
+      @output = ''
+      @quiz = quiz
+      @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
+    end
+
+    def self.allowed_options
+      opts = [
+        ['--html-tags', GetoptLong::NO_ARGUMENT],
+        ['--html-template', GetoptLong::REQUIRED_ARGUMENT]
+      ]
+      help = <<eos
+The HTML renderer uses  supports these options:
+  --html-tags
+      Show question's tags in HTML output, within an element <div class="tags">.
+  --html-template=file.html.erb
+      Use file.html.erb as HTML template, which has <%= yield %> where questions should go.
+      Default is #{@gem_root}/templates/simple.html.erb
+      You can use the local variables in the .erb template:
+        <%= quiz.title %> - the quiz title
+        <%= quiz.num_questions %> - total number of questions
+        <%= quiz.points %> - total number of points for whole quiz
+  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 [help, opts]
+    end
+
+    def render_quiz
+      render_with_template do
+        render_questions
+        @output
+      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
+    
+    # this is what's called when the HTML template yields:
+    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 Ruql::QuizContentError.new "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 @show_tags
+            @h.div(:class => 'text') do
+              question.tags.join(',')
+            end
+          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
+end

data/lib/ruql/html/version.rb

@@ -0,0 +1,5 @@
+module Ruql
+  class Html
+    VERSION = "1.0.0"
+  end
+end

data/ruql-html.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruql/html/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruql-html"
+  spec.version       = Ruql::Html::VERSION
+  spec.authors       = ["Armando Fox"]
+  spec.email         = ["fox@cs.berkeley.edu"]
+
+  spec.summary     = "HTML 5 renderer for RuQL"
+  spec.description = "HTML 5 renderer for RuQL"
+  spec.authors     = ["Armando Fox"]
+  spec.email       = 'fox@berkeley.edu'
+  spec.homepage    = 'https://github.com/saasbook/ruql-html'
+  
+  # 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 spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    #spec.metadata["changelog_uri"] = ''
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+  spec.add_runtime_dependency 'builder', '~> 3.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end
+

data/templates/simple.html.erb

@@ -0,0 +1,32 @@
+<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.question .tags { font-weight: bold; background-color: yellow; display: block; margin: 2px; padding: 2px; }
+    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">Student ID:</div>
+    </div>
+    <h1><%= quiz.title %></h1>
+    <div align="center">
+      <%= quiz.num_questions %> questions, points indicated per question,
+      <%= quiz.points %> points total.  
+    </div>
+    <%= yield %>
+  </body>
+</html>

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ruql-html
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Armando Fox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-03 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
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: HTML 5 renderer for RuQL
+email: fox@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruql/html.rb
+- lib/ruql/html/html.rb
+- lib/ruql/html/version.rb
+- ruql-html.gemspec
+- templates/simple.html.erb
+homepage: https://github.com/saasbook/ruql-html
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saasbook/ruql-html
+  source_code_uri: https://github.com/saasbook/ruql-html
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: HTML 5 renderer for RuQL
+test_files: []