Merge branch 'mig/13.0/hr_payroll_timesheet' into '13.0'

mig/13.0/hr_payroll_timesheet into 13.0

See merge request hibou-io/hibou-odoo/suite!407

hr_payroll_timesheet/__init__.py

@@ -0,0 +1,15 @@
+from . import models
+
+
+def ts_payroll_pre_init_hook(cr):
+    """
+    This module installs a Work Entry Type with code "TS_OT"
+    If you have undergone a migration (either for this module
+    or even your own Payslip Work Entry lines with code "TS_OT")
+    then the uniqueness constraint will prevent this module
+    from installing.
+    """
+    cr.execute("UPDATE hr_work_entry_type "
+               "SET code = 'TS_OT-PRE-INSTALL' "
+               "WHERE code = 'TS_OT';"
+               )

hr_payroll_timesheet/__manifest__.py

@@ -0,0 +1,23 @@
+{
+    'name': 'Timesheets on Payslips',
+    'description': 'Get Timesheet hours onto Employee Payslips.',
+    'version': '13.0.1.0.0',
+    'website': 'https://hibou.io/',
+    'author': 'Hibou Corp. <hello@hibou.io>',
+    'license': 'AGPL-3',
+    'category': 'Human Resources',
+    'data': [
+        'data/hr_payroll_timesheet_data.xml',
+        'views/hr_contract_view.xml',
+        'views/hr_payslip_views.xml',
+    ],
+    'demo': [
+        'data/hr_payroll_timesheet_demo.xml',
+    ],
+    'depends': [
+        'hr_payroll',
+        'hr_timesheet_work_entry',
+        'hr_payroll_overtime',
+    ],
+    'pre_init_hook': 'ts_payroll_pre_init_hook',
+}

hr_payroll_timesheet/data/hr_payroll_timesheet_data.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <!-- Work Entry Type -->
+    <record id="work_input_timesheet_overtime" model="hr.work.entry.type">
+        <field name="name">Timesheet Overtime</field>
+        <field name="code">TS_OT</field>
+    </record>
+
+    <record id="hr_timesheet_work_entry.work_input_timesheet" model="hr.work.entry.type">
+        <field name="overtime_type_id" ref="hr_payroll_overtime.work_entry_overtime_type"/>
+        <field name="overtime_work_type_id" ref="work_input_timesheet_overtime"/>
+    </record>
+
+</odoo>

hr_payroll_timesheet/data/hr_payroll_timesheet_demo.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <!-- add overtime type+rules on internal demo type -->
+    <record id="hr_timesheet_work_entry.work_input_timesheet_internal" model="hr.work.entry.type">
+        <field name="overtime_type_id" ref="hr_payroll_overtime.work_entry_overtime_type"/>
+        <field name="overtime_work_type_id" ref="work_input_timesheet_overtime"/>
+    </record>
+
+</odoo>

hr_payroll_timesheet/migrations/13.0.0.0.1/pre-migration.py

@@ -0,0 +1,6 @@
+
+def migrate(cr, version):
+    # pre_init_hook script only runs on install,
+    # if you're coming from 12.0 we need the same change
+    from odoo.addons.hr_payroll_timesheet import ts_payroll_pre_init_hook
+    ts_payroll_pre_init_hook(cr)

hr_payroll_timesheet/models/__init__.py

@@ -0,0 +1,3 @@
+from . import account
+from . import hr_contract
+from . import hr_payslip

hr_payroll_timesheet/models/account.py

@@ -0,0 +1,13 @@
+from odoo import fields, models
+
+
+class AnalyticLine(models.Model):
+    _inherit = 'account.analytic.line'
+
+    payslip_id = fields.Many2one('hr.payslip', string="Payslip", readonly=True, ondelete='set null')
+
+    def unlink(self):
+        ts_with_payslip = self.filtered(lambda ts: ts.payslip_id)
+        ts_with_payslip.write({'payslip_id': False})
+        return super(AnalyticLine, self - ts_with_payslip).unlink()
+

hr_payroll_timesheet/models/hr_contract.py

@@ -0,0 +1,7 @@
+from odoo import fields, models
+
+
+class HrContract(models.Model):
+    _inherit = 'hr.contract'
+
+    paid_hourly_timesheet = fields.Boolean(string="Paid Hourly Timesheet", default=False)

hr_payroll_timesheet/models/hr_payslip.py

@@ -0,0 +1,94 @@
+from collections import defaultdict
+from odoo import api, fields, models, _
+
+
+class HrPayslip(models.Model):
+    _inherit = 'hr.payslip'
+
+    timesheet_ids = fields.One2many('account.analytic.line', 'payslip_id', string='Timesheets',
+                                     help='Timesheets represented by payslip.', readonly=True,
+                                     states={'draft': [('readonly', False)], 'verify': [('readonly', False)]})
+    timesheet_count = fields.Integer(compute='_compute_timesheet_count')
+
+    @api.depends('timesheet_ids', 'timesheet_ids.payslip_id')
+    def _compute_timesheet_count(self):
+        for payslip in self:
+            payslip.timesheet_count = len(payslip.timesheet_ids)
+
+    def _get_worked_day_lines(self):
+        # Called at the end of _onchange_employee()
+        worked_day_lines = super()._get_worked_day_lines()
+        return self._timesheet_get_worked_day_lines(worked_day_lines)
+
+    def _timesheet_get_worked_day_lines(self, worked_day_lines):
+        """
+        Filters out basic "Attendance"/"Work Calendar" entries as they would add to salary.
+        Note that this is during an onchange (probably).
+        :returns: a list of dict containing the worked days values that should be applied for the given payslip
+        """
+        if not self.contract_id.paid_hourly_timesheet:
+            return worked_day_lines
+        if not self.state in ('draft', 'verify'):
+            return worked_day_lines
+
+        timesheet_to_keep = self.timesheet_ids.filtered(lambda ts: ts.employee_id == self.employee_id
+                                                        and ts.date <= self.date_to)
+        timesheet_to_keep |= self.env['account.analytic.line'].search([
+            ('employee_id', '=', self.employee_id.id),
+            ('date', '<=', self.date_to),
+            ('payslip_id', '=', False),
+        ])
+        self.update({'timesheet_ids': [(6, 0, timesheet_to_keep.ids)]})
+
+        timesheet_type = self.env.ref('hr_tiemsheet_work_entry.work_input_timesheet', raise_if_not_found=False)
+        if not timesheet_type:
+            # different default type
+            timesheet_type = self.struct_id.type_id.default_work_entry_type_id
+            if not timesheet_type:
+                # return early, include the "work calendar lines"
+                return worked_day_lines
+
+        original_work_type = self.env.ref('hr_work_entry.work_entry_type_attendance', raise_if_not_found=False)
+        if original_work_type:
+            # filter out "work calendar lines"
+            worked_day_lines = [w for w in worked_day_lines if w['work_entry_type_id'] != original_work_type.id]
+
+        work_data = self._pre_aggregate_timesheet_data(timesheet_type)
+        processed_data = self.aggregate_overtime(work_data)
+
+        worked_day_lines += [{
+                'number_of_days': data[0],
+                'number_of_hours': data[1],
+                'amount': data[1] * data[2] * self._wage_for_work_type(work_type),
+                'contract_id': self.contract_id.id,
+                'work_entry_type_id': work_type.id,
+            } for work_type, data in processed_data.items()]
+
+        return worked_day_lines
+
+    def _wage_for_work_type(self, work_type):
+        # Override if you pay differently for different work types
+        return self.contract_id.wage
+
+    def _pre_aggregate_timesheet_data(self, default_workentrytype):
+        worked_ts = defaultdict(list)
+        for ts in self.timesheet_ids.sorted('id'):
+            if ts.unit_amount:
+                ts_iso = ts.date.isocalendar()
+                timesheet_type = ts.work_type_id or default_workentrytype
+                if timesheet_type in self.struct_id.unpaid_work_entry_type_ids:
+                    # this is unpaid, so we have to skip it from aggregation
+                    continue
+                worked_ts[ts_iso].append((timesheet_type, ts.unit_amount, ts))
+        res = [(k, worked_ts[k]) for k in sorted(worked_ts.keys())]
+        return res
+
+    def action_open_timesheets(self):
+        self.ensure_one()
+        return {
+            'type': 'ir.actions.act_window',
+            'name': _('Paid Timesheets'),
+            'res_model': 'account.analytic.line',
+            'view_mode': 'tree,form',
+            'domain': [('id', 'in', self.timesheet_ids.ids)],
+        }

hr_payroll_timesheet/tests/__init__.py

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

hr_payroll_timesheet/tests/test_payslip_timesheet.py

@@ -0,0 +1,183 @@
+from odoo.tests import common
+
+
+class TestPayslipTimesheet(common.TransactionCase):
+
+    def setUp(self):
+        super(TestPayslipTimesheet, self).setUp()
+        self.test_hourly_wage = 21.5
+        self.employee = self.env.ref('hr.employee_hne')
+        self.contract = self.env['hr.contract'].create({
+            'name': 'Test',
+            'employee_id': self.employee.id,
+            'structure_type_id': self.env.ref('hr_payroll.structure_type_employee').id,
+            'date_start': '2018-01-01',
+            'resource_calendar_id': self.employee.resource_calendar_id.id,
+            'wage': self.test_hourly_wage,
+            'paid_hourly_timesheet': True,
+            'state': 'open',
+        })
+        self.payslip_dummy = self.env['hr.payslip'].create({
+            'name': 'test slip dummy',
+            'employee_id': self.employee.id,
+            'date_from': '2017-01-01',
+            'date_to': '2017-01-31',
+        })
+        self.payslip = self.env['hr.payslip'].create({
+            'name': 'test slip',
+            'employee_id': self.employee.id,
+            'date_from': '2018-01-01',
+            'date_to': '2018-01-31',
+        })
+        self.project = self.env['project.project'].create({
+            'name': 'Timesheets',
+        })
+
+    def test_payslip_timesheet(self):
+        self.assertTrue(self.contract.paid_hourly_timesheet)
+
+        # Day 1
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-01',
+            'unit_amount': 5.0,
+            'name': 'test',
+        })
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-01',
+            'unit_amount': 3.0,
+            'name': 'test',
+        })
+
+        # Day 2
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-02',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+
+        # Make one that should be excluded.
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2017-01-01',
+            'unit_amount': 5.0,
+            'name': 'test',
+            'payslip_id': self.payslip_dummy.id,
+        })
+
+        self.payslip._onchange_employee()
+        self.assertTrue(self.payslip.contract_id, 'No auto-discovered contract!')
+        wage = self.test_hourly_wage
+        self.payslip.compute_sheet()
+        self.assertTrue(self.payslip.worked_days_line_ids)
+
+        timesheet_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
+        self.assertTrue(timesheet_line)
+        self.assertEqual(timesheet_line.number_of_days, 2.0)
+        self.assertEqual(timesheet_line.number_of_hours, 18.0)
+
+        # Day 3
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-03',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 4
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-04',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 5
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-05',
+            'unit_amount': 10.0,
+            'name': 'test',
+        })
+        # Day 6
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-06',
+            'unit_amount': 4.0,
+            'name': 'test',
+        })
+
+        self.payslip.state = 'draft'
+        self.payslip._onchange_employee()
+        timesheet_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
+        timesheet_overtime_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS_OT')
+        self.assertTrue(timesheet_line)
+        self.assertEqual(timesheet_line.number_of_days, 5.0)
+        self.assertEqual(timesheet_line.number_of_hours, 40.0)
+        self.assertTrue(timesheet_overtime_line)
+        self.assertEqual(timesheet_overtime_line.number_of_days, 1.0)
+        self.assertEqual(timesheet_overtime_line.number_of_hours, 12.0)
+
+    def test_payslip_timesheet_specific_work_entry_type(self):
+        self.assertTrue(self.contract.paid_hourly_timesheet)
+        worktype = self.env.ref('hr_timesheet_work_entry.work_input_timesheet_internal')
+
+        # Day 1
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-01',
+            'unit_amount': 5.0,
+            'name': 'test',
+        })
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-01',
+            'unit_amount': 3.0,
+            'name': 'test',
+        })
+
+        # Day 2
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2018-01-02',
+            'unit_amount': 10.0,
+            'name': 'test',
+            'work_type_id': worktype.id,
+        })
+
+        # Make one that should be excluded.
+        self.env['account.analytic.line'].create({
+            'employee_id': self.employee.id,
+            'project_id': self.project.id,
+            'date': '2017-01-01',
+            'unit_amount': 5.0,
+            'name': 'test',
+            'payslip_id': self.payslip_dummy.id,
+        })
+
+        self.payslip._onchange_employee()
+        self.assertTrue(self.payslip.contract_id, 'No auto-discovered contract!')
+        wage = self.test_hourly_wage
+        self.payslip.compute_sheet()
+        self.assertTrue(self.payslip.worked_days_line_ids)
+
+        timesheet_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == 'TS')
+        self.assertTrue(timesheet_line)
+        self.assertEqual(timesheet_line.number_of_days, 1.0)
+        self.assertEqual(timesheet_line.number_of_hours, 8.0)
+
+        worktype_line = self.payslip.worked_days_line_ids.filtered(lambda l: l.code == worktype.code)
+        self.assertTrue(worktype_line)
+        self.assertEqual(worktype_line.number_of_days, 1.0)
+        self.assertEqual(worktype_line.number_of_hours, 10.0)

hr_payroll_timesheet/views/hr_contract_view.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <record id="hr_contract_form_inherit" model="ir.ui.view">
+        <field name="name">hr.contract.form.inherit</field>
+        <field name="model">hr.contract</field>
+        <field name="inherit_id" ref="hr_contract.hr_contract_view_form"/>
+        <field name="arch" type="xml">
+            <data>
+                <xpath expr="//field[@name='advantages']" position="after">
+                    <field name="paid_hourly_timesheet"/>
+                </xpath>
+                <xpath expr="//div[@name='wage']/span" position="replace">
+                    <span attrs="{'invisible': [('paid_hourly_timesheet', '=', True)]}">/ pay period</span>
+                    <span attrs="{'invisible': [('paid_hourly_timesheet', '=', False)]}">/ hour</span>
+                </xpath>
+            </data>
+        </field>
+    </record>
+</odoo>

hr_payroll_timesheet/views/hr_payslip_views.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="hr_payslip_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.payslip.view.form.inherit</field>
+        <field name="model">hr.payslip</field>
+        <field name="inherit_id" ref="hr_payroll.view_hr_payslip_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//div[@name='button_box']" position="inside">
+                <button class="oe_stat_button" name="action_open_timesheets" type="object" icon="fa-history" attrs="{'invisible': [('timesheet_count', '=', 0)]}">
+                    <field string="Timesheets" name="timesheet_count" widget="statinfo"/>
+                </button>
+            </xpath>
+            <xpath expr="//field[@name='number']" position="after">
+                <field name="timesheet_ids" invisible="1" widget="many2many"/>
+            </xpath>
+        </field>
+    </record>
+
+</odoo>

hr_timesheet_work_entry/__init__.py

@@ -0,0 +1,15 @@
+from . import models
+
+
+def ts_work_type_pre_init_hook(cr):
+    """
+    This module installs a Work Entry Type with code "TS"
+    If you have undergone a migration (either for this module
+    or even your own Payslip Work Entry lines with code "TS")
+    then the uniqueness constraint will prevent this module
+    from installing.
+    """
+    cr.execute("UPDATE hr_work_entry_type "
+               "SET code = 'TS-PRE-INSTALL' "
+               "WHERE code = 'TS';"
+               )

hr_timesheet_work_entry/__manifest__.py

@@ -0,0 +1,22 @@
+{
+    'name': 'Timesheet Work Entry Type',
+    'description': 'Set work types on timesheet records.',
+    'version': '13.0.1.0.0',
+    'website': 'https://hibou.io/',
+    'author': 'Hibou Corp. <hello@hibou.io>',
+    'license': 'AGPL-3',
+    'category': 'Human Resources',
+    'depends': [
+        'hr_timesheet',
+        'hr_work_entry',
+    ],
+    'data': [
+        'data/hr_timesheet_work_entry_data.xml',
+        'views/timesheet_views.xml',
+        'views/work_entry_views.xml',
+    ],
+    'demo': [
+        'data/hr_timesheet_work_entry_demo.xml',
+    ],
+    'pre_init_hook': 'ts_work_type_pre_init_hook',
+}

hr_timesheet_work_entry/data/hr_timesheet_work_entry_data.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="work_input_timesheet" model="hr.work.entry.type">
+        <field name="name">Timesheet</field>
+        <field name="code">TS</field>
+        <field name="allow_timesheet" eval="True"/>
+    </record>
+
+</odoo>

hr_timesheet_work_entry/data/hr_timesheet_work_entry_demo.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="work_input_timesheet_internal" model="hr.work.entry.type">
+        <field name="name">Internal</field>
+        <field name="code">TS_INTERNAL</field>
+        <field name="allow_timesheet" eval="True"/>
+    </record>
+
+</odoo>

hr_timesheet_work_entry/models/__init__.py

@@ -0,0 +1,2 @@
+from . import timesheet
+from . import work_entry

hr_timesheet_work_entry/models/timesheet.py

@@ -0,0 +1,9 @@
+from odoo import api, fields, models
+
+
+class AccountAnalyticLine(models.Model):
+    _inherit = 'account.analytic.line'
+
+    work_type_id = fields.Many2one('hr.work.entry.type', string='Work Type',
+                                   default=lambda self: self.env.ref('hr_timesheet_work_entry.work_input_timesheet',
+                                                                     raise_if_not_found=False))

hr_timesheet_work_entry/models/work_entry.py

@@ -0,0 +1,7 @@
+from odoo import fields, models
+
+
+class HrWorkEntryType(models.Model):
+    _inherit = 'hr.work.entry.type'
+
+    allow_timesheet = fields.Boolean(string='Allow on Timesheet')

hr_timesheet_work_entry/tests/__init__.py

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

hr_timesheet_work_entry/tests/test_timesheet_work_type.py

@@ -0,0 +1,19 @@
+from odoo.tests import common
+
+
+class TestTimesheetWorkType(common.TransactionCase):
+    def setUp(self):
+        super().setUp()
+        self.employee = self.env.ref('hr.employee_hne')
+        self.project = self.env.ref('project.project_project_2')
+        self.default_work_type = self.env.ref('hr_timesheet_work_entry.work_input_timesheet')
+
+    def test_01_work_type(self):
+        timesheet = self.env['account.analytic.line'].create({
+            'name': '/',
+            'employee_id': self.employee.id,
+            'unit_amount': 1.0,
+            'project_id': self.project.id,
+        })
+        self.assertTrue(timesheet.work_type_id)
+        self.assertEqual(timesheet.work_type_id, self.default_work_type)

hr_timesheet_work_entry/views/timesheet_views.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="hr_timesheet_line_tree_inherit" model="ir.ui.view">
+        <field name="name">account.analytic.line.tree.hr_timesheet.inherit</field>
+        <field name="model">account.analytic.line</field>
+        <field name="inherit_id" ref="hr_timesheet.hr_timesheet_line_tree"/>
+        <field name="arch" type="xml">
+            <xpath expr="//tree/field[@name='task_id']" position="after">
+                <field name="work_type_id"
+                       domain="[('allow_timesheet', '=', True)]"
+                       context="{'default_allow_timesheet': True}" />
+            </xpath>
+        </field>
+    </record>
+
+    <record id="hr_timesheet_line_form_inherit" model="ir.ui.view">
+        <field name="name">account.analytic.line.form.inherit</field>
+        <field name="model">account.analytic.line</field>
+        <field name="inherit_id" ref="hr_timesheet.hr_timesheet_line_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='task_id']" position="after">
+                <field name="work_type_id"
+                       domain="[('allow_timesheet', '=', True)]"
+                       context="{'default_allow_timesheet': True}" />
+            </xpath>
+        </field>
+    </record>
+
+</odoo>

hr_timesheet_work_entry/views/work_entry_views.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+
+    <record id="hr_work_entry_type_view_form_inherit" model="ir.ui.view">
+        <field name="name">hr.work.type.view.form.inherit</field>
+        <field name="model">hr.work.entry.type</field>
+        <field name="inherit_id" ref="hr_work_entry.hr_work_entry_type_view_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//group/group" position="after">
+                <group name="timesheet" string="Timesheets">
+                    <field name="allow_timesheet"/>
+                </group>
+            </xpath>
+        </field>
+    </record>
+
+    <menuitem
+        id="hr_work_entry_type_menu"
+        name="Work Entry Types"
+        parent="hr_timesheet.hr_timesheet_menu_configuration"
+        action="hr_work_entry.hr_work_entry_type_action"/>
+
+</odoo>