Merge pull request #807 from OpenSPP/804-develop-the-donor-management-module

pithtech · web-flow · commit fe6f118644f5 · 2025-09-15T11:17:10.000+08:00
Develop the Donor Management Module
diff --git a/spp_registry_donor/__init__.py b/spp_registry_donor/__init__.py
@@ -0,0 +1 @@
+from . import models
diff --git a/spp_registry_donor/__manifest__.py b/spp_registry_donor/__manifest__.py
@@ -0,0 +1,34 @@
+# Part of OpenSPP. See LICENSE file for full copyright and licensing details.
+
+{
+    "name": "OpenSPP Registry Donor",
+    "summary": "OpenSPP Donor Registry Management",
+    "category": "OpenSPP",
+    "version": "17.0.1.0.0",
+    "sequence": 1,
+    "author": "OpenSPP.org",
+    "website": "https://github.com/OpenSPP/openspp-modules",
+    "license": "LGPL-3",
+    "development_status": "Alpha",
+    "maintainers": ["gonzalesedwin1123"],
+    "depends": [
+        "base",
+        "g2p_registry_base",
+        "spp_registry_base",
+        "spp_user_roles",
+    ],
+    "data": [
+        # Security
+        "security/security.xml",
+        "security/ir.model.access.csv",
+        # Views
+        "views/res_partner_views.xml",
+        # Data
+        "data/user_roles.xml",
+    ],
+    "demo": [],
+    "images": [],
+    "application": True,
+    "installable": True,
+    "auto_install": False,
+}
diff --git a/spp_registry_donor/data/user_roles.xml b/spp_registry_donor/data/user_roles.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="user_role_donor_user" model="res.users.role">
+        <field name="name">Donor User</field>
+        <field name="role_type">global</field>
+        <field name="comment">Readonly access to Donor Management.</field>
+        <field name="implied_ids" eval="[(4, ref('group_donor_user'))]" />
+    </record>
+
+    <record id="user_role_donor_manager" model="res.users.role">
+        <field name="name">Donor Manager</field>
+        <field name="role_type">global</field>
+        <field name="comment">Admin access to Donor Management.</field>
+        <field name="implied_ids" eval="[(4, ref('group_donor_manager'))]" />
+    </record>
+</odoo>
diff --git a/spp_registry_donor/models/__init__.py b/spp_registry_donor/models/__init__.py
@@ -0,0 +1 @@
+from . import res_partner
diff --git a/spp_registry_donor/models/res_partner.py b/spp_registry_donor/models/res_partner.py
@@ -0,0 +1,12 @@
+from odoo import fields, models
+
+
+class ResPartner(models.Model):
+    _inherit = "res.partner"
+
+    is_donor = fields.Boolean(
+        string="Is Donor",
+        help="Check if this partner is a donor",
+        tracking=True,
+        index=True,
+    )
diff --git a/spp_registry_donor/pyproject.toml b/spp_registry_donor/pyproject.toml
@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"
diff --git a/spp_registry_donor/security/ir.model.access.csv b/spp_registry_donor/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_res_partner_donor_user,res.partner.donor.user,base.model_res_partner,spp_registry_donor.group_donor_user,1,0,0,0
+access_res_partner_donor_manager,res.partner.donor.manager,base.model_res_partner,spp_registry_donor.group_donor_manager,1,1,1,1
diff --git a/spp_registry_donor/security/security.xml b/spp_registry_donor/security/security.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <data noupdate="0">
+        <!-- Category -->
+        <record id="module_category_donor" model="ir.module.category">
+            <field name="name">Donor Management</field>
+            <field name="sequence">21</field>
+        </record>
+
+        <!-- Groups -->
+        <record id="group_donor_user" model="res.groups">
+            <field name="name">Donor User</field>
+            <field name="category_id" ref="module_category_donor" />
+        </record>
+
+        <record id="group_donor_manager" model="res.groups">
+            <field name="name">Donor Manager</field>
+            <field name="category_id" ref="module_category_donor" />
+            <field name="implied_ids" eval="[(4, ref('g2p_registry_base.group_g2p_registrar'))]" />
+            <field name="users" eval="[
+                (4, ref('base.user_admin')),
+            ]" />
+        </record>
+    </data>
+
+    <!-- Record Rules -->
+    <data noupdate="1">
+        <record id="rule_donor_user" model="ir.rule">
+            <field name="name">Donor Users: Read Access</field>
+            <field name="model_id" ref="base.model_res_partner" />
+            <field
+                name="domain_force"
+            >['|', ('is_donor', '=', True), ('is_company', '=', False), ('type', '=', 'contact')]</field>
+            <field name="groups" eval="[(4, ref('group_donor_user'))]" />
+            <field name="perm_read" eval="True" />
+            <field name="perm_write" eval="False" />
+            <field name="perm_create" eval="False" />
+            <field name="perm_unlink" eval="False" />
+        </record>
+
+        <record id="rule_donor_manager" model="ir.rule">
+            <field name="name">Donor Managers: Full Access</field>
+            <field name="model_id" ref="base.model_res_partner" />
+            <field
+                name="domain_force"
+            >['|', ('is_donor', '=', True), ('is_company', '=', False), ('type', '=', 'contact')]</field>
+            <field name="groups" eval="[(4, ref('group_donor_manager'))]" />
+            <field name="perm_read" eval="True" />
+            <field name="perm_write" eval="True" />
+            <field name="perm_create" eval="True" />
+            <field name="perm_unlink" eval="True" />
+        </record>
+    </data>
+</odoo>
diff --git a/spp_registry_donor/static/description/icon.png b/spp_registry_donor/static/description/icon.png
diff --git a/spp_registry_donor/static/description/icon_registry.png b/spp_registry_donor/static/description/icon_registry.png
diff --git a/spp_registry_donor/tests/__init__.py b/spp_registry_donor/tests/__init__.py
@@ -0,0 +1 @@
+from . import test_donor
diff --git a/spp_registry_donor/tests/test_donor.py b/spp_registry_donor/tests/test_donor.py
@@ -0,0 +1,122 @@
+from ast import literal_eval
+
+from odoo.exceptions import AccessError
+from odoo.tests import tagged
+from odoo.tests.common import TransactionCase
+
+
+@tagged("post_install", "-at_install")
+class TestDonorRegistry(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+
+        # Create users with different access levels
+        cls.donor_user = cls.env["res.users"].create(
+            {
+                "name": "Donor User",
+                "login": "donor_user",
+                "email": "donor@test.com",
+                "groups_id": [
+                    (4, cls.env.ref("spp_registry_donor.group_donor_user").id),
+                    (4, cls.env.ref("base.group_user").id),  # Internal User group
+                ],
+            }
+        )
+
+        cls.donor_manager = cls.env["res.users"].create(
+            {
+                "name": "Donor Manager",
+                "login": "donor_manager",
+                "email": "donor_manager@test.com",
+                "groups_id": [
+                    (4, cls.env.ref("spp_registry_donor.group_donor_manager").id),
+                    (4, cls.env.ref("base.group_user").id),  # Internal User group
+                    (4, cls.env.ref("g2p_registry_base.group_g2p_admin").id),
+                ],
+            }
+        )
+
+        # Create test partners
+        cls.donor = cls.env["res.partner"].create(
+            {
+                "name": "Test Donor",
+                "is_donor": True,
+                "email": "test.donor@example.com",
+            }
+        )
+
+        cls.non_donor = cls.env["res.partner"].create(
+            {
+                "name": "Non Donor Partner",
+                "is_donor": False,
+                "email": "non.donor@example.com",
+            }
+        )
+
+    def test_01_donor_creation(self):
+        """Test donor creation and fields"""
+        self.assertTrue(self.donor.is_donor, "Partner should be marked as donor")
+        self.assertFalse(self.non_donor.is_donor, "Partner should not be marked as donor")
+
+    def test_02_donor_user_access(self):
+        """Test donor user access rights"""
+        # Switch to donor user
+        donor_user_env = self.env["res.partner"].with_user(self.donor_user)
+
+        # Should be able to read donor records
+        donor = donor_user_env.browse(self.donor.id)
+        self.assertEqual(donor.name, "Test Donor", "Donor user should be able to read donor records")
+
+        # Should not be able to create/write/unlink donor records
+        with self.assertRaises(AccessError):
+            donor_user_env.create(
+                {
+                    "name": "New Donor",
+                    "is_donor": True,
+                }
+            )
+
+        with self.assertRaises(AccessError):
+            donor.write({"name": "Updated Name"})
+
+        with self.assertRaises(AccessError):
+            donor.unlink()
+
+    def test_03_donor_manager_access(self):
+        """Test donor manager access rights"""
+        # Switch to donor manager
+        manager_env = self.env["res.partner"].with_user(self.donor_manager)
+
+        # Should be able to create donor
+        new_donor = manager_env.create(
+            {
+                "name": "New Donor by Manager",
+                "is_donor": True,
+                "email": "new.donor@example.com",
+            }
+        )
+        self.assertTrue(new_donor.is_donor, "Manager should be able to create donors")
+
+        # Should be able to update donor
+        new_donor.write({"name": "Updated Donor Name"})
+        self.assertEqual(new_donor.name, "Updated Donor Name", "Manager should be able to update donors")
+
+        # Should be able to delete donor
+        new_donor.unlink()
+        self.assertFalse(manager_env.search([("id", "=", new_donor.id)]), "Manager should be able to delete donors")
+
+    def test_04_action_window(self):
+        """Test the donor action window"""
+        action = self.env["ir.actions.act_window"]._for_xml_id("spp_registry_donor.action_registry_donor")
+
+        # Check action configuration
+        self.assertEqual(action["res_model"], "res.partner", "Action should target res.partner model")
+
+        # Convert domain string to list using ast.literal_eval if needed
+        domain = action["domain"]
+        if isinstance(domain, str):
+            domain = literal_eval(domain)
+        self.assertEqual(domain, [("is_donor", "=", True)], "Action should filter donors only")
+
+        self.assertIn("default_is_donor", action["context"], "Action should set default donor context")
diff --git a/spp_registry_donor/views/res_partner_views.xml b/spp_registry_donor/views/res_partner_views.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+    <!-- Form View Extension -->
+    <record id="view_registry_donor_form" model="ir.ui.view">
+        <field name="name">view.registry.donor.form</field>
+        <field name="model">res.partner</field>
+        <field name="inherit_id" ref="base.view_partner_form" />
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='company_type']" position="after">
+                <field name="is_donor" />
+                <label for="is_donor" string="Is a Donor" />
+            </xpath>
+        </field>
+    </record>
+
+    <!-- Search View Extension -->
+    <record id="view_registry_donor_filter" model="ir.ui.view">
+        <field name="name">view.registry.donor.filter</field>
+        <field name="model">res.partner</field>
+        <field name="inherit_id" ref="base.view_res_partner_filter" />
+        <field name="arch" type="xml">
+            <filter name="type_company" position="after">
+                <filter string="Donors" name="group_donor" domain="[('is_donor', '=', True)]" />
+            </filter>
+        </field>
+    </record>
+
+    <!-- Action for Donors -->
+    <record id="action_registry_donor" model="ir.actions.act_window">
+        <field name="name">Donors</field>
+        <field name="res_model">res.partner</field>
+        <field name="view_mode">tree,form</field>
+        <field name="domain">[('is_donor', '=', True)]</field>
+        <field name="context">{
+            'default_is_donor': True,
+            'search_default_group_donor': True,
+        }</field>
+        <field name="help" type="html">
+            <p class="o_view_nocontent_smiling_face">
+                Create a new donor
+            </p>
+        </field>
+    </record>
+
+    <!-- Menu Item -->
+    <menuitem
+        id="menu_registry_donor"
+        name="Donors"
+        parent="g2p_registry_base.g2p_main_menu_root"
+        action="action_registry_donor"
+        sequence="100"
+        groups="spp_registry_donor.group_donor_user,spp_registry_donor.group_donor_manager"
+    />
+</odoo>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[build-system]`
	`2`	`+requires = ["whool"]`
	`3`	`+build-backend = "whool.buildapi"`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink`
	`2`	`+access_res_partner_donor_user,res.partner.donor.user,base.model_res_partner,spp_registry_donor.group_donor_user,1,0,0,0`
	`3`	`+access_res_partner_donor_manager,res.partner.donor.manager,base.model_res_partner,spp_registry_donor.group_donor_manager,1,1,1,1`