From e7f604ef488de094475e5ded812d2f846fc9cff6 Mon Sep 17 00:00:00 2001 From: Ankush Menat Date: Fri, 24 Feb 2023 13:45:32 +0530 Subject: [PATCH] refactor: rename DocReminder -> Reminder --- .../{docreminder => reminder}/__init__.py | 0 .../docreminder.js => reminder/reminder.js} | 2 +- .../reminder.json} | 23 +++++++++++-------- .../docreminder.py => reminder/reminder.py} | 10 ++++---- .../test_reminder.py} | 4 ++-- .../core/doctype/log_settings/log_settings.py | 2 +- frappe/hooks.py | 2 +- frappe/public/js/frappe/form/reminders.js | 2 +- 8 files changed, 25 insertions(+), 20 deletions(-) rename frappe/automation/doctype/{docreminder => reminder}/__init__.py (100%) rename frappe/automation/doctype/{docreminder/docreminder.js => reminder/reminder.js} (79%) rename frappe/automation/doctype/{docreminder/docreminder.json => reminder/reminder.json} (83%) rename frappe/automation/doctype/{docreminder/docreminder.py => reminder/reminder.py} (91%) rename frappe/automation/doctype/{docreminder/test_docreminder.py => reminder/test_reminder.py} (83%) diff --git a/frappe/automation/doctype/docreminder/__init__.py b/frappe/automation/doctype/reminder/__init__.py similarity index 100% rename from frappe/automation/doctype/docreminder/__init__.py rename to frappe/automation/doctype/reminder/__init__.py diff --git a/frappe/automation/doctype/docreminder/docreminder.js b/frappe/automation/doctype/reminder/reminder.js similarity index 79% rename from frappe/automation/doctype/docreminder/docreminder.js rename to frappe/automation/doctype/reminder/reminder.js index a3f08c2c5e..6d1a72bab2 100644 --- a/frappe/automation/doctype/docreminder/docreminder.js +++ b/frappe/automation/doctype/reminder/reminder.js @@ -1,7 +1,7 @@ // Copyright (c) 2023, Frappe Technologies and contributors // For license information, please see license.txt -// frappe.ui.form.on("DocReminder", { +// frappe.ui.form.on("Reminder", { // refresh(frm) { // }, diff --git a/frappe/automation/doctype/docreminder/docreminder.json b/frappe/automation/doctype/reminder/reminder.json similarity index 83% rename from frappe/automation/doctype/docreminder/docreminder.json rename to frappe/automation/doctype/reminder/reminder.json index 38b0f681ca..a288f205a2 100644 --- a/frappe/automation/doctype/docreminder/docreminder.json +++ b/frappe/automation/doctype/reminder/reminder.json @@ -8,16 +8,18 @@ "engine": "InnoDB", "field_order": [ "user", - "reminder_doctype", - "reminder_docname", "remind_at", "description", + "reminder_doctype", + "reminder_docname", "notified" ], "fields": [ { + "default": "__user", "fieldname": "user", "fieldtype": "Link", + "hidden": 1, "label": "User", "options": "User", "reqd": 1, @@ -28,16 +30,19 @@ "fieldtype": "Link", "in_list_view": 1, "label": "Document Type", - "options": "DocType" + "options": "DocType", + "read_only": 1 }, { "fieldname": "reminder_docname", "fieldtype": "Dynamic Link", "in_list_view": 1, "label": "Document Name", - "options": "reminder_doctype" + "options": "reminder_doctype", + "read_only": 1 }, { + "default": "now", "fieldname": "remind_at", "fieldtype": "Datetime", "in_list_view": 1, @@ -48,23 +53,23 @@ { "fieldname": "description", "fieldtype": "Small Text", - "label": "description", + "label": "Description", "reqd": 1 }, { "default": "0", "fieldname": "notified", "fieldtype": "Check", + "hidden": 1, "label": "notified" } ], - "in_create": 1, "index_web_pages_for_search": 1, "links": [], - "modified": "2023-02-24 12:28:00.642813", + "modified": "2023-02-24 13:47:50.419648", "modified_by": "Administrator", "module": "Automation", - "name": "DocReminder", + "name": "Reminder", "naming_rule": "Random", "owner": "Administrator", "permissions": [ @@ -77,7 +82,7 @@ "write": 1 } ], - "read_only": 1, + "quick_entry": 1, "sort_field": "modified", "sort_order": "DESC", "states": [], diff --git a/frappe/automation/doctype/docreminder/docreminder.py b/frappe/automation/doctype/reminder/reminder.py similarity index 91% rename from frappe/automation/doctype/docreminder/docreminder.py rename to frappe/automation/doctype/reminder/reminder.py index 61832fa2a9..795cdfda69 100644 --- a/frappe/automation/doctype/docreminder/docreminder.py +++ b/frappe/automation/doctype/reminder/reminder.py @@ -8,13 +8,13 @@ from frappe.utils import cint from frappe.utils.data import add_to_date, get_datetime, now_datetime -class DocReminder(Document): +class Reminder(Document): @staticmethod def clear_old_logs(days=30): from frappe.query_builder import Interval from frappe.query_builder.functions import Now - table = frappe.qb.DocType("DocReminder") + table = frappe.qb.DocType("Reminder") frappe.db.delete(table, filters=(table.remind_at < (Now() - Interval(days=days)))) def validate(self): @@ -47,7 +47,7 @@ def create_new_reminder( reminder_doctype: str | None = None, reminder_docname: str | None = None, ): - reminder = frappe.new_doc("DocReminder") + reminder = frappe.new_doc("Reminder") reminder.description = description reminder.remind_at = remind_at @@ -65,7 +65,7 @@ def send_reminders(): lower_threshold = add_to_date(now_datetime(), hours=-8, as_string=True, as_datetime=True) pending_reminders = frappe.get_all( - "DocReminder", + "Reminder", filters=[ ("remind_at", "<=", upper_threshold), ("remind_at", ">=", lower_threshold), # dont send too old reminders if failed to send @@ -75,4 +75,4 @@ def send_reminders(): ) for reminder in pending_reminders: - frappe.get_doc("DocReminder", reminder).send_reminder() + frappe.get_doc("Reminder", reminder).send_reminder() diff --git a/frappe/automation/doctype/docreminder/test_docreminder.py b/frappe/automation/doctype/reminder/test_reminder.py similarity index 83% rename from frappe/automation/doctype/docreminder/test_docreminder.py rename to frappe/automation/doctype/reminder/test_reminder.py index 54cf47fc2e..84cc258701 100644 --- a/frappe/automation/doctype/docreminder/test_docreminder.py +++ b/frappe/automation/doctype/reminder/test_reminder.py @@ -2,13 +2,13 @@ # See license.txt import frappe -from frappe.automation.doctype.docreminder.docreminder import create_new_reminder, send_reminders +from frappe.automation.doctype.reminder.reminder import create_new_reminder, send_reminders from frappe.desk.doctype.notification_log.notification_log import get_notification_logs from frappe.tests.utils import FrappeTestCase from frappe.utils import add_to_date, now_datetime -class TestDocReminder(FrappeTestCase): +class TestReminder(FrappeTestCase): def test_reminder(self): description = "TEST_REMINDER" diff --git a/frappe/core/doctype/log_settings/log_settings.py b/frappe/core/doctype/log_settings/log_settings.py index eb617d2ee2..4a3b457bcc 100644 --- a/frappe/core/doctype/log_settings/log_settings.py +++ b/frappe/core/doctype/log_settings/log_settings.py @@ -20,7 +20,7 @@ DEFAULT_LOGTYPES_RETENTION = { "Submission Queue": 30, "Prepared Report": 30, "Webhook Request Log": 30, - "DocReminder": 30, + "Reminder": 30, } diff --git a/frappe/hooks.py b/frappe/hooks.py index aaed06124f..b0d8e53f4a 100644 --- a/frappe/hooks.py +++ b/frappe/hooks.py @@ -194,7 +194,7 @@ scheduler_events = { "frappe.email.doctype.email_account.email_account.notify_unreplied", "frappe.utils.global_search.sync_global_search", "frappe.monitor.flush", - "frappe.automation.doctype.docreminder.docreminder.send_reminders", + "frappe.automation.doctype.reminder.reminder.send_reminders", ], "hourly": [ "frappe.model.utils.link_count.update_link_count", diff --git a/frappe/public/js/frappe/form/reminders.js b/frappe/public/js/frappe/form/reminders.js index f417a709a0..f761e26594 100644 --- a/frappe/public/js/frappe/form/reminders.js +++ b/frappe/public/js/frappe/form/reminders.js @@ -85,7 +85,7 @@ export class ReminderManager { create_reminder() { frappe - .xcall("frappe.automation.doctype.docreminder.docreminder.create_new_reminder", { + .xcall("frappe.automation.doctype.reminder.reminder.create_new_reminder", { remind_at: this.dialog.get_value("remind_at"), description: this.dialog.get_value("description"), reminder_doctype: this.frm?.doc.doctype,