canvas_cc 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 335a9d5e80554dd49b1f2a808572f76dcb9a893b
-  data.tar.gz: 53d0b452e3d8c12e80c429d0b3a04305089ae674
+  metadata.gz: f549d5258b5e77abe036e1c2070fcd2351345c8d
+  data.tar.gz: 2778c373ba05e902c8c2218c85ea27d0d902c602
 SHA512:
-  metadata.gz: 68777d5e4bfd36a453e9fa28c0d9b059d2e1875b80aa3901a66e2cfa16ebc60a65b69b7b55f36b69e269a1005b0017ecc75efb1288164ab9abd03188d72eca7b
-  data.tar.gz: 7a839022ffee44b07107454e08a1be76bfda54dca1e8115eb06659d9dccfa2c815229b2a1bdb8c4b3b91a24a36d2b67517eb9f28a753ea6b4ad705b128fd1b2b
+  metadata.gz: 8834a9d8cd2be57252702bba48465b14172fd654bb653e9ec06d8b05df702082be980f4799ba8c506922ef2fb32aa6dd863346e5df63d9bac0d85fa22999dc1e
+  data.tar.gz: 2fbd1b27bda3cbe03cd0fcca130a8c091c23b415448a39c66c41e1d0f5aa1ba54d8a91df28ed5292ca26e3d6576ab6e34e80d7239275eb196190eadf9d7fde38

data/lib/canvas_cc/canvas_cc/cartridge_creator.rb

@@ -41,6 +41,7 @@ module CanvasCc::CanvasCC
       Dir.mkdir(File.join(dir, COURSE_SETTINGS_DIR))
       CanvasCc::CanvasCC::CanvasExportWriter.new(dir).write
       CanvasCc::CanvasCC::CourseSettingWriter.new(dir, @course).write
+      CanvasCc::CanvasCC::CourseSyllabusWriter.new(dir, @course.syllabus).write
       CanvasCc::CanvasCC::AssignmentGroupWriter.new(dir, @course.assignment_groups).write
       CanvasCc::CanvasCC::ModuleMetaWriter.new(dir, *@course.canvas_modules).write
       CanvasCc::CanvasCC::ImsManifestGenerator.new(dir, @course).write

data/lib/canvas_cc/canvas_cc/course_syllabus_writer.rb

@@ -0,0 +1,42 @@
+module CanvasCc::CanvasCC
+  class CourseSyllabusWriter
+
+    COURSE_SYLLABUS_FILE = 'syllabus.html'
+
+    def initialize(work_dir, syllabus)
+      @work_dir = work_dir
+      @syllabus = syllabus
+    end
+
+    def write
+      return if @syllabus == nil
+
+      builder = build_syllabus_html
+
+      syllabus_directory = File.join(@work_dir, CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR)
+      FileUtils.mkdir_p(syllabus_directory)
+      syllabus_file = File.join(syllabus_directory, COURSE_SYLLABUS_FILE)
+      File.open(syllabus_file, 'w') do |f|
+        f.write(builder.to_html)
+      end
+    end
+
+    private
+
+    def build_syllabus_html
+      Nokogiri::HTML::Builder.new(:encoding => 'UTF-8') do |doc|
+        doc.html { |html|
+          html.head { |head|
+            head.meta('http-equiv' => 'Content-Type', content: 'text/html; charset=utf-8')
+            head.title 'Syllabus'
+          }
+
+          html.body { |body|
+            body << Nokogiri::HTML::fragment(@syllabus.html)
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/canvas_cc/canvas_cc/ims_manifest_generator.rb

@@ -6,6 +6,7 @@ module CanvasCc::CanvasCC
     SCHEMA_VERSION = '1.1.0'
     LOMIMSCC = 'lomimscc'
     SETTINGS_POSTFIX = '_settings'
+    SYLLABUS_POSTFIX = '_syllabus'
     TYPE_LAR = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
     CANVAS_EXPORT_PATH = 'course_settings/canvas_export.txt'
     ALL_MODULES_IDENTIFIER = 'LearningModules'
@@ -98,6 +99,7 @@ module CanvasCc::CanvasCC
     def resources(xml, resources)
       xml.resources { |xml|
         course_setting_resource(xml)
+        course_syllabus_resource(xml)
         resources.each do |resource|
           xml.resource(resource.attributes) do |xml|
             resource.files.each { |file| xml.file(href: file) }
@@ -118,6 +120,15 @@ module CanvasCc::CanvasCC
       }
     end
 
+    def course_syllabus_resource(xml)
+      course_settings_dir = CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR
+      syllabus_file = File.join(course_settings_dir, CanvasCc::CanvasCC::CourseSyllabusWriter::COURSE_SYLLABUS_FILE)
+      xml.resource('identifier' => @course.identifier + SYLLABUS_POSTFIX,
+                   'type' => TYPE_LAR,
+                   'href' => syllabus_file) do |xml|
+        xml.file('href' => syllabus_file)
+      end
+    end
 
   end
 end

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
+                  :assignments, :assessments, :question_banks, :assignment_groups, :folders, :syllabus
 
     def initialize
       @settings = {}

data/lib/canvas_cc/canvas_cc/models/syllabus.rb

@@ -0,0 +1,12 @@
+module CanvasCc::CanvasCC::Models
+  class Syllabus < CanvasCc::CanvasCC::Models::Resource
+
+    DIR = '/syllabus'
+
+    attr_accessor :html
+
+    def initialize
+      super
+    end
+  end
+end

data/lib/canvas_cc/version.rb

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

data/lib/canvas_cc.rb

@@ -53,6 +53,7 @@ module CanvasCc
     autoload :DiscussionWriter, 'canvas_cc/canvas_cc/discussion_writer'
     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 :QuestionWriter, 'canvas_cc/canvas_cc/question_writer'
     autoload :CalculatedQuestionWriter, 'canvas_cc/canvas_cc/calculated_question_writer'
@@ -74,6 +75,7 @@ module CanvasCc
     module Models
       autoload :Course, 'canvas_cc/canvas_cc/models/course'
       autoload :Assignment, 'canvas_cc/canvas_cc/models/assignment'
+      autoload :Syllabus, 'canvas_cc/canvas_cc/models/syllabus'
       autoload :AssignmentGroup, 'canvas_cc/canvas_cc/models/assignment_group'
       autoload :Assessment, 'canvas_cc/canvas_cc/models/assessment'
       autoload :DiscussionTopic, 'canvas_cc/canvas_cc/models/discussion_topic'

data/spec/moodle2cc/canvas_cc/cartridge_creator_spec.rb

@@ -13,6 +13,7 @@ module CanvasCc::CanvasCC
       course.canvas_modules << Models::CanvasModule.new
 
       CanvasExportWriter.any_instance.stub(:write)
+      CourseSyllabusWriter.any_instance.stub(:write)
       CourseSettingWriter.any_instance.stub(:write)
       ModuleMetaWriter.any_instance.stub(:write)
       ImsManifestGenerator.any_instance.stub(:write)
@@ -27,7 +28,7 @@ module CanvasCc::CanvasCC
       FileUtils.rm_r tmpdir
     end
 
-    [CanvasExportWriter, CourseSettingWriter, ModuleMetaWriter, ImsManifestGenerator,
+    [CanvasExportWriter, CourseSyllabusWriter, CourseSettingWriter, ModuleMetaWriter, ImsManifestGenerator,
      FileMetaWriter, PageWriter, DiscussionWriter, AssignmentWriter, QuestionBankWriter].each do |klass|
       it "writes #{klass}" do
         writer_double = double(write: nil)

data/spec/moodle2cc/canvas_cc/course_syllabus_writer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe CanvasCc::CanvasCC::CourseSyllabusWriter do
+  subject(:writer) { CanvasCc::CanvasCC::CourseSyllabusWriter.new(work_dir, syllabus) }
+  let(:work_dir) { Dir.mktmpdir }
+  let(:syllabus) { CanvasCc::CanvasCC::Models::Syllabus.new }
+
+  after(:each) do
+    FileUtils.rm_r work_dir
+  end
+
+  it 'it writes the syllabus html file' do
+    syllabus.html = '<h2>This is the body</h2>'
+    writer.write
+    html = Nokogiri::HTML(File.read(File.join(work_dir,
+                                              CanvasCc::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR,
+                                              CanvasCc::CanvasCC::CourseSyllabusWriter::COURSE_SYLLABUS_FILE)))
+    expect(html.at_css('meta[http-equiv]')[:'http-equiv']).to eq 'Content-Type'
+    expect(html.at_css('meta[http-equiv]')[:content]).to eq 'text/html; charset=utf-8'
+    expect(html.at_css('title').text).to eq 'Syllabus'
+    expect(html.at_css('body').inner_html.to_s).to eq '<h2>This is the body</h2>'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_cc
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - Instructure
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -258,6 +258,7 @@ files:
 - lib/canvas_cc/canvas_cc/canvas_export_writer.rb
 - lib/canvas_cc/canvas_cc/cartridge_creator.rb
 - lib/canvas_cc/canvas_cc/course_setting_writer.rb
+- lib/canvas_cc/canvas_cc/course_syllabus_writer.rb
 - lib/canvas_cc/canvas_cc/discussion_writer.rb
 - lib/canvas_cc/canvas_cc/essay_question_writer.rb
 - lib/canvas_cc/canvas_cc/file_meta_writer.rb
@@ -287,6 +288,7 @@ files:
 - lib/canvas_cc/canvas_cc/models/question_group.rb
 - lib/canvas_cc/canvas_cc/models/range.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
 - lib/canvas_cc/canvas_cc/models/web_link.rb
 - lib/canvas_cc/canvas_cc/models/workflow_state.rb
@@ -326,6 +328,7 @@ files:
 - spec/moodle2cc/canvas_cc/canvas_export_writer_spec.rb
 - spec/moodle2cc/canvas_cc/cartridge_creator_spec.rb
 - spec/moodle2cc/canvas_cc/course_setting_writer_spec.rb
+- spec/moodle2cc/canvas_cc/course_syllabus_writer_spec.rb
 - spec/moodle2cc/canvas_cc/discussion_writer_spec.rb
 - spec/moodle2cc/canvas_cc/essay_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb
@@ -420,7 +423,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Create Canvas CC compatible file
@@ -432,6 +435,7 @@ test_files:
 - spec/moodle2cc/canvas_cc/canvas_export_writer_spec.rb
 - spec/moodle2cc/canvas_cc/cartridge_creator_spec.rb
 - spec/moodle2cc/canvas_cc/course_setting_writer_spec.rb
+- spec/moodle2cc/canvas_cc/course_syllabus_writer_spec.rb
 - spec/moodle2cc/canvas_cc/discussion_writer_spec.rb
 - spec/moodle2cc/canvas_cc/essay_question_writer_spec.rb
 - spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb
@@ -506,3 +510,4 @@ test_files:
 - test/unit/logger_test.rb
 - test/unit/migrator_test.rb
 - test/unit/resource_factory_test.rb
+has_rdoc: