Changeset 59342ce in flexoentity

Timestamp:

10/19/25 11:42:00 (3 months ago)

Author:

Enrico Schwass <ennoausberlin@…>

Branches:

master

Children:

0b4a5e6

Parents:

0036877

Message:

all tests green

Files:

• flexoentity/__init__.py (modified) (1 diff)
• flexoentity/flexo_entity.py (modified) (10 diffs)
• flexoentity/id_factory.py (modified) (3 diffs)
• tests/test_id_lifecycle.py (added)
• tests/test_id_stress.py (added)
• tests/test_persistance_integrity.py (added)

flexoentity/__init__.py

@@ -6 +6 @@
 - FlexoEntity: lifecycle-tracked base class for all Flex-O domain objects
 """
+from importlib.metadata import version, PackageNotFoundError
+from .id_factory import FlexOID, canonical_seed
+from .flexo_entity import FlexoEntity, EntityType, EntityState
 
-from .id_factory import FlexOID, canonical_seed
-from .flexo_entity import FlexoEntity
+__all__ = [
+    "FlexOID",
+    "canonical_seed",
+    "FlexoEntity",
+    "EntityType",
+    "EntityState",
+]
 
-__all__ = ["FlexOID", "canonical_seed", "FlexoEntity"]
-__version__ = "1.0.0"
+# Optional: keep dynamic version retrieval synced with pyproject.toml
+try:
+    __version__ = version("flexoentity")
+except PackageNotFoundError:
+    __version__ = "0.0.0-dev"

flexoentity/flexo_entity.py

@@ -9 +9 @@
 from typing import Optional
 from abc import ABC
-
-from id_factory import FlexOID
-
+import hashlib
+
+
+from flexoentity.id_factory import FlexOID
+from flexoentity import canonical_seed
+ 
 
 # ──────────────────────────────────────────────────────────────────────────────
@@ -56 +59 @@
             EntityState.APPROVED: "A",
             EntityState.APPROVED_AND_SIGNED: "S",
+            EntityState.PUBLISHED: "P",
             EntityState.OBSOLETE: "O",
+
         }
         return mapping[self]
@@ -69 +74 @@
             "A": cls.APPROVED,
             "S": cls.APPROVED_AND_SIGNED,
+            "P": cls.PUBLISHED,
             "O": cls.OBSOLETE,
         }
@@ -77 +83 @@
 
     def __str__(self):
-        return self.value
+        return self.name
 
 
@@ -139 +145 @@
         return cls.from_dict(data)
 
+    @staticmethod
+    def should_version(state) -> bool:
+        """
+        Determine if a given lifecycle state should trigger a version increment.
+
+        Entities typically version when they move into more stable or
+        externally visible states, such as APPROVED, SIGNED, or PUBLISHED.
+        """
+
+        return state in (
+            EntityState.APPROVED,
+            EntityState.APPROVED_AND_SIGNED,
+            EntityState.PUBLISHED,
+        )
+    
     # ───────────────────────────────────────────────────────────────
     def _update_fingerprint(self) -> bool:
         """Recalculate fingerprint and return True if content changed."""
         # extract version from current flexo_id
-        new_oid = FlexOID.generate(self.domain, self.etype, self.text_seed, self.flexo_id.version)
+        new_oid = FlexOID.generate(self.domain, self.etype.short(), self.state.short(), self.text_seed, self.flexo_id.version)
         if new_oid.signature != self.flexo_id.signature:
             self.flexo_id = new_oid
@@ -157 +178 @@
 
         # Check if version should bump
-        if FlexOID.should_version(self.etype, target_state):
-            if self._update_fingerprint():
-                self.flexo_id = FlexOID.next_version(self.flexo_id)
+        if self.should_version(target_state):
+            self._update_fingerprint()
+            self.flexo_id = FlexOID.next_version(self.flexo_id)
 
         self.state = target_state
@@ -184 +205 @@
         """
         Move from DRAFT to APPROVED state.
-        Draft entities receive a new permanent FlexOID.
+        Draft entities receive a new permanent FlexOID with incremented version.
         """
         if self.state == EntityState.DRAFT:
-            # Generate a brand new permanent ID
+            new_version = self.flexo_id.version + 1
             new_fid = FlexOID.generate(
                 self.domain,
-                self.etype,
+                self.etype.short(),
+                EntityState.APPROVED.short(),
                 self.text_seed,
-                draft=False
+                version=new_version
             )
             self.previous_id = self.flexo_id  # optional: keep audit trail
             self.flexo_id = new_fid
-
             self.state = EntityState.APPROVED
             self.updated_at = datetime.utcnow()
@@ -203 +224 @@
 
     def sign(self):
-        # FIXME: We need to define clear conditions, when resigning is neccessary and allowed
-        #        if self.state == EntityState.APPROVED:
-        #            self._transition(EntityState.APPROVED_AND_SIGNED)
-        #            self.bump_version()
         self._transition(EntityState.APPROVED_AND_SIGNED)
-        self.bump_version()
 
     def publish(self):
@@ -220 +236 @@
     def clone_new_base(self):
         """Start new lineage when obsolete."""
-        self.flexo_id = FlexOID.clone_new_base(self.domain, self.etype, self.text_seed)
+        self.flexo_id = FlexOID.clone_new_base(
+            self.domain,
+            self.etype.short(),
+            self.state.short(),
+            self.text_seed,
+        )
         self.state = EntityState.DRAFT
         self.updated_at = datetime.utcnow()
@@ -235 +256 @@
             self.updated_at = datetime.utcnow()
 
+
+    # ───────────────────────────────────────────────────────────────
+    # Integrity verification
+    # ───────────────────────────────────────────────────────────────
+
     @staticmethod
     def verify_integrity(entity) -> bool:
         """
-        Verify if the stored fingerprint matches recalculated fingerprint.
-        Returns True if intact, False if tampered or corrupted.
-        """
-        recalculated = FlexOID.generate(entity.domain, entity.etype, entity.text_seed, entity.version)
-        return recalculated.signature == entity.flexo_id.signature
+        Verify *state-aware* integrity.
+
+        This method validates that the entity's stored digital signature
+        matches a freshly recalculated one, based on the combination of:
+
+            text_seed + current lifecycle state (one-letter code)
+
+        Returns
+        -------
+        bool
+            True if the entity's *state and content* are unchanged,
+            False if either was altered or corrupted.
+        """
+        seed = canonical_seed(f"{entity.text_seed}:{entity.state.short()}")
+        recalculated_sig = hashlib.blake2s(
+            seed.encode("utf-8"), digest_size=8
+        ).hexdigest().upper()
+
+        return recalculated_sig == entity.flexo_id.signature
+
+    @staticmethod
+    def verify_content_integrity(entity) -> bool:
+        """
+        Verify *content-only* integrity (ignores lifecycle state).
+
+        This method checks whether the stored entity's signature matches
+        a fresh hash of its text seed alone. It does not include the
+        lifecycle state in the fingerprint.
+
+        Returns
+        -------
+        bool
+        True if the text content has not been altered,
+        False if it differs from the original content.
+        """
+        seed = canonical_seed(entity.text_seed)
+        recalculated_sig = hashlib.blake2s(
+            seed.encode("utf-8"), digest_size=8
+        ).hexdigest().upper()
+        return recalculated_sig == entity.flexo_id.signature
 
     def allowed_transitions(self) -> list[str]:

flexoentity/id_factory.py

@@ -28 +28 @@
     """
     if isinstance(obj, str):
-        text = " ".join(obj.lower().split())
+        text = " ".join(obj.split())
         return text
     if isinstance(obj, dict):
@@ -91 +91 @@
     # ──────────────────────────────────────────────────────────────────────────
     @staticmethod
-    def generate(domain: str, etype: str, estate: str, text: str, version: int = 1):
+    def generate(domain: str, etype: str, estate: str, text: str,
+                 version: int = 1, enforce_unique = True):
         """
         Generate a new, versioned, and state-aware Flex-O ID.
@@ -138 +139 @@
 
         base_hash = FlexOID._blake_hash(seed)
-        unique_hash = FlexOID._ensure_unique(base_hash, version)
+        unique_hash = FlexOID._ensure_unique(base_hash, version)if enforce_unique else base_hash
 
         ver_part = f"{version:03d}{estate}"