From a2f4298af4588be992b049633b11f715357a13a0 Mon Sep 17 00:00:00 2001 From: Carlos Roca Date: Wed, 14 Aug 2024 08:23:21 +0200 Subject: [PATCH] [ADD] web_widget_remaining_days_exact_date: New module to show exact date when remaining days shown This module is adding an option to the remaining_days widget to be able to show the exact date. --- .../web_widget_remaining_days_exact_date | 1 + .../setup.py | 6 + .../README.rst | 105 +++++ .../__init__.py | 0 .../__manifest__.py | 20 + .../readme/CONTRIBUTORS.rst | 4 + .../readme/DESCRIPTION.rst | 1 + .../readme/USAGE.rst | 9 + .../static/description/index.html | 446 ++++++++++++++++++ .../src/remaining_days/remaining_days.esm.js | 42 ++ 10 files changed, 634 insertions(+) create mode 120000 setup/web_widget_remaining_days_exact_date/odoo/addons/web_widget_remaining_days_exact_date create mode 100644 setup/web_widget_remaining_days_exact_date/setup.py create mode 100644 web_widget_remaining_days_exact_date/README.rst create mode 100644 web_widget_remaining_days_exact_date/__init__.py create mode 100644 web_widget_remaining_days_exact_date/__manifest__.py create mode 100644 web_widget_remaining_days_exact_date/readme/CONTRIBUTORS.rst create mode 100644 web_widget_remaining_days_exact_date/readme/DESCRIPTION.rst create mode 100644 web_widget_remaining_days_exact_date/readme/USAGE.rst create mode 100644 web_widget_remaining_days_exact_date/static/description/index.html create mode 100644 web_widget_remaining_days_exact_date/static/src/remaining_days/remaining_days.esm.js diff --git a/setup/web_widget_remaining_days_exact_date/odoo/addons/web_widget_remaining_days_exact_date b/setup/web_widget_remaining_days_exact_date/odoo/addons/web_widget_remaining_days_exact_date new file mode 120000 index 000000000000..baeac123f453 --- /dev/null +++ b/setup/web_widget_remaining_days_exact_date/odoo/addons/web_widget_remaining_days_exact_date @@ -0,0 +1 @@ +../../../../web_widget_remaining_days_exact_date \ No newline at end of file diff --git a/setup/web_widget_remaining_days_exact_date/setup.py b/setup/web_widget_remaining_days_exact_date/setup.py new file mode 100644 index 000000000000..28c57bb64031 --- /dev/null +++ b/setup/web_widget_remaining_days_exact_date/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/web_widget_remaining_days_exact_date/README.rst b/web_widget_remaining_days_exact_date/README.rst new file mode 100644 index 000000000000..ffaa7cc1efb4 --- /dev/null +++ b/web_widget_remaining_days_exact_date/README.rst @@ -0,0 +1,105 @@ +==================================== +Web Widget Remaining Days Exact Date +==================================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:c71bd5f0f41e5a6661d1d1866db575053f328abd16c559071f5eb8e916cd4f88 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/16.0/web_widget_remaining_days_exact_date + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_widget_remaining_days_exact_date + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows displaying the exact date alongside the remaining days. + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +If in any case the exact date doesn't need to be displayed, we can disable the +functionality by adding `options="{'exact_date': False}"` to the field that has the +widget. + +**Example** + +.. code:: xml + + + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Tecnativa + +Contributors +~~~~~~~~~~~~ + +* `Tecnativa `_ + + * Pedro M. Baeza + * Carlos Roca + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-CarlosRoca13| image:: https://github.com/CarlosRoca13.png?size=40px + :target: https://github.com/CarlosRoca13 + :alt: CarlosRoca13 + +Current `maintainer `__: + +|maintainer-CarlosRoca13| + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_widget_remaining_days_exact_date/__init__.py b/web_widget_remaining_days_exact_date/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/web_widget_remaining_days_exact_date/__manifest__.py b/web_widget_remaining_days_exact_date/__manifest__.py new file mode 100644 index 000000000000..a4c52a9937e6 --- /dev/null +++ b/web_widget_remaining_days_exact_date/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2024 Tecnativa - Carlos Roca +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl-3.0) + +{ + "name": "Web Widget Remaining Days Exact Date", + "summary": "Allows displaying the exact date alongside the remaining days", + "version": "16.0.1.0.0", + "development_status": "Alpha", + "website": "https://github.com/OCA/web", + "author": "Tecnativa, Odoo Community Association (OCA)", + "maintainers": ["CarlosRoca13"], + "license": "AGPL-3", + "depends": ["web"], + "assets": { + "web.assets_backend": [ + "web_widget_remaining_days_exact_date/static/src/remaining_days" + "/remaining_days.esm.js", + ], + }, +} diff --git a/web_widget_remaining_days_exact_date/readme/CONTRIBUTORS.rst b/web_widget_remaining_days_exact_date/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000000..825701131223 --- /dev/null +++ b/web_widget_remaining_days_exact_date/readme/CONTRIBUTORS.rst @@ -0,0 +1,4 @@ +* `Tecnativa `_ + + * Pedro M. Baeza + * Carlos Roca \ No newline at end of file diff --git a/web_widget_remaining_days_exact_date/readme/DESCRIPTION.rst b/web_widget_remaining_days_exact_date/readme/DESCRIPTION.rst new file mode 100644 index 000000000000..320025e9f885 --- /dev/null +++ b/web_widget_remaining_days_exact_date/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module allows displaying the exact date alongside the remaining days. \ No newline at end of file diff --git a/web_widget_remaining_days_exact_date/readme/USAGE.rst b/web_widget_remaining_days_exact_date/readme/USAGE.rst new file mode 100644 index 000000000000..a764d75899b9 --- /dev/null +++ b/web_widget_remaining_days_exact_date/readme/USAGE.rst @@ -0,0 +1,9 @@ +If in any case the exact date doesn't need to be displayed, we can disable the +functionality by adding `options="{'exact_date': False}"` to the field that has the +widget. + +**Example** + +.. code:: xml + + \ No newline at end of file diff --git a/web_widget_remaining_days_exact_date/static/description/index.html b/web_widget_remaining_days_exact_date/static/description/index.html new file mode 100644 index 000000000000..03c5ed3dc39f --- /dev/null +++ b/web_widget_remaining_days_exact_date/static/description/index.html @@ -0,0 +1,446 @@ + + + + + +Web Widget Remaining Days Exact Date + + + +
+

Web Widget Remaining Days Exact Date

+ + +

Alpha License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

+

This module allows displaying the exact date alongside the remaining days.

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Usage

+

If in any case the exact date doesn’t need to be displayed, we can disable the +functionality by adding options=”{‘exact_date’: False}” to the field that has the +widget.

+

Example

+
+<field name="date_deadline" widget="remaining_days" options="{'exact_date': False}"/>
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Tecnativa
    • +
+
+
+

Contributors

+
    +
  • Tecnativa
      +
    • Pedro M. Baeza
      • +
    • Carlos Roca
      • +
    +
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

CarlosRoca13

+

This module is part of the OCA/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/web_widget_remaining_days_exact_date/static/src/remaining_days/remaining_days.esm.js b/web_widget_remaining_days_exact_date/static/src/remaining_days/remaining_days.esm.js new file mode 100644 index 000000000000..de8d8fcd5843 --- /dev/null +++ b/web_widget_remaining_days_exact_date/static/src/remaining_days/remaining_days.esm.js @@ -0,0 +1,42 @@ +/** @odoo-module **/ +/* Copyright 2024 Tecnativa - Carlos Roca + * License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */ +import {RemainingDaysField} from "@web/views/fields/remaining_days/remaining_days_field"; +import {patch} from "@web/core/utils/patch"; +import {sprintf} from "@web/core/utils/strings"; + +patch( + RemainingDaysField.prototype, + "web_widget_remaining_days_exact_date.RemainingDaysField", + { + get diffString() { + var value = this._super(...arguments); + // 99 is hardcoded because Odoo uses this value to display the exact + // date at this point + // https://github.com/odoo/odoo/blob/9cb802340f7a769327e9e5f0c4085cb837269551/addons/web/static/src/views/fields/remaining_days/remaining_days_field.js#L42 + if (value && this.props.exact_date && Math.abs(this.diffDays) <= 99) { + value = sprintf("%s (%s)", value, this.formattedValue); + } + return value; + }, + } +); +RemainingDaysField.props = { + ...RemainingDaysField.props, + exact_date: {type: Boolean, optional: true}, +}; +RemainingDaysField.defaultProps = { + ...RemainingDaysField.defaultProps, + exact_date: true, +}; +const superExtractProps = RemainingDaysField.extractProps; +RemainingDaysField.extractProps = ({attrs}) => { + var res = {}; + if (superExtractProps) { + res = superExtractProps({attrs}); + } + return { + ...res, + exact_date: attrs.options.exact_date, + }; +};