[ADD] estate: add chapters 5–15 of Server Framework 101

This commit adds the core sections of the Server Framework 101 tutorial, from chapter 5 (Add a model) to chapter 15 (Add security groups).

These chapters walk through progressively building a functional Odoo module, including defining models, views, menus, access controls, security groups, and testing setups. They serve as an educational reference for new developers learning to develop server-side features in Odoo.

Included topics:

- Creating models and fields

- Defining views (form, tree)

- Adding menus and actions

- Configuring access rights and record rules

- Organizing data files and dependencies

- Writing and loading test data

- Creating security groups and assigning permissions

This is part of a full tutorial module and does not include production-ready features, but aims to demonstrate development best practices.

Author: jcha-odoo

estate/__manifest__.py

@@ -1,8 +1,8 @@
 {
-    'name': "Real Estate",
+    'name': 'Real Estate',
     'version': '1.0',
     'depends': ['base'],
-    'author': "Jay Chauhan",
+    'author': 'Jay Chauhan',
     'category': 'Category',
     'description': """
         Real Estate Management Module
@@ -18,10 +18,14 @@
         - User-friendly views and search with filters and group-by options for efficient property management
     """,
     'data': [
+        'views/estate_property_offer_view.xml',
+        'views/estate_property_type_view.xml',
+        'views/estate_property_tag_view.xml',
+        'views/estate_property_view.xml',
+        'views/estate_menu.xml',
         'security/ir.model.access.csv',
-        'views/estate_menus.xml',
-        'views/estate_property_views.xml'
     ],
     'installable': True,
-    'application': True
+    'application': True,
+    'license': 'LGPL-3'
 }

estate/models/__init__.py

@@ -1 +1 @@
-from . import estate_property
+from . import estate_property, estate_property_type, estate_property_tag, estate_property_offer, inherited_user

estate/models/estate_property.py

@@ -1,78 +1,239 @@
-from odoo import models, fields
+# Python Imports
 from datetime import date
 from dateutil.relativedelta import relativedelta
 
+# Odoo Imports
+from odoo import _, api, fields, models
+from odoo.exceptions import UserError, ValidationError
+from odoo.tools.float_utils import float_compare, float_is_zero
+
 
 class EstateProperty(models.Model):
     _name = 'estate.property'
     _description = 'Estate Property'
+    _order = 'id desc'
 
-    # Title of the property (required)
-    name = fields.Char(string='Title', required=True)
-
-    # Detailed description text
-    description = fields.Text(string='Description')
-
-    # Postcode as a simple Char field
-    postcode = fields.Char(string='Postcode')
-
-    # Availability date with default 3 months from today; copy=False avoids duplication on record duplication
+    # -----------------------------
+    # Field Declarations
+    # -----------------------------
+    name = fields.Char(
+        string='Title',
+        required=True,
+        help='Title or name of the property.'
+    )
+    description = fields.Text(
+        string='Description',
+        help='Detailed description of the property.'
+    )
+    postcode = fields.Char(
+        string='Postcode',
+        help='Postal code of the property location.'
+    )
     date_availability = fields.Date(
         string='Availability From',
         copy=False,
-        default=(date.today() + relativedelta(months=3))
+        default=(date.today() + relativedelta(months=3)),
+        help='Date from which the property will be available.'
+    )
+    expected_price = fields.Float(
+        string='Expected Price',
+        required=True,
+        help='Price expected by the seller for this property.'
+    )
+    selling_price = fields.Float(
+        string='Selling Price',
+        readonly=True,
+        copy=False,
+        help='Final selling price once the property is sold.'
+    )
+    bedrooms = fields.Integer(
+        string='Bedrooms',
+        default=2,
+        help='Number of bedrooms in the property.'
+    )
+    living_area = fields.Integer(
+        string='Living Area (sqm)',
+        help='Living area size in square meters.'
+    )
+    facades = fields.Integer(
+        string='Facades',
+        help='Number of facades of the property.'
+    )
+    garage = fields.Integer(
+        string='Garage',
+        help='Number of garage spaces.'
+    )
+    garden = fields.Boolean(
+        string='Garden',
+        help='Whether the property has a garden.'
+    )
+    garden_area = fields.Integer(
+        string='Garden Area (sqm)',
+        help='Size of the garden area in square meters.'
     )
-
-    # Expected sale price (required)
-    expected_price = fields.Float(string='Expected Price', required=True)
-
-    # Actual selling price, read-only (set by system or workflow), not copied on duplication
-    selling_price = fields.Float(string='Selling Price', readonly=True, copy=False)
-
-    # Number of bedrooms with default value
-    bedrooms = fields.Integer(string='Bedrooms', default=2)
-
-    # Living area in square meters
-    living_area = fields.Integer(string='Living Area (sqm)')
-
-    # Number of facades
-    facades = fields.Integer(string='Facades')
-
-    # Garage capacity count
-    garage = fields.Integer(string='Garage')
-
-    # Boolean indicating if garden exists
-    garden = fields.Boolean(string='Garden')
-
-    # Garden area in square meters
-    garden_area = fields.Integer(string='Garden Area (sqm)')
-
-    # Orientation of the garden with default 'north'
     garden_orientation = fields.Selection(
+        string='Garden Orientation',
         selection=[
             ('north', 'North'),
             ('south', 'South'),
             ('east', 'East'),
-            ('west', 'West')
+            ('west', 'West'),
         ],
-        string='Garden Orientation',
-        default='north'
+        default='north',
+        help='Direction the garden faces.'
     )
-
-    # Status of the property; required, default 'new', not copied on duplication
     state = fields.Selection(
+        string='Status',
         selection=[
             ('new', 'New'),
             ('offer_received', 'Offer Received'),
             ('offer_accepted', 'Offer Accepted'),
             ('sold', 'Sold'),
             ('cancelled', 'Cancelled'),
         ],
-        string='Status',
         required=True,
         copy=False,
-        default='new'
+        default='new',
+        help='Current status of the property.'
+    )
+    active = fields.Boolean(
+        string='Active',
+        default=True,
+        help='Whether the property is active and visible.'
+    )
+    property_type_id = fields.Many2one(
+        'estate.property.type',
+        string='Property Type',
+        help='Type or category of the property.'
+    )
+    buyer_id = fields.Many2one(
+        'res.partner',
+        string='Buyer',
+        copy=False,
+        help='Partner who bought the property.'
+    )
+    sales_id = fields.Many2one(
+        'res.users',
+        string='Salesman',
+        default=lambda self: self.env.user,
+        help='Salesperson responsible for the property.'
+    )
+    tag_ids = fields.Many2many(
+        'estate.property.tag',
+        string='Tags',
+        help='Tags to classify the property.'
+    )
+    offer_ids = fields.One2many(
+        'estate.property.offer',
+        'property_id',
+        string='Offers',
+        help='Offers made on this property.'
+    )
+
+    # -----------------------------
+    # SQL Constraints
+    # -----------------------------
+    _sql_constraints = [
+        ('check_expected_price', 'CHECK(expected_price > 0)', 'Expected price cannot be negative.'),
+        ('check_selling_price', 'CHECK(selling_price > 0)', 'Selling price cannot be negative.'),
+    ]
+
+    # -----------------------------
+    # Computed Fields
+    # -----------------------------
+    total = fields.Float(
+        string='Total (sqm)',
+        compute='_compute_total_area',
+        help='Total area of the property including living and garden areas.'
+    )
+    best_price = fields.Float(
+        string='Best Offer',
+        compute='_compute_best_price',
+        help='Highest offer price received for the property.'
     )
 
-    # Active flag to archive/unarchive records easily
-    active = fields.Boolean(string='Active', default=True)
+    @api.depends('living_area', 'garden_area')
+    def _compute_total_area(self):
+        """Compute total area as sum of living area and garden area."""
+        for record in self:
+            record.total = (record.living_area or 0) + (record.garden_area or 0)
+
+    @api.depends('offer_ids.price')
+    def _compute_best_price(self):
+        """Compute highest offer price or 0 if no offers."""
+        for record in self:
+            offer_prices = record.offer_ids.mapped('price')
+            record.best_price = max(offer_prices) if offer_prices else 0.0
+
+    # -----------------------------
+    # Action Methods
+    # -----------------------------
+    def action_sold(self):
+        """Set property state to 'sold', with validation against invalid states."""
+        for record in self:
+            if record.state == 'cancelled':
+                raise UserError('A cancelled property cannot be set as sold.')
+            elif record.state == 'sold':
+                raise UserError('Property is already sold.')
+            else:
+                record.state = 'sold'
+
+    def action_cancel(self):
+        """Set property state to 'cancelled', with validation against invalid states."""
+        for record in self:
+            if record.state == 'sold':
+                raise UserError('A sold property cannot be cancelled.')
+            elif record.state == 'cancelled':
+                raise UserError('Property is already cancelled.')
+            else:
+                record.state = 'cancelled'
+
+    # -----------------------------
+    # Constraints
+    # -----------------------------
+    @api.constrains('selling_price', 'expected_price')
+    def _check_selling_price(self):
+        """
+        Ensure selling price is at least 90% of expected price.
+        Raises ValidationError if condition is not met.
+        """
+        for record in self:
+            if record.selling_price and record.selling_price < 0.9 * record.expected_price:
+                raise ValidationError(
+                    _("The selling price must be at least 90%% of the expected price.\n"
+                        "Expected Price: %(expected).2f\nSelling Price: %(selling).2f")
+                    % {
+                        'expected': record.expected_price,
+                        'selling': record.selling_price
+                    }
+                )
+
+    @api.constrains('selling_price', 'expected_price')
+    def _check_selling_price_above_90_percent(self):
+        """
+        Validate selling price with float precision.
+        Ignores zero selling price, otherwise enforces minimum 90% threshold.
+        """
+        for record in self:
+            if float_is_zero(record.selling_price, precision_digits=2):
+                continue
+            min_acceptable_price = 0.9 * record.expected_price
+            if float_compare(record.selling_price, min_acceptable_price, precision_digits=2) < 0:
+                raise ValidationError(
+                    _("The selling price must be at least 90%% of the expected price.\n"
+                        "Expected Price: %(expected_price).2f\nSelling Price: %(selling_price).2f")
+                    % {
+                        'expected_price': record.expected_price,
+                        'selling_price': record.selling_price
+                    }
+                )
+
+    @api.ondelete(at_uninstall=False)
+    def _check_can_be_deleted(self):
+        """
+        Restrict deletion to properties in 'new' or 'cancelled' state.
+        Raises UserError otherwise.
+        """
+        for record in self:
+            if record.state not in ['new', 'cancelled']:
+                raise UserError("You can only delete properties that are New or Cancelled.")