canvas_cc 0.0.26 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f549d5258b5e77abe036e1c2070fcd2351345c8d
-  data.tar.gz: 2778c373ba05e902c8c2218c85ea27d0d902c602
+  metadata.gz: e278cfc9b75f8c345086fa2d354d14feb5a44501
+  data.tar.gz: 9ad3871e6e8a73c4f44e0652dba1641730c8c8d7
 SHA512:
-  metadata.gz: 8834a9d8cd2be57252702bba48465b14172fd654bb653e9ec06d8b05df702082be980f4799ba8c506922ef2fb32aa6dd863346e5df63d9bac0d85fa22999dc1e
-  data.tar.gz: 2fbd1b27bda3cbe03cd0fcca130a8c091c23b415448a39c66c41e1d0f5aa1ba54d8a91df28ed5292ca26e3d6576ab6e34e80d7239275eb196190eadf9d7fde38
+  metadata.gz: 4193e0b211dbafdab20a6ec6314249a4d5c325f80b745a7171aac48ced6345f45638f633ed9e7029bac86ba8651e2135b84a588776d66a446058a733a99458bf
+  data.tar.gz: f6a0226e896598af99e45ffd61ee7f3abcc3926915a498763d5271c2d17bfe0b0099f3a7e81327d4ea0580047ec4280d2a4689956671f09b8aa797f1c04697c8

data/lib/canvas_cc/canvas_cc/cartridge_creator.rb

@@ -51,6 +51,7 @@ module CanvasCc::CanvasCC
       CanvasCc::CanvasCC::AssignmentWriter.new(dir, *@course.assignments).write
       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
     end
 
     def zip_dir(out_file, dir)

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
+                  :assignments, :assessments, :question_banks, :assignment_groups, :folders, :syllabus, :outcomes
 
     def initialize
       @settings = {}
@@ -16,6 +16,7 @@ module CanvasCc::CanvasCC::Models
       @assessments = []
       @question_banks = []
       @assignment_groups = []
+      @outcomes = []
     end
 
     def start_at

data/lib/canvas_cc/canvas_cc/models/outcome.rb

@@ -0,0 +1,11 @@
+module CanvasCc::CanvasCC::Models
+  class Outcome
+    attr_accessor :identifier, :title, :description, :points_possible, :mastery_points,
+      :ratings, :is_global_outcome, :ratings, :external_identifier
+
+    def initialize
+      @ratings = []
+    end
+
+  end
+end

data/lib/canvas_cc/canvas_cc/models/rating.rb

@@ -0,0 +1,5 @@
+module CanvasCc::CanvasCC::Models
+  class Rating
+    attr_accessor :id, :description, :points, :criterion_id, :long_description
+  end
+end

data/lib/canvas_cc/canvas_cc/outcome_writer.rb

@@ -0,0 +1,40 @@
+module CanvasCc::CanvasCC
+  class OutcomeWriter
+    LEARNING_OUTCOMES_FILE = 'learning_outcomes.xml'
+
+    def initialize(work_dir, *outcomes)
+      @work_dir = work_dir
+      @outcomes = outcomes
+    end
+
+    def write
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        write_outcomes(xml) do |xml|
+          @outcomes.each do |outcome|
+            xml.learningOutcome(identifier: outcome.identifier) do
+              xml.title outcome.title
+              xml.description outcome.description
+              xml.points_possible outcome.points_possible
+              xml.mastery_points outcome.mastery_points
+              xml << CanvasCc::CanvasCC::RatingWriter.new(*outcome.ratings).write
+              xml.is_global_outcome outcome.is_global_outcome
+              xml.external_identifier outcome.external_identifier if outcome.external_identifier
+            end
+          end
+        end
+      end.to_xml
+      File.open(File.join(@work_dir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, LEARNING_OUTCOMES_FILE), 'w') { |f| f.write(xml) }
+    end
+
+    private
+    def write_outcomes(xml)
+      xml.learningOutcomes(
+        '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/canvas_cc/rating_writer.rb

@@ -0,0 +1,27 @@
+module CanvasCc::CanvasCC
+  class RatingWriter
+
+    def initialize(*ratings)
+      @ratings = ratings
+    end
+
+    # It is assumed that ratings will be written only within the context of another object,
+    # such as learning outcomes or rubrics
+    def write
+      Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.ratings do |xml|
+          @ratings.each do |rating|
+            xml.rating do
+              xml.id rating.id
+              xml.description rating.description
+              xml.points rating.points
+              xml.criterion_id rating.criterion_id
+              xml.long_description rating.long_description
+            end
+          end
+        end
+      end.to_xml
+    end
+  end
+
+end

data/lib/canvas_cc/version.rb

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

data/lib/canvas_cc.rb

@@ -54,6 +54,8 @@ module CanvasCc
     autoload :AssignmentWriter, 'canvas_cc/canvas_cc/assignment_writer'
     autoload :AssignmentGroupWriter, 'canvas_cc/canvas_cc/assignment_group_writer'
     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 :QuestionWriter, 'canvas_cc/canvas_cc/question_writer'
     autoload :CalculatedQuestionWriter, 'canvas_cc/canvas_cc/calculated_question_writer'
@@ -97,6 +99,8 @@ module CanvasCc
       autoload :Range, 'canvas_cc/canvas_cc/models/range'
       autoload :ModulePrerequisite, 'canvas_cc/canvas_cc/models/module_prerequisite'
       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'
     end
   end
 end

data/spec/moodle2cc/canvas_cc/models/outcome_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::Models::Outcome do
+  it_behaves_like 'it has an attribute for', :identifier
+  it_behaves_like 'it has an attribute for', :title
+  it_behaves_like 'it has an attribute for', :description
+  it_behaves_like 'it has an attribute for', :points_possible
+  it_behaves_like 'it has an attribute for', :mastery_points
+  it('has an attribute for ratings') { expect(subject.ratings).to eql [] }
+  it_behaves_like 'it has an attribute for', :is_global_outcome
+  it_behaves_like 'it has an attribute for', :external_identifier
+end

data/spec/moodle2cc/canvas_cc/models/page_spec.rb

@@ -11,8 +11,6 @@ module CanvasCc::CanvasCC::Models
     it_behaves_like 'it has an attribute for', :body
     it_behaves_like 'it has an attribute for', :title
 
-    its(:type) { should eq 'webcontent' }
-
     it "hashes the identifier" do
       page.identifier = 3
       expect(page.identifier).to eq 3
@@ -31,4 +29,4 @@ module CanvasCc::CanvasCC::Models
     end
 
   end
-end
+end

data/spec/moodle2cc/canvas_cc/models/rating_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::Models::Rating do
+  it_behaves_like 'it has an attribute for', :id
+  it_behaves_like 'it has an attribute for', :description
+  it_behaves_like 'it has an attribute for', :points
+  it_behaves_like 'it has an attribute for', :criterion_id
+  it_behaves_like 'it has an attribute for', :long_description
+end

data/spec/moodle2cc/canvas_cc/outcome_writer_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::OutcomeWriter do
+  let(:outcome) do
+    outcome = CanvasCc::CanvasCC::Models::Outcome.new
+    outcome.identifier = SecureRandom.hex
+    outcome.points_possible = 5
+    outcome.mastery_points = 5
+    outcome.is_global_outcome = false
+    outcome
+  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(outcome)
+
+    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 an outcome' do
+    xml = write_xml(outcome)
+    node = xml.at_xpath('//xmlns:learningOutcomes/xmlns:learningOutcome')
+    expect(node.attr(:identifier)).to eql outcome.identifier
+    expect(node.at_xpath('xmlns:points_possible').text).to eql '5'
+    expect(node.at_xpath('xmlns:mastery_points').text).to eql '5'
+    expect(node.at_xpath('xmlns:is_global_outcome').text).to eql 'false'
+  end
+
+  private
+  def write_xml(outcome)
+    CanvasCc::CanvasCC::OutcomeWriter.new(tmpdir, outcome).write
+    path = File.join(tmpdir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR,
+      CanvasCc::CanvasCC::OutcomeWriter::LEARNING_OUTCOMES_FILE)
+    Nokogiri::XML(File.read(path))
+  end
+end

data/spec/moodle2cc/canvas_cc/rating_writer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::RatingWriter do
+  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'
+    tmp_rating
+  end
+
+  it 'writes ratings' do
+    xml = write_xml rating
+    node = xml.at_xpath('//ratings/rating')
+    expect(node.at_xpath('id').text).to eql rating.id
+    expect(node.at_xpath('description').text).to eql rating.description
+    expect(node.at_xpath('points').text).to eql rating.points.to_s
+    expect(node.at_xpath('criterion_id').text).to eql rating.criterion_id
+    expect(node.at_xpath('long_description').text).to eql rating.long_description
+  end
+
+  private
+  def write_xml(rating)
+    writer = CanvasCc::CanvasCC::RatingWriter.new rating
+    Nokogiri::XML(writer.write)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_cc
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.27
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -282,11 +282,13 @@ files:
 - lib/canvas_cc/canvas_cc/models/module_prerequisite.rb
 - lib/canvas_cc/canvas_cc/models/multiple_dropdowns_question.rb
 - lib/canvas_cc/canvas_cc/models/numerical_question.rb
+- lib/canvas_cc/canvas_cc/models/outcome.rb
 - lib/canvas_cc/canvas_cc/models/page.rb
 - lib/canvas_cc/canvas_cc/models/question.rb
 - lib/canvas_cc/canvas_cc/models/question_bank.rb
 - lib/canvas_cc/canvas_cc/models/question_group.rb
 - 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/syllabus.rb
 - lib/canvas_cc/canvas_cc/models/web_content.rb
@@ -298,10 +300,12 @@ files:
 - lib/canvas_cc/canvas_cc/multiple_choice_question_writer.rb
 - lib/canvas_cc/canvas_cc/multiple_dropdowns_question_writer.rb
 - lib/canvas_cc/canvas_cc/numerical_question_writer.rb
+- lib/canvas_cc/canvas_cc/outcome_writer.rb
 - lib/canvas_cc/canvas_cc/page_writer.rb
 - lib/canvas_cc/canvas_cc/question_bank_writer.rb
 - 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/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
@@ -345,8 +349,10 @@ files:
 - spec/moodle2cc/canvas_cc/models/discussion_spec.rb
 - spec/moodle2cc/canvas_cc/models/discussion_topic_spec.rb
 - spec/moodle2cc/canvas_cc/models/module_item_spec.rb
+- spec/moodle2cc/canvas_cc/models/outcome_spec.rb
 - spec/moodle2cc/canvas_cc/models/page_spec.rb
 - spec/moodle2cc/canvas_cc/models/question_spec.rb
+- spec/moodle2cc/canvas_cc/models/rating_spec.rb
 - spec/moodle2cc/canvas_cc/models/resource_spec.rb
 - spec/moodle2cc/canvas_cc/models/web_content_spec.rb
 - spec/moodle2cc/canvas_cc/models/web_link_spec.rb
@@ -356,9 +362,11 @@ files:
 - spec/moodle2cc/canvas_cc/multiple_choice_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/multiple_dropdowns_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/numerical_question_writer_spec.rb
+- spec/moodle2cc/canvas_cc/outcome_writer_spec.rb
 - spec/moodle2cc/canvas_cc/page_writer_spec.rb
 - 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/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
@@ -452,8 +460,10 @@ test_files:
 - spec/moodle2cc/canvas_cc/models/discussion_spec.rb
 - spec/moodle2cc/canvas_cc/models/discussion_topic_spec.rb
 - spec/moodle2cc/canvas_cc/models/module_item_spec.rb
+- spec/moodle2cc/canvas_cc/models/outcome_spec.rb
 - spec/moodle2cc/canvas_cc/models/page_spec.rb
 - spec/moodle2cc/canvas_cc/models/question_spec.rb
+- spec/moodle2cc/canvas_cc/models/rating_spec.rb
 - spec/moodle2cc/canvas_cc/models/resource_spec.rb
 - spec/moodle2cc/canvas_cc/models/web_content_spec.rb
 - spec/moodle2cc/canvas_cc/models/web_link_spec.rb
@@ -463,9 +473,11 @@ test_files:
 - spec/moodle2cc/canvas_cc/multiple_choice_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/multiple_dropdowns_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/numerical_question_writer_spec.rb
+- spec/moodle2cc/canvas_cc/outcome_writer_spec.rb
 - spec/moodle2cc/canvas_cc/page_writer_spec.rb
 - 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/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