From 6507bdd82cfba05569b112b5c02899a5ad7ab3af Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 4 Oct 2013 11:50:23 +0200 Subject: [PATCH 01/20] [IMP] turns out PIL includes MIME mapping bzr revid: xmo@openerp.com-20131004095023-dudohbovvinqz8om --- openerp/addons/base/ir/ir_fields.py | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/openerp/addons/base/ir/ir_fields.py b/openerp/addons/base/ir/ir_fields.py index de45d2d1f1f..49ccf2ce91a 100644 --- a/openerp/addons/base/ir/ir_fields.py +++ b/openerp/addons/base/ir/ir_fields.py @@ -506,10 +506,4 @@ class ir_fields_converter(orm.Model): except: # no idea what "suitable exceptions" are raise ValueError("Invalid image content") - mime = PIL_MIME_MAPPING.get(image.format) - if mime is None: - raise ValueError("Unknown PIL format %s" % image.format) - - return ('' % (mime, value)), [] - -PIL_MIME_MAPPING = {'PNG': 'image/png', 'JPEG': 'image/jpeg', 'GIF': 'image/gif', } + return ('' % (Image.MIME[image.format], value)), [] From 81a82ca37f28853f39407a347504cc70c140236d Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 4 Oct 2013 13:41:55 +0200 Subject: [PATCH 02/20] [IMP] make qweb into an openerp object also attempt to improve/simplify a few implementation details bzr revid: xmo@openerp.com-20131004114155-j2639jx6dwvkz3hh --- openerp/addons/base/ir/__init__.py | 1 + .../qweb.py => addons/base/ir/ir_qweb.py} | 98 +++++++++++-------- openerp/addons/base/ir/ir_ui_view.py | 13 ++- openerp/tests/test_qweb.py | 4 +- 4 files changed, 67 insertions(+), 49 deletions(-) rename openerp/{tools/qweb.py => addons/base/ir/ir_qweb.py} (84%) diff --git a/openerp/addons/base/ir/__init__.py b/openerp/addons/base/ir/__init__.py index c6034e0f7ee..ca2786ef0ee 100644 --- a/openerp/addons/base/ir/__init__.py +++ b/openerp/addons/base/ir/__init__.py @@ -39,6 +39,7 @@ import ir_config_parameter import osv_memory_autovacuum import ir_mail_server import ir_fields +import ir_qweb # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: diff --git a/openerp/tools/qweb.py b/openerp/addons/base/ir/ir_qweb.py similarity index 84% rename from openerp/tools/qweb.py rename to openerp/addons/base/ir/ir_qweb.py index a448cb0f1a6..ab5bb0673a9 100644 --- a/openerp/tools/qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -1,8 +1,8 @@ +# -*- coding: utf-8 -*- import logging import re import werkzeug.utils -#from openerp.tools.safe_eval import safe_eval as eval import xml # FIXME use lxml import traceback @@ -32,7 +32,8 @@ BUILTINS = { } class QWebContext(dict): - def __init__(self, data, undefined_handler=None): + def __init__(self, data, undefined_handler=None, loader=None): + self.loader = loader self.undefined_handler = undefined_handler dic = BUILTINS.copy() dic.update(data) @@ -47,7 +48,15 @@ class QWebContext(dict): else: return self.get(key, self.undefined_handler(key, self)) -class QWebXml(object): + def copy(self): + return QWebContext(dict.copy(self), + undefined_handler=self.undefined_handler, + loader=self.loader) + + def __copy__(self): + return self.copy() + +class QWeb(orm.AbstractModel): """QWeb Xml templating engine The templating engine use a very simple syntax, "magic" xml attributes, to @@ -63,48 +72,61 @@ class QWebXml(object): """ - def __init__(self, loader=None, undefined_handler=None): - self.loader = loader - self.undefined_handler = undefined_handler - self.node = xml.dom.Node - self._t = {} - self._render_tag = {} - self._format_regex = re.compile('(#\{(.*?)\})|(\{\{(.*?)\}\})') - self._void_elements = set(['area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen', - 'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr']) - prefix = 'render_tag_' - for i in [j for j in dir(self) if j.startswith(prefix)]: - name = i[len(prefix):].replace('_', '-') - self._render_tag[name] = getattr(self.__class__, i) - self._render_att = {} - prefix = 'render_att_' - for i in [j for j in dir(self) if j.startswith(prefix)]: - name = i[len(prefix):].replace('_', '-') - self._render_att[name] = getattr(self.__class__, i) + _name = 'ir.templating.qweb' + + node = xml.dom.Node + _void_elements = frozenset([ + 'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen', + 'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr']) + _format_regex = re.compile('(#\{(.*?)\})|(\{\{(.*?)\}\})') + + def __init__(self, pool, cr): + super(QWeb, self).__init__(pool, cr) + self._t = {} + + self._render_tag = self.prefixed_methods('render_tag_') + self._render_att = self.prefixed_methods('render_att_') + + def prefixed_methods(self, prefix): + """ Extracts all methods prefixed by ``prefix``, and returns a mapping + of (t-name, method) where the t-name is the method name with prefix + removed and underscore converted to dashes + + :param str prefix: + :return: dict + """ + return dict( + (name[len(prefix):].replace('_', '-'), getattr(type(self), name)) + for name in dir(self) + if name.startswith(prefix)) def register_tag(self, tag, func): self._render_tag[tag] = func - def add_template(self, x): + def load_document(self, x): + """ + Loads an XML document and installs any contained template in the engine + """ if hasattr(x, 'documentElement'): dom = x elif x.startswith(" Date: Fri, 4 Oct 2013 14:52:04 +0200 Subject: [PATCH 03/20] [FIX] let's not reimplement re.sub by hand, shall we? bzr revid: xmo@openerp.com-20131004125204-qgpi7346p1u9amcu --- openerp/addons/base/ir/ir_qweb.py | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index ab5bb0673a9..78b5f401d61 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -79,7 +79,14 @@ class QWeb(orm.AbstractModel): _void_elements = frozenset([ 'area', 'base', 'br', 'col', 'embed', 'hr', 'img', 'input', 'keygen', 'link', 'menuitem', 'meta', 'param', 'source', 'track', 'wbr']) - _format_regex = re.compile('(#\{(.*?)\})|(\{\{(.*?)\}\})') + _format_regex = re.compile( + '(?:' + # ruby-style pattern + '#\{(.+?)\}' + ')|(?:' + # jinja-style pattern + '\{\{(.+?)\}\}' + ')') def __init__(self, pool, cr): super(QWeb, self).__init__(pool, cr) @@ -149,18 +156,17 @@ class QWeb(orm.AbstractModel): return str(val) def eval_format(self, expr, v): - use_native = True - for m in self._format_regex.finditer(expr): - use_native = False - expr = expr.replace(m.group(), self.eval_str(m.groups()[1] or m.groups()[3], v)) + expr, replacements = self._format_regex.subn( + lambda m: self.eval_str(m.group(1) or m.group(2), v), + expr) - if not use_native: + if replacements: return expr - else: - try: - return str(expr % v) - except: - raise Exception("QWeb: format error '%s' " % expr) + + try: + return str(expr % v) + except: + raise Exception("QWeb: format error '%s' " % expr) def eval_bool(self, expr, v): val = self.eval(expr, v) From cd31b4af4db3059587d59d18d98e1e8b9eb36721 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 11:15:56 +0200 Subject: [PATCH 04/20] [IMP] move field conversion around ir.fields architecture turns out not to be a very good or simple fit, especially as different widgets/fields need different granularity of customizations. Having objects dedicated to each field type/widget makes things simpler as it allows a conversion pipeline which can be plugged into at any point. bzr revid: xmo@openerp.com-20131007091556-03azc2mdhcb7kmwo --- openerp/addons/base/ir/ir_fields.py | 71 --------- openerp/addons/base/ir/ir_qweb.py | 149 +++++++++++++++--- openerp/addons/base/ir/ir_ui_view.py | 2 +- .../addons/base/security/ir.model.access.csv | 9 +- .../addons/test_converter/tests/test_html.py | 80 +++++----- openerp/tests/test_qweb.py | 11 +- 6 files changed, 176 insertions(+), 146 deletions(-) diff --git a/openerp/addons/base/ir/ir_fields.py b/openerp/addons/base/ir/ir_fields.py index 49ccf2ce91a..39f7f99b5fa 100644 --- a/openerp/addons/base/ir/ir_fields.py +++ b/openerp/addons/base/ir/ir_fields.py @@ -149,30 +149,6 @@ class ir_fields_converter(orm.Model): return functools.partial( converter, cr, uid, model, column, context=context) - def from_field(self, cr, uid, model, column, totype='str', context=None): - """ Fetches a converter for the provided column object, to the - specified type. - - A converter is a callable taking a value as returned by a read on the - column, and returning a formatted value of type ``totype``. - - By default, tries to get a method on itself with a name matching the - pattern ``_$totype_from_${column._type}`` and returns it. - - Error conditions are similar to :meth:`~.to_field` - - :param column: column object to generate a value from - :param str totype: - :return: a function (column.read_type -> totype) - :rtype: Callable | None - """ - converter = getattr( - self, '_%s_from_%s' % (totype, column._type), None) - if not converter: return None - - return functools.partial( - converter, cr, uid, model, column, context=context) - def _str_to_boolean(self, cr, uid, model, column, value, context=None): # all translatables used for booleans true, yes, false, no = _(u"true"), _(u"yes"), _(u"false"), _(u"no") @@ -460,50 +436,3 @@ class ir_fields_converter(orm.Model): commands.append(CREATE(writable)) return commands, warnings - - def _html_from_passthrough(self, cr, uid, model, column, value, context=None): - """ - escapes the value and returns it directly - """ - return werkzeug.utils.escape(value), [] - - _html_from_char = _html_from_integer = \ - _html_from_date = _html_from_datetime = _html_from_passthrough - - def _html_from_float(self, cr, uid, model, column, value, context=None): - width, precision = column.digits or (None, None) - if precision is None: - fmt = '{value}' - else: - fmt = '{value:.{precision}f}' - - return werkzeug.utils.escape( - fmt.format(value=value, width=width, precision=precision, )), [] - - def _html_from_text(self, cr, uid, model, column, value, context=None): - """ - Escapes the value and converts newlines to br. This is bullshit. - """ - return werkzeug.utils.escape(value).replace('\n', '
\n'), [] - - def _html_from_selection(self, cr, uid, model, column, value, context=None): - selection = dict(openerp.osv.fields.selection.reify( - cr, uid, model, column, context=context)) - return werkzeug.utils.escape(selection[value]), [] - - def _html_from_html(self, cr, uid, model, column, value, context=None): - return value, [] - - def _html_from_many2one(self, cr, uid, model, column, value, context=None): - return werkzeug.utils.escape(value.name_get()[0][1]).replace('\n', '
\n'), [] - - def _html_from_binary(self, cr, uid, model, column, value, context=None): - try: - image = Image.open(cStringIO.StringIO(value.decode('base64'))) - except IOError: - raise ValueError("Non-image binary fields can not be converted to HTML") - try: image.verify() - except: # no idea what "suitable exceptions" are - raise ValueError("Invalid image content") - - return ('' % (Image.MIME[image.format], value)), [] diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 78b5f401d61..8d9bd97adf6 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -1,12 +1,15 @@ # -*- coding: utf-8 -*- +import cStringIO +import json import logging import re +import Image import werkzeug.utils import xml # FIXME use lxml import traceback -from openerp.osv import osv, orm +from openerp.osv import osv, orm, fields _logger = logging.getLogger(__name__) @@ -73,7 +76,7 @@ class QWeb(orm.AbstractModel): """ - _name = 'ir.templating.qweb' + _name = 'ir.qweb' node = xml.dom.Node _void_elements = frozenset([ @@ -364,37 +367,139 @@ class QWeb(orm.AbstractModel): assert node_name != 't',\ "t-field can not be used on a t element, provide an actual HTML node" - record, field = t_att["field"].rsplit('.', 1) + record, field_name = t_att["field"].rsplit('.', 1) record = self.eval_object(record, v) - column = record._model._all_columns[field].column - field_type = column._type + column = record._model._all_columns[field_name].column + options = json.loads(t_att.get('field-options') or '{}') + field_type = get_field_type(column, options) - req = v['request'] - converter = req.registry['ir.fields.converter'].from_field( - req.cr, req.uid, record._model, column, totype='html') + converter = self.pool.get('ir.qweb.field.' + field_type, + self.pool['ir.qweb.field']) + return converter.to_html(record._cr, record._uid, field_name, record, options, + e, t_att, g_att, v) + + +class FieldConverter(osv.AbstractModel): + _name = 'ir.qweb.field' + + def attributes(self, cr, uid, field_name, record, options, + source_element, g_att, t_att, qweb_context): + column = record._model._all_columns[field_name].column + field_type = get_field_type(column, options) + return [ + ('data-oe-model', record._model._name), + ('data-oe-id', record.id), + ('data-oe-field', field_name), + ('data-oe-type', field_type), + ('data-oe-translate', '1' if column.translate else '0'), + ('data-oe-expression', t_att['field']), + ] + + def value_to_html(self, cr, uid, value, column, options=None): + """ Converts a single value to its HTML version/output + """ + return werkzeug.utils.escape(value) + + def record_to_html(self, cr, uid, field_name, record, column, options=None): + """ Converts the specified field of a ``record`` to HTML + """ + return self.value_to_html( + cr, uid, record[field_name], column, options=None) + + def to_html(self, cr, uid, field_name, record, options, + source_element, t_att, g_att, qweb_context): + """ Converts a ``t-field[t-field-options]?`` to its HTML output + """ content = None try: - value = record[field] - if value: - content, warnings = converter(value) - assert not warnings + content = self.record_to_html( + cr, uid, field_name, record, + record._model._all_columns[field_name].column, + options) except KeyError: - _logger.warning("t-field no field %s for model %s", field, record._model._name) + _logger.warning("t-field no field %s for model %s", field_name, record._model._name) g_att += ''.join( ' %s="%s"' % (name, werkzeug.utils.escape(value)) - for name, value in [ - ('data-oe-model', record._model._name), - ('data-oe-id', record.id), - ('data-oe-field', field), - ('data-oe-type', field_type), - ('data-oe-translate', '1' if column.translate else '0'), - ('data-oe-expression', t_att['field']), - ] + for name, value in self.attributes( + cr, uid, field_name, record, options, + source_element, g_att, t_att, qweb_context) ) - return self.render_element(e, t_att, g_att, v, content or "") + return self.render_element(cr, uid, source_element, t_att, g_att, + qweb_context, content) + + def render_element(self, cr, uid, source_element, t_att, g_att, qweb_context, content): + return self.pool['ir.qweb'].render_element( + source_element, t_att, g_att, qweb_context, content or '') + +class FloatConverter(osv.AbstractModel): + _name = 'ir.qweb.field.float' + _inherit = 'ir.qweb.field' + + def value_to_html(self, cr, uid, value, column, options=None): + width, precision = column.digits or (None, None) + fmt = '{value}' if precision is None else '{value:.{precision}f}' + + return werkzeug.utils.escape( + fmt.format(value=value, width=width, precision=precision, )) + +class TextConverter(osv.AbstractModel): + _name = 'ir.qweb.field.text' + _inherit = 'ir.qweb.field' + + def value_to_html(self, cr, uid, value, column, options=None): + """ + Escapes the value and converts newlines to br. This is bullshit. + """ + return werkzeug.utils.escape(value).replace('\n', '
\n') + +class SelectionConverter(osv.AbstractModel): + _name = 'ir.qweb.field.selection' + _inherit = 'ir.qweb.field' + + def record_to_html(self, cr, uid, field_name, record, column, options=None): + # FIXME: context + value = record[field_name] + selection = dict(fields.selection.reify( + cr, uid, record._model, column)) + return self.value_to_html( + cr, uid, selection[value], column, options=options) + +class ManyToOneConverter(osv.AbstractModel): + _name = 'ir.qweb.field.many2one' + _inherit = 'ir.qweb.field' + + def value_to_html(self, cr, uid, value, column, options=None): + return werkzeug.utils.escape(value.name_get()[0][1]).replace('\n', '
\n') + +class HTMLConverter(osv.AbstractModel): + _name = 'ir.qweb.field.html' + _inherit = 'ir.qweb.field' + + def value_to_html(self, cr, uid, value, column, options=None): + return value + +class BinaryConverter(osv.AbstractModel): + _name = 'ir.qweb.field.binary' + _inherit = 'ir.qweb.field' + + def value_to_html(self, cr, uid, value, column, options=None): + try: + image = Image.open(cStringIO.StringIO(value.decode('base64'))) + except IOError: + raise ValueError("Non-image binary fields can not be converted to HTML") + try: image.verify() + except: # no idea what "suitable exceptions" are + raise ValueError("Invalid image content") + + return ('' % (Image.MIME[image.format], value)) + +def get_field_type(column, options): + """ Gets a t-field's effective type from the field's column and its options + """ + return options.get('widget', column._type) # leave this, al. diff --git a/openerp/addons/base/ir/ir_ui_view.py b/openerp/addons/base/ir/ir_ui_view.py index 2e0cd3eb541..3813221c7cf 100644 --- a/openerp/addons/base/ir/ir_ui_view.py +++ b/openerp/addons/base/ir/ir_ui_view.py @@ -771,7 +771,7 @@ class view(osv.osv): def loader(name): return self.read_template(cr, uid, name, context=context) - engine = self.pool['ir.templating.qweb'] + engine = self.pool['ir.qweb'] return engine.render( id_or_xml_id, values, loader=loader, undefined_handler=lambda key, v: None) diff --git a/openerp/addons/base/security/ir.model.access.csv b/openerp/addons/base/security/ir.model.access.csv index 62b68c67aab..8003579b2ae 100644 --- a/openerp/addons/base/security/ir.model.access.csv +++ b/openerp/addons/base/security/ir.model.access.csv @@ -110,4 +110,11 @@ "access_ir_actions_client","ir_actions_client all","model_ir_actions_client",,1,0,0,0 "access_ir_needaction_mixin","ir_needaction_mixin","model_ir_needaction_mixin",,1,1,1,1 "access_res_partner_public","res.partner","base.model_res_partner","base.group_public",1,0,0,0 - +access_ir_qweb,access_ir_qweb,model_ir_qweb,,0,0,0,0 +access_ir_qweb_field,access_ir_qweb_field,model_ir_qweb_field,,0,0,0,0 +access_ir_qweb_field_float,access_ir_qweb_field_float,model_ir_qweb_field_float,,0,0,0,0 +access_ir_qweb_field_text,access_ir_qweb_field_text,model_ir_qweb_field_text,,0,0,0,0 +access_ir_qweb_field_selection,access_ir_qweb_field_selection,model_ir_qweb_field_selection,,0,0,0,0 +access_ir_qweb_field_many2one,access_ir_qweb_field_many2one,model_ir_qweb_field_many2one,,0,0,0,0 +access_ir_qweb_field_html,access_ir_qweb_field_html,model_ir_qweb_field_html,,0,0,0,0 +access_ir_qweb_field_binary,access_ir_qweb_field_binary,model_ir_qweb_field_binary,,0,0,0,0 diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index b4ad5c35679..7f2713b2761 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -1,5 +1,6 @@ # -*- encoding: utf-8 -*- import base64 +import functools import os from openerp.tests import common @@ -9,69 +10,65 @@ directory = os.path.dirname(__file__) class TestHTMLExport(common.TransactionCase): def setUp(self): super(TestHTMLExport, self).setUp() - self.Converter = self.registry('ir.fields.converter') self.Model = self.registry('test_converter.test_model') + self.columns = self.Model._all_columns def get_column(self, name): return self.Model._all_columns[name].column def get_converter(self, name): - return self.Converter.from_field( - self.cr, self.uid, self.Model, self.get_column(name), - totype="html") + column = self.get_column(name) + try: + model = self.registry('ir.qweb.field.' + column._type) + except KeyError: + model = self.registry('ir.qweb.field') + + return lambda value: model.value_to_html( + self.cr, self.uid, value, column) def test_char(self): converter = self.get_converter('char') - value, warnings = converter('foo') + value = converter('foo') self.assertEqual(value, 'foo') - self.assertEqual(warnings, []) - value, warnings = converter("foo") + value = converter("foo") self.assertEqual(value, "foo<bar>") - self.assertEqual(warnings, []) def test_integer(self): converter = self.get_converter('integer') - value, warnings = converter(42) + value = converter(42) self.assertEqual(value, "42") - self.assertEqual(warnings, []) def test_float(self): converter = self.get_converter('float') - value, warnings = converter(42.0) + value = converter(42.0) self.assertEqual(value, "42.0") - self.assertEqual(warnings, []) - value, warnings = converter(42.0100) + value = converter(42.0100) self.assertEqual(value, "42.01") - self.assertEqual(warnings, []) - value, warnings = converter(42.01234) + value = converter(42.01234) self.assertEqual(value, "42.01234") - self.assertEqual(warnings, []) def test_numeric(self): converter = self.get_converter('numeric') - value, warnings = converter(42.0) + value = converter(42.0) self.assertEqual(value, '42.00') - self.assertEqual(warnings, []) - value, warnings = converter(42.01234) + value = converter(42.01234) self.assertEqual(value, '42.01') - self.assertEqual(warnings, []) def test_text(self): converter = self.get_converter('text') - value, warnings = converter("This is my text-kai") + value = converter("This is my text-kai") self.assertEqual(value, "This is my text-kai") - self.assertEqual(warnings, []) - value, warnings = converter(""" + value = converter(""" . The current line (address) in the buffer. $ The last line in the buffer. n The nth, line in the buffer where n is a number in the range [0,$]. @@ -89,9 +86,8 @@ class TestHTMLExport(common.TransactionCase): -n The nth previous line, where n is a non-negative number.
+ The next line. This is equivalent to +1 and may be repeated with cumulative effect.
""") - self.assertEqual(warnings, []) - value, warnings = converter(""" + value = converter(""" fgdkls;hjas;lj fdslkj d;lasjfa lkdja lfks fldkjsfhs fldskjh """) @@ -99,33 +95,29 @@ class TestHTMLExport(common.TransactionCase): fgdkls;hjas;lj <b>fdslkj</b> d;lasjfa lkdja <a href=http://spam.com>lfks</a>
fldkjsfhs <i style="color: red"><a href="http://spamspam.com">fldskjh</a></i>
""") - self.assertEqual(warnings, []) def test_many2one(self): converter = self.get_converter('many2one') Sub = self.registry('test_converter.test_model.sub') id0 = Sub.create(self.cr, self.uid, {'name': "Foo"}) - value, warnings = converter(Sub.browse(self.cr, self.uid, id0)) + value = converter(Sub.browse(self.cr, self.uid, id0)) self.assertEqual(value, "Foo") - self.assertEqual(warnings, []) id1 = Sub.create(self.cr, self.uid, {'name': "Foo"}) - value, warnings = converter(Sub.browse(self.cr, self.uid, id1)) + value = converter(Sub.browse(self.cr, self.uid, id1)) self.assertEqual(value, "Fo<b>o</b>") - self.assertEqual(warnings, []) def test_binary(self): converter = self.get_converter('binary') with open(os.path.join(directory, 'test_vectors', 'image'), 'rb') as f: content = f.read() - value, warnings = converter(content.encode('base64')) + value = converter(content.encode('base64')) self.assertEqual( value, '' % ( content.encode('base64') )) - self.assertEqual(warnings, []) with open(os.path.join(directory, 'test_vectors', 'pdf'), 'rb') as f: content = f.read() @@ -140,24 +132,30 @@ class TestHTMLExport(common.TransactionCase): converter(content.encode('base64')) def test_selection(self): - converter = self.get_converter('selection') + [record] = self.Model.browse(self.cr, self.uid, [self.Model.create(self.cr, self.uid, { + 'selection': 2, + 'selection_str': 'C', + })]) - value, warnings = converter(2) + column_name = 'selection' + column = self.get_column(column_name) + converter = self.registry('ir.qweb.field.selection') + + value = converter.record_to_html( + self.cr, self.uid, column_name, record, column) self.assertEqual(value, "réponse B") - self.assertEqual(warnings, []) - converter = self.get_converter('selection_str') - - value, warnings = converter('C') + column_name = 'selection_str' + column = self.get_column(column_name) + value = converter.record_to_html( + self.cr, self.uid, column_name, record, column) self.assertEqual(value, "Qu'est-ce qu'il fout ce maudit pancake, tabernacle ?") - self.assertEqual(warnings, []) def test_html(self): converter = self.get_converter('html') input = 'span' - value, warnings = converter(input) + value = converter(input) self.assertEqual(value, input) - self.assertEqual(warnings, []) # o2m, m2m? # reference? diff --git a/openerp/tests/test_qweb.py b/openerp/tests/test_qweb.py index f38aa3dd875..17e47dc6096 100644 --- a/openerp/tests/test_qweb.py +++ b/openerp/tests/test_qweb.py @@ -8,17 +8,10 @@ import common impl = dom.getDOMImplementation() document = impl.createDocument(None, None, None) -Request = namedtuple('Request', 'cr uid registry') -class RegistryProxy(object): - def __init__(self, func): - self.func = func - def __getitem__(self, name): - return self.func(name) - class TestQWebTField(common.TransactionCase): def setUp(self): super(TestQWebTField, self).setUp() - self.engine = self.registry('ir.templating.qweb') + self.engine = self.registry('ir.qweb') def test_trivial(self): field = document.createElement('span') @@ -32,7 +25,6 @@ class TestQWebTField(common.TransactionCase): result = self.engine.render_node(field, { 'company': root_company, - 'request': Request(self.cr, self.uid, RegistryProxy(self.registry)) }) self.assertEqual( @@ -57,7 +49,6 @@ class TestQWebTField(common.TransactionCase): result = self.engine.render_node(field, { 'company': root_company, - 'request': Request(self.cr, self.uid, RegistryProxy(self.registry)) }) self.assertEqual( result, From 7a8ea1eb7580eee31a0a1b09837813c32cd32404 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 13:31:33 +0200 Subject: [PATCH 05/20] [IMP] move image serialization to image widget, not all binary fields bzr revid: xmo@openerp.com-20131007113133-y0xcj0tgp8ionrzo --- openerp/addons/base/ir/ir_qweb.py | 8 +++--- .../addons/base/security/ir.model.access.csv | 2 +- .../addons/test_converter/tests/test_html.py | 27 +++++++++++-------- 3 files changed, 21 insertions(+), 16 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 8d9bd97adf6..39a7bb804b1 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -482,20 +482,20 @@ class HTMLConverter(osv.AbstractModel): def value_to_html(self, cr, uid, value, column, options=None): return value -class BinaryConverter(osv.AbstractModel): - _name = 'ir.qweb.field.binary' +class ImageConverter(osv.AbstractModel): + _name = 'ir.qweb.field.image' _inherit = 'ir.qweb.field' def value_to_html(self, cr, uid, value, column, options=None): try: image = Image.open(cStringIO.StringIO(value.decode('base64'))) + image.verify() except IOError: raise ValueError("Non-image binary fields can not be converted to HTML") - try: image.verify() except: # no idea what "suitable exceptions" are raise ValueError("Invalid image content") - return ('' % (Image.MIME[image.format], value)) + return '' % (Image.MIME[image.format], value) def get_field_type(column, options): """ Gets a t-field's effective type from the field's column and its options diff --git a/openerp/addons/base/security/ir.model.access.csv b/openerp/addons/base/security/ir.model.access.csv index 8003579b2ae..dcb56f93f7c 100644 --- a/openerp/addons/base/security/ir.model.access.csv +++ b/openerp/addons/base/security/ir.model.access.csv @@ -117,4 +117,4 @@ access_ir_qweb_field_text,access_ir_qweb_field_text,model_ir_qweb_field_text,,0, access_ir_qweb_field_selection,access_ir_qweb_field_selection,model_ir_qweb_field_selection,,0,0,0,0 access_ir_qweb_field_many2one,access_ir_qweb_field_many2one,model_ir_qweb_field_many2one,,0,0,0,0 access_ir_qweb_field_html,access_ir_qweb_field_html,model_ir_qweb_field_html,,0,0,0,0 -access_ir_qweb_field_binary,access_ir_qweb_field_binary,model_ir_qweb_field_binary,,0,0,0,0 +access_ir_qweb_field_image,access_ir_qweb_field_image,model_ir_qweb_field_image,,0,0,0,0 diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 7f2713b2761..342864df044 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -108,28 +108,33 @@ class TestHTMLExport(common.TransactionCase): value = converter(Sub.browse(self.cr, self.uid, id1)) self.assertEqual(value, "Fo<b>o</b>") - def test_binary(self): - converter = self.get_converter('binary') + def test_image(self): + column = self.get_column('binary') + converter = self.registry('ir.qweb.field.image') + with open(os.path.join(directory, 'test_vectors', 'image'), 'rb') as f: content = f.read() - value = converter(content.encode('base64')) - self.assertEqual( - value, '' % ( - content.encode('base64') - )) + value = converter.value_to_html( + self.cr, self.uid, content.encode('base64'), column) + self.assertEqual( + value, '' % ( + content.encode('base64') + )) with open(os.path.join(directory, 'test_vectors', 'pdf'), 'rb') as f: content = f.read() - with self.assertRaises(ValueError): - converter(content.encode('base64')) + with self.assertRaises(ValueError): + converter.value_to_html( + self.cr, self.uid, 'binary', content.encode('base64'), column) with open(os.path.join(directory, 'test_vectors', 'pptx'), 'rb') as f: content = f.read() - with self.assertRaises(ValueError): - converter(content.encode('base64')) + with self.assertRaises(ValueError): + converter.value_to_html( + self.cr, self.uid, 'binary', content.encode('base64'), column) def test_selection(self): [record] = self.Model.browse(self.cr, self.uid, [self.Model.create(self.cr, self.uid, { From a30a4640c2f52e8f8639955a1438a7e13311589d Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 14:51:55 +0200 Subject: [PATCH 06/20] [IMP] add some docstrings, split out fetching the converter model in ir.qweb in its own method This way, it's possible to inherit from ir.qweb and override converter discovery bzr revid: xmo@openerp.com-20131007125155-5j0xeov213sz4ccq --- openerp/addons/base/ir/ir_qweb.py | 59 +++++++++++++++++-- .../addons/test_converter/tests/test_html.py | 5 +- 2 files changed, 56 insertions(+), 8 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 39a7bb804b1..38c65aa9838 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -374,18 +374,48 @@ class QWeb(orm.AbstractModel): options = json.loads(t_att.get('field-options') or '{}') field_type = get_field_type(column, options) - converter = self.pool.get('ir.qweb.field.' + field_type, - self.pool['ir.qweb.field']) + converter = self.get_converter_for(field_type) return converter.to_html(record._cr, record._uid, field_name, record, options, e, t_att, g_att, v) + def get_converter_for(self, field_type): + return self.pool.get('ir.qweb.field.' + field_type, + self.pool['ir.qweb.field']) + class FieldConverter(osv.AbstractModel): + """ Used to convert a t-field specification into an output HTML field. + + :meth:`~.to_html` is the entry point of this conversion from QWeb, it: + + * converts the record value to html using :meth:`~.record_to_html` + * generates the metadata attributes (``data-oe-``) to set on the root + result node + * generates the root result node itself through :meth:`~.render_element` + """ _name = 'ir.qweb.field' def attributes(self, cr, uid, field_name, record, options, source_element, g_att, t_att, qweb_context): + """ + Generates the metadata attributes (prefixed by ``data-oe-`` for the + root node of the field conversion. Attribute values are escaped by the + parent using ``werkzeug.utils.escape``. + + The default attributes are: + + * ``model``, the name of the record's model + * ``id`` the id of the record to which the field belongs + * ``field`` the name of the converted field + * ``type`` the logical field type (widget, may not match the column's + ``type``, may not be any _column subclass name) + * ``translate``, a boolean flag (``0`` or ``1``) denoting whether the + column is translatable + * ``expression``, the original expression + + :returns: iterable of (attribute name, attribute value) pairs. + """ column = record._model._all_columns[field_name].column field_type = get_field_type(column, options) return [ @@ -403,14 +433,20 @@ class FieldConverter(osv.AbstractModel): return werkzeug.utils.escape(value) def record_to_html(self, cr, uid, field_name, record, column, options=None): - """ Converts the specified field of a ``record`` to HTML + """ Converts the specified field of the browse_record ``record`` to + HTML """ return self.value_to_html( cr, uid, record[field_name], column, options=None) def to_html(self, cr, uid, field_name, record, options, source_element, t_att, g_att, qweb_context): - """ Converts a ``t-field[t-field-options]?`` to its HTML output + """ Converts a ``t-field`` to its HTML output. A ``t-field`` may be + extended by a ``t-field-options``, which is a JSON-serialized mapping + of configuration values. + + A default configuration key is ``widget`` which can override the + field's own ``_type``. """ content = None try: @@ -431,7 +467,10 @@ class FieldConverter(osv.AbstractModel): return self.render_element(cr, uid, source_element, t_att, g_att, qweb_context, content) - def render_element(self, cr, uid, source_element, t_att, g_att, qweb_context, content): + def render_element(self, cr, uid, source_element, t_att, g_att, + qweb_context, content): + """ Final rendering hook, by default just calls ir.qweb's ``render_element`` + """ return self.pool['ir.qweb'].render_element( source_element, t_att, g_att, qweb_context, content or '') @@ -483,6 +522,14 @@ class HTMLConverter(osv.AbstractModel): return value class ImageConverter(osv.AbstractModel): + """ ``image`` widget rendering, inserts a data:uri-using image tag in the + document. May be overridden by e.g. the website module to generate links + instead. + + .. todo:: what happens if different output need different converters? e.g. + reports may need embedded images or FS links whereas website + needs website-aware + """ _name = 'ir.qweb.field.image' _inherit = 'ir.qweb.field' @@ -492,7 +539,7 @@ class ImageConverter(osv.AbstractModel): image.verify() except IOError: raise ValueError("Non-image binary fields can not be converted to HTML") - except: # no idea what "suitable exceptions" are + except: # image.verify() throws "suitable exceptions", I have no idea what they are raise ValueError("Invalid image content") return '' % (Image.MIME[image.format], value) diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 342864df044..a80cbb61748 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -115,11 +115,12 @@ class TestHTMLExport(common.TransactionCase): with open(os.path.join(directory, 'test_vectors', 'image'), 'rb') as f: content = f.read() + encoded_content = content.encode('base64') value = converter.value_to_html( - self.cr, self.uid, content.encode('base64'), column) + self.cr, self.uid, encoded_content, column) self.assertEqual( value, '' % ( - content.encode('base64') + encoded_content )) with open(os.path.join(directory, 'test_vectors', 'pdf'), 'rb') as f: From 5ca6feb3fb4076a701ecafbe2a77ed20ffb331ac Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 15:25:54 +0200 Subject: [PATCH 07/20] [IMP] split out HTML export tests into a bunch of classes bzr revid: xmo@openerp.com-20131007132554-4vq2u80zhst8n1ei --- openerp/tests/addons/test_converter/models.py | 1 + .../addons/test_converter/tests/test_html.py | 26 ++++++++++++++----- 2 files changed, 20 insertions(+), 7 deletions(-) diff --git a/openerp/tests/addons/test_converter/models.py b/openerp/tests/addons/test_converter/models.py index 9be3c9d675e..99f32a5aa91 100644 --- a/openerp/tests/addons/test_converter/models.py +++ b/openerp/tests/addons/test_converter/models.py @@ -36,3 +36,4 @@ class test_model_sub(orm.Model): _columns = { 'name': fields.char() } + diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index a80cbb61748..5874fa7e9a5 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -1,16 +1,17 @@ # -*- encoding: utf-8 -*- -import base64 -import functools import os from openerp.tests import common directory = os.path.dirname(__file__) -class TestHTMLExport(common.TransactionCase): + +class TestExport(common.TransactionCase): + _model = None + def setUp(self): - super(TestHTMLExport, self).setUp() - self.Model = self.registry('test_converter.test_model') + super(TestExport, self).setUp() + self.Model = self.registry(self._model) self.columns = self.Model._all_columns def get_column(self, name): @@ -26,6 +27,10 @@ class TestHTMLExport(common.TransactionCase): return lambda value: model.value_to_html( self.cr, self.uid, value, column) +class TestBasicExport(TestExport): + _model = 'test_converter.test_model' + +class TestCharExport(TestBasicExport): def test_char(self): converter = self.get_converter('char') @@ -35,12 +40,14 @@ class TestHTMLExport(common.TransactionCase): value = converter("foo") self.assertEqual(value, "foo<bar>") +class TestIntegerExport(TestBasicExport): def test_integer(self): converter = self.get_converter('integer') value = converter(42) self.assertEqual(value, "42") +class TestFloatExport(TestBasicExport): def test_float(self): converter = self.get_converter('float') @@ -62,6 +69,7 @@ class TestHTMLExport(common.TransactionCase): value = converter(42.01234) self.assertEqual(value, '42.01') +class TestTextExport(TestBasicExport): def test_text(self): converter = self.get_converter('text') @@ -96,6 +104,7 @@ class TestHTMLExport(common.TransactionCase): fldkjsfhs <i style="color: red"><a href="http://spamspam.com">fldskjh</a></i>
""") +class TestMany2OneExport(TestBasicExport): def test_many2one(self): converter = self.get_converter('many2one') Sub = self.registry('test_converter.test_model.sub') @@ -108,6 +117,7 @@ class TestHTMLExport(common.TransactionCase): value = converter(Sub.browse(self.cr, self.uid, id1)) self.assertEqual(value, "Fo<b>o</b>") +class TestBinaryExport(TestBasicExport): def test_image(self): column = self.get_column('binary') converter = self.registry('ir.qweb.field.image') @@ -137,6 +147,7 @@ class TestHTMLExport(common.TransactionCase): converter.value_to_html( self.cr, self.uid, 'binary', content.encode('base64'), column) +class TestSelectionExport(TestBasicExport): def test_selection(self): [record] = self.Model.browse(self.cr, self.uid, [self.Model.create(self.cr, self.uid, { 'selection': 2, @@ -157,11 +168,12 @@ class TestHTMLExport(common.TransactionCase): self.cr, self.uid, column_name, record, column) self.assertEqual(value, "Qu'est-ce qu'il fout ce maudit pancake, tabernacle ?") +class TestHTMLExport(TestBasicExport): def test_html(self): converter = self.get_converter('html') input = 'span' value = converter(input) self.assertEqual(value, input) - # o2m, m2m? - # reference? +# o2m, m2m? +# reference? From 727b0e27c58734b899baf186eba7e73cec4274ba Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 16:53:46 +0200 Subject: [PATCH 08/20] [ADD] currency qweb field widget, postfix currency bzr revid: xmo@openerp.com-20131007145346-a3hlb6xjdwroyvzb --- openerp/addons/base/ir/ir_qweb.py | 14 ++++++ .../addons/test_converter/ir.model.access.csv | 1 + openerp/tests/addons/test_converter/models.py | 8 ++++ .../addons/test_converter/tests/test_html.py | 45 +++++++++++++++++++ 4 files changed, 68 insertions(+) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 38c65aa9838..4c9c20e348d 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -544,6 +544,20 @@ class ImageConverter(osv.AbstractModel): return '' % (Image.MIME[image.format], value) +class CurrencyConverter(osv.AbstractModel): + """ ``currency`` converter, has a mandatory option ``currency``. + + The currency field is a (float) value, the linked ``currency`` is an m2o + to a ``res.currency`` indicating how to format the field. + """ + _name = 'ir.qweb.field.currency' + _inherit = 'ir.qweb.field' + + def record_to_html(self, cr, uid, field_name, record, column, options): + return u'{0} {1}'.format( + record[field_name], + record[options['currency']].symbol) + def get_field_type(column, options): """ Gets a t-field's effective type from the field's column and its options """ diff --git a/openerp/tests/addons/test_converter/ir.model.access.csv b/openerp/tests/addons/test_converter/ir.model.access.csv index 66937821c94..137589d79fa 100644 --- a/openerp/tests/addons/test_converter/ir.model.access.csv +++ b/openerp/tests/addons/test_converter/ir.model.access.csv @@ -1,3 +1,4 @@ id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink access_converter_model,access_converter_model,model_test_converter_test_model,,1,1,1,1 access_test_converter_test_model_sub,access_test_converter_test_model_sub,model_test_converter_test_model_sub,,1,1,1,1 +access_test_converter_currency,access_test_converter_currency,model_test_converter_currency,,1,1,1,1 diff --git a/openerp/tests/addons/test_converter/models.py b/openerp/tests/addons/test_converter/models.py index 99f32a5aa91..4e1e0c62e38 100644 --- a/openerp/tests/addons/test_converter/models.py +++ b/openerp/tests/addons/test_converter/models.py @@ -37,3 +37,11 @@ class test_model_sub(orm.Model): 'name': fields.char() } + +class test_model_currency(orm.Model): + _name = 'test_converter.currency' + + _columns = { + 'value': fields.float(digits=(16, 55)), + 'currency_id': fields.many2one('res.currency'), + } diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 5874fa7e9a5..641aed5529a 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -1,10 +1,14 @@ # -*- encoding: utf-8 -*- +import json import os +import xml.dom.minidom from openerp.tests import common directory = os.path.dirname(__file__) +impl = xml.dom.minidom.getDOMImplementation() +doc = impl.createDocument(None, None, None) class TestExport(common.TransactionCase): _model = None @@ -69,6 +73,46 @@ class TestFloatExport(TestBasicExport): value = converter(42.01234) self.assertEqual(value, '42.01') +class TestCurrencyExport(TestExport): + _model = 'test_converter.currency' + + def setUp(self): + super(TestCurrencyExport, self).setUp() + self.Currency = self.registry('res.currency') + + def create(self, model, context=None, **values): + return model.browse( + self.cr, self.uid, + model.create(self.cr, self.uid, values, context=context), + context=context) + + def convert(self, obj): + converter = self.registry('ir.qweb.field.currency') + options = {'widget': 'currency', 'currency': 'currency_id'} + converted = converter.to_html( + self.cr, self.uid, 'value', obj, options, + doc.createElement('span'), + {'field': 'obj.value', 'field-options': json.dumps(options)}, + '', {'obj': obj}) + return converted + + def test_currency_post(self): + currency = self.create(self.Currency, name="Test", symbol=u"test") + obj = self.create(self.Model, value=0.12, currency_id=currency.id) + + converted = self.convert(obj) + + self.assertEqual( + converted, + '' + '0.12 ' + '{symbol}'.format( + obj=obj, + symbol=currency.symbol.encode('utf-8') + ),) + class TestTextExport(TestBasicExport): def test_text(self): converter = self.get_converter('text') @@ -175,5 +219,6 @@ class TestHTMLExport(TestBasicExport): input = 'span' value = converter(input) self.assertEqual(value, input) + # o2m, m2m? # reference? From a6e49518868fa8f205d2b7ad2113a7f9c4d67f89 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 7 Oct 2013 17:03:30 +0200 Subject: [PATCH 09/20] [ADD] currency prefix symbol bzr revid: xmo@openerp.com-20131007150330-sys0320gaui2crtt --- openerp/addons/base/ir/ir_qweb.py | 18 +++++++++++++-- .../addons/test_converter/tests/test_html.py | 23 +++++++++++++++++-- 2 files changed, 37 insertions(+), 4 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 4c9c20e348d..cb5e741b409 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -554,9 +554,23 @@ class CurrencyConverter(osv.AbstractModel): _inherit = 'ir.qweb.field' def record_to_html(self, cr, uid, field_name, record, column, options): - return u'{0} {1}'.format( + symbol_pre = symbol_post = space_pre = space_post = u'' + currency = record[options['currency']] + if currency.position == 'before': + space_pre = u' ' + symbol_pre = currency.symbol + else: + space_post = u' ' + symbol_post = currency.symbol + + return u'{symbol_pre}{space_pre}' \ + u'{0}' \ + u'{space_post}{symbol_post}'.format( record[field_name], - record[options['currency']].symbol) + space_pre=space_pre, + symbol_pre=symbol_pre, + space_post=space_post, + symbol_post=symbol_post,) def get_field_type(column, options): """ Gets a t-field's effective type from the field's column and its options diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 641aed5529a..f36333487f7 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -107,8 +107,27 @@ class TestCurrencyExport(TestExport): '' - '0.12 ' - '{symbol}'.format( + '0.12' + ' {symbol}'.format( + obj=obj, + symbol=currency.symbol.encode('utf-8') + ),) + + def test_currency_pre(self): + currency = self.create( + self.Currency, name="Test", symbol=u"test", position='before') + obj = self.create(self.Model, value=0.12, currency_id=currency.id) + + converted = self.convert(obj) + + self.assertEqual( + converted, + '' + '{symbol} ' + '0.12' + ''.format( obj=obj, symbol=currency.symbol.encode('utf-8') ),) From 47fc0a1093f349eed491db7cb3ced2ef1252c094 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 08:42:26 +0200 Subject: [PATCH 10/20] [ADD] apply currency's rounding to currency widget values bzr revid: xmo@openerp.com-20131008064226-ry22z6w23d88szr8 --- openerp/addons/base/ir/ir_qweb.py | 4 +++- .../addons/test_converter/tests/test_html.py | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index cb5e741b409..609f527d7dc 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -554,6 +554,8 @@ class CurrencyConverter(osv.AbstractModel): _inherit = 'ir.qweb.field' def record_to_html(self, cr, uid, field_name, record, column, options): + Currency = self.pool['res.currency'] + symbol_pre = symbol_post = space_pre = space_post = u'' currency = record[options['currency']] if currency.position == 'before': @@ -566,7 +568,7 @@ class CurrencyConverter(osv.AbstractModel): return u'{symbol_pre}{space_pre}' \ u'{0}' \ u'{space_post}{symbol_post}'.format( - record[field_name], + Currency.round(cr, uid, currency, record[field_name]), space_pre=space_pre, symbol_pre=symbol_pre, space_post=space_post, diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index f36333487f7..026cfae7f3c 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -132,6 +132,25 @@ class TestCurrencyExport(TestExport): symbol=currency.symbol.encode('utf-8') ),) + def test_currency_precision(self): + """ Precision should be the currency's, not the float field's + """ + currency = self.create(self.Currency, name="Test", symbol=u"test",) + obj = self.create(self.Model, value=0.1234567, currency_id=currency.id) + + converted = self.convert(obj) + + self.assertEqual( + converted, + '' + '0.12' + ' {symbol}'.format( + obj=obj, + symbol=currency.symbol.encode('utf-8') + ),) + class TestTextExport(TestBasicExport): def test_text(self): converter = self.get_converter('text') From 5e1c17a3a77f6f7d47d5ef389b0a804a7c6b1f87 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 09:07:42 +0200 Subject: [PATCH 11/20] [ADD] docstring about qweb usage bzr revid: xmo@openerp.com-20131008070742-4k1egtvmdvz3pv6e --- openerp/addons/base/ir/ir_qweb.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 609f527d7dc..f9b960852f0 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -73,7 +73,18 @@ class QWeb(orm.AbstractModel): - loader: function that return a template + QWeb rendering can be used for many tasks. As a result, customizations + made by one task context (to either the main qweb rendering or to specific + fields rendering) could break other tasks. + To avoid that, ``ir.qweb`` was consciously made inheritable and the "root" + of an object hierarchy. If you need extensions or alterations which could + be incompatible with other subsystems, you should create a local object + inheriting from ``ir.qweb`` and customize that. + + If you need to customize t-fields rendering, subclass the ir.qweb.field + model (and its sub-models) then override :meth:`~.get_converter_for` to + fetch the right field converters for your qweb model. """ _name = 'ir.qweb' From e29028ea0e2db98ae93d13cf8c3658a4a58c3c4f Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 10:25:43 +0200 Subject: [PATCH 12/20] [ADD] missing access rule thing bzr revid: xmo@openerp.com-20131008082543-pzpknr48xfdbxxna --- openerp/addons/base/security/ir.model.access.csv | 1 + 1 file changed, 1 insertion(+) diff --git a/openerp/addons/base/security/ir.model.access.csv b/openerp/addons/base/security/ir.model.access.csv index dcb56f93f7c..53853d253e1 100644 --- a/openerp/addons/base/security/ir.model.access.csv +++ b/openerp/addons/base/security/ir.model.access.csv @@ -118,3 +118,4 @@ access_ir_qweb_field_selection,access_ir_qweb_field_selection,model_ir_qweb_fiel access_ir_qweb_field_many2one,access_ir_qweb_field_many2one,model_ir_qweb_field_many2one,,0,0,0,0 access_ir_qweb_field_html,access_ir_qweb_field_html,model_ir_qweb_field_html,,0,0,0,0 access_ir_qweb_field_image,access_ir_qweb_field_image,model_ir_qweb_field_image,,0,0,0,0 +access_ir_qweb_field_currency,access_ir_qweb_field_currency,model_ir_qweb_field_currency,,0,0,0,0 From d414f8c7cfdaea98430d552f5213ca2f22f0ab38 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 10:25:55 +0200 Subject: [PATCH 13/20] [IMP] make view rendering engine kinda sorta pluggable bzr revid: xmo@openerp.com-20131008082555-l8b2mu8ny8ouf5n5 --- openerp/addons/base/ir/ir_ui_view.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/openerp/addons/base/ir/ir_ui_view.py b/openerp/addons/base/ir/ir_ui_view.py index bfcb1a5bf64..f9bd5458bf6 100644 --- a/openerp/addons/base/ir/ir_ui_view.py +++ b/openerp/addons/base/ir/ir_ui_view.py @@ -765,14 +765,13 @@ class view(osv.osv): self.translate_qweb(cr, uid, id_, node, lang, context) return arch - def render(self, cr, uid, id_or_xml_id, values, context=None): + def render(self, cr, uid, id_or_xml_id, values, engine='ir.qweb', context=None): if not context: context = {} def loader(name): return self.read_template(cr, uid, name, context=context) - engine = self.pool['ir.qweb'] - return engine.render( + return self.pool[engine].render( id_or_xml_id, values, loader=loader, undefined_handler=lambda key, v: None) From 273f62bc785658ec72ce54f13b5c032d47b34785 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 11:22:07 +0200 Subject: [PATCH 14/20] [IMP] move translate flag out of base qweb rendering bzr revid: xmo@openerp.com-20131008092207-m27ox8pebl36a45p --- openerp/addons/base/ir/ir_qweb.py | 1 - openerp/tests/addons/test_converter/tests/test_html.py | 6 +++--- openerp/tests/test_qweb.py | 2 -- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index f9b960852f0..ac15f9ff56b 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -434,7 +434,6 @@ class FieldConverter(osv.AbstractModel): ('data-oe-id', record.id), ('data-oe-field', field_name), ('data-oe-type', field_type), - ('data-oe-translate', '1' if column.translate else '0'), ('data-oe-expression', t_att['field']), ] diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 026cfae7f3c..20f55986ffe 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -106,7 +106,7 @@ class TestCurrencyExport(TestExport): converted, '' + 'data-oe-expression="obj.value">' '0.12' ' {symbol}'.format( obj=obj, @@ -124,7 +124,7 @@ class TestCurrencyExport(TestExport): converted, '' + 'data-oe-expression="obj.value">' '{symbol} ' '0.12' ''.format( @@ -144,7 +144,7 @@ class TestCurrencyExport(TestExport): converted, '' + 'data-oe-expression="obj.value">' '0.12' ' {symbol}'.format( obj=obj, diff --git a/openerp/tests/test_qweb.py b/openerp/tests/test_qweb.py index 17e47dc6096..3bdff5e63d0 100644 --- a/openerp/tests/test_qweb.py +++ b/openerp/tests/test_qweb.py @@ -31,7 +31,6 @@ class TestQWebTField(common.TransactionCase): result, '%s' % ( company_id, "My Test Company",)) @@ -54,7 +53,6 @@ class TestQWebTField(common.TransactionCase): result, '%s' % ( company_id, cgi.escape(s.encode('utf-8')),)) From ef848653afba19649545fa3e19f222e9f5dd3076 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Tue, 8 Oct 2013 14:20:06 +0200 Subject: [PATCH 15/20] [FIX] rename currency widget to monetary to match views bzr revid: xmo@openerp.com-20131008122006-k7xjv2lkd0t7lza7 --- openerp/addons/base/ir/ir_qweb.py | 12 ++++++------ openerp/addons/base/security/ir.model.access.csv | 2 +- .../tests/addons/test_converter/ir.model.access.csv | 2 +- openerp/tests/addons/test_converter/models.py | 4 ++-- .../tests/addons/test_converter/tests/test_html.py | 12 ++++++------ 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index ac15f9ff56b..9405b5086ca 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -554,20 +554,20 @@ class ImageConverter(osv.AbstractModel): return '' % (Image.MIME[image.format], value) -class CurrencyConverter(osv.AbstractModel): - """ ``currency`` converter, has a mandatory option ``currency``. +class MonetaryConverter(osv.AbstractModel): + """ ``monetary`` converter, has a mandatory option ``currency_field``. - The currency field is a (float) value, the linked ``currency`` is an m2o - to a ``res.currency`` indicating how to format the field. + The currency field is a (float) value, the linked ``currency_field`` is an + m2o to a ``res.currency`` indicating how to format the field. """ - _name = 'ir.qweb.field.currency' + _name = 'ir.qweb.field.monetary' _inherit = 'ir.qweb.field' def record_to_html(self, cr, uid, field_name, record, column, options): Currency = self.pool['res.currency'] symbol_pre = symbol_post = space_pre = space_post = u'' - currency = record[options['currency']] + currency = record[options['currency_field']] if currency.position == 'before': space_pre = u' ' symbol_pre = currency.symbol diff --git a/openerp/addons/base/security/ir.model.access.csv b/openerp/addons/base/security/ir.model.access.csv index 53853d253e1..2bdb17f7db7 100644 --- a/openerp/addons/base/security/ir.model.access.csv +++ b/openerp/addons/base/security/ir.model.access.csv @@ -118,4 +118,4 @@ access_ir_qweb_field_selection,access_ir_qweb_field_selection,model_ir_qweb_fiel access_ir_qweb_field_many2one,access_ir_qweb_field_many2one,model_ir_qweb_field_many2one,,0,0,0,0 access_ir_qweb_field_html,access_ir_qweb_field_html,model_ir_qweb_field_html,,0,0,0,0 access_ir_qweb_field_image,access_ir_qweb_field_image,model_ir_qweb_field_image,,0,0,0,0 -access_ir_qweb_field_currency,access_ir_qweb_field_currency,model_ir_qweb_field_currency,,0,0,0,0 +access_ir_qweb_field_monetary,access_ir_qweb_field_monetary,model_ir_qweb_field_monetary,,0,0,0,0 diff --git a/openerp/tests/addons/test_converter/ir.model.access.csv b/openerp/tests/addons/test_converter/ir.model.access.csv index 137589d79fa..ff4ac975996 100644 --- a/openerp/tests/addons/test_converter/ir.model.access.csv +++ b/openerp/tests/addons/test_converter/ir.model.access.csv @@ -1,4 +1,4 @@ id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink access_converter_model,access_converter_model,model_test_converter_test_model,,1,1,1,1 access_test_converter_test_model_sub,access_test_converter_test_model_sub,model_test_converter_test_model_sub,,1,1,1,1 -access_test_converter_currency,access_test_converter_currency,model_test_converter_currency,,1,1,1,1 +access_test_converter_monetary,access_test_converter_monetary,model_test_converter_monetary,,1,1,1,1 diff --git a/openerp/tests/addons/test_converter/models.py b/openerp/tests/addons/test_converter/models.py index 4e1e0c62e38..0cd861aa274 100644 --- a/openerp/tests/addons/test_converter/models.py +++ b/openerp/tests/addons/test_converter/models.py @@ -38,8 +38,8 @@ class test_model_sub(orm.Model): } -class test_model_currency(orm.Model): - _name = 'test_converter.currency' +class test_model_monetary(orm.Model): + _name = 'test_converter.monetary' _columns = { 'value': fields.float(digits=(16, 55)), diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 20f55986ffe..96f710473aa 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -74,7 +74,7 @@ class TestFloatExport(TestBasicExport): self.assertEqual(value, '42.01') class TestCurrencyExport(TestExport): - _model = 'test_converter.currency' + _model = 'test_converter.monetary' def setUp(self): super(TestCurrencyExport, self).setUp() @@ -87,8 +87,8 @@ class TestCurrencyExport(TestExport): context=context) def convert(self, obj): - converter = self.registry('ir.qweb.field.currency') - options = {'widget': 'currency', 'currency': 'currency_id'} + converter = self.registry('ir.qweb.field.monetary') + options = {'widget': 'monetary', 'currency_field': 'currency_id'} converted = converter.to_html( self.cr, self.uid, 'value', obj, options, doc.createElement('span'), @@ -105,7 +105,7 @@ class TestCurrencyExport(TestExport): self.assertEqual( converted, '' '0.12' ' {symbol}'.format( @@ -123,7 +123,7 @@ class TestCurrencyExport(TestExport): self.assertEqual( converted, '' '{symbol} ' '0.12' @@ -143,7 +143,7 @@ class TestCurrencyExport(TestExport): self.assertEqual( converted, '' '0.12' ' {symbol}'.format( From 9cbc632fa16c7a047847a0bdff81d288d4f83ad5 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 11 Oct 2013 12:51:20 +0200 Subject: [PATCH 16/20] [IMP] smartenify res_currency code bzr revid: xmo@openerp.com-20131011105120-1d5fg06j6zsuxty2 --- openerp/addons/base/res/res_currency.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/openerp/addons/base/res/res_currency.py b/openerp/addons/base/res/res_currency.py index a496a1eccdf..61128a5ce99 100644 --- a/openerp/addons/base/res/res_currency.py +++ b/openerp/addons/base/res/res_currency.py @@ -40,20 +40,21 @@ class res_currency(osv.osv): if context is None: context = {} res = {} - if 'date' in context: - date = context['date'] - else: - date = time.strftime('%Y-%m-%d') - date = date or time.strftime('%Y-%m-%d') + + date = context.get('date') or time.strftime('%Y-%m-%d') # Convert False values to None ... currency_rate_type = context.get('currency_rate_type_id') or None # ... and use 'is NULL' instead of '= some-id'. operator = '=' if currency_rate_type else 'is' for id in ids: - cr.execute("SELECT currency_id, rate FROM res_currency_rate WHERE currency_id = %s AND name <= %s AND currency_rate_type_id " + operator +" %s ORDER BY name desc LIMIT 1" ,(id, date, currency_rate_type)) + cr.execute('SELECT rate FROM res_currency_rate ' + 'WHERE currency_id = %s ' + 'AND name <= %s ' + 'AND currency_rate_type_id ' + operator + ' %s ' + 'ORDER BY name desc LIMIT 1', + (id, date, currency_rate_type)) if cr.rowcount: - id, rate = cr.fetchall()[0] - res[id] = rate + res[id] = cr.fetchone()[0] elif not raise_on_no_rate: res[id] = 0 else: From 20f89a8d85cc00e1a345b085ff002b891db771ea Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 11 Oct 2013 13:16:20 +0200 Subject: [PATCH 17/20] [IMP] change monetary t-field options, make them more sensible and flexible bzr revid: xmo@openerp.com-20131011111620-sitjaxoykgjp2175 --- openerp/addons/base/ir/ir_qweb.py | 53 ++++++++++++++----- .../addons/test_converter/tests/test_html.py | 25 ++++++--- 2 files changed, 60 insertions(+), 18 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 9405b5086ca..0f829f7a982 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -464,8 +464,9 @@ class FieldConverter(osv.AbstractModel): cr, uid, field_name, record, record._model._all_columns[field_name].column, options) - except KeyError: - _logger.warning("t-field no field %s for model %s", field_name, record._model._name) + except Exception: + _logger.warning("Could not get field %s for model %s", + field_name, record._model._name, exc_info=True) g_att += ''.join( ' %s="%s"' % (name, werkzeug.utils.escape(value)) @@ -477,11 +478,14 @@ class FieldConverter(osv.AbstractModel): return self.render_element(cr, uid, source_element, t_att, g_att, qweb_context, content) + def qweb_object(self): + return self.pool['ir.qweb'] + def render_element(self, cr, uid, source_element, t_att, g_att, qweb_context, content): """ Final rendering hook, by default just calls ir.qweb's ``render_element`` """ - return self.pool['ir.qweb'].render_element( + return self.qweb_object().render_element( source_element, t_att, g_att, qweb_context, content or '') class FloatConverter(osv.AbstractModel): @@ -555,35 +559,60 @@ class ImageConverter(osv.AbstractModel): return '' % (Image.MIME[image.format], value) class MonetaryConverter(osv.AbstractModel): - """ ``monetary`` converter, has a mandatory option ``currency_field``. + """ ``monetary`` converter, has two mandatory options ``source_currency`` + and ``display_currency``. Both are evaluated in the qweb context, must + yield a res.currency browse_record and are used to convert currency field + value into a display value, and (using the display currency) format the + currency symbol. - The currency field is a (float) value, the linked ``currency_field`` is an - m2o to a ``res.currency`` indicating how to format the field. + The currency field is a (float) value. + + .. note:: the monetary converter internally adds the qweb context to its + options mapping, so that the context is available to callees. + It's set under the ``_qweb_context`` key. """ _name = 'ir.qweb.field.monetary' _inherit = 'ir.qweb.field' + def to_html(self, cr, uid, field_name, record, options, + source_element, t_att, g_att, qweb_context): + options['_qweb_context'] = qweb_context + return super(MonetaryConverter, self).to_html( + cr, uid, field_name, record, options, + source_element, t_att, g_att, qweb_context) + def record_to_html(self, cr, uid, field_name, record, column, options): - Currency = self.pool['res.currency'] + source = self.source_currency(cr, uid, options) + display = self.display_currency(cr, uid, options) + + value = self.pool['res.currency'].compute( + cr, uid, source.id, display.id, record[field_name]) symbol_pre = symbol_post = space_pre = space_post = u'' - currency = record[options['currency_field']] - if currency.position == 'before': + if display.position == 'before': space_pre = u' ' - symbol_pre = currency.symbol + symbol_pre = display.symbol else: space_post = u' ' - symbol_post = currency.symbol + symbol_post = display.symbol return u'{symbol_pre}{space_pre}' \ u'{0}' \ u'{space_post}{symbol_post}'.format( - Currency.round(cr, uid, currency, record[field_name]), + value, space_pre=space_pre, symbol_pre=symbol_pre, space_post=space_post, symbol_post=symbol_post,) + def source_currency(self, cr, uid, options): + return self.qweb_object().eval_object( + options['source_currency'], options['_qweb_context']) + + def display_currency(self, cr, uid, options): + return self.qweb_object().eval_object( + options['display_currency'], options['_qweb_context']) + def get_field_type(column, options): """ Gets a t-field's effective type from the field's column and its options """ diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 96f710473aa..aca9967e89b 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -79,6 +79,8 @@ class TestCurrencyExport(TestExport): def setUp(self): super(TestCurrencyExport, self).setUp() self.Currency = self.registry('res.currency') + self.base = self.create(self.Currency, name="Source", symbol=u'source') + self.create_rate(self.base) def create(self, model, context=None, **values): return model.browse( @@ -86,21 +88,30 @@ class TestCurrencyExport(TestExport): model.create(self.cr, self.uid, values, context=context), context=context) - def convert(self, obj): + def convert(self, obj, dest): converter = self.registry('ir.qweb.field.monetary') - options = {'widget': 'monetary', 'currency_field': 'currency_id'} + options = { + 'widget': 'monetary', + 'source_currency': 'c1', + 'display_currency': 'c2' + } converted = converter.to_html( self.cr, self.uid, 'value', obj, options, doc.createElement('span'), {'field': 'obj.value', 'field-options': json.dumps(options)}, - '', {'obj': obj}) + '', {'obj': obj, 'c1': self.base, 'c2': dest, }) return converted + def create_rate(self, currency, rate=1.0): + Rate = self.registry('res.currency.rate') + self.create(Rate, name='1970-01-01', rate=rate, currency_id=currency.id) + def test_currency_post(self): currency = self.create(self.Currency, name="Test", symbol=u"test") + self.create_rate(currency) obj = self.create(self.Model, value=0.12, currency_id=currency.id) - converted = self.convert(obj) + converted = self.convert(obj, dest=currency) self.assertEqual( converted, @@ -116,9 +127,10 @@ class TestCurrencyExport(TestExport): def test_currency_pre(self): currency = self.create( self.Currency, name="Test", symbol=u"test", position='before') + self.create_rate(currency) obj = self.create(self.Model, value=0.12, currency_id=currency.id) - converted = self.convert(obj) + converted = self.convert(obj, dest=currency) self.assertEqual( converted, @@ -136,9 +148,10 @@ class TestCurrencyExport(TestExport): """ Precision should be the currency's, not the float field's """ currency = self.create(self.Currency, name="Test", symbol=u"test",) + self.create_rate(currency) obj = self.create(self.Model, value=0.1234567, currency_id=currency.id) - converted = self.convert(obj) + converted = self.convert(obj, dest=currency) self.assertEqual( converted, From df0fc4afc288229a0f8ecf3d16a1d20ae777baea Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 11 Oct 2013 13:47:03 +0200 Subject: [PATCH 18/20] [IMP] test conversions correctly applied, remove unnecessary fields bzr revid: xmo@openerp.com-20131011114703-rgg9nsyrm6k92uak --- openerp/tests/addons/test_converter/models.py | 1 - .../addons/test_converter/tests/test_html.py | 25 ++++++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/openerp/tests/addons/test_converter/models.py b/openerp/tests/addons/test_converter/models.py index 0cd861aa274..9074ba8178f 100644 --- a/openerp/tests/addons/test_converter/models.py +++ b/openerp/tests/addons/test_converter/models.py @@ -43,5 +43,4 @@ class test_model_monetary(orm.Model): _columns = { 'value': fields.float(digits=(16, 55)), - 'currency_id': fields.many2one('res.currency'), } diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index aca9967e89b..06e7ffce97a 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -109,7 +109,7 @@ class TestCurrencyExport(TestExport): def test_currency_post(self): currency = self.create(self.Currency, name="Test", symbol=u"test") self.create_rate(currency) - obj = self.create(self.Model, value=0.12, currency_id=currency.id) + obj = self.create(self.Model, value=0.12) converted = self.convert(obj, dest=currency) @@ -128,7 +128,7 @@ class TestCurrencyExport(TestExport): currency = self.create( self.Currency, name="Test", symbol=u"test", position='before') self.create_rate(currency) - obj = self.create(self.Model, value=0.12, currency_id=currency.id) + obj = self.create(self.Model, value=0.12) converted = self.convert(obj, dest=currency) @@ -144,12 +144,31 @@ class TestCurrencyExport(TestExport): symbol=currency.symbol.encode('utf-8') ),) + def test_currency_rate_conversion(self): + currency = self.create( + self.Currency, name="Test", symbol=u"dest") + self.create_rate(currency, rate=2.0) + obj = self.create(self.Model, value=0.12) + + converted = self.convert(obj, dest=currency) + + self.assertEqual( + converted, + '' + '0.24' + ' {symbol}'.format( + obj=obj, + symbol=currency.symbol.encode('utf-8') + ),) + def test_currency_precision(self): """ Precision should be the currency's, not the float field's """ currency = self.create(self.Currency, name="Test", symbol=u"test",) self.create_rate(currency) - obj = self.create(self.Model, value=0.1234567, currency_id=currency.id) + obj = self.create(self.Model, value=0.1234567) converted = self.convert(obj, dest=currency) From 29d10fd8ea9f49d35f2902ad64ddef2b133449ea Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Fri, 11 Oct 2013 16:25:12 +0200 Subject: [PATCH 19/20] [REM] conversion in monetary widget, turns out to be a misunderstood need bzr revid: xmo@openerp.com-20131011142512-3j5vuik1o4k6q6jj --- openerp/addons/base/ir/ir_qweb.py | 19 ++---------- .../addons/test_converter/tests/test_html.py | 29 +------------------ 2 files changed, 4 insertions(+), 44 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index 0f829f7a982..2090233f20d 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -559,13 +559,8 @@ class ImageConverter(osv.AbstractModel): return '' % (Image.MIME[image.format], value) class MonetaryConverter(osv.AbstractModel): - """ ``monetary`` converter, has two mandatory options ``source_currency`` - and ``display_currency``. Both are evaluated in the qweb context, must - yield a res.currency browse_record and are used to convert currency field - value into a display value, and (using the display currency) format the - currency symbol. - - The currency field is a (float) value. + """ ``monetary`` converter, has a mandatory option + ``display_currency``. .. note:: the monetary converter internally adds the qweb context to its options mapping, so that the context is available to callees. @@ -582,12 +577,8 @@ class MonetaryConverter(osv.AbstractModel): source_element, t_att, g_att, qweb_context) def record_to_html(self, cr, uid, field_name, record, column, options): - source = self.source_currency(cr, uid, options) display = self.display_currency(cr, uid, options) - value = self.pool['res.currency'].compute( - cr, uid, source.id, display.id, record[field_name]) - symbol_pre = symbol_post = space_pre = space_post = u'' if display.position == 'before': space_pre = u' ' @@ -599,16 +590,12 @@ class MonetaryConverter(osv.AbstractModel): return u'{symbol_pre}{space_pre}' \ u'{0}' \ u'{space_post}{symbol_post}'.format( - value, + record[field_name], space_pre=space_pre, symbol_pre=symbol_pre, space_post=space_post, symbol_post=symbol_post,) - def source_currency(self, cr, uid, options): - return self.qweb_object().eval_object( - options['source_currency'], options['_qweb_context']) - def display_currency(self, cr, uid, options): return self.qweb_object().eval_object( options['display_currency'], options['_qweb_context']) diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index 06e7ffce97a..f0c48df4a93 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -92,23 +92,17 @@ class TestCurrencyExport(TestExport): converter = self.registry('ir.qweb.field.monetary') options = { 'widget': 'monetary', - 'source_currency': 'c1', 'display_currency': 'c2' } converted = converter.to_html( self.cr, self.uid, 'value', obj, options, doc.createElement('span'), {'field': 'obj.value', 'field-options': json.dumps(options)}, - '', {'obj': obj, 'c1': self.base, 'c2': dest, }) + '', {'obj': obj, 'c2': dest, }) return converted - def create_rate(self, currency, rate=1.0): - Rate = self.registry('res.currency.rate') - self.create(Rate, name='1970-01-01', rate=rate, currency_id=currency.id) - def test_currency_post(self): currency = self.create(self.Currency, name="Test", symbol=u"test") - self.create_rate(currency) obj = self.create(self.Model, value=0.12) converted = self.convert(obj, dest=currency) @@ -127,7 +121,6 @@ class TestCurrencyExport(TestExport): def test_currency_pre(self): currency = self.create( self.Currency, name="Test", symbol=u"test", position='before') - self.create_rate(currency) obj = self.create(self.Model, value=0.12) converted = self.convert(obj, dest=currency) @@ -144,30 +137,10 @@ class TestCurrencyExport(TestExport): symbol=currency.symbol.encode('utf-8') ),) - def test_currency_rate_conversion(self): - currency = self.create( - self.Currency, name="Test", symbol=u"dest") - self.create_rate(currency, rate=2.0) - obj = self.create(self.Model, value=0.12) - - converted = self.convert(obj, dest=currency) - - self.assertEqual( - converted, - '' - '0.24' - ' {symbol}'.format( - obj=obj, - symbol=currency.symbol.encode('utf-8') - ),) - def test_currency_precision(self): """ Precision should be the currency's, not the float field's """ currency = self.create(self.Currency, name="Test", symbol=u"test",) - self.create_rate(currency) obj = self.create(self.Model, value=0.1234567) converted = self.convert(obj, dest=currency) From a720eec77c4df8b08cdf38da3929030a6f2f3c05 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Mon, 14 Oct 2013 11:36:57 +0200 Subject: [PATCH 20/20] [FIX] monetary field rounding, QWebContext in tests bzr revid: xmo@openerp.com-20131014093657-wl00zhbgk5b1zs0o --- openerp/addons/base/ir/ir_qweb.py | 3 ++- .../addons/test_converter/tests/test_html.py | 4 ++-- openerp/tests/test_qweb.py | 15 ++++++++------- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/openerp/addons/base/ir/ir_qweb.py b/openerp/addons/base/ir/ir_qweb.py index e7566f9e232..3fe5cb03c03 100644 --- a/openerp/addons/base/ir/ir_qweb.py +++ b/openerp/addons/base/ir/ir_qweb.py @@ -615,6 +615,7 @@ class MonetaryConverter(osv.AbstractModel): source_element, t_att, g_att, qweb_context) def record_to_html(self, cr, uid, field_name, record, column, options): + Currency = self.pool['res.currency'] display = self.display_currency(cr, uid, options) symbol_pre = symbol_post = space_pre = space_post = u'' @@ -628,7 +629,7 @@ class MonetaryConverter(osv.AbstractModel): return u'{symbol_pre}{space_pre}' \ u'{0}' \ u'{space_post}{symbol_post}'.format( - record[field_name], + Currency.round(cr, uid, display, record[field_name]), space_pre=space_pre, symbol_pre=symbol_pre, space_post=space_post, diff --git a/openerp/tests/addons/test_converter/tests/test_html.py b/openerp/tests/addons/test_converter/tests/test_html.py index f0c48df4a93..d433c814958 100644 --- a/openerp/tests/addons/test_converter/tests/test_html.py +++ b/openerp/tests/addons/test_converter/tests/test_html.py @@ -4,6 +4,7 @@ import os import xml.dom.minidom from openerp.tests import common +from openerp.addons.base.ir import ir_qweb directory = os.path.dirname(__file__) @@ -80,7 +81,6 @@ class TestCurrencyExport(TestExport): super(TestCurrencyExport, self).setUp() self.Currency = self.registry('res.currency') self.base = self.create(self.Currency, name="Source", symbol=u'source') - self.create_rate(self.base) def create(self, model, context=None, **values): return model.browse( @@ -98,7 +98,7 @@ class TestCurrencyExport(TestExport): self.cr, self.uid, 'value', obj, options, doc.createElement('span'), {'field': 'obj.value', 'field-options': json.dumps(options)}, - '', {'obj': obj, 'c2': dest, }) + '', ir_qweb.QWebContext({'obj': obj, 'c2': dest, })) return converted def test_currency_post(self): diff --git a/openerp/tests/test_qweb.py b/openerp/tests/test_qweb.py index 3bdff5e63d0..662946c175e 100644 --- a/openerp/tests/test_qweb.py +++ b/openerp/tests/test_qweb.py @@ -1,9 +1,10 @@ # -*- coding: utf-8 -*- import cgi -from collections import namedtuple from xml.dom import minidom as dom import common +from openerp.addons.base.ir import ir_qweb +import openerp.addons.base.ir.ir_qweb impl = dom.getDOMImplementation() document = impl.createDocument(None, None, None) @@ -23,9 +24,9 @@ class TestQWebTField(common.TransactionCase): }) root_company = Companies.browse(self.cr, self.uid, company_id) - result = self.engine.render_node(field, { + result = self.engine.render_node(field, ir_qweb.QWebContext({ 'company': root_company, - }) + })) self.assertEqual( result, @@ -46,9 +47,9 @@ class TestQWebTField(common.TransactionCase): }) root_company = Companies.browse(self.cr, self.uid, company_id) - result = self.engine.render_node(field, { + result = self.engine.render_node(field, ir_qweb.QWebContext({ 'company': root_company, - }) + })) self.assertEqual( result, '