[FIX] spp_code_generator: Fixed the action_process_entities to consider the entitles name (Household or Individual)

Author: gonzalesedwin1123

spp_code_generator/IMPLEMENTATION_GUIDE.md

@@ -103,13 +103,20 @@ YAML File Upload → Validation → Parse → Extract Entities → Create Fields
 **Field Naming Convention**:
 
 ```
-YAML: "hh_id"
-Odoo: "z_cst_hh_id"
+YAML Entity: "Household", Field: "hh_id"
+Odoo: "x_cst_grp_hh_id"
+
+YAML Entity: "Individual", Field: "person_id"
+Odoo: "x_cst_indv_person_id"
 
 Prefix breakdown:
-- z_     : OpenSPP custom field prefix
+- x_     : Odoo custom field prefix
 - cst_   : Custom (not indicator)
-- hh_id  : Original field ID from YAML
+- grp_   : Group/Household fields
+- indv_  : Individual fields
+- field_id : Original field ID from YAML
+
+This matches the spp_custom_fields_ui module conventions for proper UI integration.
 ```
 
 **Args**:
@@ -207,22 +214,24 @@ entities:
 
 For the above YAML, the following fields would be created in `res.partner`:
 
-| YAML Field ID | Odoo Field Name | Type      | Required |
-| ------------- | --------------- | --------- | -------- |
-| hh_id         | z_cst_hh_id     | Char      | Yes      |
-| province      | z_cst_province  | Char      | No       |
-| person_id     | z_cst_person_id | Char      | Yes      |
-| birthdate     | z_cst_birthdate | Date      | Yes      |
-| gender        | z_cst_gender    | Selection | Yes      |
+| Entity     | YAML Field ID | Odoo Field Name      | Type      | Required |
+| ---------- | ------------- | -------------------- | --------- | -------- |
+| Household  | hh_id         | x_cst_grp_hh_id      | Char      | Yes      |
+| Household  | province      | x_cst_grp_province   | Char      | No       |
+| Individual | person_id     | x_cst_indv_person_id | Char      | Yes      |
+| Individual | birthdate     | x_cst_indv_birthdate | Date      | Yes      |
+| Individual | gender        | x_cst_indv_gender    | Selection | Yes      |
 
 ### Selection Field Example
 
-For `gender` enum field:
+For `gender` enum field in Individual entity:
 
 ```python
-Field: z_cst_gender
+Field: x_cst_indv_gender
 Type: Selection
 Values: [('Female', 'Female'), ('Male', 'Male')]
+Target Type: indv
+Field Category: cst
 ```
 
 ---
@@ -324,17 +333,39 @@ Completed at: 2025-10-23 10:30:15
 
 ### Field Naming
 
-Follows OpenSPP field naming patterns:
+Follows `spp_custom_fields_ui` field naming patterns:
+
+- `x_`: Odoo custom field prefix (standard)
+- `cst_`: Custom/arbitrary fields (not indicators `ind_`)
+- `grp_`: Group/Household entity fields
+- `indv_`: Individual entity fields
 
-- `z_`: General prefix for custom fields
-- `cst_`: Custom/arbitrary fields (not indicators)
-- Example: `z_cst_hh_id`
+**Examples**:
+
+- Group field: `x_cst_grp_hh_id`
+- Individual field: `x_cst_indv_person_id`
 
 ### Why This Pattern?
 
-1. **z\_**: Groups all custom fields together
-2. **cst\_**: Distinguishes from indicators (`ind_`)
-3. **Prevents conflicts**: With standard Odoo fields
+1. **x\_**: Standard Odoo prefix for custom fields
+2. **cst\_**: Distinguishes from computed indicators (`ind_`)
+3. **grp\_/indv\_**: Entity-specific prefix for UI filtering
+4. **Integration**: Matches `spp_custom_fields_ui` for proper display in registry UIs
+5. **Prevents conflicts**: With standard Odoo and OpenSPP fields
+
+### spp_custom_fields_ui Integration
+
+Created fields include metadata for `spp_custom_fields_ui`:
+
+- `target_type`: "grp" or "indv"
+- `field_category`: "cst" (custom)
+- `draft_name`: Original field ID from YAML
+
+This ensures fields appear correctly in:
+
+- Group/Household forms
+- Individual forms
+- Custom field management UI
 
 ---
 

spp_code_generator/__manifest__.py

@@ -18,7 +18,12 @@
         "g2p_registry_group",
         "g2p_registry_membership",
         "g2p_programs",
+        "spp_custom_field",
+        "spp_custom_fields_ui",
     ],
+    "external_dependencies": {
+        "python": ["PyYAML"],
+    },
     "data": [
         "security/ir.model.access.csv",
         "views/code_generator_views.xml",

spp_code_generator/models/code_generator.py

@@ -100,6 +100,35 @@ def _get_odoo_field_type(self, yaml_field_type):
         }
         return type_mapping.get(yaml_field_type, "char")
 
+    def _get_entity_prefix(self, entity_name):
+        """
+        Determine the field prefix based on entity type.
+
+        Args:
+            entity_name (str): Name of the entity (e.g., 'Household', 'Individual')
+
+        Returns:
+            str: Field prefix following OpenSPP conventions
+                - 'x_cst_grp_' for groups/households
+                - 'x_cst_indv_' for individuals
+        """
+        entity_lower = entity_name.lower()
+
+        # Check if entity is a group/household
+        if any(keyword in entity_lower for keyword in ["household", "group", "family"]):
+            return "x_cst_grp"
+        # Check if entity is an individual
+        elif any(keyword in entity_lower for keyword in ["individual", "member", "person"]):
+            return "x_cst_indv"
+        else:
+            # Default to group if uncertain
+            _logger.warning(
+                "Unknown entity type '%s', defaulting to group prefix. "
+                "Consider using 'Household' or 'Individual' as entity names.",
+                entity_name,
+            )
+            return "x_cst_grp"
+
     def _create_field_from_spec(self, entity_name, field_spec):
         """
         Create an Odoo field in res.partner based on field specification from YAML.
@@ -120,6 +149,10 @@ def _create_field_from_spec(self, entity_name, field_spec):
                 'values': [...],              # Optional: For enum types, list of allowed values
                 'description': '...'          # Optional: Help text for the field
             }
+
+        Field Naming Convention (matching spp_custom_fields_ui):
+            - Groups/Households: x_cst_grp_{field_id}
+            - Individuals: x_cst_indv_{field_id}
         """
         self.ensure_one()
 
@@ -135,9 +168,10 @@ def _create_field_from_spec(self, entity_name, field_spec):
             _logger.warning("Skipping field with incomplete specification: %s", field_spec)
             return None
 
-        # Prepare field name with prefix based on OpenSPP conventions
-        # z_cst_ prefix for custom fields
-        field_name = f"z_cst_{field_id}"
+        # Prepare field name with prefix based on entity type
+        # Follows spp_custom_fields_ui convention: x_cst_grp_ or x_cst_indv_
+        prefix = self._get_entity_prefix(entity_name)
+        field_name = f"{prefix}_{field_id}"
 
         # Check if field already exists
         IrModelFields = self.env["ir.model.fields"]
@@ -155,6 +189,9 @@ def _create_field_from_spec(self, entity_name, field_spec):
         # Map YAML type to Odoo type
         odoo_field_type = self._get_odoo_field_type(field_type)
 
+        # Determine target type for spp_custom_fields_ui integration
+        target_type = "grp" if "grp" in prefix else "indv"
+
         # Prepare field values
         field_values = {
             "name": field_name,
@@ -165,6 +202,9 @@ def _create_field_from_spec(self, entity_name, field_spec):
             "required": is_required,
             "help": field_description or f"Custom field for {entity_name}: {field_label}",
             "state": "manual",  # Manual fields can be deleted
+            "target_type": target_type,  # For spp_custom_fields_ui: 'grp' or 'indv'
+            "field_category": "cst",  # For spp_custom_fields_ui: 'cst' (custom)
+            "draft_name": field_id,  # Original field ID from YAML
         }
 
         # Handle selection/enum fields