canvas_link_migrator 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68ad9b1c1c452ba59ce56cae7ec072c38c185a4b5e4e3457082d8356dc95cd95
-  data.tar.gz: cc85f34cf8cb4abdb812d6582f213371afc6ccfd0a8ca6bb11f6152367d3d359
+  metadata.gz: 69ea954296733466368b26038c4408f864cb840c758591a3129a5cb0c2970a96
+  data.tar.gz: 4bb90f2745274adfe514bd22ff321a2ec62dafd379b6ad3cb90aff739c2a8fee
 SHA512:
-  metadata.gz: 8c8c85af3a7357591b9f07ddae0c98649c72880fc134c56cdafb20deb5083d2379020b7c459b191beeb4973f8fab878c831fb39b801b4249f4f8d1407eaec040
-  data.tar.gz: eded5e2885a8e3be4c22a2878c75e7ad889621f5a0f2bc4b57242656e5800aab0ad87d1ce5d18185b4080c1526f50382b81c49330feb74bf3d90925926cdbea3
+  metadata.gz: 26f74e87e3e4a5240d7e0de8782d429d0e194ac311d9453ae636b7cbe114bfdb5fda2948b3c6fd135f462cd5a59369406e3eb908e595b4ab0a1669eb45f536e0
+  data.tar.gz: 31a6317ec5d8fdd8ba524713a5f71ad948740ce6ae27e5f35b3691a78222efeb04a25cf8c127b4c76791e01588831e9df96dc3deea60a2485d31b4d342d7aed8

data/lib/canvas_link_migrator/link_parser.rb

@@ -210,7 +210,9 @@ module CanvasLinkMigrator
                    migration_id: $1,
                    rest: $2,
                    in_media_iframe: attr == "src" && ["iframe", "source"].include?(node.name) && node["data-media-id"],
-                   media_attachment: media_attachment)
+                   media_attachment: media_attachment,
+                   target_blank: node['target'] == "_blank" && node.name == "a" && attr == "href"
+        )
       elsif url =~ %r{(?:\$CANVAS_OBJECT_REFERENCE\$|\$WIKI_REFERENCE\$)/([^/]*)/([^?]*)(\?.*)?}
         if KNOWN_REFERENCE_TYPES.include?($1)
           unresolved(:object, type: $1, migration_id: $2, query: $3)

data/lib/canvas_link_migrator/link_resolver.rb

@@ -116,13 +116,14 @@ module CanvasLinkMigrator
       when :file_ref
         file_id = @migration_id_converter.convert_attachment_migration_id(link[:migration_id])
         if file_id
-          rest = link[:rest].presence || "/preview"
+          rest = link[:rest].presence
+          rest ||= "/preview" unless link[:target_blank]
 
           # Icon Maker files should not have the course
           # context prepended to the URL. This prevents
           # redirects to non cross-origin friendly urls
           # during a file fetch
-          if rest.include?("icon_maker_icon=1")
+          if rest&.include?("icon_maker_icon=1")
             link[:new_value] = "/files/#{file_id}#{rest}"
           elsif link[:in_media_iframe] && link[:media_attachment]
             link[:new_value] = "/media_attachments_iframe/#{file_id}#{rest}"

data/lib/canvas_link_migrator/resource_map_service.rb

@@ -69,7 +69,7 @@ module CanvasLinkMigrator
 
     # Looks up a wiki page slug for a migration id
     def convert_wiki_page_migration_id_to_slug(migration_id)
-      resources.dig("wiki_pages", migration_id, "destination", "url")
+      resources.dig("wiki_pages", migration_id, "destination", "url") || resources.dig("pages", migration_id, "destination", "url")
     end
 
     # looks up a discussion topic

data/lib/canvas_link_migrator/version.rb

@@ -1,3 +1,3 @@
 module CanvasLinkMigrator
-  VERSION = "0.0.1"
+  VERSION = "1.0.5"
 end

data/spec/canvas_link_migrator/imported_html_converter_spec.rb

@@ -25,7 +25,7 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
   # tests link_parser and link_resolver
 
   describe ".convert" do
-    before do
+    before(:each) do
       @path = "/courses/2/"
       @converter = CanvasLinkMigrator::ImportedHtmlConverter.new(resource_map: JSON.parse(File.read("spec/fixtures/canvas_resource_map.json")))
     end
@@ -44,6 +44,24 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
       expect(bad_links).to be_nil
     end
 
+    context "when pages in resource map but no wiki_pages" do
+      before(:each) do
+        @converter = CanvasLinkMigrator::ImportedHtmlConverter.new(resource_map: JSON.parse(File.read("spec/fixtures/canvas_resource_map_pages.json")))
+      end
+
+        it "converts a wiki reference with migration id" do
+          test_string = %(<a href="%24WIKI_REFERENCE%24/pages/A?query=blah">Test Wiki Page</a>)
+          html, bad_links = @converter.convert_exported_html(test_string)
+          expect(html).to eq %(<a href="#{@path}pages/slug-a?query=blah">Test Wiki Page</a>)
+          expect(bad_links).to be_nil
+        end
+
+        it "converts a wiki reference by migration id" do
+          test_string = %(<a href="wiki_page_migration_id=A">Test Wiki Page</a>)
+          expect(@converter.convert_exported_html(test_string)).to eq([%(<a href="#{@path}pages/slug-a">Test Wiki Page</a>), nil])
+        end
+    end
+
     context "when course attachments exist" do
       subject { @converter.convert_exported_html(test_string) }
 

data/spec/canvas_link_migrator/link_parser_spec.rb

@@ -29,6 +29,12 @@ describe CanvasLinkMigrator::LinkParser do
   end
 
   describe "convert_link" do
+    it "marks target=_blank anchor tags" do
+      doc = Nokogiri::HTML5.fragment("<a target=\"_blank\"></a>")
+      parsed = parser.parse_url("$CANVAS_COURSE_REFERENCE$/file_ref/whatevs", doc.at_css('a'), "href")
+      expect(parsed[:target_blank]).to be true
+    end
+
     it "converts inner html of anchor tags when appropriate" do
       doc = Nokogiri::HTML5.fragment("<a href=\"$WIKI_REFERENCE$/pages/1\">$WIKI_REFERENCE$/pages/1</a>")
       parser.convert_link(doc.at_css('a'), "href","wiki_page", "migrationid", "")

data/spec/canvas_link_migrator/link_resolver_spec.rb

@@ -33,6 +33,12 @@ describe CanvasLinkMigrator::LinkResolver do
       expect(link[:new_value]).to eq("/courses/2/pages/slug-a?foo=bar")
     end
 
+    it "converts wiki_pages links with pages in resource map" do
+      link = { link_type: :wiki_page, migration_id: "A", query: "?foo=bar" }
+      resolver(JSON.parse(File.read("spec/fixtures/canvas_resource_map_pages.json"))).resolve_link!(link)
+      expect(link[:new_value]).to eq("/courses/2/pages/slug-a?foo=bar")
+    end
+
     it "converts module_item links" do
       link = { link_type: :module_item, migration_id: "C", query: "?foo=bar" }
       resolver.resolve_link!(link)
@@ -45,6 +51,12 @@ describe CanvasLinkMigrator::LinkResolver do
       expect(link[:new_value]).to eq("/courses/2/files/6/preview")
     end
 
+    it "does not suffix /preview to target blank links" do
+      link = { link_type: :file_ref, target_blank: true, migration_id: "F" }
+      resolver.resolve_link!(link)
+      expect(link[:new_value]).to eq("/courses/2/files/6")
+    end
+
     it "converts attachment urls" do
       link = { link_type: :object, type: "attachments", migration_id: "E", query: "?foo=bar" }
       resolver.resolve_link!(link)

data/spec/fixtures/canvas_resource_map_pages.json

@@ -0,0 +1,134 @@
+{
+    "attachment_path_id_lookup": {
+      "subfolder/test.png": "G",
+      "subfolder/with a space/test.png": "F",
+      "subfolder/with a space/yodawg.mov": "I",
+      "subfolder/withCapital/test.png": "migration_id!",
+      "lolcat.mp3": "H",
+      "test.png": "E"
+    },
+    "contains_migration_ids": true,
+    "destination_course": "2",
+    "destination_hosts": [
+      "apple.edu",
+      "kiwi.edu"
+    ],
+    "destination_root_folder": "course files/",
+    "resource_mapping": {
+      "announcements": {
+        "H": {
+          "source": {
+            "id": "9"
+          },
+          "destination": {
+            "id": "10"
+          }
+        }
+      },
+      "assignments": {
+        "I": {
+          "source": {
+            "id": "11"
+          },
+          "destination": {
+            "id": "12"
+          }
+        }
+      },
+      "discussion_topics": {
+        "G": {
+          "destination": {
+            "id": "7"
+          },
+          "source": {
+            "id": "6"
+          }
+        }
+      },
+      "files": {
+        "E": {
+          "destination": {
+            "id": "5",
+            "media_entry_id": "m-stuff"
+          },
+          "source": {
+            "id": "3",
+            "media_entry_id": "m-stuff"
+          }
+        },
+        "F": {
+          "destination": {
+            "id": "6",
+            "media_entry_id": "m-stuff"
+          },
+          "source": {
+            "id": "4",
+            "media_entry_id": "m-stuff"
+          }
+        },
+        "G": {
+          "destination": {
+            "id": "7"
+          },
+          "source": {
+            "id": "2"
+          }
+        },
+        "H": {
+          "destination": {
+            "id": "8",
+            "media_entry_id": "m-lolcat"
+          },
+          "source": {
+            "id": "3",
+            "media_entry_id": "m-lolcat"
+          }
+        },
+        "I": {
+          "destination": {
+            "id": "9",
+            "media_entry_id": "m-yodawg"
+          },
+          "source": {
+            "id": "4",
+            "media_entry_id": "m-yodawg"
+          }
+        }
+      },
+      "module_items": {
+        "C": {
+          "destination": {
+            "id": "3"
+          },
+          "source": {
+            "id": "2"
+          }
+        }
+      },
+      "modules": {
+        "J": {
+          "destination": {
+            "id": "36"
+          },
+          "source": {
+            "id": "22"
+          }
+        }
+      },
+      "pages": {
+        "A": {
+          "destination": {
+            "id": "2",
+            "url": "slug-a"
+          },
+          "source": {
+            "id": "1",
+            "url": "slug-a"
+          }
+        }
+      }
+    },
+    "source_course": "1",
+    "source_host": "pineapple.edu"
+  }
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Mysti Lilla
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-29 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -147,6 +147,7 @@ files:
 - spec/canvas_link_migrator/link_resolver_spec.rb
 - spec/canvas_link_migrator_spec.rb
 - spec/fixtures/canvas_resource_map.json
+- spec/fixtures/canvas_resource_map_pages.json
 - spec/spec_helper.rb
 - test.sh
 homepage: