Update class_diagram_generator.py

class_diagram_generator.py

@@ -4,6 +4,192 @@ from tempfile import NamedTemporaryFile
 import os
 
 def generate_class_diagram(json_input: str, output_format: str) -> str:
+    """
+    Generates a class diagram from JSON input.
+
+    Args:
+        json_input (str): A JSON string describing the class diagram structure.
+                          It must follow the Expected JSON Format Example below.
+
+    Expected JSON Format Example:
+    {
+      "classes": [
+        {
+          "name": "Vehicle",
+          "type": "abstract",
+          "attributes": [
+            {"name": "id", "type": "String", "visibility": "-"},
+            {"name": "brand", "type": "String", "visibility": "#"},
+            {"name": "model", "type": "String", "visibility": "#"},
+            {"name": "year", "type": "int", "visibility": "#"},
+            {"name": "price", "type": "double", "visibility": "+"},
+            {"name": "vehicleCount", "type": "int", "visibility": "+", "static": true}
+          ],
+          "methods": [
+            {"name": "Vehicle", "parameters": [{"name": "brand", "type": "String"}, {"name": "model", "type": "String"}], "return_type": "Vehicle", "visibility": "+"},
+            {"name": "startEngine", "return_type": "void", "visibility": "+", "abstract": true},
+            {"name": "stopEngine", "return_type": "void", "visibility": "+"},
+            {"name": "getPrice", "return_type": "double", "visibility": "+"},
+            {"name": "setPrice", "parameters": [{"name": "price", "type": "double"}], "return_type": "void", "visibility": "+"},
+            {"name": "getTotalVehicles", "return_type": "int", "visibility": "+", "static": true}
+          ]
+        },
+        {
+          "name": "Car",
+          "type": "class",
+          "attributes": [
+            {"name": "doors", "type": "int", "visibility": "-"},
+            {"name": "transmission", "type": "TransmissionType", "visibility": "-"},
+            {"name": "fuelType", "type": "FuelType", "visibility": "-"}
+          ],
+          "methods": [
+            {"name": "Car", "parameters": [{"name": "brand", "type": "String"}, {"name": "model", "type": "String"}, {"name": "doors", "type": "int"}], "return_type": "Car", "visibility": "+"},
+            {"name": "startEngine", "return_type": "void", "visibility": "+"},
+            {"name": "openTrunk", "return_type": "void", "visibility": "+"},
+            {"name": "getDoors", "return_type": "int", "visibility": "+"},
+            {"name": "setTransmission", "parameters": [{"name": "transmission", "type": "TransmissionType"}], "return_type": "void", "visibility": "+"}
+          ]
+        },
+        {
+          "name": "Motorcycle",
+          "type": "class",
+          "attributes": [
+            {"name": "engineSize", "type": "int", "visibility": "-"},
+            {"name": "hasWindshield", "type": "boolean", "visibility": "-"}
+          ],
+          "methods": [
+            {"name": "Motorcycle", "parameters": [{"name": "brand", "type": "String"}, {"name": "model", "type": "String"}], "return_type": "Motorcycle", "visibility": "+"},
+            {"name": "startEngine", "return_type": "void", "visibility": "+"},
+            {"name": "wheelie", "return_type": "void", "visibility": "+"},
+            {"name": "getEngineSize", "return_type": "int", "visibility": "+"}
+          ]
+        },
+        {
+          "name": "Engine",
+          "type": "class",
+          "attributes": [
+            {"name": "horsepower", "type": "int", "visibility": "-"},
+            {"name": "cylinders", "type": "int", "visibility": "-"},
+            {"name": "fuelType", "type": "FuelType", "visibility": "-"}
+          ],
+          "methods": [
+            {"name": "Engine", "parameters": [{"name": "horsepower", "type": "int"}, {"name": "cylinders", "type": "int"}], "return_type": "Engine", "visibility": "+"},
+            {"name": "start", "return_type": "boolean", "visibility": "+"},
+            {"name": "stop", "return_type": "void", "visibility": "+"},
+            {"name": "getHorsepower", "return_type": "int", "visibility": "+"}
+          ]
+        },
+        {
+          "name": "TransmissionType",
+          "type": "enum",
+          "attributes": [
+            {"name": "MANUAL", "type": "TransmissionType", "visibility": "+", "static": true},
+            {"name": "AUTOMATIC", "type": "TransmissionType", "visibility": "+", "static": true},
+            {"name": "CVT", "type": "TransmissionType", "visibility": "+", "static": true}
+          ],
+          "methods": []
+        },
+        {
+          "name": "FuelType",
+          "type": "enum",
+          "attributes": [
+            {"name": "GASOLINE", "type": "FuelType", "visibility": "+", "static": true},
+            {"name": "DIESEL", "type": "FuelType", "visibility": "+", "static": true},
+            {"name": "ELECTRIC", "type": "FuelType", "visibility": "+", "static": true},
+            {"name": "HYBRID", "type": "FuelType", "visibility": "+", "static": true}
+          ],
+          "methods": []
+        },
+        {
+          "name": "VehicleService",
+          "type": "interface",
+          "attributes": [],
+          "methods": [
+            {"name": "maintenance", "parameters": [{"name": "vehicle", "type": "Vehicle"}], "return_type": "void", "visibility": "+", "abstract": true},
+            {"name": "repair", "parameters": [{"name": "vehicle", "type": "Vehicle"}, {"name": "issue", "type": "String"}], "return_type": "boolean", "visibility": "+", "abstract": true},
+            {"name": "inspectVehicle", "parameters": [{"name": "vehicle", "type": "Vehicle"}], "return_type": "InspectionReport", "visibility": "+", "abstract": true}
+          ]
+        },
+        {
+          "name": "GarageService",
+          "type": "class",
+          "attributes": [
+            {"name": "garageName", "type": "String", "visibility": "-"},
+            {"name": "location", "type": "String", "visibility": "-"}
+          ],
+          "methods": [
+            {"name": "GarageService", "parameters": [{"name": "name", "type": "String"}], "return_type": "GarageService", "visibility": "+"},
+            {"name": "maintenance", "parameters": [{"name": "vehicle", "type": "Vehicle"}], "return_type": "void", "visibility": "+"},
+            {"name": "repair", "parameters": [{"name": "vehicle", "type": "Vehicle"}, {"name": "issue", "type": "String"}], "return_type": "boolean", "visibility": "+"},
+            {"name": "inspectVehicle", "parameters": [{"name": "vehicle", "type": "Vehicle"}], "return_type": "InspectionReport", "visibility": "+"}
+          ]
+        }
+      ],
+      "relationships": [
+        {
+          "from": "Car",
+          "to": "Vehicle",
+          "type": "inheritance",
+          "label": "extends"
+        },
+        {
+          "from": "Motorcycle",
+          "to": "Vehicle",
+          "type": "inheritance",
+          "label": "extends"
+        },
+        {
+          "from": "Car",
+          "to": "Engine",
+          "type": "composition",
+          "label": "has",
+          "multiplicity_from": "1",
+          "multiplicity_to": "1"
+        },
+        {
+          "from": "Motorcycle",
+          "to": "Engine",
+          "type": "composition",
+          "label": "has",
+          "multiplicity_from": "1",
+          "multiplicity_to": "1"
+        },
+        {
+          "from": "Car",
+          "to": "TransmissionType",
+          "type": "association",
+          "label": "uses",
+          "multiplicity_from": "1",
+          "multiplicity_to": "1"
+        },
+        {
+          "from": "Vehicle",
+          "to": "FuelType",
+          "type": "association",
+          "label": "uses",
+          "multiplicity_from": "1",
+          "multiplicity_to": "1"
+        },
+        {
+          "from": "GarageService",
+          "to": "VehicleService",
+          "type": "realization",
+          "label": "implements"
+        },
+        {
+          "from": "GarageService",
+          "to": "Vehicle",
+          "type": "dependency",
+          "label": "services",
+          "multiplicity_from": "1",
+          "multiplicity_to": "*"
+        }
+      ]
+    }
+
+    Returns:
+        str: The filepath to the generated PNG image file.
+    """
     try:
         if not json_input.strip():
             return "Error: Empty input"