Merge branch 'mig/15.0/hr_attendance_work_entry' into '15.0'

mig/15.0/hr_attendance_work_entry into 15.0

See merge request hibou-io/hibou-odoo/suite!1122
This commit is contained in:
Jared Kipe
2021-10-07 18:10:16 +00:00
17 changed files with 627 additions and 0 deletions

View File

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

View File

@@ -0,0 +1,33 @@
{
'name': 'Attendance Work Entry Type',
'description': 'Set work types on attendance records.',
'version': '15.0.1.0.0',
'website': 'https://hibou.io/',
'author': 'Hibou Corp. <hello@hibou.io>',
'license': 'AGPL-3',
'category': 'Human Resources',
'depends': [
'hr_attendance',
'hr_work_entry',
],
'data': [
'data/hr_attendance_work_entry_data.xml',
'views/attendance_views.xml',
'views/employee_views.xml',
'views/work_entry_views.xml',
],
'demo': [
'data/hr_attendance_work_entry_demo.xml',
],
'assets': {
'web.assets_qweb': [
'hr_attendance_work_entry/static/src/xml/hr_attendance.xml',
],
'web.assets_backend': [
'hr_attendance_work_entry/static/src/js/kiosk_confirm.js',
'hr_attendance_work_entry/static/src/js/my_attendances.js',
'hr_attendance_work_entry/static/src/scss/hr_attendances.scss',
],
},
'pre_init_hook': 'attn_payroll_pre_init_hook',
}

View File

@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="work_input_attendance" model="hr.work.entry.type">
<field name="name">Attendance</field>
<field name="code">ATTN</field>
<field name="allow_attendance" eval="True"/>
<field name="attendance_state">checked_in</field>
<field name="attendance_icon">fa-sign-in</field>
</record>
<!-- Rename Stock "Attendance" type -->
<record id="hr_work_entry.work_entry_type_attendance" model="hr.work.entry.type">
<field name="name">Work Calendar</field>
</record>
</odoo>

View File

@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="work_input_attendance_break" model="hr.work.entry.type">
<field name="name">Break</field>
<field name="code">ATTN_BREAK</field>
<field name="allow_attendance" eval="True"/>
<field name="attendance_state">break</field>
<field name="attendance_icon">fa-hourglass-1</field>
</record>
<record id="work_input_attendance_lunch" model="hr.work.entry.type">
<field name="name">Lunch</field>
<field name="code">ATTN_LUNCH</field>
<field name="allow_attendance" eval="True"/>
<field name="attendance_state">lunch</field>
<field name="attendance_icon">fa-coffee</field>
</record>
</odoo>

View File

@@ -0,0 +1,3 @@
from . import attendance
from . import employee
from . import work_entry

View File

@@ -0,0 +1,14 @@
from odoo import api, fields, models
class HrAttendance(models.Model):
_inherit = 'hr.attendance'
work_type_id = fields.Many2one('hr.work.entry.type', string='Work Type',
default=lambda self: self.env.ref('hr_attendance_work_entry.work_input_attendance',
raise_if_not_found=False))
@api.model
def gather_attendance_work_types(self):
work_types = self.env['hr.work.entry.type'].sudo().search([('allow_attendance', '=', True)])
return work_types.read(['id', 'name', 'attendance_icon'])

View File

@@ -0,0 +1,61 @@
from odoo import api, fields, models, _
from odoo.exceptions import UserError
class HrEmployee(models.Model):
_inherit = 'hr.employee'
attendance_state = fields.Selection(selection_add=[('break', 'Break'), ('lunch', 'Lunch')])
@api.depends('last_attendance_id.work_type_id', 'last_attendance_id.check_in', 'last_attendance_id.check_out', 'last_attendance_id')
def _compute_attendance_state(self):
for employee in self:
att = employee.last_attendance_id.sudo()
if not att or att.check_out:
employee.attendance_state = 'checked_out'
elif employee.last_attendance_id.work_type_id.attendance_state:
employee.attendance_state = employee.last_attendance_id.work_type_id.attendance_state
else:
employee.attendance_state = 'checked_in'
def attendance_manual(self, next_action, entered_pin=None, work_type_id=None):
self = self.with_context(work_type_id=work_type_id)
if not entered_pin:
# fix for pin mode with specific argument order for work_type_id
entered_pin = None
return super(HrEmployee, self).attendance_manual(next_action, entered_pin=entered_pin)
def _attendance_action_change(self):
""" Check In/Check Out action
Check In: create a new attendance record
Check Out: modify check_out field of appropriate attendance record
"""
self.ensure_one()
action_date = fields.Datetime.now()
work_type_id = self._context.get('work_type_id', False)
if self.attendance_state == 'checked_out':
vals = {
'employee_id': self.id,
'check_in': action_date,
}
if work_type_id:
# if we don't have a work_type_id, we want the default
vals['work_type_id'] = work_type_id
return self.env['hr.attendance'].create(vals)
attendance = self.env['hr.attendance'].search([('employee_id', '=', self.id), ('check_out', '=', False)], limit=1)
if attendance and work_type_id:
# work_type_id is the "next" attendance type
attendance.check_out = action_date
vals = {
'employee_id': self.id,
'check_in': action_date,
'work_type_id': work_type_id,
}
return self.env['hr.attendance'].create(vals)
if attendance:
attendance.check_out = action_date
else:
raise UserError(_('Cannot perform check out on %(empl_name)s, could not find corresponding check in. '
'Your attendances have probably been modified manually by human resources.') % {'empl_name': self.sudo().name, })
return attendance

View File

@@ -0,0 +1,15 @@
from odoo import fields, models
class HrWorkEntryType(models.Model):
_inherit = 'hr.work.entry.type'
_order = 'sequence, id'
allow_attendance = fields.Boolean(string='Allow in Attendance')
attendance_icon = fields.Char(string='Attendance Icon', default='fa-sign-in')
attendance_state = fields.Selection([
# ('checked_out', "Checked out"), # reserved for detecting new punch in
('checked_in', "Checked in"),
('break', 'Break'),
('lunch', 'Lunch'),
], string='Attendance State', default='checked_in')

View File

@@ -0,0 +1,71 @@
odoo.define('hr_attendance_work_entry.kiosk_confirm', function (require) {
"use strict";
var core = require('web.core');
var KioskConfirm = require('hr_attendance.kiosk_confirm');
var KioskConfirmTyped = KioskConfirm.extend({
events: _.extend({}, KioskConfirm.prototype.events, {
"click .o_hr_attendance_punch_type": _.debounce(function(e) {
var work_entry_type = $(e.target).data('work-entry-type');
this.update_attendance(work_entry_type);
}, 200, true),
"click .o_hr_attendance_pin_pad_button_work": _.debounce(function(e) {
var work_entry_type = $(e.target).data('work-entry-type');
this.update_attendance_pin(work_entry_type);
}, 200, true),
}),
willStart: function () {
var self = this;
var def = this._rpc({
model: 'hr.attendance',
method: 'gather_attendance_work_types',
args: []})
.then(function (res) {
self.work_types = res;
});
return Promise.all([def, this._super.apply(this, arguments)]);
},
update_attendance: function (type) {
var self = this;
this._rpc({
model: 'hr.employee',
method: 'attendance_manual',
args: [[self.employee_id], this.next_action, false, type],
})
.then(function(result) {
if (result.action) {
self.do_action(result.action);
} else if (result.warning) {
self.do_warn(result.warning);
}
});
},
update_attendance_pin: function (type) {
var self = this;
this.$('.o_hr_attendance_pin_pad_button_ok').attr("disabled", "disabled");
this.$('.o_hr_attendance_pin_pad_button_work').attr("disabled", "disabled");
this._rpc({
model: 'hr.employee',
method: 'attendance_manual',
args: [[this.employee_id], this.next_action, this.$('.o_hr_attendance_PINbox').val(), type],
})
.then(function(result) {
if (result.action) {
self.do_action(result.action);
} else if (result.warning) {
self.do_warn(result.warning);
self.$('.o_hr_attendance_PINbox').val('');
setTimeout( function() {
self.$('.o_hr_attendance_pin_pad_button_ok').removeAttr("disabled");
self.$('.o_hr_attendance_pin_pad_button_work').removeAttr("disabled");
}, 500);
}
});
},
});
core.action_registry.add('hr_attendance_kiosk_confirm', KioskConfirmTyped);
return KioskConfirmTyped;
});

View File

@@ -0,0 +1,50 @@
odoo.define('hr_attendance_work_entry.my_attendances', function (require) {
"use strict";
var core = require('web.core');
var MyAttendances = require('hr_attendance.my_attendances');
var MyTypedAttendances = MyAttendances.extend({
events: _.extend({}, MyAttendances.prototype.events, {
"click .o_hr_attendance_punch_type": _.debounce(function(e) {
var work_entry_type = $(e.target).data('work-entry-type');
this.update_attendance(work_entry_type);
}, 200, true),
}),
willStart: function () {
var self = this;
var def = this._rpc({
model: 'hr.attendance',
method: 'gather_attendance_work_types',
args: []})
.then(function (res) {
self.work_types = res;
});
return Promise.all([def, this._super.apply(this, arguments)]);
},
update_attendance: function (type) {
var self = this;
this._rpc({
model: 'hr.employee',
method: 'attendance_manual',
args: [[self.employee.id], 'hr_attendance.hr_attendance_action_my_attendances', false, type],
})
.then(function(result) {
if (result.action) {
self.do_action(result.action);
} else if (result.warning) {
self.do_warn(result.warning);
}
});
},
});
core.action_registry.add('hr_attendance_my_attendances', MyTypedAttendances);
return MyTypedAttendances;
});

View File

@@ -0,0 +1,31 @@
.o_hr_attendance_sign_in_out_icon {
cursor: pointer;
border-radius: .1em;
box-shadow: inset 0 -3px 0 fade-out(black, 0.7);
&.btn-secondary:hover {
color: $o-brand-primary;
}
}
#oe_hr_attendance_status {
color: $o-brand-secondary;
&.oe_hr_attendance_status_blue {
color: theme-color('info');
}
&.oe_hr_attendance_status_orange {
color: theme-color('warning');
}
}
.o_hr_attendance_kiosk_mode p.o_hr_attendance_continue {
margin-bottom: 0;
text-align: center;
font-weight: bold;
}
.o_hr_attendance_pin_pad_button_work {
font-size: 0.9em;
}

View File

@@ -0,0 +1,134 @@
<?xml version="1.0" encoding="UTF-8"?>
<templates xml:space="preserve">
<t t-extend="HrAttendanceMyMainMenu">
<t t-jquery=".o_hr_attendance_kiosk_mode" t-operation="replace">
<div class="o_hr_attendance_kiosk_mode">
<t t-set="checked_in" t-value="widget.employee.attendance_state=='checked_in'"/>
<t t-set="checked_out" t-value="widget.employee.attendance_state=='checked_out'"/>
<t t-if="widget.employee">
<div class="o_hr_attendance_user_badge o_home_menu_background">
<img class="img rounded-circle"
t-attf-src="/web/image?model=hr.employee&amp;field=image_128&amp;id=#{widget.employee.id}"
t-att-title="widget.employee.name" t-att-alt="widget.employee.name"/>
</div>
<h1 class="mb8"><t t-esc="widget.employee.name"/></h1>
<h3 class="mt8 mb24"><t t-if="!checked_in">Welcome!</t>
<t t-else="">Want to check out?</t></h3>
<h4 class="mt0 mb0 text-muted" t-if="checked_in">Today's work hours: <span
t-esc="widget.hours_today"/></h4>
<div class="container">
<div class="row">
<div id="kiosk_action_container" class="col-md-12 kiosk_action_container">
<!-- SIGN OUT OF CURRENT PUNCH TYPES -->
<a t-if="!checked_out" class="btn btn-secondary btn-block btn-warning o_hr_attendance_sign_in_out_icon"
aria-label="Sign out" title="Sign out">
<i class="fa fa-1x fa-sign-out mr-1 mt-3 mb-3"></i>
<span>
<b>Stop</b>
</span>
</a>
<p t-if="!checked_out" class="o_hr_attendance_continue">
Or, continue working as:
</p>
<t t-foreach="widget.work_types" t-as="work_type">
<a class="btn btn-block btn-secondary o_hr_attendance_punch_type mt-2 mb-2"
aria-label="Sign in" title="Sign in" t-attf-data-work-entry-type="#{work_type.id}">
<i t-attf-class="fa #{work_type.attendance_icon} fa-1x mr-1 mt-3 mb-3"> </i>
<span t-esc="work_type.name"/>
</a>
</t>
</div>
</div>
</div>
</t>
<t t-else="">
Warning : Your user should be linked to an employee to use attendance. Please contact your administrator.
</t>
</div>
</t>
</t>
<t t-extend="HrAttendanceKioskConfirm">
<t t-jquery=".o_hr_attendance_kiosk_mode" t-operation="replace">
<div class="o_hr_attendance_kiosk_mode">
<t t-set="checked_in" t-value="widget.employee_state=='checked_in'"/>
<t t-set="checked_out" t-value="widget.employee_state=='checked_out'"/>
<div class="o_hr_attendance_back_button">
<span class="btn btn-secondary btn-lg d-block d-md-none"><i class="fa fa-chevron-left mr8"/> Go back</span>
<span class="btn btn-secondary d-none d-md-inline-block"><i class="fa fa-chevron-left" role="img" aria-label="Go back" title="Go back"/></span>
</div>
<t t-if="widget.employee_id">
<div class="o_hr_attendance_user_badge o_home_menu_background">
<img class="img rounded-circle" t-attf-src="/web/image?model=hr.employee&amp;field=image_128&amp;id=#{widget.employee_id}" t-att-title="widget.employee_name" t-att-alt="widget.employee_name"/>
</div>
<h1 class="mb8"><t t-esc="widget.employee_name"/></h1>
<h3 class="mt8 mb24"><t t-if="!checked_in">Welcome! </t><t t-else="">Want to check out?</t></h3>
<h4 class="mt0 mb0 text-muted" t-if="checked_in">Today's work hours: <span t-esc="widget.employee_hours_today"/></h4>
<t t-if="!widget.use_pin">
<div id="kiosk_action_container" class="col-md-12 kiosk_action_container">
<!-- SIGN OUT OF CURRENT PUNCH TYPES -->
<a t-if="!checked_out" class="btn btn-secondary btn-block btn-warning o_hr_attendance_sign_in_out_icon"
aria-label="Sign out" title="Sign out">
<i class="fa fa-1x fa-sign-out mr-1 mt-3 mb-3"></i>
<span>
<b>Stop</b>
</span>
</a>
<p t-if="!checked_out" class="o_hr_attendance_continue">
Or, continue working as:
</p>
<t t-foreach="widget.work_types" t-as="work_type">
<a class="btn btn-block btn-secondary o_hr_attendance_punch_type mt-2 mb-2"
aria-label="Sign in" title="Sign in" t-attf-data-work-entry-type="#{work_type.id}">
<i t-attf-class="fa #{work_type.attendance_icon} fa-1x mr-1 mt-3 mb-3"> </i>
<span t-esc="work_type.name"/>
</a>
</t>
</div>
</t>
<t t-else="">
<h3 class="mt0 mb0 text-muted">Please enter your PIN to <b t-if="checked_in">check out</b><b t-else="">check in</b></h3>
<div class="row">
<div class="col-md-8 offset-md-2 o_hr_attendance_pin_pad">
<div class="row" >
<div class="col-12 mb8 mt8"><input class="o_hr_attendance_PINbox text-center" type="password" disabled="true"/></div>
</div>
<div class="row">
<t t-foreach="['1', '2', '3', '4', '5', '6', '7', '8', '9', ['C', 'btn-warning'], '0', ['ok', 'btn-primary']]" t-as="btn_name">
<div class="col-4 mb4" t-if="btn_name[0] != 'ok'">
<a t-attf-class="btn {{btn_name[1]? btn_name[1] : 'btn-secondary'}} btn-block btn-lg {{ 'o_hr_attendance_pin_pad_button_' + btn_name[0] }}"><t t-esc="btn_name[0]"/></a>
</div>
<t t-else="">
<div class="col-4 mb4" t-if="!checked_out">
<a class="btn btn-primary btn-block btn-lg o_hr_attendance_pin_pad_button_ok">Sign Out</a>
</div>
<div class="col-4 mb4" t-else=""/>
<!-- ok button -->
<div class="col-4 mb4" t-foreach="widget.work_types" t-as="work_type">
<a href="#" class="btn btn-primary btn-block btn-lg o_hr_attendance_pin_pad_button_work small" t-attf-data-work-entry-type="#{work_type.id}"><i t-attf-class="fa fa-1x #{work_type.attendance_icon} mr-1 mt-3 mb-3"></i> <t t-esc="work_type.name"/></a>
</div>
</t>
</t>
</div>
</div>
</div>
</t>
</t>
<div t-else="" class="alert alert-danger" role="alert">
<b>Error: could not find corresponding employee.</b><br/>Please return to the main menu.
</div>
<a role="button" class="oe_attendance_sign_in_out" aria-label="Sign out" title="Sign out"/>
</div>
</t>
</t>
</templates>

View File

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

View File

@@ -0,0 +1,52 @@
from time import sleep
from odoo.tests import common
class TestAttendanceWorkType(common.TransactionCase):
def setUp(self):
super().setUp()
self.employee = self.env.ref('hr.employee_hne')
self.default_work_type = self.env.ref('hr_attendance_work_entry.work_input_attendance')
def test_01_work_type(self):
attendance = self.env['hr.attendance'].create({
'employee_id': self.employee.id,
'check_in': '2020-01-06 10:00:00', # Monday
'check_out': '2020-01-06 19:00:00',
})
self.assertTrue(attendance.work_type_id)
self.assertEqual(attendance.work_type_id, self.default_work_type)
def test_11_employee_clock_in(self):
self.assertEqual(self.employee.attendance_state, 'checked_out')
attendance = self.employee._attendance_action_change()
self.assertEqual(attendance.work_type_id, self.default_work_type)
self.assertEqual(self.employee.attendance_state, 'checked_in')
# check out
self.employee._attendance_action_change()
self.assertEqual(self.employee.attendance_state, 'checked_out')
def test_12_employee_clock_in_break(self):
# check in with non-standard work type
break_type = self.env['hr.work.entry.type'].create({
'name': 'Test Break',
'code': 'TESTBREAK',
'allow_attendance': True,
'attendance_state': 'break',
})
self.employee = self.employee.with_context(work_type_id=break_type.id)
attendance = self.employee._attendance_action_change()
self.assertEqual(attendance.work_type_id, break_type)
self.assertEqual(self.employee.attendance_state, 'break')
# tests likely won't pass as the timestamps will be the same
sleep(1)
# check back in immediately with default
self.employee = self.employee.with_context(work_type_id=self.default_work_type.id)
attendance = self.employee._attendance_action_change()
self.assertEqual(attendance.work_type_id, self.default_work_type)
self.assertEqual(attendance.work_type_id.attendance_state, 'checked_in')
self.assertEqual(self.employee.last_attendance_id, attendance)
self.assertEqual(self.employee.attendance_state, 'checked_in')

View File

@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="hr_attendance_tree_inherit" model="ir.ui.view">
<field name="name">hr.attendance.tree.inherit</field>
<field name="model">hr.attendance</field>
<field name="inherit_id" ref="hr_attendance.view_attendance_tree"/>
<field name="arch" type="xml">
<xpath expr="//tree/field[@name='worked_hours']" position="before">
<field name="work_type_id" />
</xpath>
</field>
</record>
</odoo>

View File

@@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8" ?>
<odoo>
<record id="hr_kanban_view_employees_inherit" model="ir.ui.view">
<field name="name">hr.employee.kanban.inherit</field>
<field name="model">hr.employee</field>
<field name="inherit_id" ref="hr.hr_kanban_view_employees"/>
<field name="arch" type="xml">
<xpath expr="//kanban/field[@name='hr_presence_state']" position="after">
<field name="attendance_state"/>
</xpath>
<xpath expr="//strong[@class='o_kanban_record_title']/div[1]" position="before">
<div class="float-right" t-if="record.attendance_state.raw_value == 'checked_in'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_green" role="img" aria-label="Available" title="Available"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'checked_out'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_red" role="img" aria-label="Not available" title="Not available"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'lunch'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_orange" role="img" aria-label="At Lunch" title="At Lunch"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'break'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_blue" role="img" aria-label="On Break" title="On Break"></span>
</div>
</xpath>
</field>
</record>
<!-- employee kanban view specifically for hr_attendance (to check in/out) -->
<record id="hr_employees_view_kanban_inherit" model="ir.ui.view">
<field name="name">hr.employee.kanban.inherit</field>
<field name="model">hr.employee</field>
<field name="inherit_id" ref="hr_attendance.hr_employees_view_kanban"/>
<field name="arch" type="xml">
<xpath expr="//div[@id='textbox']" position="replace">
<div id="textbox">
<div class="float-right" t-if="record.attendance_state.raw_value == 'checked_in'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_green" role="img" aria-label="Available" title="Available"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'checked_out'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_red" role="img" aria-label="Not available" title="Not available"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'lunch'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_orange" role="img" aria-label="At Lunch" title="At Lunch"></span>
</div>
<div class="float-right" t-if="record.attendance_state.raw_value == 'break'">
<span id="oe_hr_attendance_status" class="fa fa-circle oe_hr_attendance_status_blue" role="img" aria-label="On Break" title="On Break"></span>
</div>
<strong>
<field name="name"/>
</strong>
</div>
</xpath>
</field>
</record>
</odoo>

View File

@@ -0,0 +1,37 @@
<?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="attendance" string="Attendance">
<field name="allow_attendance"/>
<field name="attendance_icon" attrs="{'invisible': [('allow_attendance', '=', False)]}" />
<field name="attendance_state" attrs="{'invisible': [('allow_attendance', '=', False)]}" />
</group>
</xpath>
</field>
</record>
<record id="hr_work_entry_type_view_tree_inherit" model="ir.ui.view">
<field name="name">hr.work.type.view.tree.inherit</field>
<field name="model">hr.work.entry.type</field>
<field name="inherit_id" ref="hr_work_entry.hr_work_entry_type_view_tree"/>
<field name="arch" type="xml">
<xpath expr="//tree/field[1]" position="before">
<field name="sequence" widget="handle"/>
</xpath>
</field>
</record>
<menuitem
id="hr_work_entry_type_menu"
name="Work Entry Types"
parent="hr_attendance.menu_hr_attendance_root"
sequence="90"
action="hr_work_entry.hr_work_entry_type_action"/>
</odoo>