canvas_cc 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e278cfc9b75f8c345086fa2d354d14feb5a44501
-  data.tar.gz: 9ad3871e6e8a73c4f44e0652dba1641730c8c8d7
+  metadata.gz: 3a8a64dd671c54241f7d1051eb176a106f2937f3
+  data.tar.gz: 74ee921f395af8bc0b813a24aa4a98c03cf5c2dc
 SHA512:
-  metadata.gz: 4193e0b211dbafdab20a6ec6314249a4d5c325f80b745a7171aac48ced6345f45638f633ed9e7029bac86ba8651e2135b84a588776d66a446058a733a99458bf
-  data.tar.gz: f6a0226e896598af99e45ffd61ee7f3abcc3926915a498763d5271c2d17bfe0b0099f3a7e81327d4ea0580047ec4280d2a4689956671f09b8aa797f1c04697c8
+  metadata.gz: 1686311c4077fb06f9311d4965bf77915bb323c0a1f761aa2c5b083083b0ba39ed13aacfcfd0c4b87839e458e5e0c4e5a4a93917aeabc82de2c8047f84d72421
+  data.tar.gz: c6159917b40b05111da1c66397bf315f5620c798adea0897f40853e3556846782387e7b2d028826005e9886c142f15916b5d893e28283c073c444c87f6984e13

data/lib/canvas_cc/canvas_cc/assignment_helper.rb

@@ -26,5 +26,11 @@ module CanvasCc::CanvasCC::AssignmentHelper
     xml.automatic_peer_reviews assignment.automatic_peer_reviews unless assignment.automatic_peer_reviews.nil?
     xml.anonymous_peer_reviews assignment.anonymous_peer_reviews unless assignment.anonymous_peer_reviews.nil?
     xml.quiz_identifierref assignment.quiz_identifierref unless assignment.quiz_identifierref.nil?
+    unless assignment.rubric.nil?
+      xml.rubric_identifierref assignment.rubric.identifier
+      xml.rubric_external_identifier assignment.rubric.external_identifier
+    end
+    xml.rubric_use_for_grading assignment.rubric_use_for_grading unless assignment.rubric_use_for_grading.nil?
+    xml.rubric_hide_score_total assignment.rubric_hide_score_total unless assignment.rubric_hide_score_total.nil?
   end
 end

data/lib/canvas_cc/canvas_cc/cartridge_creator.rb

@@ -52,6 +52,7 @@ module CanvasCc::CanvasCC
       CanvasCc::CanvasCC::QuestionBankWriter.new(dir, *@course.question_banks).write
       CanvasCc::CanvasCC::AssessmentWriter.new(dir, *@course.assessments).write
       CanvasCc::CanvasCC::OutcomeWriter.new(dir, *@course.outcomes).write
+      CanvasCc::CanvasCC::RubricWriter.new(dir, *@course.rubrics).write
     end
 
     def zip_dir(out_file, dir)

data/lib/canvas_cc/canvas_cc/models/assignment.rb

@@ -4,7 +4,7 @@ module CanvasCc::CanvasCC::Models
                   :assignment_group_identifier_ref, :workflow_state, :points_possible, :grading_type, :all_day,
                   :submission_types, :position, :peer_review_count, :peer_reviews_assigned, :peer_reviews,
                   :automatic_peer_reviews, :grade_group_students_individually, :muted, :turnitin_enabled,
-                  :anonymous_peer_reviews, :quiz_identifierref
+                  :anonymous_peer_reviews, :quiz_identifierref, :rubric, :rubric_use_for_grading, :rubric_hide_score_total
 
     LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
     ASSIGNMENT_SETTINGS_FILE = 'assignment_settings.xml'

data/lib/canvas_cc/canvas_cc/models/course.rb

@@ -2,7 +2,7 @@ module CanvasCc::CanvasCC::Models
   class Course
 
     attr_accessor :format, :identifier, :copyright, :settings, :resources, :canvas_modules, :files, :pages, :discussions,
-                  :assignments, :assessments, :question_banks, :assignment_groups, :folders, :syllabus, :outcomes
+                  :assignments, :assessments, :question_banks, :assignment_groups, :folders, :syllabus, :outcomes, :rubrics
 
     def initialize
       @settings = {}
@@ -17,6 +17,7 @@ module CanvasCc::CanvasCC::Models
       @question_banks = []
       @assignment_groups = []
       @outcomes = []
+      @rubrics = []
     end
 
     def start_at

data/lib/canvas_cc/canvas_cc/models/rubric.rb

@@ -0,0 +1,11 @@
+module CanvasCc::CanvasCC::Models
+  class Rubric
+    META_ATTRIBUTES = %i(external_identifier title description read_only
+      reusable public points_possible free_form_criterion_comments)
+    attr_accessor :identifier, :criteria, *META_ATTRIBUTES
+
+    def initialize
+      @criteria = []
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/rubric_criterion.rb

@@ -0,0 +1,10 @@
+module CanvasCc::CanvasCC::Models
+  class RubricCriterion
+    META_ATTRIBUTES = %i(description long_description points mastery_points ignore_for_sorting)
+    attr_accessor :id, :learning_outcome, :ratings, *META_ATTRIBUTES
+
+    def initialize
+      @ratings = []
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/rubric_writer.rb

@@ -0,0 +1,52 @@
+module CanvasCc::CanvasCC
+  class RubricWriter
+    RUBRICS_FILE = 'rubrics.xml'
+
+    def initialize(work_dir, *rubrics)
+      @work_dir = work_dir
+      @rubrics = rubrics
+    end
+
+    def write
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        write_rubrics(xml) do |xml|
+          @rubrics.each do |rubric|
+            xml.rubric(identifier: rubric.identifier) do
+              CanvasCc::CanvasCC::Models::Rubric::META_ATTRIBUTES.each do |attr|
+                xml.send(attr, rubric.send(attr)) unless rubric.send(attr).nil?
+              end
+              write_criteria xml, rubric
+            end
+          end
+        end
+      end.to_xml
+      File.open(File.join(@work_dir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, RUBRICS_FILE), 'w') { |f| f.write(xml) }
+    end
+
+    def write_criteria(xml, rubric)
+      xml.criteria do
+        rubric.criteria.each do |criterion|
+          xml.criterion do
+            xml.criterion_id criterion.id
+            CanvasCc::CanvasCC::Models::RubricCriterion::META_ATTRIBUTES.each do |attr|
+              xml.send(attr, criterion.send(attr)) unless criterion.send(attr).nil?
+            end
+            xml.learning_outcome_identifierref criterion.learning_outcome.identifier if criterion.learning_outcome
+            xml << CanvasCc::CanvasCC::RatingWriter.new(*criterion.ratings).write
+          end
+        end
+      end
+    end
+
+    private
+    def write_rubrics(xml)
+      xml.rubrics(
+        'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
+      ) {
+        yield xml
+      }
+    end
+  end
+end

data/lib/canvas_cc/version.rb

@@ -1,3 +1,3 @@
 module CanvasCc
-  VERSION = "0.0.27"
+  VERSION = "0.0.28"
 end

data/lib/canvas_cc.rb

@@ -56,6 +56,7 @@ module CanvasCc
     autoload :CourseSyllabusWriter, 'canvas_cc/canvas_cc/course_syllabus_writer'
     autoload :OutcomeWriter, 'canvas_cc/canvas_cc/outcome_writer'
     autoload :RatingWriter, 'canvas_cc/canvas_cc/rating_writer'
+    autoload :RubricWriter, 'canvas_cc/canvas_cc/rubric_writer'
 
     autoload :QuestionWriter, 'canvas_cc/canvas_cc/question_writer'
     autoload :CalculatedQuestionWriter, 'canvas_cc/canvas_cc/calculated_question_writer'
@@ -101,6 +102,8 @@ module CanvasCc
       autoload :ModuleCompletionRequirement, 'canvas_cc/canvas_cc/models/module_completion_requirement'
       autoload :Outcome, 'canvas_cc/canvas_cc/models/outcome'
       autoload :Rating, 'canvas_cc/canvas_cc/models/rating'
+      autoload :Rubric, 'canvas_cc/canvas_cc/models/rubric'
+      autoload :RubricCriterion, 'canvas_cc/canvas_cc/models/rubric_criterion'
     end
   end
 end

data/spec/moodle2cc/canvas_cc/cartridge_creator_spec.rb

@@ -22,6 +22,8 @@ module CanvasCc::CanvasCC
       DiscussionWriter.any_instance.stub(:write)
       AssignmentWriter.any_instance.stub(:write)
       QuestionBankWriter.any_instance.stub(:write)
+      OutcomeWriter.any_instance.stub(:write)
+      RubricWriter.any_instance.stub(:write)
     end
 
     after :each do
@@ -29,7 +31,7 @@ module CanvasCc::CanvasCC
     end
 
     [CanvasExportWriter, CourseSyllabusWriter, CourseSettingWriter, ModuleMetaWriter, ImsManifestGenerator,
-     FileMetaWriter, PageWriter, DiscussionWriter, AssignmentWriter, QuestionBankWriter].each do |klass|
+     FileMetaWriter, PageWriter, DiscussionWriter, AssignmentWriter, QuestionBankWriter, OutcomeWriter, RubricWriter].each do |klass|
       it "writes #{klass}" do
         writer_double = double(write: nil)
         klass.stub(:new).and_return(writer_double)
@@ -48,4 +50,4 @@ module CanvasCc::CanvasCC
     end
 
   end
-end
+end

data/spec/moodle2cc/canvas_cc/rubric_writer_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::RubricWriter do
+  let!(:rubric) do
+    rubric = CanvasCc::CanvasCC::Models::Rubric.new
+    rubric.identifier = SecureRandom.hex
+    rubric.title = 'some rubric'
+    rubric
+  end
+
+  let!(:criterion) do
+    criterion = CanvasCc::CanvasCC::Models::RubricCriterion.new
+    criterion.id = SecureRandom.hex
+    criterion.description = 'some criterion'
+    rubric.criteria << criterion
+    criterion
+  end
+
+  let!(:rating) do
+    tmp_rating = CanvasCc::CanvasCC::Models::Rating.new
+    tmp_rating.id = '123'
+    tmp_rating.description = 'a rating'
+    tmp_rating.points = 5
+    tmp_rating.criterion_id = '123'
+    tmp_rating.long_description = 'a longer description'
+    criterion.ratings << tmp_rating
+    tmp_rating
+  end
+
+  let(:tmpdir) { Dir.mktmpdir }
+
+  before :each do
+    Dir.mkdir(File.join(tmpdir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR))
+  end
+
+  after :each do
+    FileUtils.rm_r tmpdir
+  end
+
+  it 'xml contains the correct schema' do
+    xml = write_xml(rubric)
+
+    valid_schema = File.read(fixture_path(File.join('common_cartridge', 'schema', 'cccv1p0.xsd')))
+    xsd = Nokogiri::XML::Schema(valid_schema)
+    expect(xsd.validate(xml)).to be_truthy
+  end
+
+  it 'writes a rubric' do
+    xml = write_xml(rubric)
+    node = xml.at_xpath('//xmlns:rubrics/xmlns:rubric')
+    expect(node.attr('identifier')).to eql rubric.identifier
+    expect(node.at_xpath('xmlns:title').text).to eql rubric.title
+    criterion_node = node.at_xpath('./xmlns:criteria/xmlns:criterion')
+    expect(criterion_node.at_xpath('xmlns:criterion_id').text).to eql criterion.id
+    expect(criterion_node.at_xpath('xmlns:description').text).to eql criterion.description
+    rating_node = criterion_node.at_xpath('./xmlns:ratings/xmlns:rating')
+    expect(rating_node.at_xpath('xmlns:id').text).to eql rating.id
+    expect(rating_node.at_xpath('xmlns:description').text).to eql rating.description
+  end
+
+  private
+  def write_xml(rubric)
+    CanvasCc::CanvasCC::RubricWriter.new(tmpdir, rubric).write
+    path = File.join(tmpdir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR,
+      CanvasCc::CanvasCC::RubricWriter::RUBRICS_FILE)
+    Nokogiri::XML(File.read(path))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_cc
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -290,6 +290,8 @@ files:
 - lib/canvas_cc/canvas_cc/models/range.rb
 - lib/canvas_cc/canvas_cc/models/rating.rb
 - lib/canvas_cc/canvas_cc/models/resource.rb
+- lib/canvas_cc/canvas_cc/models/rubric.rb
+- lib/canvas_cc/canvas_cc/models/rubric_criterion.rb
 - lib/canvas_cc/canvas_cc/models/syllabus.rb
 - lib/canvas_cc/canvas_cc/models/web_content.rb
 - lib/canvas_cc/canvas_cc/models/web_link.rb
@@ -306,6 +308,7 @@ files:
 - lib/canvas_cc/canvas_cc/question_group_writer.rb
 - lib/canvas_cc/canvas_cc/question_writer.rb
 - lib/canvas_cc/canvas_cc/rating_writer.rb
+- lib/canvas_cc/canvas_cc/rubric_writer.rb
 - lib/canvas_cc/canvas_cc/short_answer_question_writer.rb
 - lib/canvas_cc/canvas_cc/text_only_question_writer.rb
 - lib/canvas_cc/canvas_cc/true_false_question_writer.rb
@@ -367,6 +370,7 @@ files:
 - spec/moodle2cc/canvas_cc/question_bank_writer_spec.rb
 - spec/moodle2cc/canvas_cc/question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/rating_writer_spec.rb
+- spec/moodle2cc/canvas_cc/rubric_writer_spec.rb
 - spec/moodle2cc/canvas_cc/short_answer_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/text_only_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/true_false_question_writer_spec.rb
@@ -478,6 +482,7 @@ test_files:
 - spec/moodle2cc/canvas_cc/question_bank_writer_spec.rb
 - spec/moodle2cc/canvas_cc/question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/rating_writer_spec.rb
+- spec/moodle2cc/canvas_cc/rubric_writer_spec.rb
 - spec/moodle2cc/canvas_cc/short_answer_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/text_only_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/true_false_question_writer_spec.rb