From d5797f967bc8d7b8553b2e1393a03d53224dc85f Mon Sep 17 00:00:00 2001
From: John Corrigan <jcorrigan@instructure.com>
Date: Wed, 28 Oct 2015 13:00:51 -0500
Subject: [PATCH] handle files added directly to the item list of a module

fixes CNVS-23798

test plan:
- Have a course with content separated into modules, including specific
  files.
- Confirm that course is configured to sort by module (default
  behavior).
- Export course as an ePub at `/epub_exports`.
- Observe that file names are included as part of the module list.
- Click the link to get to the file template.
- Observe that the file can be viewed by clicking on the tile name.

Change-Id: I28c6afeba668714ed284cc5437fb06d522b4f855
Reviewed-on: https://gerrit.instructure.com/65988
Tested-by: Jenkins
Reviewed-by: Matt Berns <mberns@instructure.com>
Product-Review: John Corrigan <jcorrigan@instructure.com>
QA-Review: John Corrigan <jcorrigan@instructure.com>
---
 lib/cc/exporter/epub/book.rb                  |  4 ++--
 .../epub/converters/files_converter.rb        |  2 +-
 .../epub/converters/media_converter.rb        | 15 ++++++++++++--
 .../epub/converters/object_path_converter.rb  |  2 +-
 lib/cc/exporter/epub/exporter.rb              |  8 +++++---
 .../epub/templates/files_template.html.erb    | 20 +++++++++++++++++++
 .../module_sorting_template.html.erb          |  2 +-
 spec/lib/cc/exporter/epub/exporter_spec.rb    |  2 +-
 8 files changed, 44 insertions(+), 11 deletions(-)
 create mode 100644 lib/cc/exporter/epub/templates/files_template.html.erb

diff --git a/lib/cc/exporter/epub/book.rb b/lib/cc/exporter/epub/book.rb
index 44765edd959..ee83f0e4577 100644
--- a/lib/cc/exporter/epub/book.rb
+++ b/lib/cc/exporter/epub/book.rb
@@ -12,7 +12,7 @@ module CC::Exporter::Epub
     def add_files
       files.each do |file_data|
         File.open(file_data[:path_to_file]) do |file|
-          epub.add_item(file_data[:local_path], file, file_data[:migration_id], {
+          epub.add_item(file_data[:local_path], file, file_data[:identifier], {
             'media-type' => file_data[:media_type]
           })
         end
@@ -40,7 +40,7 @@ module CC::Exporter::Epub
         b.set_primary_identifier(pub_id)
         b.language = I18n.locale
         b.add_title(title, nil, GEPUB::TITLE_TYPE::MAIN) do |title|
-          title.file_as = "#{title} Epub"
+          title.file_as = "#{title} ePub"
           title.display_seq = 1
         end
         b.add_creator('Canvas by Instructure') do |creator|
diff --git a/lib/cc/exporter/epub/converters/files_converter.rb b/lib/cc/exporter/epub/converters/files_converter.rb
index 1adb50a9a22..200b8ff3de1 100644
--- a/lib/cc/exporter/epub/converters/files_converter.rb
+++ b/lib/cc/exporter/epub/converters/files_converter.rb
@@ -57,7 +57,7 @@ module CC::Exporter::Epub::Converters
 
       def to_h
         return {
-          migration_id: data['identifier'],
+          identifier: data['identifier'],
           local_path: local_path,
           file_name: File.basename(local_path),
           path_to_file: path_to_file,
diff --git a/lib/cc/exporter/epub/converters/media_converter.rb b/lib/cc/exporter/epub/converters/media_converter.rb
index 225e882bdbe..d41ab7ae1af 100644
--- a/lib/cc/exporter/epub/converters/media_converter.rb
+++ b/lib/cc/exporter/epub/converters/media_converter.rb
@@ -97,7 +97,12 @@ module CC::Exporter::Epub::Converters
     #
     # <audio src='media/audio.mp3' controls='controls' />
     def convert_audio_tags!(html_node)
-      html_node.search('a.instructure_audio_link, a.audio_comment').each do |audio_link|
+      selector = [
+        "a.instructure_audio_link",
+        "a.audio_comment",
+        "a[href$='mp3']"
+      ].join(',')
+      html_node.search(selector).each do |audio_link|
         audio_link.replace(<<-AUDIO_TAG)
           <audio src="#{audio_link['href']}" controls="controls">
             #{I18n.t('Audio content is not supported by your device or app.')}
@@ -117,7 +122,13 @@ module CC::Exporter::Epub::Converters
     #
     # <video src='media/video.mp4' controls='controls' />
     def convert_video_tags!(html_node)
-      html_node.search('a.instructure_video_link, a.video_comment').each do |video_link|
+      selector = [
+        "a.instructure_video_link",
+        "a.video_comment",
+        "a[href$='m4v']",
+        "a[href$='mp4']"
+      ].join(',')
+      html_node.search(selector).each do |video_link|
         video_link.replace(<<-VIDEO_TAG)
           <video src="#{video_link['href']}" controls="controls">
             #{I18n.t('Video content is not supported by your device or app.')}
diff --git a/lib/cc/exporter/epub/converters/object_path_converter.rb b/lib/cc/exporter/epub/converters/object_path_converter.rb
index 8380a7cd14c..5b30cf9110e 100644
--- a/lib/cc/exporter/epub/converters/object_path_converter.rb
+++ b/lib/cc/exporter/epub/converters/object_path_converter.rb
@@ -35,7 +35,7 @@ module CC::Exporter::Epub::Converters
     end
 
     def object_path_selector
-      selector = [
+      return [
         "a", [
           "[href*='#{OBJECT_TOKEN.gsub('$', '')}']",
           "[href*='#{WIKI_TOKEN.gsub('$', '')}']"
diff --git a/lib/cc/exporter/epub/exporter.rb b/lib/cc/exporter/epub/exporter.rb
index c700429f66c..15f2e453f78 100644
--- a/lib/cc/exporter/epub/exporter.rb
+++ b/lib/cc/exporter/epub/exporter.rb
@@ -10,11 +10,13 @@ module CC::Exporter::Epub
       announcements: "Announcements",
       topics: "Discussion Topics",
       quizzes: "Quizzes",
-      pages: "Wiki Pages"
+      pages: "Wiki Pages",
+      files: "Files"
     }.freeze
 
     LINKED_RESOURCE_KEY = {
       "Assignment" => :assignments,
+      "Attachment" => :files,
       "DiscussionTopic" => :topics,
       "Quizzes::Quiz" => :quizzes,
       "WikiPage" => :pages
@@ -34,7 +36,7 @@ module CC::Exporter::Epub
     def templates
       @_templates ||= {
         title: cartridge_json[:title],
-        files: cartridge_json[:files]
+        files: cartridge_json[:files],
       }.tap do |hash|
         resources = filter_syllabus_for_modules ? module_ids : LINKED_RESOURCE_KEY.values
         hash.merge!(
@@ -42,7 +44,7 @@ module CC::Exporter::Epub
           :announcements => create_universal_template(:announcements)
         )
         resources.each do |resource_type|
-          hash.merge!(resource_type => create_content_template(resource_type))
+          hash.reverse_merge!(resource_type => create_content_template(resource_type))
         end
       end
     end
diff --git a/lib/cc/exporter/epub/templates/files_template.html.erb b/lib/cc/exporter/epub/templates/files_template.html.erb
new file mode 100644
index 00000000000..7e8a57dbfe2
--- /dev/null
+++ b/lib/cc/exporter/epub/templates/files_template.html.erb
@@ -0,0 +1,20 @@
+<% if item.has_key?(:local_path) %>
+  <h2 id="<%= item[:identifier] %>">
+    <%= item[:file_name] %>
+  </h2>
+  <%= convert_media_from_string!(<<-HTML)
+    <a href="#{item[:local_path]}">
+      #{I18n.t("Click here to see the file.")}
+    </a>
+    HTML
+  %>
+<% else %>
+  <h2 id="<%= item[:linked_resource_id] %>">
+    <%= item[:title] %>
+  </h2>
+  <%= I18n.t(
+    "File %{filename} could not be included in the ePub document. Please see separate zip file for access.", {
+      filename: item[:title]
+    })
+  %>
+<% end %>
diff --git a/lib/cc/exporter/epub/templates/module_sorting_template.html.erb b/lib/cc/exporter/epub/templates/module_sorting_template.html.erb
index d9a66f9f743..7e87c479a93 100644
--- a/lib/cc/exporter/epub/templates/module_sorting_template.html.erb
+++ b/lib/cc/exporter/epub/templates/module_sorting_template.html.erb
@@ -7,7 +7,7 @@
     <h1 id="<%= content[:migration_id]%>"><%= title %></h1>
     <ol>
     <% content[:items].each do |item| %>
-      <li><a href="#<%= "#{item[:identifier]}" %>"><%= item[:title] %></a></li>
+      <li><a href="#<%= "#{item[:linked_resource_id]}" %>"><%= item[:title] %></a></li>
     <% end %>
     </ol>
     <div style="page-break-before:always;"></div>
diff --git a/spec/lib/cc/exporter/epub/exporter_spec.rb b/spec/lib/cc/exporter/epub/exporter_spec.rb
index 99c50a1284b..cfb21611548 100644
--- a/spec/lib/cc/exporter/epub/exporter_spec.rb
+++ b/spec/lib/cc/exporter/epub/exporter_spec.rb
@@ -39,7 +39,7 @@ describe "Exporter" do
     it "should not contain content type keys" do
       # once we have a more robust imscc we should add another test to check
       # that the keys reflect the module migration ids
-      content_keys = CC::Exporter::Epub::Exporter::LINKED_RESOURCE_KEY.values
+      content_keys = CC::Exporter::Epub::Exporter::LINKED_RESOURCE_KEY.except("Attachment").values
       expect(content_keys.any? {|k| exporter.templates.key?(k)}).to be_falsey
     end
   end