diff --git a/.copier-answers.yml b/.copier-answers.yml index a34b1374..e64882c8 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,8 +1,7 @@ # Do NOT update manually; changes here will be overwritten by Copier -_commit: v1.14.2 +_commit: v1.17.1 _src_path: gh:oca/oca-addons-repo-template ci: GitHub -dependency_installation_mode: PIP generate_requirements_txt: true github_check_license: true github_ci_extra_env: {} @@ -11,14 +10,14 @@ github_enable_makepot: true github_enable_stale_action: true github_enforce_dev_status_compatibility: true include_wkhtmltopdf: false +odoo_test_flavor: Both odoo_version: 16.0 org_name: Odoo Community Association (OCA) org_slug: OCA -rebel_module_groups: [] +rebel_module_groups: +- account_journal_restrict_mode repo_description: 'TODO: add repo description.' repo_name: account-financial-tools repo_slug: account-financial-tools repo_website: https://github.com/OCA/account-financial-tools -travis_apt_packages: [] -travis_apt_sources: [] diff --git a/.eslintrc.yml b/.eslintrc.yml index 9429bc68..fed88d70 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -22,6 +22,7 @@ globals: odoo: readonly openerp: readonly owl: readonly + luxon: readonly # Styling is handled by Prettier, so we only need to enable AST rules; # see https://github.com/OCA/maintainer-quality-tools/pull/618#issuecomment-558576890 diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 23e6e58d..f1d350cd 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -13,7 +13,7 @@ jobs: pre-commit: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: actions/setup-python@v2 - name: Get python version run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV @@ -25,6 +25,15 @@ jobs: run: pip install pre-commit - name: Run pre-commit run: pre-commit run --all-files --show-diff-on-failure --color=always + env: + # Consider valid a PR that changes README fragments but doesn't + # change the README.rst file itself. It's not really a problem + # because the bot will update it anyway after merge. This way, we + # lower the barrier for functional contributors that want to fix the + # readme fragments, while still letting developers get README + # auto-generated (which also helps functionals when using runboat). + # DOCS https://pre-commit.com/#temporarily-disabling-hooks + SKIP: oca-gen-addon-readme - name: Check that all files generated by pre-commit are in git run: | newfiles="$(git ls-files --others --exclude-from=.gitignore)" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f1b2b9fd..8396d502 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest name: Detect unreleased dependencies steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - run: | for reqfile in requirements.txt test-requirements.txt ; do if [ -f ${reqfile} ] ; then @@ -36,10 +36,19 @@ jobs: matrix: include: - container: ghcr.io/oca/oca-ci/py3.10-odoo16.0:latest - makepot: "true" + include: "account_journal_restrict_mode" name: test with Odoo - container: ghcr.io/oca/oca-ci/py3.10-ocb16.0:latest + include: "account_journal_restrict_mode" name: test with OCB + makepot: "true" + - container: ghcr.io/oca/oca-ci/py3.10-odoo16.0:latest + exclude: "account_journal_restrict_mode" + name: test with Odoo + - container: ghcr.io/oca/oca-ci/py3.10-ocb16.0:latest + exclude: "account_journal_restrict_mode" + name: test with OCB + makepot: "true" services: postgres: image: postgres:12.0 @@ -49,8 +58,11 @@ jobs: POSTGRES_DB: odoo ports: - 5432:5432 + env: + INCLUDE: "${{ matrix.include }}" + EXCLUDE: "${{ matrix.exclude }}" steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: persist-credentials: false - name: Install addons and dependencies diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d918b5b4..808b75f0 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,6 +12,8 @@ exclude: | /static/(src/)?lib/| # Repos using Sphinx to generate docs don't need prettying ^docs/_templates/.*\.html$| + # Don't bother non-technical authors with formatting issues in docs + readme/.*\.(rst|md)$| # You don't usually want a bot to modify your legal texts (LICENSE.*|COPYING.*) default_language_version: @@ -33,12 +35,24 @@ repos: language: fail files: '[a-zA-Z0-9_]*/i18n/en\.po$' - repo: https://github.com/oca/maintainer-tools - rev: 4cd2b852214dead80822e93e6749b16f2785b2fe + rev: 969238e47c07d0c40573acff81d170f63245d738 hooks: # update the NOT INSTALLABLE ADDONS section above - id: oca-update-pre-commit-excluded-addons - id: oca-fix-manifest-website args: ["https://github.com/OCA/account-financial-tools"] + - id: oca-gen-addon-readme + args: + - --addons-dir=. + - --branch=16.0 + - --org-name=OCA + - --repo-name=account-financial-tools + - --if-source-changed + - repo: https://github.com/OCA/odoo-pre-commit-hooks + rev: v0.0.25 + hooks: + - id: oca-checks-odoo-module + - id: oca-checks-po - repo: https://github.com/myint/autoflake rev: v1.6.1 hooks: @@ -125,7 +139,7 @@ repos: name: flake8 additional_dependencies: ["flake8-bugbear==21.9.2"] - repo: https://github.com/OCA/pylint-odoo - rev: 7.0.2 + rev: v8.0.19 hooks: - id: pylint_odoo name: pylint with optional checks diff --git a/.pylintrc b/.pylintrc index cad9c2f1..55491327 100644 --- a/.pylintrc +++ b/.pylintrc @@ -5,12 +5,12 @@ load-plugins=pylint_odoo score=n [ODOOLINT] -readme_template_url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" -manifest_required_authors=Odoo Community Association (OCA) -manifest_required_keys=license -manifest_deprecated_keys=description,active -license_allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 -valid_odoo_versions=16.0 +readme-template-url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" +manifest-required-authors=Odoo Community Association (OCA) +manifest-required-keys=license +manifest-deprecated-keys=description,active +license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 +valid-odoo-versions=16.0 [MESSAGES CONTROL] disable=all diff --git a/.pylintrc-mandatory b/.pylintrc-mandatory index fa4b81c4..7a0cd4ef 100644 --- a/.pylintrc-mandatory +++ b/.pylintrc-mandatory @@ -4,12 +4,12 @@ load-plugins=pylint_odoo score=n [ODOOLINT] -readme_template_url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" -manifest_required_authors=Odoo Community Association (OCA) -manifest_required_keys=license -manifest_deprecated_keys=description,active -license_allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 -valid_odoo_versions=16.0 +readme-template-url="https://github.com/OCA/maintainer-tools/blob/master/template/module/README.rst" +manifest-required-authors=Odoo Community Association (OCA) +manifest-required-keys=license +manifest-deprecated-keys=description,active +license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3 +valid-odoo-versions=16.0 [MESSAGES CONTROL] disable=all diff --git a/account_journal_restrict_mode/README.rst b/account_journal_restrict_mode/README.rst new file mode 100644 index 00000000..2878ca69 --- /dev/null +++ b/account_journal_restrict_mode/README.rst @@ -0,0 +1,88 @@ +============================= +Account Journal Restrict Mode +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:805f2c472057df7cac02a1fab129fb2399674fb8352dec49fa4a07b32566eb62 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Faccount--financial--tools-lightgray.png?logo=github + :target: https://github.com/OCA/account-financial-tools/tree/16.0/account_journal_restrict_mode + :alt: OCA/account-financial-tools +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/account-financial-tools-16-0/account-financial-tools-16-0-account_journal_restrict_mode + :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/account-financial-tools&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module enables by default the setting *Lock Posted Entries with Hash* in +all Journals and prevents the setting to be modified. + +The goal is to assure that all journal entries are locked when posted to prevent +them to be modified. + +**Table of contents** + +.. contents:: + :local: + +Known issues / Roadmap +====================== + +* Odoo hides the setting *Lock Posted Entries with Hash* on Bank and Cash + Journals, but enabling it does not cause issues in the reconciliation for now. + If the Odoo logic changes at any point, the module may need to be adapted to + only force the setting on other types of journals. + +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 +~~~~~~~ + +* ForgeFlow S.L. + +Contributors +~~~~~~~~~~~~ + +* Jordi Masvidal + +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/account-financial-tools `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/account_journal_restrict_mode/__init__.py b/account_journal_restrict_mode/__init__.py new file mode 100644 index 00000000..e66fb1c2 --- /dev/null +++ b/account_journal_restrict_mode/__init__.py @@ -0,0 +1,4 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from . import models +from .hooks import post_init_hook diff --git a/account_journal_restrict_mode/__manifest__.py b/account_journal_restrict_mode/__manifest__.py new file mode 100644 index 00000000..01721a51 --- /dev/null +++ b/account_journal_restrict_mode/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +{ + "name": "Account Journal Restrict Mode", + "summary": "Lock All Posted Entries of Journals.", + "version": "16.0.1.0.0", + "author": "ForgeFlow S.L., Odoo Community Association (OCA)", + "website": "https://github.com/OCA/account-financial-tools", + "category": "Accounting", + "depends": [ + "account", + ], + "license": "AGPL-3", + "data": [], + "installable": True, + "post_init_hook": "post_init_hook", +} diff --git a/account_journal_restrict_mode/hooks.py b/account_journal_restrict_mode/hooks.py new file mode 100644 index 00000000..31671f92 --- /dev/null +++ b/account_journal_restrict_mode/hooks.py @@ -0,0 +1,13 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). + +from odoo import SUPERUSER_ID, api + + +def post_init_hook(cr, registry): + """Enable restrict mode on all journals""" + env = api.Environment(cr, SUPERUSER_ID, {}) + journals_to_update = env["account.journal"].search( + [("restrict_mode_hash_table", "=", False)] + ) + journals_to_update.write({"restrict_mode_hash_table": True}) diff --git a/account_journal_restrict_mode/models/__init__.py b/account_journal_restrict_mode/models/__init__.py new file mode 100644 index 00000000..a8e96f29 --- /dev/null +++ b/account_journal_restrict_mode/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from . import account_journal diff --git a/account_journal_restrict_mode/models/account_journal.py b/account_journal_restrict_mode/models/account_journal.py new file mode 100644 index 00000000..921ac92b --- /dev/null +++ b/account_journal_restrict_mode/models/account_journal.py @@ -0,0 +1,19 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from odoo import _, api, fields, models +from odoo.exceptions import UserError + + +class AccountJournal(models.Model): + _inherit = "account.journal" + + restrict_mode_hash_table = fields.Boolean(default=True) + + @api.constrains("restrict_mode_hash_table") + def _check_journal_restrict_mode(self): + for rec in self: + if not rec.restrict_mode_hash_table: + raise UserError( + _("Journal %s must have Lock Posted Entries enabled.") % rec.name + ) diff --git a/account_journal_restrict_mode/readme/CONTRIBUTORS.rst b/account_journal_restrict_mode/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..e4263e41 --- /dev/null +++ b/account_journal_restrict_mode/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Jordi Masvidal diff --git a/account_journal_restrict_mode/readme/DESCRIPTION.rst b/account_journal_restrict_mode/readme/DESCRIPTION.rst new file mode 100644 index 00000000..1afc6c1b --- /dev/null +++ b/account_journal_restrict_mode/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module enables by default the setting *Lock Posted Entries with Hash* in +all Journals and prevents the setting to be modified. + +The goal is to assure that all journal entries are locked when posted to prevent +them to be modified. diff --git a/account_journal_restrict_mode/readme/ROADMAP.rst b/account_journal_restrict_mode/readme/ROADMAP.rst new file mode 100644 index 00000000..c13dd56b --- /dev/null +++ b/account_journal_restrict_mode/readme/ROADMAP.rst @@ -0,0 +1,4 @@ +* Odoo hides the setting *Lock Posted Entries with Hash* on Bank and Cash + Journals, but enabling it does not cause issues in the reconciliation for now. + If the Odoo logic changes at any point, the module may need to be adapted to + only force the setting on other types of journals. diff --git a/account_journal_restrict_mode/static/description/icon.png b/account_journal_restrict_mode/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/account_journal_restrict_mode/static/description/icon.png differ diff --git a/account_journal_restrict_mode/static/description/index.html b/account_journal_restrict_mode/static/description/index.html new file mode 100644 index 00000000..f6d4ec40 --- /dev/null +++ b/account_journal_restrict_mode/static/description/index.html @@ -0,0 +1,434 @@ + + + + + + +Account Journal Restrict Mode + + + +
+

Account Journal Restrict Mode

+ + +

Beta License: AGPL-3 OCA/account-financial-tools Translate me on Weblate Try me on Runboat

+

This module enables by default the setting Lock Posted Entries with Hash in +all Journals and prevents the setting to be modified.

+

The goal is to assure that all journal entries are locked when posted to prevent +them to be modified.

+

Table of contents

+ +
+

Known issues / Roadmap

+
    +
  • Odoo hides the setting Lock Posted Entries with Hash on Bank and Cash +Journals, but enabling it does not cause issues in the reconciliation for now. +If the Odoo logic changes at any point, the module may need to be adapted to +only force the setting on other types of journals.
  • +
+
+
+

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

+
    +
  • ForgeFlow S.L.
  • +
+
+
+

Contributors

+ +
+
+

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.

+

This module is part of the OCA/account-financial-tools project on GitHub.

+

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

+
+
+
+ + diff --git a/account_journal_restrict_mode/tests/__init__.py b/account_journal_restrict_mode/tests/__init__.py new file mode 100644 index 00000000..f42a275d --- /dev/null +++ b/account_journal_restrict_mode/tests/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from . import test_account_journal_restrict_mode diff --git a/account_journal_restrict_mode/tests/test_account_journal_restrict_mode.py b/account_journal_restrict_mode/tests/test_account_journal_restrict_mode.py new file mode 100644 index 00000000..fbd5eb20 --- /dev/null +++ b/account_journal_restrict_mode/tests/test_account_journal_restrict_mode.py @@ -0,0 +1,20 @@ +# Copyright 2023 ForgeFlow S.L. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html). + +from odoo.exceptions import UserError +from odoo.tests import common + + +class TestAccountJournalRestrictMode(common.TransactionCase): + @classmethod + def setUpClass(cls): + super(TestAccountJournalRestrictMode, cls).setUpClass() + cls.account_journal_obj = cls.env["account.journal"] + + def test_journal_default_lock_entries(self): + journal = self.account_journal_obj.create( + {"name": "Test Journal", "code": "TJ", "type": "general"} + ) + self.assertTrue(journal.restrict_mode_hash_table) + with self.assertRaises(UserError): + journal.write({"restrict_mode_hash_table": False}) diff --git a/setup/account_journal_restrict_mode/odoo/addons/account_journal_restrict_mode b/setup/account_journal_restrict_mode/odoo/addons/account_journal_restrict_mode new file mode 120000 index 00000000..6d1da32a --- /dev/null +++ b/setup/account_journal_restrict_mode/odoo/addons/account_journal_restrict_mode @@ -0,0 +1 @@ +../../../../account_journal_restrict_mode \ No newline at end of file diff --git a/setup/account_journal_restrict_mode/setup.py b/setup/account_journal_restrict_mode/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/account_journal_restrict_mode/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)