ruql-olx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b338552de6eca7a95e525b113b681a31bda209ea1e2f728056361b1110cbc89d
+  data.tar.gz: 458284a76b3f4b2df93ca269b7ca8fa28b2b66687334b2928e6e7f82c72c8879
+SHA512:
+  metadata.gz: 1f69c1e66ee0d7df6df0519dad6c5724992a2143a72dacca0c5533de619d2967d8a653c65622d42ae8f4494eade64a682b67b6c9ba51927b7369066197d1dcd3
+  data.tar.gz: a37db5380cdf926e2846ce20ce0283029d6fedc0859479cd3a287687eddc9cd5b569c6c2d183499a45ac2b45bb40ba921e6ae1d8d08169bd7d73a0b1e0c27385

data/.gitignore

@@ -0,0 +1,2 @@
+TAGS
+pkg

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

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    ruql-olx (0.0.1)
+      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.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    ruql (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruql-olx!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,61 @@
+# Ruql::Olx
+
+This formatter requires [ruql](https://github.com/saasbook/ruql) and
+allows formatting RuQL quizzes as OLX or Open Learning XML, a format
+developed and used by [edX](https://edx.org) for rendering course assets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruql-olx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruql-olx
+
+## Usage
+
+The simplest usage is `ruql olx --sequential seq.xml quizfile.rb > output.olx`.
+
+The OLX representation of all the questions in `quizfile.rb` will be
+left in the file `output.olx`.
+
+The file `seq.xml` will contain the necessary XML markup for the quiz
+metadata itself, such as time limit, the fact that it's graded, etc.
+This XML snippet needs to be copied into the correct file in the
+appropriate `sequentials` subdirectory of an edX course export.
+If the `--sequential` option is omitted, no such file is created.
+
+## Limitations of current version
+
+The time limit is computed as 1 point per minute plus 5
+minutes of slop, rounded up to the nearest 5 minutes.
+
+The other metadata items (graded or not, etc.) cannot be customized
+except by manually editing the `seq.xml` file.
+
+Normally, RuQL questions that have the same `group` attribute value
+are considered a "pool" of questions from which a particular subset
+are randomly used each time a quiz is generated.  The current version
+of the gem ignores this field and simply outputs *all* questions in
+the `quizfile.rb`.
+
+    
+## Development/Contributing
+
+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).
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/saasbook/ruql-olx. 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::Olx project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/saasbook/ruql-olx/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/olx"
+
+# 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/olx.rb

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

data/lib/ruql/olx/olx.rb

@@ -0,0 +1,120 @@
+module Ruql
+  class Olx
+    require 'builder'
+    require 'erb'
+    
+    attr_reader :output
+
+    def initialize(quiz,options={})
+      @sequential = options.delete('--sequential')
+      @output = ''
+      @quiz = quiz
+      @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
+    end
+
+    def self.allowed_options
+      opts = [
+        ['--sequential', GetoptLong::REQUIRED_ARGUMENT] 
+      ]
+      help = <<eos
+The OLX renderer supports these options:
+  --sequential <filename>.xml
+      Write the OLX quiz header (includes quiz name, time limit, etc to <filename>.xml.
+      This information can be copy-pasted into the appropriate <sequential> OLX element
+      in a course export.  If omitted, no quiz header .xml file is created.
+eos
+      return [help, opts]
+    end
+
+    def render_quiz
+      render_questions
+      write_quiz_header if @sequential
+      @output
+    end
+
+    # write the quiz header
+    def write_quiz_header
+      fh = File.open(@sequential, 'w')
+      @quiz_header = Builder::XmlMarkup.new(:target => fh, :indent => 2)
+      @quiz_header.sequential(
+        is_time_limited: "true",
+        default_time_limit_minutes: self.time_limit,
+        display_name: @quiz.title,
+        exam_review_rules: "",
+        is_onboarding_exam: "false",
+        is_practice_exam: "false",
+        is_proctored_enabled: "false")
+      fh.close
+    end
+
+    def time_limit
+      minutes_per_point = 1
+      slop = 5 # extra time for setup, etc
+      limit =  @quiz.points.to_i * minutes_per_point + slop
+      # round up to next 5 minutes
+      limit += 5 - (limit % 5)
+      limit
+    end
+
+    # this is what's called when the OLX template yields:
+    def render_questions
+      @quiz.questions.each do |q|
+        case q
+        when MultipleChoice then render_multiple_choice(q)
+        when SelectMultiple then render_select_multiple(q)
+        else
+          raise Ruql::QuizContentError.new "Unknown question type: #{q}"
+        end
+      end
+    end
+
+    # //This Question has Html formatting in the answer
+    # <problem display_name="Multiple Choice" markdown="null">
+    #   <multiplechoiceresponse>
+    #     <label>Which condition is necessary when using Ruby's collection methods such as map and reject?</label>
+    #     <description> </description>
+    #     <choicegroup type="MultipleChoice">
+    #       <choice correct="false">The collection on which they operate must consist of objects of the same type.</choice>
+    #       <choice correct="true">The collection must respond to <pre> &lt;tt&gt;each&lt;/tt&gt; </pre></choice>
+    #       <choice correct="false">Every element of the collection must respond to <pre> &lt;tt&gt;each&lt;/tt&gt; </pre></choice>
+    #       <choice correct="false">The collection itself must be one of Ruby's built-in collection types, such as <pre> &lt;tt&gt;Array&lt;/tt&gt; or &lt;tt&gt;Set&lt;/tt&gt; </pre></choice>
+    #     </choicegroup>
+    #   </multiplechoiceresponse>
+    # </problem>
+    def render_multiple_choice(q)
+      @h.problem(display_name: 'MultipleChoice', markdown: 'null') do
+        @h.multiplechoiceresponse do
+          render_question_text(q)
+          @h.choicegroup(type: 'MultipleChoice') do
+            render_answers(q)
+          end
+        end
+      end
+      @output << "\n\n"
+    end
+
+    def render_select_multiple(q)
+      @h.problem(display_name: 'Checkboxes', markdown: 'null') do
+        @h.choiceresponse do
+          render_question_text(q)
+          @h.checkboxgroup do
+            render_answers(q)
+          end
+        end
+      end
+    end
+
+    def render_answers(q)
+      q.answers.each do |answer|
+        @h.choice(correct: answer.correct?)  { |l| l << answer.answer_text }
+      end
+    end
+
+    def render_question_text(q)
+      qtext = q.question_text
+      qtext << " Select ALL that apply." if q.multiple
+      @h.label { |l| l << qtext }
+    end
+
+  end
+end

data/lib/ruql/olx/version.rb

@@ -0,0 +1,5 @@
+module Ruql
+  class Olx
+    VERSION = "0.0.1"
+  end
+end

data/ruql-olx.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruql/olx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruql-olx"
+  spec.version       = Ruql::Olx::VERSION
+  spec.summary     = "OLX 5 renderer for RuQL"
+  spec.description = "OLX 5 renderer for RuQL"
+  spec.authors     = ["Armando Fox"]
+  spec.email       = 'fox@berkeley.edu'
+  spec.homepage    = 'https://github.com/saasbook/ruql-olx'
+  
+  # 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 '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
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ruql-olx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Armando Fox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-29 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: OLX 5 renderer for RuQL
+email: fox@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruql/olx.rb
+- lib/ruql/olx/olx.rb
+- lib/ruql/olx/version.rb
+- ruql-olx.gemspec
+homepage: https://github.com/saasbook/ruql-olx
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/saasbook/ruql-olx
+  source_code_uri: https://github.com/saasbook/ruql-olx
+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: OLX 5 renderer for RuQL
+test_files: []