From 357657fa7333a97f2cd8c5196bb361a86883a583 Mon Sep 17 00:00:00 2001 From: Rucha Mahabal Date: Thu, 24 Jun 2021 13:00:50 +0530 Subject: [PATCH] chore: create a separate controller file for EmployeeBoardingController --- .../employee_boarding_controller.py | 128 ++++++++++++++++++ .../employee_onboarding.js | 2 +- .../employee_onboarding.py | 8 +- .../employee_separation.js | 2 +- .../employee_separation.py | 2 +- erpnext/hr/utils.py | 119 ---------------- erpnext/projects/doctype/project/project.py | 2 +- 7 files changed, 136 insertions(+), 127 deletions(-) create mode 100644 erpnext/controllers/employee_boarding_controller.py diff --git a/erpnext/controllers/employee_boarding_controller.py b/erpnext/controllers/employee_boarding_controller.py new file mode 100644 index 0000000000..e7f7130407 --- /dev/null +++ b/erpnext/controllers/employee_boarding_controller.py @@ -0,0 +1,128 @@ +# Copyright (c) 2021, Frappe Technologies Pvt. Ltd. and Contributors +# License: GNU General Public License v3. See license.txt + +import erpnext +import frappe +from frappe import _ +from frappe.desk.form import assign_to +from frappe.model.document import Document +from frappe.utils import flt, unique + +class EmployeeBoardingController(Document): + ''' + Create the project and the task for the boarding process + Assign to the concerned person and roles as per the onboarding/separation template + ''' + def validate(self): + # remove the task if linked before submitting the form + if self.amended_from: + for activity in self.activities: + activity.task = '' + + def on_submit(self): + # create the project for the given employee onboarding + project_name = _(self.doctype) + ' : ' + if self.doctype == 'Employee Onboarding': + project_name += self.job_applicant + else: + project_name += self.employee + + project = frappe.get_doc({ + 'doctype': 'Project', + 'project_name': project_name, + 'expected_start_date': self.date_of_joining if self.doctype == 'Employee Onboarding' else self.resignation_letter_date, + 'department': self.department, + 'company': self.company + }).insert(ignore_permissions=True, ignore_mandatory=True) + + self.db_set('project', project.name) + self.db_set('boarding_status', 'Pending') + self.reload() + self.create_task_and_notify_user() + + def create_task_and_notify_user(self): + # create the task for the given project and assign to the concerned person + for activity in self.activities: + if activity.task: + continue + + task = frappe.get_doc({ + 'doctype': 'Task', + 'project': self.project, + 'subject': activity.activity_name + ' : ' + self.employee_name, + 'description': activity.description, + 'department': self.department, + 'company': self.company, + 'task_weight': activity.task_weight + }).insert(ignore_permissions=True) + activity.db_set('task', task.name) + + users = [activity.user] if activity.user else [] + if activity.role: + user_list = frappe.db.sql_list(''' + SELECT + DISTINCT(has_role.parent) + FROM + `tabHas Role` has_role + LEFT JOIN `tabUser` user + ON has_role.parent = user.name + WHERE + has_role.parenttype = 'User' + AND user.enabled = 1 + AND has_role.role = %s + ''', activity.role) + users = unique(users + user_list) + + if 'Administrator' in users: + users.remove('Administrator') + + # assign the task the users + if users: + self.assign_task_to_users(task, users) + + def assign_task_to_users(self, task, users): + for user in users: + args = { + 'assign_to': [user], + 'doctype': task.doctype, + 'name': task.name, + 'description': task.description or task.subject, + 'notify': self.notify_users_by_email + } + assign_to.add(args) + + def on_cancel(self): + # delete task project + for task in frappe.get_all('Task', filters={'project': self.project}): + frappe.delete_doc('Task', task.name, force=1) + frappe.delete_doc('Project', self.project, force=1) + self.db_set('project', '') + for activity in self.activities: + activity.db_set('task', '') + + +@frappe.whitelist() +def get_onboarding_details(parent, parenttype): + return frappe.get_all('Employee Boarding Activity', + fields=['activity_name', 'role', 'user', 'required_for_employee_creation', 'description', 'task_weight'], + filters={'parent': parent, 'parenttype': parenttype}, + order_by= 'idx') + + +def update_employee_boarding_status(project): + employee_onboarding = frappe.db.exists('Employee Onboarding', {'project': project.name}) + employee_separation = frappe.db.exists('Employee Separation', {'project': project.name}) + + if not (employee_onboarding or employee_separation): + return + + status = 'Pending' + if flt(project.percent_complete) > 0.0 and flt(project.percent_complete) < 100.0: + status = 'In Process' + elif flt(project.percent_complete) == 100.0: + status = 'Completed' + + if employee_onboarding: + frappe.db.set_value('Employee Onboarding', employee_onboarding, 'boarding_status', status) + elif employee_separation: + frappe.db.set_value('Employee Separation', employee_separation, 'boarding_status', status) diff --git a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.js b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.js index bd72629c0d..5d1a024ebb 100644 --- a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.js +++ b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.js @@ -56,7 +56,7 @@ frappe.ui.form.on('Employee Onboarding', { frm.set_value("activities" ,""); if (frm.doc.employee_onboarding_template) { frappe.call({ - method: "erpnext.hr.utils.get_onboarding_details", + method: "erpnext.controllers.employee_boarding_controller.get_onboarding_details", args: { "parent": frm.doc.employee_onboarding_template, "parenttype": "Employee Onboarding Template" diff --git a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py index 6cc2bf5cd8..55fe317b9e 100644 --- a/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py +++ b/erpnext/hr/doctype/employee_onboarding/employee_onboarding.py @@ -5,7 +5,7 @@ from __future__ import unicode_literals import frappe from frappe import _ -from erpnext.hr.utils import EmployeeBoardingController +from erpnext.controllers.employee_boarding_controller import EmployeeBoardingController from frappe.model.mapper import get_mapped_doc class IncompleteTaskError(frappe.ValidationError): pass @@ -16,9 +16,9 @@ class EmployeeOnboarding(EmployeeBoardingController): self.validate_duplicate_employee_onboarding() def validate_duplicate_employee_onboarding(self): - emp_onboarding = frappe.db.exists("Employee Onboarding",{"job_applicant": self.job_applicant}) + emp_onboarding = frappe.db.exists("Employee Onboarding", {"job_applicant": self.job_applicant}) if emp_onboarding and emp_onboarding != self.name: - frappe.throw(_("Employee Onboarding: {0} is already for Job Applicant: {1}").format(frappe.bold(emp_onboarding), frappe.bold(self.job_applicant))) + frappe.throw(_("Employee Onboarding: {0} already exists for Job Applicant: {1}").format(frappe.bold(emp_onboarding), frappe.bold(self.job_applicant))) def validate_employee_creation(self): if self.docstatus != 1: @@ -30,7 +30,7 @@ class EmployeeOnboarding(EmployeeBoardingController): else: task_status = frappe.db.get_value("Task", activity.task, "status") if task_status not in ["Completed", "Cancelled"]: - frappe.throw(_("All the mandatory Task for employee creation hasn't been done yet."), IncompleteTaskError) + frappe.throw(_("All the mandatory tasks for employee creation are not completed yet."), IncompleteTaskError) def on_submit(self): super(EmployeeOnboarding, self).on_submit() diff --git a/erpnext/hr/doctype/employee_separation/employee_separation.js b/erpnext/hr/doctype/employee_separation/employee_separation.js index 33830796b6..d9011b2001 100644 --- a/erpnext/hr/doctype/employee_separation/employee_separation.js +++ b/erpnext/hr/doctype/employee_separation/employee_separation.js @@ -29,7 +29,7 @@ frappe.ui.form.on('Employee Separation', { frm.set_value("activities" ,""); if (frm.doc.employee_separation_template) { frappe.call({ - method: "erpnext.hr.utils.get_onboarding_details", + method: "erpnext.controllers.employee_boarding_controller.get_onboarding_details", args: { "parent": frm.doc.employee_separation_template, "parenttype": "Employee Separation Template" diff --git a/erpnext/hr/doctype/employee_separation/employee_separation.py b/erpnext/hr/doctype/employee_separation/employee_separation.py index b64668157b..8afee25d31 100644 --- a/erpnext/hr/doctype/employee_separation/employee_separation.py +++ b/erpnext/hr/doctype/employee_separation/employee_separation.py @@ -3,7 +3,7 @@ # For license information, please see license.txt from __future__ import unicode_literals -from erpnext.hr.utils import EmployeeBoardingController +from erpnext.controllers.employee_boarding_controller import EmployeeBoardingController class EmployeeSeparation(EmployeeBoardingController): def validate(self): diff --git a/erpnext/hr/utils.py b/erpnext/hr/utils.py index 97420efe64..3cc1a014d7 100644 --- a/erpnext/hr/utils.py +++ b/erpnext/hr/utils.py @@ -13,125 +13,6 @@ from frappe.utils import (add_days, cstr, flt, format_datetime, formatdate, class DuplicateDeclarationError(frappe.ValidationError): pass - -class EmployeeBoardingController(Document): - ''' - Create the project and the task for the boarding process - Assign to the concerned person and roles as per the onboarding/separation template - ''' - def validate(self): - # remove the task if linked before submitting the form - if self.amended_from: - for activity in self.activities: - activity.task = '' - - def on_submit(self): - # create the project for the given employee onboarding - project_name = _(self.doctype) + " : " - if self.doctype == "Employee Onboarding": - project_name += self.job_applicant - else: - project_name += self.employee - - project = frappe.get_doc({ - "doctype": "Project", - "project_name": project_name, - "expected_start_date": self.date_of_joining if self.doctype == "Employee Onboarding" else self.resignation_letter_date, - "department": self.department, - "company": self.company - }).insert(ignore_permissions=True, ignore_mandatory=True) - - self.db_set("project", project.name) - self.db_set("boarding_status", "Pending") - self.reload() - self.create_task_and_notify_user() - - def create_task_and_notify_user(self): - # create the task for the given project and assign to the concerned person - for activity in self.activities: - if activity.task: - continue - - task = frappe.get_doc({ - "doctype": "Task", - "project": self.project, - "subject": activity.activity_name + " : " + self.employee_name, - "description": activity.description, - "department": self.department, - "company": self.company, - "task_weight": activity.task_weight - }).insert(ignore_permissions=True) - activity.db_set("task", task.name) - - users = [activity.user] if activity.user else [] - if activity.role: - user_list = frappe.db.sql_list(''' - SELECT - DISTINCT(has_role.parent) - FROM - `tabHas Role` has_role - LEFT JOIN `tabUser` user - ON has_role.parent = user.name - WHERE - has_role.parenttype = 'User' - AND user.enabled = 1 - AND has_role.role = %s - ''', activity.role) - users = unique(users + user_list) - - if "Administrator" in users: - users.remove("Administrator") - - # assign the task the users - if users: - self.assign_task_to_users(task, users) - - def assign_task_to_users(self, task, users): - for user in users: - args = { - 'assign_to': [user], - 'doctype': task.doctype, - 'name': task.name, - 'description': task.description or task.subject, - 'notify': self.notify_users_by_email - } - assign_to.add(args) - - def on_cancel(self): - # delete task project - for task in frappe.get_all("Task", filters={"project": self.project}): - frappe.delete_doc("Task", task.name, force=1) - frappe.delete_doc("Project", self.project, force=1) - self.db_set('project', '') - for activity in self.activities: - activity.db_set("task", "") - - -@frappe.whitelist() -def get_onboarding_details(parent, parenttype): - return frappe.get_all("Employee Boarding Activity", - fields=["activity_name", "role", "user", "required_for_employee_creation", "description", "task_weight"], - filters={"parent": parent, "parenttype": parenttype}, - order_by= "idx") - -def update_employee_boarding_status(project): - employee_onboarding = frappe.db.exists('Employee Onboarding', {'project': project.name}) - employee_separation = frappe.db.exists('Employee Separation', {'project': project.name}) - - if not (employee_onboarding or employee_separation): - return - - status = 'Pending' - if flt(project.percent_complete) > 0.0 and flt(project.percent_complete) < 100.0: - status = 'In Process' - elif flt(project.percent_complete) == 100.0: - status = 'Completed' - - if employee_onboarding: - frappe.db.set_value('Employee Onboarding', employee_onboarding, 'boarding_status', status) - elif employee_separation: - frappe.db.set_value('Employee Separation', employee_separation, 'boarding_status', status) - def set_employee_name(doc): if doc.employee and not doc.employee_name: doc.employee_name = frappe.db.get_value("Employee", doc.employee, "employee_name") diff --git a/erpnext/projects/doctype/project/project.py b/erpnext/projects/doctype/project/project.py index 0ee9990620..1e4b2b0b86 100644 --- a/erpnext/projects/doctype/project/project.py +++ b/erpnext/projects/doctype/project/project.py @@ -14,7 +14,7 @@ from erpnext.hr.doctype.daily_work_summary.daily_work_summary import get_users_e from erpnext.hr.doctype.holiday_list.holiday_list import is_holiday from frappe.model.document import Document from erpnext.education.doctype.student_attendance.student_attendance import get_holiday_list -from erpnext.hr.utils import update_employee_boarding_status +from erpnext.controllers.employee_boarding_controller import update_employee_boarding_status class Project(Document): def get_feed(self):