canvas_link_migrator 1.0.18 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 949c23c7d951df591af05de644bc829ceada5889aed295bb8e8dee5b897054ee
-  data.tar.gz: 8418a95af9eca811bf3e3848987bbd83bef233ca7aadaf33455f277cecb759b0
+  metadata.gz: 1295e9d9f0470130b2967896d1356ef0669d95082acf1f591347ee9896cae968
+  data.tar.gz: c28022e251c0755942ccdadb7462335ce3d97f29594d7ef7480c847a3c40bc2a
 SHA512:
-  metadata.gz: 0e886dbeaefd433185a7036739dba643c4c26add118b0dd737ee79db6e1dd7e384ba1a5389491023a857b72727055f494e2894746e5f55849ea13f11855c5b4b
-  data.tar.gz: 97f130e22876d639a79faf0b062442252df9392b8e2338a6bf6b46793a83d815b954b43e34f4e1ff1fce97f7e4856b4ca34e5085e1b212c58f653dc05ff89c9d
+  metadata.gz: da9757bd142342be4507fac11f7ad2c67f3b138f89a1db2e276ef5f80f363438b35512aef904ea0d6bfd9238c0d58ef90b5a21aaea0c8ededfe60456969e5bdc
+  data.tar.gz: cb128cfa720324395074336a325587d33940d6c664bf52df33988553347a8b4907ce1434e964194902920f7564276b1b9a0d88ed38c7d403a4c419869cdbc006

data/lib/canvas_link_migrator/imported_html_converter.rb

@@ -37,11 +37,14 @@ module CanvasLinkMigrator
       LinkParser::REFERENCE_KEYWORDS.each { |ref| url.gsub!("%24#{ref}%24", "$#{ref}$") }
       # create the link map for a single link (parse)
       link_parsing_result = link_parser.parse_single_url(url, link_type)
-      link_parser.handle_parsed_url(url, link_parsing_result, nil, nil, link_type, nil, nil)
-      # resolve_link! on the single element link map
-      link_resolver.resolve_link!(link_parsing_result, link_type)
-      # return the new value
-      link_parsing_result[:new_value]
+      if link_parsing_result[:resolved]
+        link_parser.perform_substitutions_and_make_relative_if_possible(url, link_parsing_result)
+      else
+        link_parser.handle_unresolved_link(url, link_parsing_result, nil, nil, link_type, nil, nil)
+        # resolve_link! on the single element link map
+        link_resolver.resolve_link!(link_parsing_result, link_type)
+        link_parsing_result[:new_value]
+      end
     end
 
     def convert_exported_html(input_html)

data/lib/canvas_link_migrator/link_parser.rb

@@ -180,7 +180,7 @@ module CanvasLinkMigrator
       add_unresolved_link(result, item_type, mig_id, field)
     end
 
-    def handle_resolved_link(url, result, node, attr)
+    def perform_substitutions_and_make_relative_if_possible(url, result)
       new_url = result[:new_url] || url
       unless CanvasLinkMigrator.relative_url?(new_url)
         # perform configured substitutions
@@ -200,7 +200,11 @@ module CanvasLinkMigrator
           nil
         end
       end
-      node[attr] = new_url
+      new_url
+    end
+
+    def handle_resolved_link(url, result, node, attr)
+      node[attr] = perform_substitutions_and_make_relative_if_possible(url, result)
     end
 
     def unresolved(type, data = {})

data/lib/canvas_link_migrator/version.rb

@@ -1,3 +1,3 @@
 module CanvasLinkMigrator
-  VERSION = "1.0.18"
+  VERSION = "1.0.19"
 end

data/spec/canvas_link_migrator/imported_html_converter_spec.rb

@@ -438,5 +438,198 @@ describe CanvasLinkMigrator::ImportedHtmlConverter do
       link = @converter.convert_single_link(test_string)
       expect(link).to eq "/courses/2/files/9?verifier=u9&type=video&amp=&embedded=true"
     end
+
+    it "handles $CANVAS_COURSE_REFERENCE$/ without crashing" do
+      link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$/")
+      expect(link).to eq "#{@path}"
+    end
+
+    it "handles $CANVAS_COURSE_REFERENCE$/ with link_type: :media_object without crashing" do
+      # Not sure this is a realistic case, but we should at least not crash on it
+      link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$/", link_type: :media_object)
+      expect(link).to eq "#{@path}"
+    end
+
+    it "handles external URLs without crashing" do
+      link = @converter.convert_single_link("http://example.com/")
+      expect(link).to eq "http://example.com/"
+    end
+
+    it "returns nil for failed assignment substitution" do
+      link = @converter.convert_single_link("$CANVAS_OBJECT_REFERENCE$/assignments/noexist")
+      # passing thru might also be acceptable
+      expect(link).to be_nil
+    end
+
+    it "doesn't care about existence of wiki page slugs" do
+      link = @converter.convert_single_link("$WIKI_REFERENCE$/pages/slug-no-exist")
+      expect(link).to eq "/courses/2/pages/slug-no-exist"
+    end
+
+    it "doesn't care about existence of wiki page slugs (with fragment)" do
+      link = @converter.convert_single_link("$WIKI_REFERENCE$/pages/slug-no-exist#hello-world")
+      expect(link).to eq "/courses/2/pages/slug-no-exist#hello-world"
+    end
+
+    it "passes through incorrectly used $CANVAS_OBJECT_REFERENCE$" do
+      link = @converter.convert_single_link("http://example.com/courses/123/assignments/$CANVAS_OBJECT_REFERENCE$")
+      # returning nil might also be acceptable
+      expect(link).to eq "http://example.com/courses/123/assignments/$CANVAS_OBJECT_REFERENCE$"
+    end
+
+    it "returns nil for failed assignment substitution (on a different domain)" do
+      link = @converter.convert_single_link("http://pineapple.edu/$CANVAS_OBJECT_REFERENCE$/assignments/g2fac96de3e3dc1270155dddedb5bb1ce")
+      # passing through might also be acceptable
+      expect(link).to be_nil
+    end
+
+    it "returns nil for failed assignment substitution (used instead of host)" do
+      link = @converter.convert_single_link("http://$CANVAS_OBJECT_REFERENCE$/assignments/g2fac96de3e3dc1270155dddedb5bb1ce")
+      expect(link).to be_nil
+    end
+
+    it "passes through $CANVAS_COURSE_REFERENCE$ used weirdly" do
+      link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$<b>/foo")
+      # nil would probably also be acceptable
+      expect(link).to eq "$CANVAS_COURSE_REFERENCE$<b>/foo"
+    end
+
+    it "passes through $INVALID_KEYWORD$" do
+      link = @converter.convert_single_link("http://example.com/$INVALID_KEYWORD$/path")
+      expect(link).to eq "http://example.com/$INVALID_KEYWORD$/path"
+    end
+
+    it "handles %24CANVAS_OBJECT_REFERENCE%24 like $CANVAS_OBJECT_REFERENCE$" do
+      link = @converter.convert_single_link("%24CANVAS_OBJECT_REFERENCE%24/assignments/I")
+      expect(link).to eq "/courses/2/assignments/12"
+    end
+
+    it "preserves absolute URLs with query params and fragments" do
+      link = @converter.convert_single_link("https://example.com/123?456#789")
+      expect(link).to eq "https://example.com/123?456#789"
+    end
+
+    it "preserves absolute URLs to other courses" do
+      link = @converter.convert_single_link("https://example.com/courses/123/assignments/123")
+      expect(link).to eq "https://example.com/courses/123/assignments/123"
+    end
+
+    it "converts assignment reference by migration id" do
+      link = @converter.convert_single_link("$CANVAS_OBJECT_REFERENCE$/assignments/I")
+      expect(link).to eq "/courses/2/assignments/12"
+    end
+
+    it "relative-izes absolute URLs in course domains with fragments" do
+      # I'm not 100% sure how important this case is, but this follows the
+      # behavior of translated HTML
+      link = @converter.convert_single_link("http://apple.edu/courses/18/settings#tab-navigation")
+      expect(link).to eq "/courses/18/settings#tab-navigation"
+    end
+
+    it "converts course reference with fragment" do
+      link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$/settings#tab-navigation")
+      expect(link).to eq "/courses/2/settings#tab-navigation"
+    end
+
+    it "converts wiki reference by slug" do
+      link = @converter.convert_single_link("$WIKI_REFERENCE$/pages/slug-a")
+      expect(link).to eq "/courses/2/pages/slug-a"
+    end
+
+    it "converts wiki reference with fragment" do
+      link = @converter.convert_single_link("$WIKI_REFERENCE$/pages/slug-a#hello-world")
+      expect(link).to eq "/courses/2/pages/slug-a#hello-world"
+    end
+
+    it "preserves absolute URLs with invalid keywords" do
+      link = @converter.convert_single_link("http://example.com/$WHATEVER$/foo")
+      expect(link).to eq "http://example.com/$WHATEVER$/foo"
+    end
+
+    it "preserves absolute URLs with malformed $123$ syntax" do
+      link = @converter.convert_single_link("http://example.com/$123$/foo")
+      expect(link).to eq "http://example.com/$123$/foo"
+    end
+
+    it "preserves absolute URLs with errant $ characters" do
+      link = @converter.convert_single_link("http://example.com/$/foo")
+      expect(link).to eq "http://example.com/$/foo"
+    end
+
+    it "doesn't crash on http://example.com/$CANVAS_COURSE_REFERENCE$/foo" do
+      link = @converter.convert_single_link("http://example.com/$CANVAS_COURSE_REFERENCE$/foo")
+      # I don't know if we actually care what happens here, as long as it doesn't crash.
+      # this seems to follow existing behavior for HTML translation
+      expect(link).to eq "/courses/2/foo"
+    end
+
+    it "passes through malformed reference with spaces" do
+      link = @converter.convert_single_link("$  $/path")
+      expect(link).to eq "$  $/path"
+    end
+
+    it "handles $CANVAS_COURSE_REFERENCE$ with other stuff" do
+      link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$/assignments/")
+      expect(link).to eq "/courses/2/assignments/"
+    end
+
+    describe 'invalid references returning file_contents' do
+      # These are invalid or malformed reference syntax that get treated as relative file paths.
+      # They get prepended with the course file_contents path, matching the existing behavior
+      # for HTML content. These cause 'broken link' pages to show up in the UI.
+      # That said, I'm not 100% sure we care that much about the actual values as they are
+      # invalid, so feel free to change the specs if we decide to handle these
+      # differently (e.g. return nil)
+
+      it "passes through $CANVAS_COURSE_REFERENCE" do
+        link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE")
+        expect(link).to eq("/courses/2/file_contents/course%20files/$CANVAS_COURSE_REFERENCE")
+      end
+
+      it "passes through lone $123" do
+        link = @converter.convert_single_link("/$123")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$123"
+      end
+
+      it "passes through errant $" do
+        link = @converter.convert_single_link("/$")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$"
+      end
+
+      it "passes through errant lone $123" do
+        link = @converter.convert_single_link("$123")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$123"
+      end
+
+      it "passes through errant lone $" do
+        link = @converter.convert_single_link("$")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$"
+      end
+
+      it "passes through starting $INVALID_KEYWORD$" do
+        link = @converter.convert_single_link("$INVALID_KEYWORD$/path")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$INVALID_KEYWORD$/path"
+      end
+
+      it "passes through errant $123$" do
+        link = @converter.convert_single_link("$123$/path")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$123$/path"
+      end
+
+      it "doesn't crash when given $CANVAS_COURSE_REFERENCE$" do
+        link = @converter.convert_single_link("$CANVAS_COURSE_REFERENCE$")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$CANVAS_COURSE_REFERENCE$"
+      end
+
+      it "doesn't crash on /courses/123/assignments/$CANVAS_OBJECT_REFERENCE$" do
+        link = @converter.convert_single_link("/courses/123/assignments/$CANVAS_OBJECT_REFERENCE$")
+        expect(link).to eq "/courses/2/file_contents/course%20files/courses/123/assignments/$CANVAS_OBJECT_REFERENCE$"
+      end
+
+      it "handles $$/path" do
+        link = @converter.convert_single_link("$$/path")
+        expect(link).to eq "/courses/2/file_contents/course%20files/$$/path"
+      end
+    end
   end
 end

data/spec/fixtures/canvas_resource_map.json

@@ -8,7 +8,6 @@
     "test.png": "E",
     "media_objects/0_bq09qam2": "F"
   },
-  "contains_migration_ids": true,
   "destination_course": "2",
   "destination_hosts": [
     "apple.edu",

data/spec/fixtures/canvas_resource_map_pages.json

@@ -7,7 +7,6 @@
       "lolcat.mp3": "H",
       "test.png": "E"
     },
-    "contains_migration_ids": true,
     "destination_course": "2",
     "destination_hosts": [
       "apple.edu",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 1.0.18
+  version: 1.0.19
 platform: ruby
 authors:
 - Mysti Lilla
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-15 00:00:00.000000000 Z
+date: 2026-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement