Custom fields improvement (#862)

* [IMP] initial improvements

* [FIX] UI

* [IMP] UI and fields

* [IMP] UI design output

* [IMP] UI design output

* [FIX] pre-commit

* [ADD] tests and improve

* [IMP] tests

* [IMP] tests

* [FIX] target type to readonly

* [FIX] pre-commit

Author: emjay0921

spp_custom_field/__init__.py

@@ -1,3 +1,4 @@
 # Part of OpenSPP. See LICENSE file for full copyright and licensing details.
 
 from . import models
+from . import tests

spp_custom_field/__manifest__.py

@@ -11,7 +11,10 @@
     "development_status": "Production/Stable",
     "maintainers": ["jeremi", "gonzalesedwin1123"],
     "depends": ["base", "g2p_registry_base"],
-    "data": [],
+    "data": [
+        "security/ir.model.access.csv",
+        "views/field_group_views.xml",
+    ],
     "assets": {},
     "demo": [],
     "images": [],

spp_custom_field/models/__init__.py

@@ -1,3 +1,5 @@
 # Part of OpenSPP. See LICENSE file for full copyright and licensing details.
 
+from . import field_group
 from . import cus_partner
+from . import ir_model_fields

spp_custom_field/models/cus_partner.py

@@ -55,7 +55,55 @@ def create_field_element(self, div_element, model_field_id, is_ind=False):
             modifiers = {"readonly": True}
             new_field.set("modifiers", json.dumps(modifiers))
 
-    def _get_view(self, view_id=None, view_type="form", **options):
+    def _group_fields_by_group(self, fields_list):
+        """
+        Group fields by their field_group_id and sort by sequence.
+        Returns a list of tuples (group_record, fields_in_group).
+        Fields without a group are returned with group_record=None.
+        """
+        from collections import defaultdict
+
+        grouped = defaultdict(list)
+
+        # Check if field_group_id exists on the model
+        has_group_field = hasattr(fields_list[0], "field_group_id") if fields_list else False
+        has_sequence_field = hasattr(fields_list[0], "sequence") if fields_list else False
+
+        for field in fields_list:
+            group_id = None
+            if has_group_field and field.field_group_id:
+                group_id = field.field_group_id.id
+            grouped[group_id].append(field)
+
+        # Sort fields within each group by sequence
+        for group_id in grouped:
+            if has_sequence_field:
+                grouped[group_id] = sorted(grouped[group_id], key=lambda f: (f.sequence, f.field_description))
+            else:
+                grouped[group_id] = sorted(grouped[group_id], key=lambda f: f.field_description)
+
+        # Get group records and sort groups by sequence
+        result = []
+        group_ids = [gid for gid in grouped.keys() if gid is not None]
+        if group_ids and "spp.custom.field.group" in self.env:
+            try:
+                group_records = self.env["spp.custom.field.group"].browse(group_ids)
+                group_records = group_records.sorted(key=lambda g: g.sequence)
+                for group in group_records:
+                    result.append((group, grouped[group.id]))
+            except KeyError:
+                # Model doesn't exist, treat all fields as ungrouped
+                _logger.warning("spp.custom.field.group model not found, ignoring field groups")
+                if None in grouped:
+                    result.append((None, grouped[None]))
+
+        # Add fields without a group at the end
+        if None in grouped:
+            result.append((None, grouped[None]))
+
+        return result
+
+    def _get_view(self, view_id=None, view_type="form", **options):  # noqa: C901
         arch, view = super()._get_view(view_id, view_type, **options)
 
         if view_type == "form":
@@ -69,7 +117,7 @@ def _get_view(self, view_id=None, view_type="form", **options):
 
             model_fields_id = self.env["ir.model.fields"].search(
                 [("model_id", "=", "res.partner")],
-                order="ttype, field_description",
+                order="sequence, ttype, field_description",
             )
             if basic_info_page:
                 if action_id.context:
@@ -79,22 +127,109 @@ def _get_view(self, view_id=None, view_type="form", **options):
                 custom_page = etree.Element("page", {"string": "Additional Details", "name": "additional_details"})
                 indicators_page = etree.Element("page", {"string": "Indicators", "name": "indicators"})
 
-                custom_div = etree.SubElement(custom_page, "div", {"class": "row mt16 o_settings_container"})
-                indicators_div = etree.SubElement(indicators_page, "div", {"class": "row mt16 o_settings_container"})
+                # Separate custom and indicator fields
+                custom_fields = []
+                indicator_fields = []
+
                 for rec in model_fields_id:
                     els = rec.name.split("_")
                     if len(els) >= 3 and (els[2] == "grp" and not is_group or els[2] == "indv" and is_group):
                         continue
 
                     if len(els) >= 2 and els[1] == "cst":
-                        self.create_field_element(custom_div, rec)
-
+                        custom_fields.append(rec)
                     elif len(els) >= 2 and els[1] == "ind":
-                        self.create_field_element(indicators_div, rec, is_ind=True)
-
-                if custom_div.getchildren():
+                        indicator_fields.append(rec)
+
+                # Process custom fields with grouping
+                if custom_fields:
+                    grouped_custom_fields = self._group_fields_by_group(custom_fields)
+
+                    # Create main container row for side-by-side layout
+                    main_row = etree.SubElement(custom_page, "div", {"class": "row"})
+
+                    for group_record, fields_in_group in grouped_custom_fields:
+                        if group_record:
+                            # Create a half-width column for each group
+                            group_col = etree.SubElement(
+                                main_row,
+                                "div",
+                                {"class": "col-12 col-lg-6"},
+                            )
+                            # Add group label/title
+                            group_label_div = etree.SubElement(
+                                group_col,
+                                "div",
+                                {"class": "o_horizontal_separator mt-2 mb-3"},
+                            )
+                            group_label = etree.SubElement(
+                                group_label_div,
+                                "strong",
+                            )
+                            group_label.text = group_record.name
+                            # Create fields container
+                            group_div = etree.SubElement(group_col, "div", {"class": "row mt16 o_settings_container"})
+                            for field in fields_in_group:
+                                self.create_field_element(group_div, field)
+                        else:
+                            # Fields without a group go in full width at the bottom
+                            if not custom_page.xpath(".//div[@class='row mt16 o_settings_container o_no_group']"):
+                                custom_div = etree.SubElement(
+                                    custom_page, "div", {"class": "row mt16 o_settings_container o_no_group"}
+                                )
+                            else:
+                                custom_div = custom_page.xpath(
+                                    ".//div[@class='row mt16 o_settings_container o_no_group']"
+                                )[0]
+                            for field in fields_in_group:
+                                self.create_field_element(custom_div, field)
+
+                # Process indicator fields with grouping
+                if indicator_fields:
+                    grouped_indicator_fields = self._group_fields_by_group(indicator_fields)
+
+                    # Create main container row for side-by-side layout
+                    main_row = etree.SubElement(indicators_page, "div", {"class": "row"})
+
+                    for group_record, fields_in_group in grouped_indicator_fields:
+                        if group_record:
+                            # Create a half-width column for each group
+                            group_col = etree.SubElement(
+                                main_row,
+                                "div",
+                                {"class": "col-12 col-lg-6"},
+                            )
+                            # Add group label/title
+                            group_label_div = etree.SubElement(
+                                group_col,
+                                "div",
+                                {"class": "o_horizontal_separator mt-2 mb-3"},
+                            )
+                            group_label = etree.SubElement(
+                                group_label_div,
+                                "strong",
+                            )
+                            group_label.text = group_record.name
+                            # Create fields container
+                            group_div = etree.SubElement(group_col, "div", {"class": "row mt16 o_settings_container"})
+                            for field in fields_in_group:
+                                self.create_field_element(group_div, field, is_ind=True)
+                        else:
+                            # Fields without a group go in full width at the bottom
+                            if not indicators_page.xpath(".//div[@class='row mt16 o_settings_container o_no_group']"):
+                                indicators_div = etree.SubElement(
+                                    indicators_page, "div", {"class": "row mt16 o_settings_container o_no_group"}
+                                )
+                            else:
+                                indicators_div = indicators_page.xpath(
+                                    ".//div[@class='row mt16 o_settings_container o_no_group']"
+                                )[0]
+                            for field in fields_in_group:
+                                self.create_field_element(indicators_div, field, is_ind=True)
+
+                if custom_page.getchildren():
                     basic_info_page[0].addnext(custom_page)
-                if indicators_div.getchildren():
+                if indicators_page.getchildren():
                     basic_info_page[0].addnext(indicators_page)
 
                 arch = doc

spp_custom_field/models/field_group.py

@@ -0,0 +1,21 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+
+from odoo import fields, models
+
+
+class CustomFieldGroup(models.Model):
+    _name = "spp.custom.field.group"
+    _description = "Custom Field Group"
+    _order = "sequence, name"
+
+    name = fields.Char(string="Group Name", required=True, translate=True)
+    target_type = fields.Selection(
+        selection=[("grp", "Group"), ("indv", "Individual")],
+        string="Target Type",
+        required=True,
+        default="grp",
+        help="Specify whether this group is for Group or Individual fields",
+    )
+    sequence = fields.Integer(string="Sequence", default=10)
+    description = fields.Text(string="Description", translate=True)
+    active = fields.Boolean(string="Active", default=True)

spp_custom_field/models/ir_model_fields.py

@@ -0,0 +1,25 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+
+from odoo import api, fields, models
+
+
+class IrModelFields(models.Model):
+    _inherit = "ir.model.fields"
+
+    field_group_id = fields.Many2one(
+        "spp.custom.field.group",
+        string="Field Group",
+        help="Group this field belongs to for UI organization",
+        domain="[('target_type', '=', target_type)]",
+    )
+    sequence = fields.Integer(
+        string="Sequence",
+        default=10,
+        help="Order of the field within its group or section",
+    )
+
+    @api.onchange("target_type")
+    def _onchange_target_type(self):
+        """Clear field_group_id if target_type changes and doesn't match"""
+        if self.field_group_id and self.field_group_id.target_type != self.target_type:
+            self.field_group_id = False

spp_custom_field/security/ir.model.access.csv

@@ -0,0 +1,3 @@
+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink
+access_spp_custom_field_group_user,spp.custom.field.group.user,model_spp_custom_field_group,base.group_user,1,0,0,0
+access_spp_custom_field_group_admin,spp.custom.field.group.admin,model_spp_custom_field_group,base.group_system,1,1,1,1

spp_custom_field/tests/__init__.py

@@ -0,0 +1,4 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+
+from . import test_field_group
+from . import test_view_generation