Skip to content

Commit

Permalink
[ADD] website_sale_product_publish_cron
Browse files Browse the repository at this point in the history
  • Loading branch information
AungKoKoLin1997 committed Jun 26, 2024
1 parent a689b0f commit ad4069c
Show file tree
Hide file tree
Showing 13 changed files with 605 additions and 0 deletions.
6 changes: 6 additions & 0 deletions setup/website_sale_product_publish_cron/setup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import setuptools

setuptools.setup(
setup_requires=['setuptools-odoo'],
odoo_addon=True,
)
82 changes: 82 additions & 0 deletions website_sale_product_publish_cron/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
=================================
Website Sale Product Publish Cron
=================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:83009533a2c2b2c4b8464e5bfe7d7c210a36cff9b8cce8322a4797002c12015d
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |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%2Fe--commerce-lightgray.png?logo=github
:target: https://github.com/OCA/e-commerce/tree/15.0/website_sale_product_publish_cron
:alt: OCA/e-commerce
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/e-commerce-15-0/e-commerce-15-0-website_sale_product_publish_cron
: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/e-commerce&target_branch=15.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module adds expected publish/unpublish date fields to the product, and a scheduled
action to publish/unpublish products according to the product settings.

This function can be useful if you run an eCommerce platform where a set of products need to be sold for a scheduled timeframe.

**Table of contents**

.. contents::
:local:

Known issues / Roadmap
======================

With this module, if a user unpublishes products that were set to remain published until
a specified expected_unpublish_date, the system will republish them during the next cron run.
The same scenario applies to manually publishing timeframe products. It's essential to update both
the expected_publish_date and expected_unpublish_date if a user decides to manually publish or unpublish for timeframe products.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/e-commerce/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 <https://github.com/OCA/e-commerce/issues/new?body=module:%20website_sale_product_publish_cron%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

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

Credits
=======

Authors
~~~~~~~

* Quartile Limited

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.

This module is part of the `OCA/e-commerce <https://github.com/OCA/e-commerce/tree/15.0/website_sale_product_publish_cron>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions website_sale_product_publish_cron/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
16 changes: 16 additions & 0 deletions website_sale_product_publish_cron/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright 2023 Quartile Limited
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
{
"name": "Website Sale Product Publish Cron",
"category": "Website",
"version": "15.0.1.0.0",
"author": "Quartile Limited, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/e-commerce",
"license": "AGPL-3",
"depends": ["website_sale"],
"data": [
"data/product_publish_cron.xml",
"views/product_template_views.xml",
],
"installable": True,
}
13 changes: 13 additions & 0 deletions website_sale_product_publish_cron/data/product_publish_cron.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo noupdate="1">
<record id="ir_cron_website_product_publish_cron" model="ir.cron">
<field name="name">Website Product: Publish and Unpublish</field>
<field name="model_id" ref="model_product_template" />
<field name="state">code</field>
<field name="code">model._check_website_product_visibility()</field>
<field name="interval_number">1</field>
<field name="interval_type">hours</field>
<field name="numbercall">-1</field>
<field name="doall" eval="False" />
</record>
</odoo>
1 change: 1 addition & 0 deletions website_sale_product_publish_cron/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import product_template
37 changes: 37 additions & 0 deletions website_sale_product_publish_cron/models/product_template.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2023 Quartile Limited
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import fields, models


class ProductTemplate(models.Model):
_inherit = "product.template"

expected_publish_date = fields.Datetime()
expected_unpublish_date = fields.Datetime()

def get_publish_domain(self):
domain = [

Check warning on line 14 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L14

Added line #L14 was not covered by tests
("website_published", "=", False),
("expected_publish_date", "<=", fields.datetime.now()),
"|",
("expected_unpublish_date", ">", fields.datetime.now()),
("expected_unpublish_date", "=", False),
]
return domain

Check warning on line 21 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L21

Added line #L21 was not covered by tests

def get_unpublish_domain(self):
domain = [

Check warning on line 24 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L24

Added line #L24 was not covered by tests
("website_published", "=", True),
("expected_unpublish_date", "<=", fields.datetime.now()),
]
return domain

Check warning on line 28 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L28

Added line #L28 was not covered by tests

def _check_website_product_visibility(self):
publish_domain = self.get_publish_domain()
publish_products = self.env["product.template"].search(publish_domain)
publish_products.write({"website_published": True})

Check warning on line 33 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L31-L33

Added lines #L31 - L33 were not covered by tests

unpublish_domain = self.get_unpublish_domain()
unpublish_products = self.env["product.template"].search(unpublish_domain)
unpublish_products.write({"website_published": False})

Check warning on line 37 in website_sale_product_publish_cron/models/product_template.py

View check run for this annotation

Codecov / codecov/patch

website_sale_product_publish_cron/models/product_template.py#L35-L37

Added lines #L35 - L37 were not covered by tests
3 changes: 3 additions & 0 deletions website_sale_product_publish_cron/readme/CONTRIBUTOR.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* `Quartile <https://www.quartile.co>`__:

* Aung Ko Ko Lin
4 changes: 4 additions & 0 deletions website_sale_product_publish_cron/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This module adds expected publish/unpublish date fields to the product, and a scheduled
action to publish/unpublish products according to the product settings.

This function can be useful if you run an eCommerce platform where a set of products need to be sold for a scheduled timeframe.
4 changes: 4 additions & 0 deletions website_sale_product_publish_cron/readme/ROADMAP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
With this module, if a user unpublishes products that were set to remain published until
a specified expected_unpublish_date, the system will republish them during the next cron run.
The same scenario applies to manually publishing timeframe products. It's essential to update both
the expected_publish_date and expected_unpublish_date if a user decides to manually publish or unpublish for timeframe products.
Loading

0 comments on commit ad4069c

Please sign in to comment.