Merge pull request #60 from hbrunn/8.0-base_field_serialized

[ADD] base_field_serialized

base_field_serialized/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from . import fields
+from . import base_field_serialized

base_field_serialized/__openerp__.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{
+    "name": "Serialized fields",
+    "version": "1.0",
+    "author": "Therp BV",
+    "license": "AGPL-3",
+    "description": """This addon restores serialized fields for Odoo 8.0
+    """,
+    "category": "Hidden/Dependency",
+    "depends": [
+        'base',
+    ],
+    "auto_install": False,
+    "installable": True,
+    "application": False,
+}

base_field_serialized/base_field_serialized.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from openerp import fields
+
+
+class Serialized(fields.Field):
+    type = 'serialized'
+
+    def convert_to_cache(self, value, env, validate=True):
+        if value:
+            return value
+        else:
+            return {}
+
+fields.Serialized = Serialized

base_field_serialized/fields.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    Copyright (C) 2004-2009 Tiny SPRL (<http://tiny.be>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+
+import simplejson
+import openerp
+from openerp.models import FIELDS_TO_PGTYPES
+from openerp.osv.fields import _column
+
+# ---------------------------------------------------------
+# Serialized fields
+# ---------------------------------------------------------
+
+
+class serialized(_column):
+    """ A field able to store an arbitrary python data structure.
+
+        Note: only plain components allowed.
+    """
+
+    def _symbol_set_struct(val):
+        return simplejson.dumps(val)
+
+    def _symbol_get_struct(self, val):
+        return simplejson.loads(val or '{}')
+
+    _prefetch = False
+    _type = 'serialized'
+
+    _symbol_c = '%s'
+    _symbol_f = _symbol_set_struct
+    _symbol_set = (_symbol_c, _symbol_f)
+    _symbol_get = _symbol_get_struct
+
+openerp.osv.fields.serialized = serialized
+FIELDS_TO_PGTYPES[openerp.osv.fields.serialized] = 'text'

base_field_serialized/tests/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+import test_serialized
+from test_serialized import TestBaseFieldSerialized

base_field_serialized/tests/test_serialized.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2014 Therp BV (<http://therp.nl>).
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU Affero General Public License as
+#    published by the Free Software Foundation, either version 3 of the
+#    License, or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+from openerp import models, fields
+from openerp.tests.common import TransactionCase
+
+
+class BaseFieldSerializedTestModel(models.Model):
+    _name = 'base.field.serialized.test.model'
+
+    serialized = fields.Serialized('Serialized')
+
+
+class TestBaseFieldSerialized(TransactionCase):
+    def test_ReadWrite(self):
+        BaseFieldSerializedTestModel._build_model(self.registry, self.cr)
+        self.env['base.field.serialized.test.model']._auto_init()
+        record = self.env['base.field.serialized.test.model'].create(
+            {'serialized': ['hello world']})
+        self.assertEqual(record.serialized, ['hello world'])
+        self.env.invalidate_all()
+        self.assertEqual(record.serialized, ['hello world'])
+        record.write({'serialized': {'hello': 'world'}})
+        self.env.invalidate_all()
+        self.assertEqual(record.serialized, {'hello': 'world'})
+        record.write({'serialized': None})
+        self.assertEqual(
+            self.registry['base.field.serialized.test.model'].browse(
+                self.cr, self.uid, record.id).serialized,
+            {})