cc2html 0.0.1 → 0.0.2

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cc2html (0.1.0)
+    cc2html (0.0.2)
       builder
       happymapper
       nokogiri
@@ -39,9 +39,9 @@ GEM
       rb-inotify (>= 0.9)
     lumberjack (1.0.4)
     method_source (0.8.2)
-    mini_portile (0.5.2)
+    mini_portile (0.5.3)
     minitest (5.0.8)
-    nokogiri (1.6.0)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
@@ -51,8 +51,8 @@ GEM
     rb-fsevent (0.9.3)
     rb-inotify (0.9.2)
       ffi (>= 0.5.0)
-    rdiscount (2.1.7)
-    rubyzip (1.1.0)
+    rdiscount (2.1.7.1)
+    rubyzip (1.1.3)
     slop (3.4.6)
     thor (0.18.1)
     timers (1.1.0)

data/README.md

@@ -15,22 +15,27 @@ Once RubyGems is installed you can install this gem:
 
     $ gem install cc2html
 
-Convert a Common Cartridge into HTML
+Convert a Common Cartridge into EPUB
 
-    $ cc2html migrate <path-to-cc-backup> <path-to-html-export-directory>
+    $ cc2html convert --format=epub <path-to-cc-backup> <name-of-epub-without-extension>
 
-Or into an epub
+Or into HTML (mostly broken) :)
 
-    $ cc2html migrate <path-to-cc-backup> <path-to-epub-export-directory> --format=epub
-    # then zip of the contents of the folder into a .epub
+    $ cc2html convert <path-to-cc-backup> <path-to-html-export-directory>
 
 ## Todo
 
- * Oh so much!
- * Support converting all Common Cartridge versions
- * Create chapters from organization sections
- * Quiz conversion
- * make epub zip automatically
+ - [ ] Oh so much!
+ - [ ] Support converting all Common Cartridge versions
+ - [x] Create chapters from organization sections
+ - [ ] Quiz conversion
+ - [ ] Styles so it looks good
+ - [ ] Configurable styles
+ - [ ] Write epub/html output tests
+ - [ ] Make HTML output work
+ - [ ] Make HTML/EPUB code more DRY
+ - [ ] Handle CC weblink/topic/assignment/LTI types better
+ - [x] Automatically zip up epub
 
 ## Contributing
 

data/lib/cc2html/builder.rb

@@ -1,9 +1,10 @@
 module CC2HTML
   class Builder
-    def initialize(manifest, dest_dir)
-      @dest_dir = dest_dir
+    def initialize(manifest, dest_name)
+      @dest_name = dest_name
       @manifest = manifest
-      @items = manifest.organizations.organization.item.items
+      @root_items = manifest.organizations.organization.item.items
+      @resources = manifest.resources.resources
       lom = manifest.metadata.lom
       @title = lom.general.title.title
       @description = lom.general.description.description if lom.general.description

data/lib/cc2html/cli.rb

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

data/lib/cc2html/converter.rb

@@ -2,18 +2,18 @@ module CC2HTML
   class Converter
     attr_reader :cc_file_path, :dest_dir
 
-    def initialize(cc_file_path, dest_dir, options={})
+    def initialize(cc_file_path, dest_name, options={})
       @cc_file_path = cc_file_path
-      @dest_dir = dest_dir
+      @dest_name = dest_name
       @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
+        CC2HTML::HtmlBuilder.new(manifest, @dest_name, @cc_file_path).generate
       elsif @settings[:format] == 'epub'
-        CC2HTML::EpubBuilder.new(manifest, @dest_dir, @cc_file_path).generate
+        CC2HTML::EpubBuilder.new(manifest, @dest_name, @cc_file_path, @settings).generate
       end
     end
 

data/lib/cc2html/epub_builder.rb

@@ -2,34 +2,51 @@ module CC2HTML
   class EpubBuilder < Builder
     TEMPLATE_DIR = '../templates/epub/'
 
-    def initialize(manifest, dest_dir, zip_file=nil)
-      super(manifest, dest_dir)
+    def initialize(manifest, dest_name, zip_file, opts={})
+      super(manifest, dest_name)
       @file_name = 'cc_book'
-      @content_dir = File.join(@dest_dir, 'content')
+      @content_dir = File.join(@dest_name, 'content')
       @zip_file = zip_file
-      @items_with_resource = @items.select{|i|i.resource}
+      @items_with_resource = @manifest.organizations.organization.item.all_items.select{|i|i.resource}
+      @leave_in_folder = opts["leave_unzipped"]
     end
 
     def generate
-      FileUtils.mkdir_p(@dest_dir)
+      FileUtils.mkdir_p(@dest_name)
       create_mimetype_file
       create_meta_inf
       FileUtils.mkdir_p(@content_dir)
       create_opf
       create_nav
       create_chapters
-      copy_html_webresources
+      copy_images
+      copy_referenced_html_webresources
+      compress_into_epub
+    end
+
+    def compress_into_epub
+      unless @leave_in_folder
+        epub = @dest_name + '.epub'
+        FileUtils.rm(epub) if File.exists?(epub)
+        Zip::File.open(epub, Zip::File::CREATE) do |zipfile|
+          Dir["#{@dest_name}/**/**"].each do |file|
+            file_path = file.sub(@dest_name+'/', '')
+            zipfile.add(file_path, file)
+          end
+        end
+        FileUtils.rmtree(@dest_name)
+      end
     end
 
     def create_mimetype_file
-      File.open(File.join(@dest_dir, 'mimetype'), 'w') do |f|
+      File.open(File.join(@dest_name, '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')
+      path = File.join(@content_dir, 'navigation.html')
 
       File.open(path, 'w') do |file|
         erb = ERB.new(File.read(template))
@@ -43,7 +60,7 @@ module CC2HTML
         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')
+        path = File.join(@content_dir, item.identifierref + '.html')
         File.open(path, 'w') do |file|
           erb = ERB.new(File.read(template))
           file.write(erb.result(binding))
@@ -51,15 +68,34 @@ module CC2HTML
       end
     end
 
-    def copy_html_webresources
+    def copy_referenced_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')
+            path = File.join(@content_dir = File.join(@dest_name, 'content'), item.identifierref + '.html')
             File.open(path, 'w') do |file|
               entry = zipfile.get_entry(item.resource.href)
+              val = entry.get_input_stream.read
+              file << val.gsub('%24IMS_CC_FILEBASE%24', 'web_resources')
+              # file << entry.get_input_stream.read
+            end
+          end
+        end
+      end
+    end
+
+    def copy_images
+      return unless @zip_file.end_with?('zip') || @zip_file.end_with?('imscc')
+      Zip::File.open(@zip_file) do |zipfile|
+        @resources.each do |resource|
+          if resource.type == 'webcontent' && resource.href &&
+                  resource.href.start_with?('web_resources') &&
+                  File.extname(resource.href) =~ /gif|jpg|png/i
+            path = File.join(@content_dir, resource.href)
+            FileUtils.mkdir_p(File.dirname(path))
+            File.open(path, 'w') do |file|
+              entry = zipfile.get_entry(resource.href)
               file << entry.get_input_stream.read
             end
           end
@@ -68,7 +104,7 @@ module CC2HTML
     end
 
     def create_meta_inf
-      meta_dir = File.join(@dest_dir, 'META-INF')
+      meta_dir = File.join(@dest_name, 'META-INF')
       FileUtils.mkdir_p(meta_dir)
       File.open(File.join(meta_dir, 'container.xml'), 'w') do |f|
         f << <<-XML
@@ -84,7 +120,7 @@ XML
 
     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')
+      path = File.join(@content_dir, @file_name + '.opf')
 
       File.open(path, 'w') do |file|
         erb = ERB.new(File.read(template))

data/lib/cc2html/html_builder.rb

@@ -3,14 +3,14 @@ module CC2HTML
     TEMPLATE_DIR = '../templates/html/'
     def initialize(manifest, dest_dir, zip_file)
       @manifest = manifest
-      @dest_dir = dest_dir
-      @items = manifest.organizations.organization.item.items
+      @dest_name = dest_dir
+      @root_items = manifest.organizations.organization.item.items
     end
 
     def generate
-      FileUtils.mkdir_p(@dest_dir)
+      FileUtils.mkdir_p(@dest_name)
       template = File.expand_path(TEMPLATE_DIR + 'index.html.erb', __FILE__)
-      path = File.join(@dest_dir, 'index.html')
+      path = File.join(@dest_name, 'index.html')
 
       #FileUtils.mkdir_p(File.dirname(path))
       File.open(path, 'w') do |file|

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

@@ -1,11 +1,22 @@
 <?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>
+<head><title>Table of contents</title></head>
+<body>
+<nav xmlns="http://www.w3.org/1999/xhtml" class="book" epub:type="toc">
+  <% @root_items.select{|ri|ri.items.any?}.each_with_index do |root, chapter_index| %>
+    <h2>Chaper <%= chapter_index + 1 %>: <%= root.title %></h2>
+
+    <ol>
+      <% root.items.each do |item| %>
+        <% if item.identifierref && item.identifierref != '' %>
+          <li><a href="<%= item.identifierref %>.html"><%= item.title %></a></li>
+        <% else %>
+          <!-- Could have sub headers in index, but may only appropriate for pages -->
+          <!--<h3><%= item.title %></h3>-->
+        <% end %>
+      <% end %>
+    </ol>
+  <% end %>
+</nav>
+</body>
 </html>

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

@@ -5,7 +5,7 @@
 </head>
 <body>
   <ul>
-    <% @items.each do |item| %>
+    <% @root_items.each do |item| %>
       <li><%= item.identifier %></li>
     <% end %>
   </ul>

data/lib/cc2html/version.rb

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

data/lib/ims/cc/manifest.rb

@@ -29,16 +29,7 @@ module IMS::CC
 
     def post_process
       parse_references
-      connect_resources_to_org_item
-    end
-
-    def connect_resources_to_org_item
-      self.organizations.organization.item.items.each do |item|
-        next unless item.identifierref
-        if res = self.resources.find_by_identifier(item.identifierref)
-          item.resource = res
-        end
-      end
+      organizations.attach_resources_to_items(resources)
     end
 
     def parse_references

data/lib/ims/cc/organizations.rb

@@ -10,7 +10,33 @@ module Organizations
     attribute :identifierref, String
     element :title, String
 
-    has_many :items, Item
+    # This is so that it only select parent items of itself,
+    # otherwise HappyMapper does .// instead of ./
+    # can this reference its own namespace somehow?
+    has_many :items, Item, :xpath => "./#{HappyMapper::DEFAULT_NS}:item"
+
+    def find_by_identifier(id)
+      if id == identifier
+        self
+      else
+        items.each do |i|
+          if item = i.find_by_identifier(id)
+            return item
+          end
+        end
+      end
+    end
+
+    def attach_resources(resources)
+      @resource = resources.find_by_identifier(identifierref) if identifierref
+      items.each { |i| i.attach_resources(resources) }
+    end
+
+    def all_items(res=[])
+      res << self
+      items.each{|i|i.all_items(res)}
+      res
+    end
   end
 
   class Organization
@@ -29,7 +55,11 @@ module Organizations
     has_one :organization, Organization
 
     def find_item_by_identifier(id)
-      self.organization.item.items.find{|i| i.identifier == id}
+      organization.item.find_by_identifier(id)
+    end
+
+    def attach_resources_to_items(resources)
+      organization.item.attach_resources(resources)
     end
   end
 

data/lib/ims/cc/topic.rb

@@ -1,10 +1,10 @@
 module IMS::CC
   class Topic
     include HappyMapper
-    #register_namespace('http://www.imsglobal.org/xsd/imsccv1p3/imsdt_v1p3', 'dt3')
-    #register_namespace('http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1', 'dt1')
+    # register_namespace('http://www.imsglobal.org/xsd/imsccv1p3/imsdt_v1p3', 'dt3')
+    # register_namespace('http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1', 'dt1')
     namespace 'http://www.imsglobal.org/xsd/imsccv1p3/imsdt_v1p3'
-    #namespace 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1'
+    # namespace 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1'
 
     tag 'topic'
     element :title, String

data/test/fixtures/flat_imsmanifest.xml

@@ -59,7 +59,16 @@
           <item identifier="I_00003" identifierref="Resource3">
             <title>Open2.net</title>
           </item>
-          <item identifier="I_00004" identifierref="Resource4">
+          <item identifier="I_00003">
+            <title>Child Folder</title>
+            <item identifier="I_00004" identifierref="Resource4">
+              <title>LTI Launch</title>
+            </item>
+          </item>
+        </item>
+        <item identifier="I_2">
+          <title>Folder 2</title>
+          <item identifier="I_00005" identifierref="Resource4">
             <title>LTI Launch</title>
           </item>
         </item>

data/test/unit/cc/organizations_test.rb

@@ -14,20 +14,41 @@ class TestUnitOrganizations < Minitest::Test
     assert_equal 'rooted-hierarchy', @orgs.organization.structure
   end
 
-  # have to figure out why happy mapper gets all items instead of just 1st children
-  #def test_it_creates_item_tree
-  #  assert_equal 1, @orgs.organization.item.items.count
-  #  assert_equal 4, @orgs.organization.item.items[0].count
-  #end
+  def test_it_creates_item_tree
+    assert_instance_of IMS::CC::Organizations::Item, @orgs.organization.item
+    assert_equal 2, @orgs.organization.item.items.count
+    assert_equal 4, @orgs.organization.item.items[0].items.count
+    assert_equal 1, @orgs.organization.item.items[0].items[3].items.count
+    assert_equal 1, @orgs.organization.item.items[1].items.count
+  end
 
   def test_gets_item_info
-    assert_equal "I_00000", @orgs.organization.item.items[0].identifier
-    assert_equal "CCv1.3 With Assignment", @orgs.organization.item.items[0].title
-    assert_equal '', @orgs.organization.item.items[0].identifierref
-
-    assert_equal "I_00001", @orgs.organization.item.items[1].identifier
-    assert_equal "Cool Assignment", @orgs.organization.item.items[1].title
-    assert_equal "Resource1", @orgs.organization.item.items[1].identifierref
+    folder1 = @orgs.organization.item.items[0]
+    assert_equal "I_00000", folder1.identifier
+    assert_equal "CCv1.3 With Assignment", folder1.title
+    assert_equal '', folder1.identifierref
+
+    assert_equal "I_00001", folder1.items[0].identifier
+    assert_equal "Cool Assignment", folder1.items[0].title
+    assert_equal "Resource1", folder1.items[0].identifierref
+
+    sub_folder = folder1.items.last
+    assert_equal "I_00003", sub_folder.identifier
+    assert_equal "Child Folder", sub_folder.title
+    assert_equal "", sub_folder.identifierref
+
+    assert_equal "I_00004", sub_folder.items[0].identifier
+    assert_equal "LTI Launch", sub_folder.items[0].title
+    assert_equal "Resource4", sub_folder.items[0].identifierref
+
+    folder2 = @orgs.organization.item.items[1]
+    assert_equal "I_2", folder2.identifier
+    assert_equal "Folder 2", folder2.title
+    assert_equal "", folder2.identifierref
+
+    assert_equal "I_00005", folder2.items[0].identifier
+    assert_equal "LTI Launch", folder2.items[0].title
+    assert_equal "Resource4", folder2.items[0].identifierref
   end
 
   def test_item_references_resource

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cc2html
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -196,6 +196,7 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 files:
+- .ruby-version
 - Gemfile
 - Gemfile.lock
 - Guardfile