[IMP] l10n_in_hr_holidays: add sandwich leaves to l10n_in

This commit, adds the Sandwich Leave Rule in Indian Localization.
The sandwich leave rule will be applied if an Employee takes leave like in
the scenario below.

Scene 1:
Friday (leave) -> Saturday -> Sunday -> Monday(Leave)
4 Leaves will be deducted from the Employee's leave balance.

Scene 2:
Tuesday(Leave) -> Wednesday(Public Holiday) -> Thursday (Leave)
3 Leaves will be deducted from the Employee's leave balance.

task-3950973

Part-of: odoo#174933
Signed-off-by: Yannick Tivisse (yti) <[email protected]>

Author: arpr-odoo

addons/l10n_in_hr_holidays/__init__.py

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

addons/l10n_in_hr_holidays/__manifest__.py

@@ -0,0 +1,16 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+{
+    'name': 'India - Time Off',
+    'version': '1.0',
+    'category': 'Human Resources/Time Off',
+    'summary': 'Leave Management of Indian Localization',
+    'countries': ['in'],
+    'depends': ['hr_holidays'],
+    'auto_install': ['hr_holidays'],
+    'data': [
+        'views/hr_leave_views.xml',
+        'views/hr_leave_type_views.xml',
+    ],
+    'license': 'LGPL-3',
+}

addons/l10n_in_hr_holidays/models/__init__.py

@@ -0,0 +1,4 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from . import hr_leave
+from . import hr_leave_type

addons/l10n_in_hr_holidays/models/hr_leave.py

@@ -0,0 +1,78 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from datetime import datetime, timedelta
+
+from odoo import models, fields
+
+
+class HolidaysRequest(models.Model):
+    _inherit = "hr.leave"
+
+    l10n_in_contains_sandwich_leaves = fields.Boolean()
+
+    def _l10n_in_apply_sandwich_rule(self, public_holidays, employee_leaves):
+        self.ensure_one()
+        if not self.request_date_from or not self.request_date_to:
+            return
+        date_from = self.request_date_from
+        date_to = self.request_date_to
+        total_leaves = (self.request_date_to - self.request_date_from).days + 1
+
+        def is_non_working_day(calendar, date):
+            return not calendar._works_on_date(date) or any(
+                datetime.date(holiday['date_from']) <= date <= datetime.date(holiday['date_to']) for holiday in public_holidays
+            )
+
+        def count_sandwich_days(calendar, date, direction):
+            current_date = date + timedelta(days=direction)
+            days_count = 0
+            while is_non_working_day(calendar, current_date):
+                days_count += 1
+                current_date += timedelta(days=direction)
+            for leave in employee_leaves:
+                if leave['request_date_from'] <= current_date <= leave['request_date_to']:
+                    return days_count
+            return 0
+
+        calendar = self.resource_calendar_id
+        total_leaves += count_sandwich_days(calendar, date_from, -1) + count_sandwich_days(calendar, date_to, 1)
+        if is_non_working_day(calendar, date_from):
+            total_leaves -= 1
+            if is_non_working_day(calendar, date_from + timedelta(days=+1)):
+                total_leaves -= 1
+        if is_non_working_day(calendar, date_to):
+            total_leaves -= 1
+            if is_non_working_day(calendar, date_to + timedelta(days=-1)):
+                total_leaves -= 1
+        return total_leaves
+
+    def _get_durations(self, check_leave_type=True, resource_calendar=None):
+        result = super()._get_durations(check_leave_type, resource_calendar)
+        indian_leaves = self.filtered(lambda c: c.company_id.country_id.code == 'IN')
+        if not indian_leaves:
+            return result
+
+        public_holidays = self.env['resource.calendar.leaves'].search([
+            ('resource_id', '=', False),
+            ('company_id', 'in', indian_leaves.company_id.ids),
+        ])
+        leaves_by_employee = dict(self._read_group(
+            domain=[
+                ('id', 'not in', self.ids),
+                ('employee_id', 'in', self.employee_id.ids),
+                ('state', 'not in', ['cancel', 'refuse']),
+                ('leave_type_request_unit', '=', 'day'),
+            ],
+            groupby=['employee_id'],
+            aggregates=['id:recordset'],
+        ))
+        for leave in indian_leaves:
+            if leave.holiday_status_id.l10n_in_is_sandwich_leave:
+                days, hours = result[leave.id]
+                updated_days = leave._l10n_in_apply_sandwich_rule(public_holidays, leaves_by_employee.get(leave.employee_id, []))
+                result[leave.id] = (updated_days, hours)
+                if updated_days:
+                    leave.l10n_in_contains_sandwich_leaves = updated_days != days
+            else:
+                leave.l10n_in_contains_sandwich_leaves = False
+        return result

addons/l10n_in_hr_holidays/models/hr_leave_type.py

@@ -0,0 +1,12 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import fields, models
+
+
+class HolidaysType(models.Model):
+    _inherit = "hr.leave.type"
+
+    l10n_in_is_sandwich_leave = fields.Boolean(
+        help="""If a leave is covering holidays, the holiday period will be included in the requested time.
+        The time took in addition will have the same treatment (allocation, pay, reports) as the initial request.
+        Holidays includes public holidays, national days, paid holidays and week-ends.""")

addons/l10n_in_hr_holidays/tests/__init__.py

@@ -0,0 +1,3 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from . import test_sandwich_leave

addons/l10n_in_hr_holidays/tests/test_sandwich_leave.py

@@ -0,0 +1,55 @@
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from freezegun import freeze_time
+from odoo.tests import tagged, TransactionCase
+
+
+@tagged('post_install_l10n', 'post_install', '-at_install')
+class TestSandwichLeave(TransactionCase):
+
+    def setUp(self):
+        super().setUp()
+        self.leave_type = self.env['hr.leave.type'].create({
+            'name': 'Test Leave Type',
+            'request_unit': 'day',
+            'l10n_in_is_sandwich_leave': True,
+        })
+
+        self.rahul_emp = self.env['hr.employee'].create({
+            'name': 'Rahul',
+            'country_id': self.env.ref('base.in').id,
+        })
+
+    def test_sandwich_leave(self):
+        with freeze_time('2023-08-15'):
+            public_holiday = self.env['resource.calendar.leaves'].create({
+                'name': 'Independence Day',
+                'date_from': '2023-08-15',
+                'date_to': '2023-08-15',
+                'resource_id': False,
+                'company_id': self.env.company.id,
+            })
+            before_holiday_leave = self.env['hr.leave'].create({
+                'name': 'Test Leave',
+                'employee_id': self.rahul_emp.id,
+                'holiday_status_id': self.leave_type.id,
+                'request_date_from': "2023-08-14",
+                'request_date_to': "2023-08-14",
+            })
+            employee_leaves = self.env['hr.leave'].search([
+                ('employee_id', '=', self.rahul_emp.id),
+                ('state', 'not in', ['cancel', 'refuse']),
+                ('leave_type_request_unit', '=', 'day'),
+            ])
+            after_holiday_leave = self.env['hr.leave'].create({
+                'name': 'Test Leave',
+                'employee_id': self.rahul_emp.id,
+                'holiday_status_id': self.leave_type.id,
+                'request_date_from': "2023-08-16",
+                'request_date_to': "2023-08-16",
+            })
+
+            leave = before_holiday_leave._l10n_in_apply_sandwich_rule(public_holiday, employee_leaves)
+            self.assertEqual(leave, 1, "The total leaves should be 1")
+            sandwiched_leave = after_holiday_leave._l10n_in_apply_sandwich_rule(public_holiday, employee_leaves)
+            self.assertEqual(sandwiched_leave, 2, "The total leaves should be 2 including sandwich leave")

addons/l10n_in_hr_holidays/views/hr_leave_type_views.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="hr_leave_type_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.leave.type.form.inherit</field>
+        <field name="model">hr.leave.type</field>
+        <field name="inherit_id" ref="hr_holidays.edit_holiday_status_form"/>
+        <field name="arch" type="xml">
+            <field name="show_on_dashboard" position="after">
+                <field name="l10n_in_is_sandwich_leave" string="Sandwich Leaves" invisible="country_code != 'IN'" />
+            </field>
+        </field>
+    </record>
+
+</odoo>

addons/l10n_in_hr_holidays/views/hr_leave_views.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="hr_leave_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.leave.view.form.inherit</field>
+        <field name="model">hr.leave</field>
+        <field name="inherit_id" ref="hr_holidays.hr_leave_view_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='leave_type_request_unit']" position="after">
+                <field name="l10n_in_contains_sandwich_leaves" invisible="1" />
+            </xpath>
+            <xpath expr="//field[@name='duration_display']" position="after">
+                <div name="l10n_in_contains_sandwich_leaves" invisible="not l10n_in_contains_sandwich_leaves" class="w-md-75 float-end ps-3 alert alert-warning" role="alert">
+                    The requested time considers the sandwich leave policy.
+                </div>
+            </xpath>
+        </field>
+    </record>
+
+</odoo>