From 790a8536b93585dca141999bfd3766d63cce6e79 Mon Sep 17 00:00:00 2001 From: Pierre Verkest Date: Tue, 14 Jul 2015 13:56:09 +0200 Subject: [PATCH] by pass readonly fields only if context is set with readonly_by_pass. This context can either be a bool or field name array --- web_readonly_bypass/__openerp__.py | 6 + .../static/src/js/readonly_bypass.js | 87 ++++++--- .../static/test/web_readonly_bypass.js | 168 ++++++++++++++++++ 3 files changed, 235 insertions(+), 26 deletions(-) create mode 100644 web_readonly_bypass/static/test/web_readonly_bypass.js diff --git a/web_readonly_bypass/__openerp__.py b/web_readonly_bypass/__openerp__.py index debb862c..c07d2006 100644 --- a/web_readonly_bypass/__openerp__.py +++ b/web_readonly_bypass/__openerp__.py @@ -108,9 +108,15 @@ promote its widespread use. To contribute to this module, please visit http://odoo-community.org. """, + "depends": [ + 'web', + ], 'js': [ 'static/src/js/readonly_bypass.js', ], + 'test': [ + 'static/test/web_readonly_bypass.js', + ], 'installable': True, 'auto_install': False, 'application': False, diff --git a/web_readonly_bypass/static/src/js/readonly_bypass.js b/web_readonly_bypass/static/src/js/readonly_bypass.js index d497826a..aa40a0d3 100644 --- a/web_readonly_bypass/static/src/js/readonly_bypass.js +++ b/web_readonly_bypass/static/src/js/readonly_bypass.js @@ -5,35 +5,70 @@ openerp.web_readonly_bypass = function(instance) { var QWeb = instance.web.qweb, _t = instance.web._t; - /** - * ignore readonly: place options['readonly_fields'] into the data - * if nothing is specified into the context - * - * create mode: remove read-only keys having a 'false' value - * - * @param boolean mode: True case of create, false case of write - * @param {Object} context->filter_out_readonly - * @param {Object} data field values to possibly be updated - * @param {Object} options Dictionary that can contain the following keys: - * - readonly_fields: Values from readonly fields to merge into the data object - */ - function ignore_readonly(data, options, mode, context){ - if (options){ - if ('readonly_fields' in options && options['readonly_fields'] && - !('filter_out_readonly' in context && - context['filter_out_readonly'] == true)) { - if(mode){ + var instance = instance; + + instance.web_readonly_bypass = { + /** + * ignore readonly: place options['readonly_fields'] into the data + * if nothing is specified into the context + * + * create mode: remove read-only keys having a 'false' value + * + * @param {Object} data field values to possibly be updated + * @param {Object} options Dictionary that can contain the following keys: + * - readonly_fields: Values from readonly fields to merge into the data object + * @param boolean mode: True case of create, false case of write + * @param {Object} context->readonly_by_pass + */ + ignore_readonly: function(data, options, mode, context){ + console.log(options ); + console.log(context ); + var readonly_by_pass_fields = this.retrieve_readonly_by_pass_fields( + options, context); + console.log(readonly_by_pass_fields ); + if(mode){ + $.each( readonly_by_pass_fields, function( key, value ) { + if(value==false){ + delete(readonly_by_pass_fields[key]); + } + }); + } + data = $.extend(data,readonly_by_pass_fields); + console.log(data ); + }, + + /** + * retrieve_readonly_by_pass_fields: retrieve readonly fields to save + * according context. + * + * @param {Object} options Dictionary that can contain the following keys: + * - readonly_fields: all values from readonly fields + * @param {Object} context->readonly_by_pass: Can be true if all + * all readonly fields should be saved or an array of field name to + * save ie: ['readonly_field_1', 'readonly_field_2'] + * @returns {Object}: readonly key/value fields to save according context + */ + retrieve_readonly_by_pass_fields: function(options, context){ + var readonly_by_pass_fields = {}; + if (options && 'readonly_fields' in options && + options['readonly_fields'] && context && + 'readonly_by_pass' in context && context['readonly_by_pass']){ + if (_.isArray(context['readonly_by_pass'])){ $.each( options.readonly_fields, function( key, value ) { - if(value==false){ - delete(options.readonly_fields[key]); + if(_.contains(context['readonly_by_pass'], key)){ + readonly_by_pass_fields[key] = value; } }); + }else{ + readonly_by_pass_fields = options.readonly_fields; } - data = $.extend(data,options['readonly_fields']) } - } + return readonly_by_pass_fields; + }, }; + readonly_bypass = instance.web_readonly_bypass; + instance.web.BufferedDataSet.include({ init : function() { @@ -50,7 +85,7 @@ openerp.web_readonly_bypass = function(instance) { */ create : function(data, options) { var self = this; - ignore_readonly(data, options, true, self.context); + readonly_bypass.ignore_readonly(data, options, true, self.context); return self._super(data,options); }, /** @@ -64,7 +99,7 @@ openerp.web_readonly_bypass = function(instance) { */ write : function(id, data, options) { var self = this; - ignore_readonly(data, options, false, self.context); + readonly_bypass.ignore_readonly(data, options, false, self.context); return self._super(id,data,options); }, @@ -88,7 +123,7 @@ openerp.web_readonly_bypass = function(instance) { */ create : function(data, options) { var self = this; - ignore_readonly(data, options, true, self.context); + readonly_bypass.ignore_readonly(data, options, true, self.context); return self._super(data,options); }, /** @@ -102,7 +137,7 @@ openerp.web_readonly_bypass = function(instance) { */ write : function(id, data, options) { var self = this; - ignore_readonly(data, options, false, self.context); + readonly_bypass.ignore_readonly(data, options, false, self.context); return self._super(id,data,options); }, diff --git a/web_readonly_bypass/static/test/web_readonly_bypass.js b/web_readonly_bypass/static/test/web_readonly_bypass.js new file mode 100644 index 00000000..4aa182a9 --- /dev/null +++ b/web_readonly_bypass/static/test/web_readonly_bypass.js @@ -0,0 +1,168 @@ +openerp.testing.section( 'web_readonly_bypass', {}, +function(test){ + test('ignore_readonly', function(instance){ + openerp.web_readonly_bypass(instance); + var data = {}; + var mode_create = true; + var options = {}; + var context = {}; + instance.web_readonly_bypass.ignore_readonly(data, options, + mode_create, context); + deepEqual(data, + {}, + "Empty context and options mode create" + ); + + mode_create = false; + data = {}; + instance.web_readonly_bypass.ignore_readonly(data, options, + mode_create, context); + deepEqual(data, + {}, + "Empty context and options mode write" + ); + + mode_create = false; + data = {}; + context = {'readonly_by_pass': true}; + options = {'readonly_fields': {'field_1': 'va1-1', + 'field_2': false, + 'field_3': 'val-3'}}; + instance.web_readonly_bypass.ignore_readonly(data, options, + mode_create, context); + deepEqual(data, + {'field_1': 'va1-1', 'field_2': false, 'field_3': 'val-3'}, + "all fields mode write" + ); + + mode_create = true; + data = {}; + context = {'readonly_by_pass': true}; + options = {'readonly_fields': {'field_1': 'va1-1', + 'field_2': false, + 'field_3': 'val-3'}}; + instance.web_readonly_bypass.ignore_readonly(data, options, + mode_create, context); + deepEqual(data, + {'field_1': 'va1-1', 'field_3': 'val-3'}, + "all fields mode create (false value are escaped)" + ); + + mode_create = true; + data = {}; + context = {}; + options = {'readonly_fields': {'field_1': 'va1-1', + 'field_2': false, + 'field_3': 'val-3'}}; + instance.web_readonly_bypass.ignore_readonly(data, options, + mode_create, context); + deepEqual(data, + {}, + "without context, default, we won't save readonly fields" + ); + }); + + test('retrieve_readonly_by_pass_fields', function(instance){ + openerp.web_readonly_bypass(instance); + var context = {'readonly_by_pass': true} + var options = {'readonly_fields': {'field_1': 'va1-1', + 'field_2': 'val-2', + 'field_3': 'val-3'}}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {'field_1': 'va1-1', 'field_2': 'val-2', 'field_3': 'val-3'}, + "All fields should be accepted!" + ); + + context = {'readonly_by_pass': ['field_1', 'field_3']}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {'field_1': 'va1-1','field_3': 'val-3'}, + "two field s1" + ); + + context = {'readonly_by_pass': ['field_1',]}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {'field_1': 'va1-1'}, + "Only field 1" + ); + + context = {'readonly_by_pass': []}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "Empty context field" + ); + + context = null; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "Null context" + ); + + context = false; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "false context" + ); + + context = {'readonly_by_pass': true} + options = {'readonly_fields': {'field_1': 'va1-1'}}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {'field_1': 'va1-1'}, + "Only one option" + ); + + + options = {'readonly_fields': {}}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "Empty readonly_fields option" + ); + + options = {}; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "Empty option" + ); + + options = null; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "null option" + ); + + options = false; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "false option" + ); + + context = false; + deepEqual( + instance.web_readonly_bypass.retrieve_readonly_by_pass_fields( + options, context), + {}, + "false option and false context" + ); + }); +}); \ No newline at end of file