Class: Ruql::Prairielearn

Inherits:
Object
  • Object
show all
Defined in:
lib/ruql/prairielearn/version.rb,
lib/ruql/prairielearn/question.rb,
lib/ruql/prairielearn/prairielearn.rb

Defined Under Namespace

Classes: Question

Constant Summary collapse

VERSION = 
"0.1.2"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(quiz, options = {}) ⇒ Prairielearn

Returns a new instance of Prairielearn.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/ruql/prairielearn/prairielearn.rb', line 7

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

Instance Attribute Details

#output ⇒ Object (readonly)

Returns the value of attribute output.



5
6
7
 
# File 'lib/ruql/prairielearn/prairielearn.rb', line 5

def output
  @output
end

Class Method Details

.allowed_options ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/ruql/prairielearn/prairielearn.rb', line 22

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

Instance Method Details

#render_quiz ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ruql/prairielearn/prairielearn.rb', line 56

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.message}\n#{e.backtrace}"
    Ruql::Prairielearn::Question.clean_up_after_error!
  end
end