canvas_link_migrator 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d147093c7e6b397c3eb184aba4af1595f782e14735a50e9d4986be628af75f3
-  data.tar.gz: cb48c35f35dd333b02ff7dcba5e3bd79d1a1a7b736b7bb14c56de11b6c91565e
+  metadata.gz: 68ad9b1c1c452ba59ce56cae7ec072c38c185a4b5e4e3457082d8356dc95cd95
+  data.tar.gz: cc85f34cf8cb4abdb812d6582f213371afc6ccfd0a8ca6bb11f6152367d3d359
 SHA512:
-  metadata.gz: 4074cbb1bfa20b00f4843327d62ee0e1cf739f7450b46698ee1a6a240054f27acd34046605e2ae4f54bbdf02b529272ba165769352e10abff1f5950c08af6ad8
-  data.tar.gz: e1deecf7b1d6586c432234092e338c9d3059f26b744072eab1cb6e644c25dbcec9ffacfb53239b6c9ffc0610c210bf80399f097f2d7efa2265686caf314a8fee
+  metadata.gz: 8c8c85af3a7357591b9f07ddae0c98649c72880fc134c56cdafb20deb5083d2379020b7c459b191beeb4973f8fab878c831fb39b801b4249f4f8d1407eaec040
+  data.tar.gz: eded5e2885a8e3be4c22a2878c75e7ad889621f5a0f2bc4b57242656e5800aab0ad87d1ce5d18185b4080c1526f50382b81c49330feb74bf3d90925926cdbea3

data/lib/canvas_link_migrator/link_parser.rb

@@ -129,7 +129,12 @@ module CanvasLinkMigrator
         url.gsub!("%24#{ref}%24", "$#{ref}$")
       end
 
-      result = parse_url(url, node, attr)
+      begin
+        result = parse_url(url, node, attr)
+      rescue Addressable::URI::InvalidURIError
+        return
+      end
+
       if result[:resolved]
         # resolved, just replace and carry on
         new_url = result[:new_url] || url
@@ -166,6 +171,10 @@ module CanvasLinkMigrator
         else
           result[:old_value] = node[attr]
           result[:placeholder] = placeholder(result[:old_value])
+          # replace the inner html of an anchor tag if it matches the href
+          if node.name == "a" && attr == "href" && node["href"] == node.inner_html.delete("\n").strip
+            node.inner_html = result[:placeholder]
+          end
           node[attr] = result[:placeholder]
         end
         add_unresolved_link(result, item_type, mig_id, field)
@@ -177,7 +186,7 @@ module CanvasLinkMigrator
     end
 
     def resolved(new_url = nil)
-      { resolved: true, new_url: new_url }
+      { resolved: true, new_url: new_url}
     end
 
     # returns a hash with resolution status and data to hold onto if unresolved
@@ -186,7 +195,7 @@ module CanvasLinkMigrator
       query_values = parsed_url.query_values
       media_attachment = query_values.try(:delete, "media_attachment") == "true"
       if media_attachment
-        parsed_url.query_values = query_values.present? ? query_values : nil
+        parsed_url.query_values = query_values.presence || nil
         url = Addressable::URI.unencode(parsed_url)
       end
 

data/spec/canvas_link_migrator/link_parser_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+#
+# Copyright (C) 2023 - present Instructure, Inc.
+#
+# This file is part of Canvas.
+#
+# Canvas is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, version 3 of the License.
+#
+# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along
+# with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "spec_helper"
+
+describe CanvasLinkMigrator::LinkParser do
+  def parser
+    migration_query_service_mock = double()
+    allow(migration_query_service_mock).to receive(:supports_embedded_images).and_return(true)
+    allow(migration_query_service_mock).to receive(:fix_relative_urls?).and_return(true)
+    CanvasLinkMigrator::LinkParser.new(migration_query_service_mock)
+  end
+
+  describe "convert_link" do
+    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", "")
+      expect(doc.at_css('a')['href']).to include("LINK.PLACEHOLDER")
+      expect(doc.at_css('a').inner_html).to include("LINK.PLACEHOLDER")
+    end
+
+    it "doesn't convert inner html of anchor tags if unnecessary" do
+      doc = Nokogiri::HTML5.fragment("<a href=\"$WIKI_REFERENCE$/pages/1\">$WIKI_REFERENCE$/pages/5</a>")
+      parser.convert_link(doc.at_css('a'), "href","wiki_page", "migrationid", "")
+      expect(doc.at_css('a')['href']).to include("LINK.PLACEHOLDER")
+      expect(doc.at_css('a').inner_html).not_to include("LINK.PLACEHOLDER")
+    end
+
+    it "doesn't convert inner html of anchor tags if unnecessary" do
+      doc = Nokogiri::HTML5.fragment("<a href=\"https://what:10.1111/HFP.0b013e31828df26\">broken link</a>")
+      expect{ parser.convert_link(doc.at_css('a'), "href", "wiki_page", "migrationid", "") }.not_to raise_error
+    end
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: canvas_link_migrator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Mysti Lilla
 - James Logan
 - Sarah Gerard
+- Math Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-04 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,6 +130,7 @@ email:
 - mysti@instructure.com
 - james.logan@instructure.com
 - sarah.gerard@instructure.com
+- luis.oliveira@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -141,6 +143,7 @@ files:
 - lib/canvas_link_migrator/resource_map_service.rb
 - lib/canvas_link_migrator/version.rb
 - spec/canvas_link_migrator/imported_html_converter_spec.rb
+- spec/canvas_link_migrator/link_parser_spec.rb
 - spec/canvas_link_migrator/link_resolver_spec.rb
 - spec/canvas_link_migrator_spec.rb
 - spec/fixtures/canvas_resource_map.json