Merge pull request #40 from chartes/unit-tests

Unit tests

Author: philippepons

repo/backend/TEI_add_id.xqm

@@ -25,7 +25,8 @@ declare default element namespace "https://github.com/chartes/dots/";
 : @return         a sequence of update operations inserting `@xml:id` attributes and replacing `@ref` values.
 :)
 declare updating function dots.update:addXmlIdToFragment($dbName as xs:string) {
-  for $fragments in db:get($dbName, $G:fragmentsRegister)//fragment
+  let $fragmentsRegister := if (db:get($dbName, $G:fragmentsRegister)) then db:get($dbName, $G:fragmentsRegister) else db:get($dbName, concat("/", $G:fragmentsRegister))
+  for $fragments in $fragmentsRegister//fragment
   let $node-id := $fragments/@node-id
   let $tei := db:get-id($dbName, $node-id)
   where not($tei/@xml:id)

repo/backend/db_switch_build.xqm

@@ -58,15 +58,16 @@ declare %private function dots.build:switcher() {
 (:~
  : Creates the "dots_default_metadata_mapping.xml" document.
  : @return a <metadataMap/> element with XPath-based mappings for title, creator, and publisher metadata.
+ : @todo vérifier que cette fonction fonctionne correctement. Et comment gérer l'ajout d'un nouveau projet ? Comment faire un update de ces paramètres ?
 :)
 declare %private function dots.build:metadataMap($rootId as xs:string := "", $rootTitle as xs:string := "", $rootDescription as xs:string := "", $linkXSL as xs:string := "", $defaultEngine as xs:string := "") {
   <metadataMap xmlns="https://github.com/chartes/dots/" xmlns:dc="http://purl.org/dc/elements/1.1/"
       xmlns:dct="http://purl.org/dc/terms/">{
     dots.build:headers("metadataMap"),
     <root>
-      <id>{if ($rootId) then $rootId else "default"}</id>
-      <title>{if ($rootTitle) then $rootTitle else "default title"}</title>
-      {if ($rootDescription) then <description>{$rootDescription}</description>}
+      <id>{if ($rootId != "") then $rootId else "default"}</id>
+      <title>{if ($rootTitle != "") then $rootTitle else "default title"}</title>
+      {if ($rootDescription != "") then <description>{$rootDescription}</description>}
     </root>,
     <mapping>      
       <dc:title xpath="//titleStmt/title[@type = 'main' or position() = 1]" scope="document"/>

repo/backend/resources_register_builder.xqm

@@ -269,22 +269,29 @@ declare function resources:getCollectionMetadata(
   return
     if ($metadataMap)
     then
-      for $metadata in $metadataMap/node()[@scope = "collection"]
-      return
-        if ($metadata/@resourceId = "all")
-        then 
-          let $key := $metadata/name()
-          return element {$key} { 
-            if ($metadata/@key) then attribute {"key"} {$metadata/@key},
-            concat($metadata/@prefix, $metadata, $metadata/@suffix) 
-          }
-        else 
-          let $source := functx:substring-after-last($metadata/@source, '/')
-          let $csv-source := $csv-map($source)
-          return
-            for $record in $csv-source($collection)
+      let $metadatas :=
+        for $metadata in $metadataMap/node()[@scope = "collection"]
+        return
+          if ($metadata/@resourceId = "all")
+          then 
+            let $key := $metadata/name()
+            return element {$key} { 
+              if ($metadata/@key) then attribute {"key"} {$metadata/@key},
+              concat($metadata/@prefix, $metadata, $metadata/@suffix) 
+            }
+          else 
+            let $source := functx:substring-after-last($metadata/@source, '/')
+            let $csv-source := $csv-map($source)
             return
-              resources:createContent($metadata, $record)
+              if (exists(map:get($csv-source, $collection)))
+              then
+                for $record in $csv-source($collection)
+                return
+                  resources:createContent($metadata, $record) 
+              else
+                ()
+        let $title := if ($metadatas/descendant-or-self::dc:title) then () else <dc:title>{$collection}</dc:title>
+        return ($title, $metadatas)
     else <dc:title>{$collection}</dc:title>
 };
 

repo/backend/update/add_collection.xqm

@@ -10,15 +10,31 @@ declare namespace dc = "http://purl.org/dc/elements/1.1/";
 
 declare namespace dots = "https://github.com/chartes/dots/";
 
+(:~ Main function to handle the addition of a collection to the database.
+: It updates the resources register, the MaxCiteDepth of the parent collection, and the switcher dots.
+: @param $dbName      Name of the database
+: @param $resourceId  Identifier of the collection to add
+: @param $parentId    Identifier of the parent collection (optional)
+:)
 declare updating function add_coll:handleAddition($dbName as xs:string, $resourceId as xs:string, $parentId as xs:string := "") {
-  add_coll:addCollToResourcesReg($dbName, $resourceId, $parentId),
-  add_coll:updateMaxCiteDepthCollection($dbName, $parentId),
-  add_coll:addCollToSwitcherDots($dbName, $resourceId)
+  let $parent := if ($parentId) then $parentId else utils_dots:getIdProject($dbName)
+  return
+    (
+      add_coll:addCollToResourcesReg($dbName, $resourceId, $parent),
+      add_coll:updateMaxCiteDepthCollection($dbName, $parent),
+      add_coll:addCollToSwitcherDots($dbName, $resourceId)
+    )
 };
 
-declare updating function add_coll:addCollToResourcesReg($dbName as xs:string, $resourceId as xs:string, $parentId as xs:string := "") {
+(:~ Function to add a collection to the resources register.
+: It inserts a new <collection/> node with metadata and updates the parent relationship.
+: @param $dbName      Name of the database
+: @param $resourceId  Identifier of the collection to add
+: @param $parentId    Identifier of the parent collection (optional)
+: @return Inserts a new <collection/> node into the resources register.
+:)
+declare updating function add_coll:addCollToResourcesReg($dbName as xs:string, $resourceId as xs:string, $parentId as xs:string) {
   let $csv := resources:getCSV-map($dbName, "collection")
-  let $parent := if ($parentId) then $parentId else utils_dots:getIdProject($dbName)
   let $resources_register := db:get($dbName, $G:resourcesRegister)//dots:member
   let $metadata := resources:getCollectionMetadata($dbName, $resourceId, $csv)
   return
@@ -40,9 +56,8 @@ declare updating function add_coll:addCollToResourcesReg($dbName as xs:string, $
 : @param $parentIds  identifier of the collection to update
 : @return updating the value of the @totalChildren attribute in a <collection/> node.
 :)
-declare updating %private function add_coll:updateMaxCiteDepthCollection($dbName as xs:string, $parentIds as xs:string) {
-  let $idParentColl := if ($parentIds = "") then utils_dots:getIdProject($dbName) else $parentIds
-  let $parent := db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $idParentColl]
+declare updating %private function add_coll:updateMaxCiteDepthCollection($dbName as xs:string, $parentId as xs:string) {
+  let $parent := db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $parentId]
   let $totalChildren := $parent/@totalChildren
   return
      if ($parent != "")

repo/backend/update/add_doc_to_collection.xqm

@@ -0,0 +1,32 @@
+xquery version "4.0";
+
+(:~  
+: This module allows TODO
+: @author École nationale des chartes - Philippe Pons
+: @since 2025-10-20
+: @version  1.0
+:)
+
+module namespace doc_to_coll = "backend/update/add_doc_to_collection"; 
+
+import module namespace G = "globals";
+
+declare namespace dots = "https://github.com/chartes/dots/";
+
+declare updating function doc_to_coll:handleAddition($dbName as xs:string, $document as element(dots:document), $collection as element(dots:collection)) {
+  doc_to_coll:updateDocumentElement($dbName, $document, $collection),
+  doc_to_coll:incrementTotalChildren($dbName, $collection)
+};
+
+declare updating function doc_to_coll:updateDocumentElement($dbName as xs:string, $document as element(dots:document), $collection as element(dots:collection)) {
+  let $parentIds := $document/@parentIds
+  return
+    replace value of node $parentIds with concat($parentIds, " ", $collection/@dtsResourceId)      
+};
+
+declare updating function doc_to_coll:incrementTotalChildren($dbName as xs:string, $collection as element(dots:collection)) {
+  let $totalChildren := $collection/@totalChildren
+  return
+    replace value of node $totalChildren with (xs:integer($totalChildren) + 1)
+};
+

repo/backend/update/add_document.xqm

@@ -5,7 +5,6 @@ xquery version "3.1";
 : @author École nationale des chartes - Philippe Pons
 : @since 2025-01-10
 : @version  1.0
-: @todo L'ajout d'un document dans une collection qui n'existe pas est possible. Comment remédier à cela ?
 :)
 
 module namespace add_doc = "backend/update/add_document";
@@ -17,45 +16,59 @@ import module namespace resources = "backend/resources_register_builder";
 import module namespace fragments = "backend/fragments_register_builder";
 import module namespace dots.update = "backend/TEI_add_id";
 import module namespace script = "script";
+import module namespace utils_dots = "utils_dots"; 
 
 declare namespace dots = "https://github.com/chartes/dots/";
 declare namespace dc = "http://purl.org/dc/elements/1.1/";
 declare namespace tei = "http://www.tei-c.org/ns/1.0";
 
-declare updating function add_doc:handleAddition($dbName, $docPath) {
-  let $csv := resources:getCSV-map($dbName, "document")
-  let $csv-frag := resources:getCSV-map($dbName, "fragment")
+(:~ Update function to handle the addition of a new document and its fragments to the database and registers.
+: @param $dbName   db name
+: @param $docPath  absolute path to the document to add
+: @return updates the database and registers with the new document and its fragments
+:)
+declare updating function add_doc:handleAddition($dbName as xs:string, $docPath as xs:string, $parentId as xs:string) {
+  let $resourceId := utils_dots:findDocId($docPath)
+  let $docInRegister := utils_dots:getDocInRegister($dbName, $resourceId) 
   return
-  (
-    add_doc:addDocToDB($dbName, $docPath),
-    add_doc:addDocToResourcesReg($dbName, $docPath, $csv)
+    if ($docInRegister)
+    then script:error(dots_error:documentExists())
+    else
+      let $csv := resources:getCSV-map($dbName, "document")
+      return
+      (
+        add_doc:addDocToDB($dbName, $docPath, $parentId),
+        add_doc:addDocToResourcesReg($dbName, $docPath, $csv)
   )
 };
 
-declare updating function add_doc:handleFragmentsAddition($dbName as xs:string, $docPath) {
-  let $csv-frag := resources:getCSV-map($dbName, "fragment")
-  return
-    add_doc:addFragInReg($dbName, $docPath, $csv-frag)
-};
+(:~~~~~~~~~~~~~~~
+Update database
+~~~~~~~~~~~~~~~~~:)
 
 (:~ Update function to add a new document with a specific path
 : @param $dbName  db name
 : @param $docPath absolute path to the document to add
+: @param $parentId identifier of the parent collection. By default, the project identifier.
 : @return add the document at the path $docPath to the db $dbName 
-: @todo the script using this function MUST check if contains($docPath, "data/").
 :)
-declare %private updating function add_doc:addDocToDB($dbName as xs:string, $docPath) {
-  let $path := substring-after($docPath, "data/")
+declare %private updating function add_doc:addDocToDB($dbName as xs:string, $docPath as xs:string, $path as xs:string) {
+  let $docName := functx:substring-after-last($docPath, "/")
   return
-    db:put($dbName, $docPath, $path)
+    db:put($dbName, $docPath, concat($path, "/", $docName))
 };
 
+(:~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update resources_register.xml
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~:)
+
 (:~ Update function to add a `<document/>` element to dots resources register (`dots/resources_register.xml`)
 : @param $dbName  db name
 : @param $docPath absolute path to the document to add
+: @param $csv map of the csv metadata
 : @return a complete <document/> node
 :)
-declare updating %private function add_doc:addDocToResourcesReg($dbName as xs:string, $docPath, $csv) {
+declare updating %private function add_doc:addDocToResourcesReg($dbName as xs:string, $docPath as xs:string, $csv) {
   let $document := doc($docPath)/tei:TEI
   let $projectName := G:getTopCollectionId($dbName)
   let $dtsResourceId := 
@@ -75,44 +88,59 @@ declare updating %private function add_doc:addDocToResourcesReg($dbName as xs:st
         return $collId
     else $projectName
   return
-    if ($document)
-    then
-      let $resources_register := db:get($dbName, $G:resourcesRegister)//dots:member
-      let $doc_in_register := $resources_register/dots:document[@dtsResourceId = $dtsResourceId]
-      return
-        if ($doc_in_register) 
-        then 
-          (
-            delete nodes $doc_in_register,
-            insert node <document xmlns="https://github.com/chartes/dots/" dtsResourceId="{$dtsResourceId}" maxCiteDepth="{$maxCiteDepth}" parentIds="{$parentIds}">{
-          resources:getDocumentMetadata($dbName, $document, $dtsResourceId, $csv),
-          resources:getDotsProjectName($projectName)
-}</document> after $doc_in_register
-          )
-        else
-          (
-            insert node <document xmlns="https://github.com/chartes/dots/" dtsResourceId="{$dtsResourceId}" maxCiteDepth="{$maxCiteDepth}" parentIds="{$parentIds}">{
-            resources:getDocumentMetadata($dbName, $document, $dtsResourceId, $csv),
-            resources:getDotsProjectName($projectName)
+    let $resources_register := db:get($dbName, $G:resourcesRegister)//dots:member
+    return
+      (
+        insert node <document xmlns="https://github.com/chartes/dots/" dtsResourceId="{$dtsResourceId}" maxCiteDepth="{$maxCiteDepth}" parentIds="{$parentIds}">{
+        resources:getDocumentMetadata($dbName, $document, $dtsResourceId, $csv),
+        resources:getDotsProjectName($projectName)
   }</document> as last into $resources_register,
-            add_doc:updateTotalChildrenCollection($dbName, $parentIds),
-            add_doc:addDocToSwitcherDots($dbName, $dtsResourceId)
-          )
-    else ()
+        add_doc:updateTotalChildrenCollection($dbName, $parentIds),
+        add_doc:addDocToSwitcherDots($dbName, $dtsResourceId)
+      )
+};
+
+(:~ Update function to increment the number of documents in the parent collection
+: @param $dbName     db name
+: @param $parentIds  identifier of the collection to update
+: @return updating the value of the @totalChildren attribute in a <collection/> node.
+:)
+declare updating %private function add_doc:updateTotalChildrenCollection($dbName as xs:string, $parentIds as xs:string) {
+  let $parent := db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $parentIds]
+  let $totalChildren := $parent/@totalChildren
+  return
+     if ($parent != "")
+     then replace value of node $totalChildren with xs:integer($parent/@totalChildren) + 1
+     else 
+       update:output("La collection parente n'existe pas.")
+};
+
+(:~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update fragments_register.xml
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~:)
+
+(:~ Update function to handle the addition of fragments from a new document to the fragments register.
+: @param $dbName   db name
+: @param $docPath  absolute path to the document containing the fragments to add
+: @return updates the fragments register with the new fragments
+:)
+declare updating function add_doc:handleFragmentsAddition($dbName as xs:string, $docPath) {
+  let $csv-frag := resources:getCSV-map($dbName, "fragment")
+  return
+    add_doc:addFragInReg($dbName, $docPath, $csv-frag)
 };
 
 (:~  Update function to add `<fragment/>` nodes to the fragments register (`dots/fragments_register`).
 : @param $dbName  db name
 : @param $docPath absolute path to the document to add
 : @return sequence of <fragment/> nodes
 :)
-declare updating %private function add_doc:addFragInReg($dbName as xs:string, $docPath, $csv) {
-  let $pathToDoc := functx:substring-after-last($docPath, "data/")
-  let $document := db:get($dbName, $pathToDoc)/tei:TEI
+declare updating %private function add_doc:addFragInReg($dbName as xs:string, $docPath, $csv) { 
   let $resourceId :=
-    if ($document/@xml:id)
-    then normalize-space($document/@xml:id)
-    else functx:substring-after-last($pathToDoc, "/")
+    if (doc($docPath)/*:TEI/@xml:id)
+    then normalize-space(doc($docPath)/*:TEI//@xml:id)
+    else functx:substring-after-last($docPath, "/")
+  let $document := utils_dots:getDocument($dbName, $resourceId)
   let $maxCiteDepth := fragments:getMaxCiteDepth($document//tei:refsDecl, 0)
   for $citeStructurePosition in $document//tei:refsDecl/tei:citeStructure
   return 
@@ -129,21 +157,9 @@ declare updating %private function add_doc:addFragInReg($dbName as xs:string, $d
       else insert node $fragment as last into $fragments_register
 };
 
-
-(:~ Update function to increment the number of documents in a collection
-: @param $dbName     db name
-: @param $parentIds  identifier of the collection to update
-: @return updating the value of the @totalChildren attribute in a <collection/> node.
-:)
-declare updating %private function add_doc:updateTotalChildrenCollection($dbName as xs:string, $parentIds as xs:string) {
-  let $parent := db:get($dbName, $G:resourcesRegister)//dots:collection[@dtsResourceId = $parentIds]
-  let $totalChildren := $parent/@totalChildren
-  return
-     if ($parent != "")
-     then replace value of node $totalChildren with xs:integer($parent/@totalChildren) + 1
-     else 
-       update:output("La collection parente n'existe pas.")
-};
+(:~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update switcher DoTS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~:)
 
 (:~ Updat function to add the documet to the switcher dots
 : @param  $dbName         db name

repo/backend/update/delete_collection.xqm

@@ -80,7 +80,8 @@ declare updating function del_coll:handleDocInColl($dbName as xs:string, $collec
       (
         delete node $document,
         delete nodes db:get($dbName, $G:fragmentsRegister)//fragment[@resourceId = $resourceId],
-        db:delete($dbName, $pathDoc)
+        db:delete($dbName, $pathDoc),
+        del_doc:updateSwitcherDots($dbName, $resourceId)
       )
     else
       (