ruql-prairielearn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72df128708909f9e1a7312c278cde75c7837fb80399de110d76610ecdf0d44ca
+  data.tar.gz: 9325c936da9ff429bf452cb111bea41d3839850fb3fb6f05846912a01311bfbb
+SHA512:
+  metadata.gz: 43ab486232fad83299403b9fc88c1d58ffe10cc474a9713677d32bf02f1b0a9ac17250809806a41df7cea2e690254e44bf4755e3a4ed24b7d820a004bb7fc0c9
+  data.tar.gz: '0917791ee973d9ff9c95a9ce4fb44a6eba4fa8a1e1fec64fceb2414779ae1ad656f0fdae48e1675986fd3b47d1935fe5b4ce53319a27d2955680bd16452c43dc'

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.6
+before_install: gem install bundler -v 1.17.3

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-prairielearn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    ruql-prairielearn (0.1.0)
+      builder (~> 3.0)
+      ruql (~> 1.0, >= 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.4)
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruql (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruql-prairielearn!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,107 @@
+# Ruql::Prairielearn
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruql/prairielearn`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruql-prairielearn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruql-prairielearn
+
+## Usage
+
+
+`ruql prairielearn --default-topic=`_topic_ `[--omit-tags=`_tag1,tag2_`] [--extra-tags=`_tag1,tag2,tag3_`] ruql_file.rb`
+
+Converts questions in `ruql_file.rb` into a set of PrairieLearn question
+generators.  Each question will go in its own subdirectory containing
+`question.html` and `info.json`.  These are assumed to be questions
+that require no special server-side files.
+The attribute `singleVariant` will be set to `true` in
+`info.json` since these questions are by definition single-variant.
+
+Supported RuQL question types and their PrairieLearn equivalent
+elements are as follows; unsupported questions are ignored with a
+warning printed to standard error:
+
+* `choice_answer` --
+
+* `select_multiple` --
+
+* `truefalse` --
+
+
+### If a RuQL question has one or more `tags`:
+
+* The first tag (with all non-alphanumeric characters replaced by de-dup'd underscores, and all lowercased)
+will be used as the subdirectory name;
+for example, `P&D vs. Agile` will become `p_d_vs_agile`.  If there are
+name collisions, then `_2`, `_3`, etc. will be appended to subsequent
+names.
+
+* The first tag, first-word-capitalized but
+otherwise verbatim, will be used as the question's `title`
+attribute in `info.json`.  Question titles need not be unique,
+so it's fine for multiple questions to have the same title.
+
+* If a tag begins with `topic:`, the rest of the tag is used as the
+  question's `topic` in `info.json`, which means it must appear in the
+  list of topics in `infoCourse.json`.
+
+### If the question does not have `tags`:
+
+* A random UUID will be generated as the subdirectory name and also
+used as the question's `title`.
+
+* The value of the required `--default-topic=` option on the command line will be used
+as the topic.
+
+
+### PrairieLearn-specific interpretation of certain tags
+
+If a question's tag list includes any tags given in the `--omit-tags`
+command line argument, that question
+won't be converted to PL format at all.  At Berkeley we use this for questions
+that were designed to be simple manually-constructed variants placed into the same logical
+RuQL group for delivery via Canvas; we hand-convert those to
+PrairieLearn and use its question generator ability.
+
+Furthermore, the tag `radio` will be added for single-answer multiple
+choice (`choice_answer` in RuQL) questions, and `checkbox` will be
+added for select-all-that-apply (`select_multiple` in RuQL) questions.
+
+### Additional tags
+
+You can optionally specify `--extra-tags=tag1,tag2,tag3` on the command line
+(where each tag can contain any characters except commas; it's your
+job to escape them properly from the shell) as extra tags that will be
+added to *all* questions.  For example, this can indicate who imported
+the questions.
+
+The final list of a question's tags is sorted in alphabetical order.
+
+## 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-prairielearn. 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::Prairielearn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruql-prairielearn/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/prairielearn"
+
+# 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/prairielearn.rb

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

data/lib/ruql/prairielearn/prairielearn.rb

@@ -0,0 +1,91 @@
+module Ruql
+  class Prairielearn
+    require 'builder'
+    
+    attr_reader :output
+
+    def initialize(quiz,options={})
+      @quiz = quiz
+      @subdirs = []             # since need unique subdir names
+      @output = ''
+      @default_topic = options.delete('--default-topic') or
+        raise Ruql::OptionsError.new("--default-topic must be specified")
+      @omit_tags = options.delete('--omit-tags').to_s.split(',')
+      @extra_tags = options.delete('--extra-tags').to_s.split(',')
+      @path = options.delete('--path')
+      if (@partial_credit = options.delete('--partial-credit'))
+        raise Ruql::OptionsError.new('--partial-credit must be one of EDC or PC if given') unless
+          %w(edc pc).include?(@partial_credit.downcase)
+      end
+    end
+
+    def self.allowed_options
+      opts = [
+        ['--default-topic', GetoptLong::REQUIRED_ARGUMENT],
+        ['--omit-tags', GetoptLong::REQUIRED_ARGUMENT],
+        ['--extra-tags',  GetoptLong::REQUIRED_ARGUMENT],
+        ['--partial-credit', GetoptLong::REQUIRED_ARGUMENT],
+        ['--path', GetoptLong::REQUIRED_ARGUMENT]
+      ]
+      help = <<eos
+The PrairieLearn renderer supports these options:
+
+  --default-topic=TopicName
+      REQUIRED: value of "topic" attribute for info.json for questions lacking
+      a tag of the form 'topic:TopicName'
+  --extra-tags=tag1,tag2
+      These tags will be added to all questions' tag lists.
+  --omit-tags=tag1,tag2
+      Any RuQL questions having tags matching these will be skipped.
+  --partial-credit={EDC|PC}
+      Grading method for "select all that apply" questions.  If omitted, default is
+      no partial credit ("all or nothing").  See documentation at
+      https://prairielearn.readthedocs.io/en/latest/elements/#pl-checkbox-element
+  --path=path/to/questions/subdir
+      If given, place each question's subdir inside this directory, which must exist.
+      If not given, the subdirectory questions/ will be used, and created if needed.
+      WARNING: in the latter case, question files may be overwritten!
+
+A RuQL question's first tag will be used as the question's "title" attribute and subdirectory
+name (properly escaped).  If no tags, uuid's will be used for these purposes.  Subdirectory
+names will be appended with _2, 3, as needed to ensure uniqueness.
+eos
+      return [help, opts]
+    end
+
+    def render_quiz
+      begin
+        questions_path = get_or_make_questions_subdir!
+        @quiz.questions.each do |q|
+          @plq = Ruql::Prairielearn::Question.new(q,@partial_credit,@extra_tags,@default_topic,questions_path)
+          if @omit_tags.any? { |t| q.tags.include? t }
+            @output << "  Skip #{@plq.digest}\n"
+            next
+          end
+          @plq.create_question_files!
+          @output << "Create #{File.basename questions_path}/#{File.basename @plq.question_dir} topic=#{@plq.topic} tags=[#{@plq.tags.join ','}]\n"
+        end
+        self
+      rescue StandardError => e
+        STDERR.puts "Exiting: #{e.backtrace}"
+        Ruql::Prairielearn::Question.clean_up_after_error!
+      end
+    end
+
+    private
+
+    def get_or_make_questions_subdir!
+      # if @path was given, use it; otherwise look for/use 'questions'
+      @path ||= 'questions'
+      # if a subdir exists with that name, use it
+      if File.directory?(@path)
+        File.absolute_path @path
+      else
+        # create a questions dir
+        Dir.mkdir(@path)
+        File.absolute_path @path
+      end
+    end
+
+  end
+end

data/lib/ruql/prairielearn/question.rb

@@ -0,0 +1,96 @@
+module Ruql
+  class Prairielearn
+    class Question
+      require 'securerandom'      # for uuid generation
+      require 'erb'
+      require 'fileutils'
+      
+      attr_reader :question, :partial_credit, :tags, :uuid, :topic, :title, :question_dir, :digest, :none_of_the_above
+
+      @@dirnames = {} # keep track of titles seen, since subdir names must be unique
+
+      def initialize(question,partial_credit,extra_tags,default_topic,path='.')
+        @gem_root = Gem.loaded_specs['ruql-prairielearn'].full_gem_path
+        @@path ||= path
+        @question = question
+        @partial_credit = partial_credit
+        @extra_tags = extra_tags
+        @json_template =            File.join(@gem_root, 'templates', 'info.json.erb')
+        @multiple_choice_template = File.join(@gem_root, 'templates', 'pl-multiple-choice.html.erb')
+        @select_multiple_template = File.join(@gem_root, 'templates', 'pl-checkbox.html.erb')
+        @uuid = SecureRandom.uuid
+        @tags = @question.question_tags
+        @digest = @question.question_text.strip[0,40] + '...'
+        @title = (@tags.empty? ? @uuid : @tags.first)
+        @topic = (t = @tags.any? { |tag| tag =~ /^topic:/ }) ?
+                   @tags.delete(t).gsub(/^topic:/, '') :
+                   default_topic
+        @tags += extra_tags
+        @none_of_the_above = question.answers.any? { |a| a =~ /^none of (these|the above)$/i }
+        @question_dir = nil
+      end
+
+      def create_question_files!
+        begin
+          @question_dir = dirname()
+          Dir.mkdir(@question_dir) unless File.directory?(@question_dir)
+          create_json!
+          create_question_html!
+        rescue RuntimeError => e
+          raise Ruql::QuizContentError.new(e.message)
+        end
+      end
+
+      # If anything goes wrong, delete any files we created
+      def self.clean_up_after_error!
+        @@dirnames.each_pair do |dir,num|
+          fullpath = File.join(@@path,dir)
+          STDERR.puts "delete #{fullpath}"
+          FileUtils.rm_rf fullpath
+          if num > 1
+            2.upto(num).each do |otherdir|
+              fullpath = File.join(@@path,"#{dir}_#{otherdir}")
+              STDERR.puts "delete #{fullpath}"
+              FileUtils.rm_rf fullpath
+            end
+          end
+        end
+      end
+      
+      private
+
+      def create_json!
+        json = ERB.new(IO.read(File.expand_path @json_template),nil,'-').result(binding)
+        File.open(File.join(@question_dir, 'info.json'), 'w') do |f|
+          f.puts json
+        end
+      end
+
+      def create_question_html!
+        case question
+        when MultipleChoice then template = @multiple_choice_template
+        when SelectMultiple then template = @select_multiple_template
+        else raise Ruql::QuizContentError.new("Unknown question type: '#{@digest}'")
+        end
+        html = ERB.new(IO.read(File.expand_path template),nil,'-').result(binding)
+        File.open(File.join(@question_dir, 'question.html'), 'w') do |f|
+          f.puts html
+        end
+      end
+      
+      def dirname
+        try_name = @title.downcase.gsub( /[^a-z0-9\-]+/i, '_')
+        if @@dirnames.has_key?(try_name)
+          @@dirnames[try_name] += 1
+          try_name << "_#{@@dirnames[try_name]}"
+        else
+          @@dirnames[try_name] = 1
+        end
+        File.join(@@path, try_name)
+      end
+    end
+  end
+end
+
+
+    

data/lib/ruql/prairielearn/version.rb

@@ -0,0 +1,5 @@
+module Ruql
+  class Prairielearn
+    VERSION = "0.1.0"
+  end
+end

data/ruql-prairielearn.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruql/prairielearn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruql-prairielearn"
+  spec.version       = Ruql::Prairielearn::VERSION
+  spec.authors       = ["Armando Fox"]
+  spec.email         = ["fox@berkeley.edu"]
+
+  spec.summary       = %q{PrairieLearn-format renderer for RuQL.}
+  spec.homepage      = %q{https://github.com/saasbook/ruql-prairielearn}
+
+  # 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"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.add_runtime_dependency 'ruql', '~> 1.0', '>= 1.0.2'
+  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/info.json.erb

@@ -0,0 +1,10 @@
+{
+  "uuid":  "<%= uuid %>",
+  "title": <%= title.to_json %>,
+  "topic": <%= topic.to_json %>,
+  "tags":  <%= tags.to_json %>,
+  "type":  "v3"
+}
+
+  
+  

data/templates/pl-checkbox.html.erb

@@ -0,0 +1,34 @@
+<pl-question-panel>
+
+  <%= question.question_text %>
+
+</pl-question-panel>
+
+<pl-checkbox
+  answers-name="t"
+<% if partial_credit.nil? -%>
+  partial-credit="false"
+<% else %>
+  partial-credit="true"
+  partial-credit-method="<%= partial_credit.downcase %>"
+<% end -%>
+  hide-letter-keys="true"
+  hide-help-text="false"
+  fixed-order="false">
+
+<% question.answers.each do |answer| -%>
+  <pl-answer correct="<%= !!(answer.correct?) %>">
+    <%= answer.answer_text %>
+<% if answer.has_explanation? -%>
+    <!-- begin hint -->
+    <pl-hide-in-panel question="true" submission="true" answer="true">
+      <div class="pl-answer-hint">
+        <%= answer.explanation %>
+      </div>
+    </pl-hide-in-panel>
+    <!-- end hint -->
+<% end -%>
+  </pl-answer>
+
+<% end -%>
+</pl-checkbox>

data/templates/pl-multiple-choice.html.erb

@@ -0,0 +1,27 @@
+<pl-question-panel>
+
+  <%= question.question_text %>
+
+</pl-question-panel>
+
+<pl-multiple-choice
+  answers-name="t"
+  none-of-the-above="<%= none_of_the_above %>"
+  hide-letter-keys="true">
+
+<% question.answers.each do |answer| -%>
+  <pl-answer correct="<%= !!(answer.correct?) %>">
+    <%= answer.answer_text %>
+<% if answer.has_explanation? -%>
+    <!-- begin hint -->
+    <pl-hide-in-panel question="true" submission="true" answer="true">
+      <div class="pl-answer-hint">
+        <%= answer.explanation %>
+      </div>
+    </pl-hide-in-panel>
+    <!-- end hint -->
+<% end -%>
+  </pl-answer>
+
+<% end -%>
+</pl-multiple-choice>

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ruql-prairielearn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Armando Fox
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !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:
+email:
+- fox@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruql/prairielearn.rb
+- lib/ruql/prairielearn/prairielearn.rb
+- lib/ruql/prairielearn/question.rb
+- lib/ruql/prairielearn/version.rb
+- ruql-prairielearn.gemspec
+- templates/info.json.erb
+- templates/pl-checkbox.html.erb
+- templates/pl-multiple-choice.html.erb
+homepage: https://github.com/saasbook/ruql-prairielearn
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saasbook/ruql-prairielearn
+  source_code_uri: https://github.com/saasbook/ruql-prairielearn
+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: PrairieLearn-format renderer for RuQL.
+test_files: []