[ADD] estate: Real Estate App for tutorials

Added Real estate app built up to the end of chapter 11

Author: Mathilde411

estate/__init__.py

@@ -0,0 +1 @@
+from . import models

estate/__manifest__.py

@@ -0,0 +1,21 @@
+{
+    'name': 'Real Estate',
+    'version': '1.0',
+    'category': 'Tutorials',
+    'depends': [
+        'base'
+    ],
+    'data': [
+        'security/ir.model.access.csv',
+
+        'views/estate_property_type_views.xml',
+        'views/estate_property_tag_views.xml',
+        'views/estate_property_offer_views.xml',
+        'views/estate_property_views.xml',
+        'views/estate_menu_views.xml'
+    ],
+    'installable': True,
+    'application': True,
+    'auto_install': False,
+    'license': 'AGPL-3'
+}

estate/models/__init__.py

@@ -0,0 +1,4 @@
+from . import property
+from . import property_offer
+from . import property_tag
+from . import property_type

estate/models/property.py

@@ -0,0 +1,120 @@
+from dateutil.relativedelta import relativedelta
+
+from odoo import models, fields, api
+from odoo.exceptions import UserError, ValidationError
+from odoo.tools import float_is_zero, float_compare
+
+
+class Property(models.Model):
+    _name = 'estate.property'
+    _description = 'Property'
+    _sql_constraints = [
+        ('check_expected_price', 'CHECK(expected_price > 0)', 'The Expected Price must be positive.'),
+        ('check_selling_price', 'CHECK(selling_price >= 0)', 'The Selling Price must be positive.'),
+        ('check_bedrooms', 'CHECK(bedrooms >= 0)', 'The number of bedrooms must be positive.'),
+        ('check_living_area', 'CHECK(living_area > 0)', 'The living area must be positive.'),
+        ('check_facades', 'CHECK(facades > 0)', 'The number of facades must be positive.'),
+        ('check_name_unique', 'UNIQUE(name)', 'The Property name must be unique.')
+    ]
+    _order = 'id desc'
+
+    name = fields.Char(string='Title', required=True)
+    description = fields.Text()
+    postcode = fields.Char()
+    date_availability = fields.Date(string='Available From', copy=False,
+                                    default=lambda self: fields.Datetime.today() + relativedelta(months=3))
+    expected_price = fields.Float(required=True)
+    selling_price = fields.Float(readonly=True, copy=False)
+    bedrooms = fields.Integer(default=2)
+    living_area = fields.Integer(string='Living Area (m²)')
+    facades = fields.Integer()
+    garage = fields.Boolean()
+    garden = fields.Boolean()
+    garden_area = fields.Integer(string='Garden Area (m²)')
+    garden_orientation = fields.Selection([
+        ('north', 'North'),
+        ('east', 'East'),
+        ('south', 'South'),
+        ('west', 'West')
+    ])
+    active = fields.Boolean(default=True)
+    state = fields.Selection([
+        ('new', 'New'),
+        ('offer_received', 'Offer Received'),
+        ('offer_accepted', 'Offer Accepted'),
+        ('sold', 'Sold'),
+        ('canceled', 'Canceled')
+    ], default='new', required=True)
+    property_type_id = fields.Many2one('estate.property.type', string='Property Type', required=True)
+    buyer_id = fields.Many2one('res.partner', string='Buyer', copy=False)
+    salesperson_id = fields.Many2one('res.users', string='Sales Person', default=lambda self: self.env.user)
+    tag_ids = fields.Many2many('estate.property.tag', string='Tags')
+    offer_ids = fields.One2many('estate.property.offer', 'property_id', string='Offers')
+    total_area = fields.Integer(string='Total Area (m²)', compute='_compute_total_area')
+    best_price = fields.Float(compute='_compute_best_price')
+
+    @api.depends('living_area', 'garden_area')
+    def _compute_total_area(self):
+        for record in self:
+            record.total_area = record.living_area + record.garden_area
+
+    @api.depends('offer_ids.price')
+    def _compute_best_price(self):
+        for record in self:
+            if len(record.offer_ids) == 0:
+                record.best_price = 0
+            else:
+                record.best_price = max(record.offer_ids.mapped('price'))
+
+    @api.onchange('garden')
+    def _onchange_garden(self):
+        if self.garden:
+            self.garden_orientation = 'north'
+            self.garden_area = 10
+        else:
+            self.garden_orientation = None
+            self.garden_area = 0
+
+    @api.constrains('selling_price', 'expected_price')
+    def _check_date_end(self):
+        for record in self:
+            if not float_is_zero(record.selling_price, precision_digits=2) and float_compare(record.selling_price,
+                                                                                             0.9 * record.expected_price,
+                                                                                             precision_digits=2) >= 0:
+                raise ValidationError("The selling price must not be below 90% of the expected price.")
+
+    def action_sold(self):
+        for record in self:
+            if record.state in ['sold', 'canceled']:
+                raise UserError('Cannot mark as sold.')
+            record.state = 'sold'
+        return True
+
+    def action_canceled(self):
+        for record in self:
+            if record.state in ['sold', 'canceled']:
+                raise UserError('Cannot mark as canceled.')
+            record.state = 'canceled'
+        return True
+
+    def action_reset(self):
+        for record in self:
+            if record.state not in ['sold', 'canceled']:
+                raise UserError('Cannot reset.')
+            record.state = 'new'
+        return True
+
+    # Make sure that only one offer is accepted
+    def set_accepted_offer(self, offer):
+        for record in self:
+            if offer is not None:
+                record.state = 'offer_accepted'
+                record.selling_price = offer.price
+                record.buyer_id = offer.partner_id
+            else:
+                record.state = 'offer_received'
+                record.selling_price = 0
+                record.buyer_id = None
+            for o in record.offer_ids:
+                if o.state == 'accepted' and (offer is None or o.id != offer.id):
+                    o.action_reset(propagate=False)

estate/models/property_offer.py

@@ -0,0 +1,58 @@
+from dateutil.relativedelta import relativedelta
+
+from odoo import models, fields, api
+
+
+class PropertyOffer(models.Model):
+    _name = 'estate.property.offer'
+    _description = 'Property Offer'
+    _sql_constraints = [
+        ('check_offer_price', 'CHECK(price > 0)', 'The Offer Price must be positive.'),
+        ('check_validity', 'CHECK(validity >= 0)', 'The Offer Validity must be positive.'),
+    ]
+    _order = 'price desc'
+
+    state = fields.Selection([
+        ('received', 'Received'),
+        ('accepted', 'Accepted'),
+        ('refused', 'Refused')
+    ], default='received', required=True, readonly=True)
+    partner_id = fields.Many2one('res.partner', string='Partner', required=True)
+    price = fields.Float()
+    property_id = fields.Many2one('estate.property', string='Property', required=True)
+    create_date = fields.Date(string='Create Date', default=lambda self: fields.Datetime.now())
+    validity = fields.Integer(string='Validity (days)', default=7)
+    deadline_date = fields.Date(string='Deadline Date', compute='_compute_deadline_date',
+                                inverse='_inverse_deadline_date')
+    property_type_id = fields.Many2one('estate.property.type', related='property_id.property_type_id')
+
+    @api.depends('validity', 'deadline_date', 'create_date')
+    def _compute_deadline_date(self):
+        for record in self:
+            record.deadline_date = record.create_date + relativedelta(days=record.validity)
+
+    @api.depends('validity', 'deadline_date', 'create_date')
+    def _inverse_deadline_date(self):
+        for record in self:
+            record.validity = (record.deadline_date - record.create_date).days
+
+    def action_accept(self, propagate=True):
+        for record in self:
+            if propagate:
+                record.property_id.set_accepted_offer(record)
+            record.state = 'accepted'
+        return True
+
+    def action_refuse(self, propagate=True):
+        for record in self:
+            if record.state == 'accepted' and propagate:
+                record.property_id.set_accepted_offer(None)
+            record.state = 'refused'
+        return True
+
+    def action_reset(self, propagate=True):
+        for record in self:
+            if record.state == 'accepted' and propagate:
+                record.property_id.set_accepted_offer(None)
+            record.state = 'received'
+        return True

estate/models/property_tag.py

@@ -0,0 +1,13 @@
+from odoo import models, fields
+
+
+class PropertyTag(models.Model):
+    _name = 'estate.property.tag'
+    _description = 'Property Tag'
+    _sql_constraints = [
+        ('check_name_unique', 'UNIQUE(name)', 'The Tag name must be unique.')
+    ]
+    _order = 'name asc'
+
+    name = fields.Char(string='Tag', required=True)
+    color = fields.Integer(string='Color')

estate/models/property_type.py

@@ -0,0 +1,21 @@
+from odoo import models, fields, api
+
+
+class PropertyType(models.Model):
+    _name = 'estate.property.type'
+    _description = 'Property Type'
+    _sql_constraints = [
+        ('check_name_unique', 'UNIQUE(name)', 'The type name must be unique.')
+    ]
+    _order = 'sequence asc, name asc'
+
+    name = fields.Char(string='Title', required=True)
+    sequence = fields.Integer('Sequence', default=1)
+    property_ids = fields.One2many('estate.property', 'property_type_id')
+    offer_ids = fields.One2many('estate.property.offer', 'property_type_id')
+    offer_count = fields.Integer(compute='_compute_offer_count')
+
+    @api.depends('offer_ids')
+    def _compute_offer_count(self):
+        for record in self:
+            record.offer_count = len(record.offer_ids)

estate/security/ir.model.access.csv

@@ -0,0 +1,5 @@
+id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink
+access_estate_property_type,access_estate_property_type,model_estate_property_type,base.group_user,1,1,1,1
+access_estate_property_tag,access_estate_property_tag,model_estate_property_tag,base.group_user,1,1,1,1
+access_estate_property_offer,access_estate_property_offer,model_estate_property_offer,base.group_user,1,1,1,1
+access_estate_property,access_estate_property,model_estate_property,base.group_user,1,1,1,1

estate/static/description/icon.png

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <menuitem id="estate_menu_root" name="Real Estate" web_icon="estate,static/description/icon.png">
+        <menuitem id="estate_advertisements_menu" name="Advertisements">
+            <menuitem id="estate_properties_menu" action="estate_property_action"/>
+        </menuitem>
+        <menuitem id="estate_settings_menu" name="Settings">
+            <menuitem id="estate_property_type_menu" action="estate_property_type_action"/>
+            <menuitem id="estate_property_tag_menu" action="estate_property_tag_action"/>
+        </menuitem>
+    </menuitem>
+</odoo>