Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[18.0][ADD] edi_exchange_template_oca_json #136

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions edi_exchange_template_oca_json/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
==========================================
EDI Exchange Template - Add JSON generator
==========================================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:81ee8002397b75724a8d89327a5ca3eb2eaa0a717e2ad37894751baff75a3425
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fedi--framework-lightgray.png?logo=github
:target: https://github.com/OCA/edi-framework/tree/18.0/edi_exchange_template_oca_json
:alt: OCA/edi-framework
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/edi-framework-18-0/edi-framework-18-0-edi_exchange_template_oca_json
: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/edi-framework&target_branch=18.0
:alt: Try me on Runboat

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

Provide extra JSON generator type for EDI exchange templates.

**Table of contents**

.. contents::
:local:

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/edi-framework/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/edi-framework/issues/new?body=module:%20edi_exchange_template_oca_json%0Aversion:%2018.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
-------

* Camptocamp

Contributors
------------

- Italo Lopes <[email protected]>

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/edi-framework <https://github.com/OCA/edi-framework/tree/18.0/edi_exchange_template_oca_json>`_ 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 edi_exchange_template_oca_json/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
14 changes: 14 additions & 0 deletions edi_exchange_template_oca_json/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Copyright 2025 Camptocamp SA
# @author Italo LOPES <[email protected]>
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
{
"name": "EDI Exchange Template - Add JSON generator",
"summary": """EDI Exchange Template - Add JSON generator.""",
"version": "18.0.1.0.0",
"development_status": "Beta",
"license": "LGPL-3",
"author": "Camptocamp, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/edi-framework",
"depends": ["edi_exchange_template_oca", "jsonifier"],
"data": [],
}
1 change: 1 addition & 0 deletions edi_exchange_template_oca_json/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import edi_exchange_template_output
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Copyright 2025 Camptocamp SA
# @author Italo LOPES <[email protected]>
# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).


from odoo import fields, models


class EDIExchangeOutputTemplate(models.Model):
_inherit = "edi.exchange.template.output"

generator = fields.Selection(
selection_add=[("json", "JSON")],
ondelete={"json": "set default"},
)

def _generate_json(self, exchange_record, **kw):
"""Generate JSON output."""
result = self._render_json_values(exchange_record, **kw)
return result

def _post_process_output(self, output):
result = super()._post_process_output(output)
if self.generator == "json":
result = self._post_process_json_output(result)
return result

def _render_json_values(self, exchange_record, **kw):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this module shouldn't rely on jsonifier.
You should be able to generate JSOn as you prefer.

The snippet can simply be something like

exporter = env.ref(...)
parser = exporter.get_json_parser()
result = record.jsonifier(parser, [one=True])

The role of this module is only to handle and validate the JSON result.

"""Render JSON values."""
parser = self._get_json_parser(exchange_record)
result = exchange_record.record.jsonify(parser=parser)
return result

def _get_json_parser(self, exchange_record):
"""Retrieve parser to use for JSON generation."""
json_parser = self._evaluate_code_snippet()
if not json_parser:
json_parser = ["display_name"]

Check warning on line 38 in edi_exchange_template_oca_json/models/edi_exchange_template_output.py

View check run for this annotation

Codecov / codecov/patch

edi_exchange_template_oca_json/models/edi_exchange_template_output.py#L38

Added line #L38 was not covered by tests
return json_parser

def _post_process_json_output(self, output):
"""Post-process JSON output."""
return str(output)
3 changes: 3 additions & 0 deletions edi_exchange_template_oca_json/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
1 change: 1 addition & 0 deletions edi_exchange_template_oca_json/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Italo Lopes \<<[email protected]>\>
1 change: 1 addition & 0 deletions edi_exchange_template_oca_json/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Provide extra JSON generator type for EDI exchange templates.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading