ds-caselaw-marklogic-api-client 41.1.3__py3-none-any.whl → 42.0.0__py3-none-any.whl

caselawclient/managers/merge/__init__.py

@@ -0,0 +1,51 @@
+import caselawclient.managers.merge.checks as checks
+from caselawclient.models.documents import Document
+from caselawclient.types import SuccessFailureMessageTuple
+
+
+def _combine_list_of_successfailure_results(
+    validations: list[SuccessFailureMessageTuple],
+) -> SuccessFailureMessageTuple:
+    """Given a list of SuccessFailureMessageTuples, combine the success/failure states and any messages into a single new object representing the overall success/failure state."""
+    success = True
+    messages: list[str] = []
+
+    for validation in validations:
+        if validation.success is False:
+            success = False
+
+        messages += validation.messages
+
+    return SuccessFailureMessageTuple(success, messages)
+
+
+class MergeManager:
+    @classmethod
+    def check_document_is_safe_as_merge_source(cls, source_document: Document) -> SuccessFailureMessageTuple:
+        """
+        Is the given document safe to be considered as a merge source?
+        """
+
+        return _combine_list_of_successfailure_results(
+            [
+                checks.check_document_is_not_version(source_document),
+                checks.check_document_has_only_one_version(source_document),
+                checks.check_document_has_never_been_published(source_document),
+                checks.check_document_is_safe_to_delete(source_document),
+            ]
+        )
+
+    @classmethod
+    def check_source_document_is_safe_to_merge_into_target(
+        cls, source_document: Document, target_document: Document
+    ) -> SuccessFailureMessageTuple:
+        """Is the given source document safe to merge into a given target?"""
+
+        return _combine_list_of_successfailure_results(
+            [
+                checks.check_documents_are_not_same_document(source_document, target_document),
+                checks.check_document_is_not_version(target_document),
+                checks.check_documents_are_same_type(source_document, target_document),
+                checks.check_source_document_is_newer_than_target(source_document, target_document),
+            ]
+        )

caselawclient/managers/merge/checks.py

@@ -0,0 +1,79 @@
+from caselawclient.models.documents import Document
+from caselawclient.types import SuccessFailureMessageTuple
+
+
+def check_document_is_not_version(document: Document) -> SuccessFailureMessageTuple:
+    """Check that the document URI isn't a specific version"""
+    if document.is_version:
+        return SuccessFailureMessageTuple(
+            False,
+            ["This document is a specific version, and cannot be used as a merge source"],
+        )
+
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_document_has_only_one_version(document: Document) -> SuccessFailureMessageTuple:
+    """Make sure the document has exactly one version."""
+    if len(document.versions) > 1:
+        return SuccessFailureMessageTuple(
+            False,
+            ["This document has more than one version"],
+        )
+
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_document_has_never_been_published(document: Document) -> SuccessFailureMessageTuple:
+    """Make sure the document has never been published."""
+    if document.has_ever_been_published:
+        return SuccessFailureMessageTuple(
+            False,
+            ["This document has previously been published"],
+        )
+
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_document_is_safe_to_delete(document: Document) -> SuccessFailureMessageTuple:
+    """Make sure the document is safe to delete."""
+    if not document.safe_to_delete:
+        return SuccessFailureMessageTuple(
+            False,
+            ["This document cannot be deleted because it is published"],
+        )
+
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_documents_are_not_same_document(document_one: Document, document_two: Document) -> SuccessFailureMessageTuple:
+    """Check that two documents aren't actually the same"""
+    if document_one.uri == document_two.uri:
+        return SuccessFailureMessageTuple(
+            False,
+            ["You cannot merge a document with itself"],
+        )
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_documents_are_same_type(document_one: Document, document_two: Document) -> SuccessFailureMessageTuple:
+    """Check to see if this document is the same type as a target document."""
+    if type(document_one) is not type(document_two):
+        return SuccessFailureMessageTuple(
+            False,
+            [
+                f"The type of {document_one.uri} ({type(document_one).document_noun}) does not match the type of {document_two.uri} ({type(document_two).document_noun})"
+            ],
+        )
+    return SuccessFailureMessageTuple(True, [])
+
+
+def check_source_document_is_newer_than_target(
+    source_document: Document, target_document: Document
+) -> SuccessFailureMessageTuple:
+    """Check to see if the created datetime of the latest version of this document is newer than the created datetime of the latest version of a target document."""
+    if source_document.version_created_datetime < target_document.version_created_datetime:
+        return SuccessFailureMessageTuple(
+            False, [f"The document at {source_document.uri} is older than the latest version of {target_document.uri}"]
+        )
+    return SuccessFailureMessageTuple(True, [])

{ds_caselaw_marklogic_api_client-41.1.3.dist-info → ds_caselaw_marklogic_api_client-42.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ds-caselaw-marklogic-api-client
-Version: 41.1.3
+Version: 42.0.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Keywords: national archives,caselaw
 Author: The National Archives
@@ -9,7 +9,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)
-Requires-Dist: certifi (>=2025.8.3,<2025.9.0)
+Requires-Dist: certifi (>=2025.10.5,<2025.11.0)
 Requires-Dist: charset-normalizer (>=3.0.0,<4.0.0)
 Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
 Requires-Dist: django-environ (>=0.12.0)

{ds_caselaw_marklogic_api_client-41.1.3.dist-info → ds_caselaw_marklogic_api_client-42.0.0.dist-info}/RECORD

@@ -6,6 +6,9 @@ caselawclient/content_hash.py,sha256=0cPC4OoABq0SC2wYFX9-24DodNigeOqksDxgxQH_hUA
 caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
 caselawclient/factories.py,sha256=HXJeWpN7__X462joco07ziNqMOOMr-wUPJ91Y69gFk8,7466
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
+caselawclient/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+caselawclient/managers/merge/__init__.py,sha256=Rd6YIGifT3TP6UOf0gBrRoYzK5MJqTPeRaIJznS8dgI,2078
+caselawclient/managers/merge/checks.py,sha256=J9RBG6jZAKIZk27jdFq-BByoRLKWsViCfHDyA8ZM3qU,3205
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
 caselawclient/models/documents/__init__.py,sha256=kBgu7V049KP5cBxH0GyePuD1gWoVs5JZFRdTzuMVKrE,24375
 caselawclient/models/documents/body.py,sha256=pzk3bm9FGIWfI0Hs8dBuzk6RCiA9M4GHfgOYKpNlzyE,8455
@@ -89,7 +92,7 @@ caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1
 caselawclient/xquery_type_dicts.py,sha256=f4PM8yZi5RRMdL2lQ8tsLUs0aJjBa5chvd-VVj40fJY,6767
 caselawclient/xslt/modify_xml_live.xsl,sha256=gNjwBun2-UzOeeuf0wNjFtN3jXm1yrwqv_KT8r1slXw,2370
 caselawclient/xslt/sample.xsl,sha256=IG-v77stjwqiw25pguh391K-5DTKiX651WqILDZixm0,825
-ds_caselaw_marklogic_api_client-41.1.3.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-41.1.3.dist-info/METADATA,sha256=02VyE_L3WKKb8uYBE9No9KhDVLx6rXninOg-76KspiY,4364
-ds_caselaw_marklogic_api_client-41.1.3.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-ds_caselaw_marklogic_api_client-41.1.3.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-42.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-42.0.0.dist-info/METADATA,sha256=UWzlCKwEKEc97aTLyHk3zvmmIaB6PFQVc8rC1a-oUOA,4366
+ds_caselaw_marklogic_api_client-42.0.0.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+ds_caselaw_marklogic_api_client-42.0.0.dist-info/RECORD,,