Update src/aibom_generator/utils.py

src/aibom_generator/utils.py

@@ -102,19 +102,24 @@ def normalize_license_id(license_text):
     return license_text
 
 
-def calculate_completeness_score(aibom: Dict[str, Any]) -> int:
+def calculate_completeness_score(aibom: Dict[str, Any]) -> Dict[str, Any]:
     """
     Calculate a completeness score for the AIBOM.
-    
+
     Args:
         aibom: The AIBOM dictionary
-        
+
     Returns:
-        Completeness score (0-100)
+        Dictionary containing:
+            - total_score: overall completeness score (0-100)
+            - section_scores: points earned per section
+            - field_checklist: dictionary showing presence (✔) or absence (✘) of key fields
     """
     score = 0
     max_score = 100
-    
+    section_scores = {}
+    field_checklist = {}
+
     # Define scoring weights for different sections
     weights = {
         "required_fields": 20,
@@ -123,39 +128,62 @@ def calculate_completeness_score(aibom: Dict[str, Any]) -> int:
         "component_model_card": 30,
         "external_references": 10,
     }
-    
-    # Check required fields (20%)
+
+    # Required Fields
     required_fields = ["bomFormat", "specVersion", "serialNumber", "version"]
-    required_score = sum(1 for field in required_fields if field in aibom)
-    score += (required_score / len(required_fields)) * weights["required_fields"]
-    
-    # Check metadata (20%)
+    required_present = [field for field in required_fields if field in aibom]
+    required_score = (len(required_present) / len(required_fields)) * weights["required_fields"]
+    section_scores["required_fields"] = round(required_score)
+    for field in required_fields:
+        field_checklist[field] = "✔" if field in required_present else "✘"
+
+    # Metadata Fields
+    metadata_score = 0
     if "metadata" in aibom:
-        metadata = aibom["metadata"]
         metadata_fields = ["timestamp", "tools", "authors", "component"]
-        metadata_score = sum(1 for field in metadata_fields if field in metadata)
-        score += (metadata_score / len(metadata_fields)) * weights["metadata"]
-    
-    # Check component basic info (20%)
-    if "components" in aibom and aibom["components"]:
-        component = aibom["components"][0]
-        component_fields = ["type", "name", "bom-ref", "purl", "description", "licenses"]
-        component_score = sum(1 for field in component_fields if field in component)
-        score += (component_score / len(component_fields)) * weights["component_basic"]
-        
-        # Check model card (30%)
-        if "modelCard" in component:
-            model_card = component["modelCard"]
-            model_card_fields = ["modelParameters", "quantitativeAnalysis", "considerations"]
-            model_card_score = sum(1 for field in model_card_fields if field in model_card)
-            score += (model_card_score / len(model_card_fields)) * weights["component_model_card"]
-    
-    # Check external references (10%)
-    if "externalReferences" in aibom and aibom["externalReferences"]:
-        score += weights["external_references"]
-    
-    return round(score)
-
+        present = [field for field in metadata_fields if field in aibom["metadata"]]
+        metadata_score = (len(present) / len(metadata_fields)) * weights["metadata"]
+        for field in metadata_fields:
+            field_checklist[f"metadata.{field}"] = "✔" if field in present else "✘"
+    section_scores["metadata"] = round(metadata_score)
+
+    # Component Basic Info
+    component_score = 0
+    component = aibom.get("components", [{}])[0]
+    component_fields = ["type", "name", "bom-ref", "purl", "description", "licenses"]
+    present = [field for field in component_fields if field in component]
+    component_score = (len(present) / len(component_fields)) * weights["component_basic"]
+    section_scores["component_basic"] = round(component_score)
+    for field in component_fields:
+        field_checklist[f"component.{field}"] = "✔" if field in present else "✘"
+
+    # Model Card Section
+    model_card_score = 0
+    model_card_fields = ["modelParameters", "quantitativeAnalysis", "considerations"]
+    if "modelCard" in component:
+        model_card = component["modelCard"]
+        present = [field for field in model_card_fields if field in model_card]
+        model_card_score = (len(present) / len(model_card_fields)) * weights["component_model_card"]
+        for field in model_card_fields:
+            field_checklist[f"modelCard.{field}"] = "✔" if field in present else "✘"
+    else:
+        for field in model_card_fields:
+            field_checklist[f"modelCard.{field}"] = "✘"
+    section_scores["component_model_card"] = round(model_card_score)
+
+    # External References
+    ext_score = weights["external_references"] if aibom.get("externalReferences") else 0
+    section_scores["external_references"] = round(ext_score)
+    field_checklist["externalReferences"] = "✔" if ext_score else "✘"
+
+    # Final total score
+    total_score = round(sum(section_scores.values()))
+
+    return {
+        "total_score": total_score,
+        "section_scores": section_scores,
+        "field_checklist": field_checklist
+    }
 
 def merge_metadata(primary: Dict[str, Any], secondary: Dict[str, Any]) -> Dict[str, Any]:
     """