ruql-olx 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a477614eb1b0baea402a669b3ae78984bad1f5956f41feb236831e185f91e9
-  data.tar.gz: 5c3d28aac985353cf40ff49361c9c773074c3acb0be03915677997895c69d43b
+  metadata.gz: 76998a04ff820500209dd5edd8bf3fee5a1eb06425367b31ce02583f242c4ec4
+  data.tar.gz: a54822aa0ccf2cf6999af1bf9ecd14a044a740820eaac184b3a7d52ebde5277b
 SHA512:
-  metadata.gz: c7320c20e7f0de379dcf0e1173b67dbb280dcea2e67c1dad747c196cb79b7387f030b59ab80a24e0494f86ce27e86316dddb77238a7fcb900ad478cf0abea8bf
-  data.tar.gz: e5fa89ae5ed156ae184292fc0eea9d806d6a924161d21ee0d5d9d2dfacf4b44a0357bd1efbcf5654a44f088a9703be0b3666999a3c0b7f6e93b7bc83f5fdc26b
+  metadata.gz: bd0bcd4bab32b7ede92f8120402085e30cf9ac03d46a6951cfaf18a0ba586ebda7638866c3e38e14ddc5a9d2a41bde931c42b76255dd06ada456cc67f75e220f
+  data.tar.gz: 706b36d71e9c5e5b8d2889ce736743e1e584eefecee42a4a61e9da0c1f13d3013965d418ba48bc10e22661a0d097d645a53a60afa640abaf995935ebf5f8441e

data/.gitignore

@@ -1,2 +1,3 @@
 TAGS
 pkg
+.byebug_history

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruql-olx (0.0.2)
+    ruql-olx (0.0.3)
       builder (~> 3.0)
       ruql (~> 1.0, >= 1.0.2)
 
@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     builder (3.2.4)
+    byebug (11.1.3)
     diff-lcs (1.4.4)
     rake (10.5.0)
     rspec (3.9.0)
@@ -31,6 +32,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.17)
+  byebug
   rake (~> 10.0)
   rspec (~> 3.0)
   ruql-olx!

data/README.md

@@ -6,9 +6,10 @@ developed and used by [edX](https://edx.org) for rendering course assets.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your application's Gemfile:
 
 ```ruby
+gem 'ruql'
 gem 'ruql-olx'
 ```
 
@@ -22,6 +23,23 @@ Or install it yourself as:
 
 ## Usage
 
+The simplest usage is to change to the root directory of the course
+export (the directory containing subdirectories `chapters`, `course`,
+etc.) and say  `ruql olx --chapter 'Chapter Display Name' quizfile.rb`
+
+
+- for each problem, create drafts/problem/<uuid>.xml containng <problem>...</problem>
+- create a sequential using existing logic; let its uid be UU.xml
+- for each quiz, create drafts/vertical/<uuid>.xml containing:
+<vertical display_name="Quiz name" index_in_children_list="0" parent_url="i4x://BerkeleyX/CSTest101/sequential/UU">
+  <problem url_name="5d7a8b06b3b5440aa9c1f6059f2e0945"/>
+  <problem url_name="2ffcfc7a92894770896bd15e311ef77e"/>
+</vertical>
+
+- search for chapters/ .xml file having <chapter display_name="Chapter
+Display Name"
+- in that file, add <sequential url_name="UU"/> as the last child of <chapter>
+
 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

data/lib/ruql/olx.rb

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

data/lib/ruql/olx/exported_edx_course.rb

@@ -0,0 +1,136 @@
+module Ruql
+  class Olx
+    class ExportedEdxCourse
+
+      require 'securerandom'      # for UUID generation
+      require 'builder'
+
+      def initialize(quiz, chapter_name, course_root, course_options, dryrun: false)
+        @dryrun = dryrun
+        @course_options = course_options
+        @quiz = quiz
+        @root = course_root
+        verify_writable_dir(@problem_dir = File.join(@root, 'drafts', 'problem'))
+        verify_writable_dir(@vertical_dir = File.join(@root, 'drafts', 'vertical'))
+        verify_writable_dir(@sequential_dir = File.join(@root, 'sequential'))
+        @chapter_file = find_chapter_file(chapter_name)
+        @course_name = find_course_name
+        @created_files = []       # to delete in case of error, or list created
+        @modified_files = []
+        @quiz_filehandle = nil
+        @problem_ids = []
+        @sequential_id = uuid()
+        @vertical_id = uuid()
+      end
+
+      # Create a file containing a single problem and remember its UUID.
+      def add_problem(xml_text)
+        url = uuid()
+        problem_file = File.join(@problem_dir, "#{url}.xml")
+        begin
+          File.open(problem_file, 'w') { |f|  f.puts xml_text  }
+          @problem_ids << url
+          @created_files << problem_file
+        rescue StandardError => e
+          cleanup
+          raise IOError.new(:message => e.message)
+        end
+      end
+      
+      def add_quiz
+        quiz_vertical = uuid()
+        begin
+          create_sequential
+          create_vertical
+          append_quiz_to_chapter
+        rescue StandardError => e
+          cleanup
+          raise IOError.new(:message => e.message)
+        end
+      end
+
+      def report
+        report = ["Files created:"]
+        @created_files.each { |f| report << "  #{f}" }
+        report << "Files modified:"
+        @modified_files.each { |f| report << "  #{f}" }
+        cleanup if @dryrun
+        report.join("\n")
+      end
+
+      private
+
+      def uuid
+        SecureRandom.hex(16)
+      end
+
+      def create_sequential
+        file = File.join(@sequential_dir, "#{@sequential_id}.xml")
+        File.open(file, 'w') do |fh|
+          quiz_header = Builder::XmlMarkup.new(:target => fh, :indent => 2)
+          quiz_header.sequential(@course_options)
+        end
+        @created_files << file
+      end
+
+      def create_vertical
+        file = File.join(@vertical_dir, "#{@vertical_id}.xml")
+        File.open(file, 'w') do |fh|
+          vert = Builder::XmlMarkup.new(:target => fh, :indent => 2)
+          vert.vertical(
+            display_name: @quiz.title,
+            index_in_children_list: 0,
+            parent_url: "i4x://#{@course_name}/sequential/#{@sequential_id}") do
+            @problem_ids.each do |prob|
+              vert.problem(url_name: prob)
+            end
+          end
+        end
+        @created_files << file
+      end
+
+      # Verify that the given directory exists and is writable
+      def verify_writable_dir(dir)
+        unless (File.directory?(dir) && File.writable?(dir)) ||
+            FileUtils.mkdir_p(dir)
+          raise IOError.new("Directory #{dir} must exist and be writable")
+        end
+      end
+
+      # Find the chapter .xml file for the chapter whose name matches 'name'.
+      # If multiple chapters match, no guarantee on which gets picked.
+      def find_chapter_file(name)
+        regex = /<chapter display_name="([^"]+)">/i
+        Dir.glob(File.join @root, 'chapter', '*.xml').each do |filename|
+          first_line = File.open(filename, &:gets)
+          return filename if (first_line =~ regex) && ($1 == name)
+        end
+        raise Ruql::OptionsError.new("Chapter '#{name}' not found in #{@root}/chapter/")
+      end
+
+      def append_quiz_to_chapter
+        # insert just before last line
+        chapter_markup = File.readlines(@chapter_file).insert(-2,
+          %Q{  <sequential url_name="#{@sequential_id}"/>})
+        File.open(@chapter_file, 'w') { |f|  f.puts chapter_markup  }
+        @modified_files << @chapter_file
+      end
+
+      # Find the course's name ("#{org}/#{course}") from course.xml file
+      def find_course_name
+        course_markup = File.readlines(File.join(@root, 'course.xml')).join('')
+        org = name = nil
+        org = $1 if  course_markup =~ /<course.*org="([^"]+)"/
+        name = $1 if course_markup =~ /<course.*course="([^"]+)"/
+        raise Ruql::OptionsError.new("Cannot get course org and name from #{@root}/course.xml") unless org && name
+        "#{org}/#{name}"
+      end
+
+      def cleanup
+        # delete any created files; ignore errors during deletion
+        @created_files.each { |f|  File.delete(f) rescue nil }
+      end
+
+    end
+  end
+end

data/lib/ruql/olx/olx.rb

@@ -6,24 +6,50 @@ module Ruql
     attr_reader :output
 
     def initialize(quiz,options={})
-      @sequential = options.delete('--sequential')
+      @quiz = quiz
+      @dryrun = !! options.delete('--dry-run')
+      if (chapter = options.delete('--chapter'))
+        root = options.delete('--root') || Dir.getwd
+        @edx = Ruql::Olx::ExportedEdxCourse.new(quiz, chapter, root,
+          # quiz options for edX
+          {
+            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"
+          },
+          dryrun: @dryrun)
+      end
       @groupselect = (options.delete('--group-select') || 1_000_000).to_i
       @output = ''
-      @quiz = quiz
-      @h = Builder::XmlMarkup.new(:target => @output, :indent => 2)
+      @h = nil                  # XML Builder object
     end
 
     def self.allowed_options
       opts = [
-        ['--sequential', GetoptLong::REQUIRED_ARGUMENT],
-        ['--group-select', GetoptLong::REQUIRED_ARGUMENT]
+        ['--chapter', GetoptLong::REQUIRED_ARGUMENT],
+        ['--root', GetoptLong::REQUIRED_ARGUMENT],
+        ['--group-select', GetoptLong::REQUIRED_ARGUMENT],
+        ['--dry-run', GetoptLong::NO_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.
+The OLX renderer modifies an exported edX course tree in place to incorporate the quiz.
+It supports these options:
+  --chapter '<name>'
+      Insert the quiz as the last child (sequential) of the chapter whose display name
+      is <name>.  Use quotes as needed to protect spaces/special characters in chapter name.
+      If multiple chapter names match, the quiz will end up in one of them.
+      If this option is omitted, the problem XML will instead be written to standard output,
+      and no files will be created or modified.
+  --root=<path>
+      Specify <path> as root directory of the edX course export.  If omitted, default is '.'
+  --dry-run
+      Only valid with --chapter: report names of created files but then delete them from export.
+      The files are created and deleted, so not a true dry run, but leaves the export intact
+      while verifying that the changes are possible.
   --group-select=<n>
       If multiple RuQL questions share the same 'group' attribute, include at most n of them
       in the output.  If omitted, defaults to "all questions in group".
@@ -32,26 +58,15 @@ eos
     end
 
     def render_quiz
+      # caller expects to find "quiz content" in @output, but if we modified edX, then
+      # output is just the report of what we did.
       @groups_seen = Hash.new { 0 }
       @group_count = 0
       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
+      if @edx
+        @edx.add_quiz
+        @output = @edx.report
+      end
     end
 
     def time_limit
@@ -66,6 +81,8 @@ eos
     # this is what's called when the OLX template yields:
     def render_questions
       @quiz.questions.each do |q|
+        question_xml = ''
+        @h = Builder::XmlMarkup.new(:target => question_xml, :indent => 2)
         # have we maxed out the number of questions per group for this group?
         next unless more_in_group?(q)
         case q
@@ -74,6 +91,12 @@ eos
         else
           raise Ruql::QuizContentError.new "Unknown question type: #{q}"
         end
+        # question_xml now contains the XML of the given question...
+        if @edx
+          @edx.add_problem(question_xml)
+        else
+          @output << question_xml << "\n"
+        end
       end
     end
 
@@ -85,19 +108,6 @@ eos
       return (@groups_seen[group] <= @groupselect)
     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
@@ -107,7 +117,6 @@ eos
           end
         end
       end
-      @output << "\n\n"
     end
 
     def render_select_multiple(q)

data/lib/ruql/olx/version.rb

@@ -1,5 +1,5 @@
 module Ruql
   class Olx
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/ruql-olx.gemspec

@@ -6,8 +6,8 @@ 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.summary     = "OLX renderer for RuQL"
+  spec.description = "OLX renderer for RuQL"
   spec.authors     = ["Armando Fox"]
   spec.email       = 'fox@berkeley.edu'
   spec.homepage    = 'https://github.com/saasbook/ruql-olx'
@@ -39,5 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruql-olx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Armando Fox
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruql
@@ -86,7 +86,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: OLX 5 renderer for RuQL
+- !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'
+description: OLX renderer for RuQL
 email: fox@berkeley.edu
 executables: []
 extensions: []
@@ -101,6 +115,7 @@ files:
 - bin/console
 - bin/setup
 - lib/ruql/olx.rb
+- lib/ruql/olx/exported_edx_course.rb
 - lib/ruql/olx/olx.rb
 - lib/ruql/olx/version.rb
 - ruql-olx.gemspec
@@ -128,5 +143,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: OLX 5 renderer for RuQL
+summary: OLX renderer for RuQL
 test_files: []