[ADD] estate: New module to manage estates

.gitignore

@@ -126,4 +126,4 @@ venv.bak/
 dmypy.json
 
 # Pyre type checker
-.pyre/
+.pyre/

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.languageServer": "None"
+}

estate/__init__.py

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

estate/__manifest__.py

@@ -0,0 +1,21 @@
+{
+    'name': "estate",
+    'version': '18.0.1.0.0',
+    'depends': ['base'],
+    'data': [
+        'security/ir.model.access.csv',
+        'views/estate_property_views.xml',
+        'views/estate_property_offer_views.xml',
+        'views/estate_property_tag_views.xml',
+        'views/estate_property_type_views.xml',
+        'views/res_users_views.xml',
+        'views/estate_menus.xml',
+        ],
+    'author': "baje",
+    'category': 'Uncategorized',
+    'description': """
+    An app to manage a Real Estate Agency
+    """,
+    'application': True,
+    'license': 'LGPL-3',
+}

estate/models/__init__.py

@@ -0,0 +1,5 @@
+from . import estate_property
+from . import estate_property_type
+from . import estate_property_tag
+from . import estate_property_offer
+from . import res_users

estate/models/estate_property.py

@@ -0,0 +1,104 @@
+from odoo import fields, models, api, _
+from dateutil.relativedelta import relativedelta
+from odoo.exceptions import UserError, ValidationError
+from odoo.tools.float_utils import float_compare, float_is_zero
+
+
+class EstateProperty(models.Model):
+    """Model representing a real estate property."""
+
+    _name = "estate.property"
+    _description = "Real Estate Properties"
+    _order = "id desc"
+    _sql_constraints = [
+        ('check_expected_price', 'CHECK(expected_price > 0 )', 'Expected price must be strictly positive.'),
+        ('check_selling_price', 'CHECK(selling_price >= 0 )', 'Selling price must be positive.'),
+    ]
+
+    def _default_date_availability(self):
+        return fields.Date.today() + relativedelta(months=3)
+
+    name = fields.Char("Title", required=True)
+    description = fields.Text("Description")
+    postcode = fields.Char("Postcode")
+    date_availability = fields.Date("Available From", default=_default_date_availability)
+    expected_price = fields.Float("Expected Price", required=True)
+    selling_price = fields.Float("Selling Price", readonly=True, copy=False)
+    bedrooms = fields.Integer("Bedrooms", default=2)
+    living_area = fields.Integer("Living Area (sqm)")
+    facades = fields.Integer("Facades")
+    garage = fields.Boolean("Garage")
+    garden = fields.Boolean("Garden")
+    garden_area = fields.Integer("Garden Area (sqm)")
+    garden_orientation = fields.Selection(
+        string="Garden Orientation",
+        selection=[
+            ('north', "North"),
+            ('south', "South"),
+            ('east', "East"),
+            ('west', "West"),
+        ],
+    )
+    active = fields.Boolean("Active", default=True)
+    state = fields.Selection(
+        string="Status",
+        selection=[
+            ('new', "New"),
+            ('offer_received', "Offer Received"),
+            ('offer_accepted', "Offer Accepted"),
+            ('sold', "Sold"),
+            ('canceled', "Canceled"),
+        ],
+        required=True,
+        copy=False,
+        default="new",
+    )
+    property_type_id = fields.Many2one("estate.property.type", string="Property Type")
+    user_id = fields.Many2one("res.users", string="Salesman", default=lambda self: self.env.user)
+    buyer_id = fields.Many2one("res.partner", string="Buyer", copy=False)
+    tag_ids = fields.Many2many("estate.property.tag", string="Tags")
+    offer_ids = fields.One2many("estate.property.offer", "property_id", string="Offers")
+    total_area = fields.Integer("Total Area (sqm)", compute="_compute_total_area")
+    best_price = fields.Float("Best Offer", 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:
+            record.best_price = max(record.offer_ids.mapped("price")) if record.offer_ids else 0.0
+
+    @api.onchange('garden')
+    def _onchange_garden(self):
+        if self.garden:
+            self.garden_area = 10
+            self.garden_orientation = 'north'
+        else:
+            self.garden_area = 0
+            self.garden_orientation = False
+
+    def action_sold(self):
+        for record in self:
+            if record.state == 'canceled':
+                raise UserError(_("Canceled properties cannot be sold."))
+            record.state = 'sold'
+
+    def action_cancel(self):
+        for record in self:
+            if record.state == 'sold':
+                raise UserError(_("Sold properties cannot be canceled."))
+            record.state = 'canceled'
+
+    @api.constrains('expected_price', 'selling_price')
+    def _check_selling_price(self):
+        for record in self:
+            if not float_is_zero(record.selling_price, precision_rounding=0.01) and float_compare(record.selling_price, record.expected_price * 0.9, precision_rounding=0.01) < 0:
+                raise ValidationError(_("The selling price cannot be lower than 90% of the expected price."))
+
+    @api.ondelete(at_uninstall=False)
+    def _unlink_if_state_is_new_or_cancelled(self):
+        if any(record.state not in ('new', 'canceled') for record in self):
+            raise UserError(_("Only new and canceled properties can be deleted."))

estate/models/estate_property_offer.py

@@ -0,0 +1,65 @@
+from odoo import fields, models, api, _
+from dateutil.relativedelta import relativedelta
+from odoo.exceptions import UserError
+from odoo.tools.float_utils import float_compare
+
+
+class EstatePropertyOffer(models.Model):
+    """Model representing an offer for a real estate property."""
+
+    _name = "estate.property.offer"
+    _description = "Real Estate Property Offers"
+    _order = "price desc"
+    _sql_constraints = [
+        ('check_offer_price', 'CHECK(price > 0)', 'An offer price must be strictly positive.'),
+    ]
+
+    price = fields.Float(string="Price")
+    status = fields.Selection(
+        string="Status",
+        selection=[
+            ('accepted', "Accepted"),
+            ('refused', "Refused"),
+        ],
+        copy=False,
+    )
+    partner_id = fields.Many2one("res.partner", string="Partner", required=True)
+    property_id = fields.Many2one("estate.property", string="Property", required=True)
+    validity = fields.Integer("Validity (days)", default=7)
+    deadline = fields.Date("Deadline", compute="_compute_deadline", inverse="_inverse_deadline")
+    property_type_id = fields.Many2one(
+        "estate.property.type", related="property_id.property_type_id", string="Property Type")
+
+    @api.depends("validity")
+    def _compute_deadline(self):
+        for record in self:
+            record.deadline = fields.Date.today() + relativedelta(days=record.validity)
+
+    def _inverse_deadline(self):
+        for record in self:
+            record.validity = (record.deadline - fields.Date.today()).days
+
+    def action_accept(self):
+        if 'accepted' in self.mapped("property_id.offer_ids.status"):
+            raise UserError(_("An offer is already accepted."))
+        for record in self:
+            record.status = 'accepted'
+            record.property_id.state = 'offer_accepted'
+            record.property_id.buyer_id = record.partner_id
+            record.property_id.selling_price = record.price
+
+    def action_refuse(self):
+        for record in self:
+            record.status = 'refused'
+
+    @api.model_create_multi
+    def create(self, values):
+        for vals in values:
+            if vals.get("property_id") and vals.get("price"):
+                prop = self.env["estate.property"].browse(vals["property_id"])
+                if prop.offer_ids:
+                    max_offer = max(prop.mapped("offer_ids.price"))
+                    if float_compare(vals["price"], max_offer, precision_rounding=0.01) <= 0:
+                        raise UserError(_("The offer must be higher than %.2f."), max_offer)
+                prop.state = "offer_received"
+        return super().create(values)

estate/models/estate_property_tag.py

@@ -0,0 +1,15 @@
+from odoo import fields, models
+
+
+class EstatePropertyTag(models.Model):
+    """Model representing a property tag."""
+
+    _name = "estate.property.tag"
+    _description = "Real Estate Property Tag"
+    _order = "name"
+    _sql_constraints = [
+        ('unique_name', 'UNIQUE(name)', 'The tag name must be unique.'),
+    ]
+
+    name = fields.Char("Name", required=True)
+    color = fields.Integer("Color")

estate/models/estate_property_type.py

@@ -0,0 +1,28 @@
+from odoo import fields, models, api
+
+
+class EstatePropertyType(models.Model):
+    """Model representing a property type."""
+
+    _name = "estate.property.type"
+    _description = "Real Estate Property Type"
+    _order = "name"
+    _sql_constraints = [
+        ('unique_name', 'UNIQUE(name)', 'The type name must be unique.'),
+    ]
+
+    name = fields.Char("Name", required=True)
+    sequence = fields.Integer("Sequence", default=10)
+    property_ids = fields.One2many("estate.property", "property_type_id", string="Properties")
+    offer_ids = fields.One2many("estate.property.offer", "property_type_id", string="Offers")
+    offer_count = fields.Integer(string="Offers Count", compute="_compute_offer_count")
+
+    @api.depends('offer_ids')
+    def _compute_offer_count(self):
+        for record in self:
+            record.offer_count = len(record.offer_ids)
+
+    def action_view_offers(self):
+        res = self.env.ref("estate.estate_property_offer_action").read()[0]
+        res["domain"] = [("id", "in", self.offer_ids.ids)]
+        return res

estate/models/res_users.py

@@ -0,0 +1,11 @@
+from odoo import fields, models
+
+
+class ResUsers(models.Model):
+    """Model extending users"""
+
+    _inherit = "res.users"
+
+    property_ids = fields.One2many(
+        "estate.property", "user_id", string="Properties", domain=[("state", "in", ["new", "offer_received"])],
+    )

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,access_estate_property,model_estate_property,base.group_user,1,1,1,1
+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

estate/views/estate_menus.xml

@@ -0,0 +1,11 @@
+<odoo>
+    <menuitem id="estate_menu_root" name="Real Estate">
+        <menuitem id="estate_advertisement_menu" name="Advertisements">
+            <menuitem id="estate_property_menu_action" action="estate_property_action"/>
+        </menuitem>
+        <menuitem id="estate_settings_menu" name="Settings">
+            <menuitem id="estate_property_type_menu_action" action="estate_property_type_action"/>
+            <menuitem id="estate_property_tag_menu_action" action="estate_property_tag_action"/>
+        </menuitem>
+    </menuitem>
+</odoo>

estate/views/estate_property_offer_views.xml

@@ -0,0 +1,19 @@
+<odoo>
+    <record id="estate_property_offer_action" model="ir.actions.act_window">
+        <field name="name">Property Offers</field>
+        <field name="res_model">estate.property.offer</field>
+        <field name="view_mode">list,form</field>
+    </record>
+    <record id="estate_property_offer_view_list" model="ir.ui.view">
+        <field name="name">estate.property.offer.view.list</field>
+        <field name="model">estate.property.offer</field>
+        <field name="arch" type="xml">
+            <list string="Property Offers" editable="bottom" decoration-success="status == 'accepted'" decoration-danger="status == 'refused'">
+                <field name="price"/>
+                <field name="partner_id"/>
+                <button name="action_accept" type="object" title="Accept" icon="fa-check"/>
+                <button name="action_refuse" type="object" title="Refuse" icon="fa-times"/>
+            </list>
+        </field>
+    </record>
+</odoo>

estate/views/estate_property_tag_views.xml

@@ -0,0 +1,16 @@
+<odoo>
+    <record id="estate_property_tag_action" model="ir.actions.act_window">
+        <field name="name">Property Tags</field>
+        <field name="res_model">estate.property.tag</field>
+        <field name="view_mode">list,form</field>
+    </record>
+    <record id="estate_property_tag_view_list" model="ir.ui.view">
+        <field name="name">estate.property.tag.view.list</field>
+        <field name="model">estate.property.tag</field>
+        <field name="arch" type="xml">
+            <list string="Property Tags" editable="bottom">
+                <field name="name"/>
+            </list>
+        </field>
+    </record>
+</odoo>

estate/views/estate_property_type_views.xml

@@ -0,0 +1,51 @@
+<odoo>
+    <record id="estate_property_type_action" model="ir.actions.act_window">
+        <field name="name">Property Types</field>
+        <field name="res_model">estate.property.type</field>
+        <field name="view_mode">list,form</field>
+    </record>
+    <record id="estate_property_type_view_form" model="ir.ui.view">
+        <field name="name">estate.property.type.view.form</field>
+        <field name="model">estate.property.type</field>
+        <field name="arch" type="xml">
+            <form>
+                <sheet>
+                    <div class="oe_title">
+                        <h1>
+                            <field name="name"/>
+                        </h1>
+                    </div>
+                    <div class="oe_button_box" name="button_box">
+                        <button name="action_view_offers"
+                            type="object"
+                            class="oe_stat_button"
+                            icon="fa-tags">
+                                <field name="offer_count" widget="statinfo" string="Offers"/>
+                        </button>
+                    </div>
+                    <notebook>
+                        <page string="Properties">
+                            <field name="property_ids">
+                                <list>
+                                    <field name="name"/>
+                                    <field name="expected_price"/>
+                                    <field name="state"/>
+                                </list>
+                            </field>
+                        </page>
+                    </notebook>
+                </sheet>
+            </form>
+        </field>
+    </record>
+    <record id="estate_property_type_view_list" model="ir.ui.view">
+        <field name="name">estate.property.type.view.list</field>
+        <field name="model">estate.property.type</field>
+        <field name="arch" type="xml">
+            <list string="Types">
+                <field name="sequence" widget="handle" />
+                <field name="name"/>
+            </list>
+        </field>
+    </record>
+</odoo>