cc2html 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cc2html.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    cc2html (0.1.0)
+      builder
+      happymapper
+      nokogiri
+      rdiscount
+      rubyzip
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.0.9)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.3)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-bundler (2.0.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+    guard-minitest (2.0.0)
+      guard (~> 2.0)
+      minitest (>= 3.0)
+    happymapper (0.4.1)
+      libxml-ruby (~> 2.0)
+    libxml-ruby (2.7.0)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    mini_portile (0.5.2)
+    minitest (5.0.8)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rdiscount (2.1.7)
+    rubyzip (1.1.0)
+    slop (3.4.6)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cc2html!
+  guard
+  guard-bundler
+  guard-minitest
+  minitest
+  rake

data/Guardfile

@@ -0,0 +1,10 @@
+guard :bundler do
+  watch('Gemfile')
+  watch('cc2html.gemspec')
+end
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?(.*)_test\.rb|)
+  watch(%r|^lib/ims/cc/(.*?)([^/]+)\.rb|)     { |m| "test/unit/#{m[1]}#{m[2]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2013 Bracken Mosbacker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# cc2html
+
+cc2html will convert Common Cartridge 1.3 packages into html or epub format
+
+Common Cartridge information: http://www.imsglobal.org/cc/index.html
+
+Use the [Github Issues](https://github.com/instructure/cc2html/issues?state=open)
+for feature requests and bug reports.
+
+## Installation/Usage
+
+### Command line
+Install RubyGems on your system, see http://rubygems.org/ for instructions.
+Once RubyGems is installed you can install this gem:
+
+    $ gem install cc2html
+
+Convert a Common Cartridge into HTML
+
+    $ cc2html migrate <path-to-cc-backup> <path-to-html-export-directory>
+
+Or into an epub
+
+    $ cc2html migrate <path-to-cc-backup> <path-to-epub-export-directory> --format=epub
+    # then zip of the contents of the folder into a .epub
+
+## Todo
+
+ * Oh so much!
+ * Support converting all Common Cartridge versions
+ * Create chapters from organization sections
+ * Quiz conversion
+ * make epub zip automatically
+
+## Contributing
+
+Run the tests:
+
+    $ bundle exec rake
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task :default => :test

data/bin/cc2html

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'cc2html'
+require 'cc2html/cli'
+
+CC2HTML::CLI.start

data/cc2html.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cc2html/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Bracken Mosbacker"]
+  gem.description   = %q{Converts an IMS Common Cartridge package to a self-contained web site or epub}
+  gem.summary       = %q{Converts an IMS Common Cartridge package to a self-contained web site or epub}
+  gem.homepage      = "https://github.com/bracken/cc2html"
+
+  gem.add_runtime_dependency "rubyzip"
+  gem.add_runtime_dependency "happymapper"
+  gem.add_runtime_dependency "builder"
+  gem.add_runtime_dependency "thor"
+  gem.add_runtime_dependency "nokogiri"
+  gem.add_runtime_dependency "rdiscount"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-bundler"
+  gem.add_development_dependency "guard-minitest"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cc2html"
+  gem.require_paths = ["lib"]
+  gem.version       = CC2HTML::VERSION
+  gem.extra_rdoc_files = %W(LICENSE)
+  gem.license = 'MIT'
+end

data/lib/cc2html/builder.rb

@@ -0,0 +1,15 @@
+module CC2HTML
+  class Builder
+    def initialize(manifest, dest_dir)
+      @dest_dir = dest_dir
+      @manifest = manifest
+      @items = manifest.organizations.organization.item.items
+      lom = manifest.metadata.lom
+      @title = lom.general.title.title
+      @description = lom.general.description.description if lom.general.description
+      if lom.rights && lom.rights.description
+        @copy_info = lom.rights.description.description
+      end
+    end
+  end
+end

data/lib/cc2html/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+module CC2HTML
+  class CLI < Thor
+    desc "migrate COMMON_CARTRIDGE_ZIP EXPORT_DIR", "Migrates Common Cartridge ZIP to an HTML representation"
+    method_option :format, :default => 'html'
+    method_options :format => :string
+
+    def migrate(source, destination)
+      converter = CC2HTML::Converter.new source, destination, options
+      converter.convert
+      puts "#{source} converted to #{converter.cc_file_path}"
+    end
+  end
+end

data/lib/cc2html/converter.rb

@@ -0,0 +1,21 @@
+module CC2HTML
+  class Converter
+    attr_reader :cc_file_path, :dest_dir
+
+    def initialize(cc_file_path, dest_dir, options={})
+      @cc_file_path = cc_file_path
+      @dest_dir = dest_dir
+      @settings = options
+    end
+
+    def convert
+      manifest = IMS::CC::Manifest.read(@cc_file_path)
+      if @settings[:format] == 'html'
+        CC2HTML::HtmlBuilder.new(manifest, @dest_dir, @cc_file_path).generate
+      elsif @settings[:format] == 'epub'
+        CC2HTML::EpubBuilder.new(manifest, @dest_dir, @cc_file_path).generate
+      end
+    end
+
+  end
+end

data/lib/cc2html/epub_builder.rb

@@ -0,0 +1,96 @@
+module CC2HTML
+  class EpubBuilder < Builder
+    TEMPLATE_DIR = '../templates/epub/'
+
+    def initialize(manifest, dest_dir, zip_file=nil)
+      super(manifest, dest_dir)
+      @file_name = 'cc_book'
+      @content_dir = File.join(@dest_dir, 'content')
+      @zip_file = zip_file
+      @items_with_resource = @items.select{|i|i.resource}
+    end
+
+    def generate
+      FileUtils.mkdir_p(@dest_dir)
+      create_mimetype_file
+      create_meta_inf
+      FileUtils.mkdir_p(@content_dir)
+      create_opf
+      create_nav
+      create_chapters
+      copy_html_webresources
+    end
+
+    def create_mimetype_file
+      File.open(File.join(@dest_dir, 'mimetype'), 'w') do |f|
+        f << "application/epub+zip\n"
+      end
+    end
+
+    def create_nav
+      template = File.expand_path(TEMPLATE_DIR + 'navigation.html.erb', __FILE__)
+      path = File.join(@content_dir = File.join(@dest_dir, 'content'), 'navigation.html')
+
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+
+    def create_chapters
+      template = File.expand_path(TEMPLATE_DIR + 'chapter.html.erb', __FILE__)
+      @items_with_resource.each do |item|
+        next if item.resource.type == 'webcontent'
+        # so stupid... I'll fix later. :)
+        @item = item
+        path = File.join(@content_dir = File.join(@dest_dir, 'content'), item.identifierref + '.html')
+        File.open(path, 'w') do |file|
+          erb = ERB.new(File.read(template))
+          file.write(erb.result(binding))
+        end
+      end
+    end
+
+    def copy_html_webresources
+      return unless @zip_file.end_with?('zip') || @zip_file.end_with?('imscc')
+      Zip::File.open(@zip_file) do |zipfile|
+        @items_with_resource.each do |item|
+          if item.resource.type == 'webcontent' && item.resource.href && item.resource.href.end_with?('html')
+            puts item.identifier
+            path = File.join(@content_dir = File.join(@dest_dir, 'content'), item.identifierref + '.html')
+            File.open(path, 'w') do |file|
+              entry = zipfile.get_entry(item.resource.href)
+              file << entry.get_input_stream.read
+            end
+          end
+        end
+      end
+    end
+
+    def create_meta_inf
+      meta_dir = File.join(@dest_dir, 'META-INF')
+      FileUtils.mkdir_p(meta_dir)
+      File.open(File.join(meta_dir, 'container.xml'), 'w') do |f|
+        f << <<-XML
+<?xml version="1.0"?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+   <rootfiles>
+      <rootfile full-path="content/#{@file_name}.opf" media-type="application/oebps-package+xml"/>
+   </rootfiles>
+</container>
+XML
+      end
+    end
+
+    def create_opf
+      template = File.expand_path(TEMPLATE_DIR + 'descriptor.opf.erb', __FILE__)
+      path = File.join(@content_dir = File.join(@dest_dir, 'content'), @file_name + '.opf')
+
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+
+  end
+end

data/lib/cc2html/html_builder.rb

@@ -0,0 +1,23 @@
+module CC2HTML
+  class HtmlBuilder
+    TEMPLATE_DIR = '../templates/html/'
+    def initialize(manifest, dest_dir, zip_file)
+      @manifest = manifest
+      @dest_dir = dest_dir
+      @items = manifest.organizations.organization.item.items
+    end
+
+    def generate
+      FileUtils.mkdir_p(@dest_dir)
+      template = File.expand_path(TEMPLATE_DIR + 'index.html.erb', __FILE__)
+      path = File.join(@dest_dir, 'index.html')
+
+      #FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+
+  end
+end

data/lib/cc2html/templates/epub/chapter.html.erb

@@ -0,0 +1,54 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.1//EN' 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd'>
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
+  <title><%= @item.title %></title>
+</head>
+  <body>
+    <h1><%= @item.title %></h1>
+
+    <% if asmnt = @item.resource.assignment %>
+      <h2>Assignment</h2>
+      <p><%= asmnt.text %></p>
+      <% if asmnt.instructor_text %>
+        <p>Instructor Text: <%= asmnt.instructor_text %></p>
+      <% end %>
+      <% if asmnt.submission_formats && asmnt.submission_formats.any? %>
+        <p>Ways to turn the assignment in:</p>
+        <ul>
+          <% asmnt.submission_formats.each do |sf| %>
+            <li><%= sf %></li>
+          <% end %>
+        </ul>
+      <% end %>
+      <% if asmnt.attachments %>
+        <h3>Attachments</h3>
+        <ul>
+          <% asmnt.attachments.attachments.each do |att| %>
+            <li><%= att.href %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    <% end %>
+
+    <% if topic = @item.resource.topic %>
+      <h2>Discussion Topic</h2>
+      <p><%= topic.text %></p>
+      <% if topic.attachments %>
+        <h3>Attachments</h3>
+        <ul>
+          <% topic.attachments.attachments.each do |att| %>
+            <li><%= att.href %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    <% end %>
+
+    <% if web_link = @item.resource.web_link %>
+      <p>Visit the web site <a href="<%= web_link.url.href %>"><%= web_link.title %></a></p>
+    <% end %>
+
+
+  </body>
+</html>

data/lib/cc2html/templates/epub/descriptor.opf.erb

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?><package xmlns:opf="http://www.idpf.org/2007/opf" xmlns:dcterms="http://purl.org/dc/terms/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.idpf.org/2007/opf" version="2.0" unique-identifier="id">
+  <metadata>
+    <dc:rights><%= @copy_info || 'Public domain' %></dc:rights>
+    <dc:creator opf:file-as="Unknown, Author">Unknown Author</dc:creator>
+    <dc:title><%= @title %></dc:title>
+    <dc:language xsi:type="dcterms:RFC4646">en</dc:language>
+    <dc:date opf:event="publication"><%= Time.now.strftime("%Y-%m-%d") %></dc:date>
+  </metadata>
+  <manifest>
+    <item href="navigation.html" media-type="application/xhtml+xml" id="toc" properties="nav"/>
+    <% @items_with_resource.each do |item| %>
+      <item href="<%= item.identifierref %>.html" id="<%= item.identifierref %>" media-type="application/xhtml+xml"/>
+    <% end %>
+  </manifest>
+  <spine>
+    <itemref idref="toc" linear="yes"/>
+    <% @items_with_resource.each do |item| %>
+      <itemref idref="<%= item.identifierref %>" linear="yes"/>
+    <% end %>
+  </spine>
+</package>

data/lib/cc2html/templates/epub/navigation.html.erb

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
+  <head><title>Table of contents</title></head>
+  <body><nav xmlns="http://www.w3.org/1999/xhtml" class="book" epub:type="toc">
+<ol>
+<% @items.each do |item| %>
+  <li><a href="<%= item.identifierref %>.html"><%= item.title %></a></li>
+<% end %>
+</ol>
+</nav></body>
+</html>

data/lib/cc2html/templates/html/assignment.html.erb

@@ -0,0 +1,13 @@
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <% if meta_fields
+       meta_fields.each_pair do |key, val|%>
+  <meta name="<%= key %>" content="<%= val %>" /> <% end %>
+  <% end %>
+  <title>Assignment: <%= title %></title>
+</head>
+<body>
+<%= body %>
+</body>
+</html>

data/lib/cc2html/templates/html/index.html.erb

@@ -0,0 +1,13 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Index</title>
+</head>
+<body>
+  <ul>
+    <% @items.each do |item| %>
+      <li><%= item.identifier %></li>
+    <% end %>
+  </ul>
+</body>
+</html>

data/lib/cc2html/templates/html/wiki_content.html.erb

@@ -0,0 +1,10 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title><%= title %></title>
+<meta name="identifier" content="<%= identifier %>"/>
+</head>
+<body>
+<%= body %>
+</body>
+</html>

data/lib/cc2html/version.rb

@@ -0,0 +1,3 @@
+module CC2HTML
+  VERSION = "0.0.1"
+end

data/lib/cc2html.rb

@@ -0,0 +1,10 @@
+require 'ims/cc'
+require 'erb'
+
+module CC2HTML
+end
+
+require 'cc2html/converter'
+require 'cc2html/builder'
+require 'cc2html/html_builder'
+require 'cc2html/epub_builder'

data/lib/ims/cc/assignment.rb

@@ -0,0 +1,37 @@
+module IMS::CC
+module Assignment
+
+  class Format
+    include HappyMapper
+
+    tag 'format'
+    attribute :type, String
+  end
+
+  class SubmissionFormats
+    include HappyMapper
+
+    tag 'submission_formats'
+    has_many :formats, Format
+  end
+
+  class Assignment
+    include HappyMapper
+    namespace 'http://www.imsglobal.org/xsd/imscc_extensions/assignment'
+
+    tag 'assignment'
+    element :title, String
+    element :text, String, :attributes => {href: String, texttype: String}
+    element :instructor_text, String, :attributes => {href: String, texttype: String}
+    element :gradable, Boolean
+    has_one :submission_formats, SubmissionFormats
+    has_one :attachments, IMS::CC::Attachments
+
+    after_parse do |assignment|
+      if assignment.submission_formats
+        assignment.submission_formats = assignment.submission_formats.formats.map{|f|f.type}
+      end
+    end
+  end
+end
+end

data/lib/ims/cc/cc.rb

@@ -0,0 +1,16 @@
+module IMS::CC
+  class Attachment
+    include HappyMapper
+
+    tag 'attachment'
+    attribute :href, String
+    attribute :role, String
+  end
+
+  class Attachments
+    include HappyMapper
+
+    tag 'attachments'
+    has_many :attachments, Attachment
+  end
+end

data/lib/ims/cc/lom.rb

@@ -0,0 +1,65 @@
+module IMS::CC
+module Lom
+  NAMESPACE = 'http://ltsc.ieee.org/xsd/imsccv1p3/LOM/manifest'
+
+  class Title
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'title'
+    element :title, String, :tag => 'string'
+  end
+
+  class Description
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'description'
+    element :description, String, :tag => 'string'
+  end
+
+  class Keyword
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'keyword'
+    element :keyword, String, :tag => 'string'
+  end
+
+  class General
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'general'
+    has_one :title, Title
+    has_one :description, Description
+    has_many :keywords, Keyword
+  end
+
+  class CopyrightAndOtherRestrictions
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'copyrightAndOtherRestrictions'
+    element :value, String
+  end
+
+  class Rights
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'rights'
+    has_one :copyrightAndOtherRestrictions, CopyrightAndOtherRestrictions
+    has_one :description, Description
+  end
+
+  class Lom
+    include HappyMapper
+    namespace NAMESPACE
+
+    tag 'lom'
+    has_one :general, General
+    has_one :rights, Rights
+  end
+end
+end