scientific: Clear an existing doi link is a new one is set

Author: schwehr

pystac/extensions/scientific.py

@@ -57,8 +57,8 @@ def get_link(self) -> pystac.Link:
         return pystac.Link(CITE_AS, doi_to_url(self.doi))
 
 
-def remove_link(links: List[pystac.Link], pub: Publication):
-    url = doi_to_url(pub.doi)
+def remove_link(links: List[pystac.Link], doi: str):
+    url = doi_to_url(doi)
     for i, a_link in enumerate(links):
         if a_link.rel != CITE_AS:
             continue
@@ -123,6 +123,11 @@ def doi(self) -> str:
 
     @doi.setter
     def doi(self, v: str) -> None:
+        if DOI in self.item.properties:
+            if v == self.item.properties[DOI]:
+                return
+            remove_link(self.item.links, self.item.properties[DOI])
+
         self.item.properties[DOI] = v
         url = doi_to_url(self.doi)
         self.item.add_link(pystac.Link(CITE_AS, url))
@@ -167,13 +172,13 @@ def remove_publication(self, publication: Optional[Publication] = None) -> None:
 
         if not publication:
             for one_pub in self.item.ext.scientific.publications:
-                remove_link(self.item.links, one_pub)
+                remove_link(self.item.links, one_pub.doi)
 
             del self.item.properties[PUBLICATIONS]
             return
 
         # One publication and link to remove
-        remove_link(self.item.links, publication)
+        remove_link(self.item.links, publication.doi)
         to_remove = publication.to_dict()
         self.item.properties[PUBLICATIONS].remove(to_remove)
 
@@ -237,6 +242,10 @@ def doi(self) -> str:
 
     @doi.setter
     def doi(self, v: str) -> None:
+        if DOI in self.collection.extra_fields:
+            if v == self.collection.extra_fields[DOI]:
+                return
+            remove_link(self.collection.links, self.collection.extra_fields[DOI])
         self.collection.extra_fields[DOI] = v
         url = doi_to_url(self.doi)
         self.collection.add_link(pystac.Link(CITE_AS, url))
@@ -283,13 +292,13 @@ def remove_publication(self, publication: Optional[Publication] = None) -> None:
 
         if not publication:
             for one_pub in self.collection.ext.scientific.publications:
-                remove_link(self.collection.links, one_pub)
+                remove_link(self.collection.links, one_pub.doi)
 
             del self.collection.extra_fields[PUBLICATIONS]
             return
 
         # One publication and link to remove
-        remove_link(self.collection.links, publication)
+        remove_link(self.collection.links, publication.doi)
         to_remove = publication.to_dict()
         self.collection.extra_fields[PUBLICATIONS].remove(to_remove)
 

tests/extensions/test_scientific.py

@@ -53,6 +53,20 @@ def test_doi(self):
         self.assertEqual(DOI_URL, link.get_href())
         self.item.validate()
 
+        # Check that setting the doi does not cause extra links.
+
+        # Same doi.
+        self.item.ext.scientific.doi = DOI
+        self.assertEqual(1, len(self.item.get_links(scientific.CITE_AS)))
+        self.item.validate()
+
+        # Different doi.
+        self.item.ext.scientific.doi = PUB1_DOI
+        self.assertEqual(1, len(self.item.get_links(scientific.CITE_AS)))
+        link = self.item.get_links(scientific.CITE_AS)[0]
+        self.assertEqual(PUB1_DOI_URL, link.get_href())
+        self.item.validate()
+
     def test_citation(self):
         self.item.ext.scientific.apply(citation=CITATION)
         self.assertEqual(CITATION, self.item.ext.scientific.citation)
@@ -187,7 +201,20 @@ def test_doi(self):
         self.assertIn(scientific.DOI, self.collection.extra_fields)
         link = self.collection.get_links(scientific.CITE_AS)[0]
         self.assertEqual(DOI_URL, link.get_href())
+        self.collection.validate()
+
+        # Check that setting the doi does not cause extra links.
 
+        # Same doi.
+        self.collection.ext.scientific.doi = DOI
+        self.assertEqual(1, len(self.collection.get_links(scientific.CITE_AS)))
+        self.collection.validate()
+
+        # Different doi.
+        self.collection.ext.scientific.doi = PUB1_DOI
+        self.assertEqual(1, len(self.collection.get_links(scientific.CITE_AS)))
+        link = self.collection.get_links(scientific.CITE_AS)[0]
+        self.assertEqual(PUB1_DOI_URL, link.get_href())
         self.collection.validate()
 
     def test_citation(self):