Merge lp:~therp-nl/web-addons/7.0-add_autoswitch into lp:~webaddons-core-editors/web-addons/7.0

[Stefan Rijnhart (Opener)]

Experimental, don't merge yet.

[lp:~therp-nl/web-addons/7.0-add_autoswitch]

18. By Stefan Rijnhart (Opener) on 2013-11-08

[RFR] Additional line break

19. By Stefan Rijnhart (Opener) on 2013-11-08

[IMP] Variable name

20. By Stefan Rijnhart (Opener) on 2013-11-08

[RFR] Comments

21. By Stefan Rijnhart (Opener) on 2013-11-08

[ADD] Example XML stanza

22. By Stefan Rijnhart (Opener) on 2013-11-08

[FIX] Missing, albeit optional colon

23. By Stefan Rijnhart (Opener) on 2013-11-11

[IMP] Missing colon

Unmerged revisions

23. By Stefan Rijnhart (Opener) on 2013-11-11

[IMP] Missing colon

22. By Stefan Rijnhart (Opener) on 2013-11-08

[FIX] Missing, albeit optional colon

21. By Stefan Rijnhart (Opener) on 2013-11-08

[ADD] Example XML stanza

20. By Stefan Rijnhart (Opener) on 2013-11-08

[RFR] Comments

19. By Stefan Rijnhart (Opener) on 2013-11-08

[IMP] Variable name

18. By Stefan Rijnhart (Opener) on 2013-11-08

[RFR] Additional line break

17. By Stefan Rijnhart (Opener) on 2013-11-08

[IMP] Comments, spacing

16. By Stefan Rijnhart (Opener) on 2013-11-08

[RFR] Eliminate unnecessary variable

15. By Stefan Rijnhart (Opener) on 2013-11-08

[DEL] Debug statements

14. By Stefan Rijnhart (Opener) on 2013-11-08

[IMP] Restrict autoswitching to search views with the autoswitch attribute

=== added directory 'web_autoswitch_to_form'
=== added file 'web_autoswitch_to_form/__init__.py'
=== added file 'web_autoswitch_to_form/__openerp__.py'
--- web_autoswitch_to_form/__openerp__.py	1970-01-01 00:00:00 +0000
+++ web_autoswitch_to_form/__openerp__.py	2013-11-11 11:35:35 +0000
@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+##############################################################################
+#
+#    OpenERP, Open Source Management Solution
+#    This module copyright (C) 2013 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" : "Auto-switch to form mode for singleton search results",
+    "version" : "0.1",
+    "author" : "Therp BV",
+    "category": 'Tools',
+    "description": """
+When the 'autoswitch' attribute is defined on a search view, searches with only
+one result will automatically open the form view for the record.
+
+Note that the 'autoswitch' attribute on search elements in XML views is not
+allowed by the RNG validation. You can circumvent the validation by setting
+an attribute version="7.0" as well.
+
+As an example, here is the necessary code to enable this functionality on 
+the product view:
+
+        <record id="product_search_form_view" model="ir.ui.view">
+            <field name="name">product.search.form</field>
+            <field name="model">product.product</field>
+            <field name="inherit_id"
+                   ref="product.product_search_form_view"/>
+            <field name="arch" type="xml">
+                <xpath expr="/search[@string='Product']" position="attributes">
+                    <attribute name="version">7.0</attribute>
+                    <attribute name="autoswitch">1</attribute>
+                </xpath>
+            </field>
+        </record>
+
+    """,
+    'website': 'http://therp.nl',
+    'depends' : ['web_kanban'],
+    'js': ['static/src/js/web_autoswitch_to_form.js'],
+    'data': [
+        ],
+}

=== added directory 'web_autoswitch_to_form/static'
=== added directory 'web_autoswitch_to_form/static/src'
=== added directory 'web_autoswitch_to_form/static/src/js'
=== added file 'web_autoswitch_to_form/static/src/js/web_autoswitch_to_form.js'
--- web_autoswitch_to_form/static/src/js/web_autoswitch_to_form.js	1970-01-01 00:00:00 +0000
+++ web_autoswitch_to_form/static/src/js/web_autoswitch_to_form.js	2013-11-11 11:35:35 +0000
@@ -0,0 +1,117 @@
+/* 
+
+   Copyright (C) 2013 Therp BV
+   License: GNU AFFERO GENERAL PUBLIC LICENSE
+            Version 3 or any later version
+
+*/
+
+openerp.web_autoswitch_to_form = function(instance) {
+
+    instance.web.ViewManager.include({
+        switch_mode: function(view_type, no_store, view_options) {
+            /*
+              Suppress autoswitch after manually changing modes, or
+              it could become annoying when the user attempts to
+              switch to a list view of a single item
+            */
+            this.flags.suppress_autoswitch = true;
+            return this._super(view_type, no_store, view_options);
+        },
+    });
+    
+    instance.web.SearchView.include({
+        disable_autoswitch: function() {
+            if (this.__parentedParent && this.__parentedParent.flags !== undefined) {
+                this.__parentedParent.flags.suppress_autoswitch = true;
+            }
+        },
+
+        check_autoswitch: function(data) {
+            if (this.__parentedParent
+                    && this.__parentedParent.flags !== undefined
+                    && data.arch && data.arch.attrs) {
+                this.__parentedParent.flags.autoswitch = data.arch.attrs.autoswitch;
+            }
+        },
+
+        start: function() {
+            /*
+              When a filter is removed, suppress autoswitch if the search
+              that is then triggered has only one result
+
+              Auto-switching is enabled per search view by the 'autoswitch'
+              attribute on the search element of the search view
+            */
+            res = this._super();
+            this.query.on('remove', this.proxy(this.disable_autoswitch));
+            this.on('search_view_loaded', this, this.check_autoswitch);
+            return res;
+        },
+    });        
+
+    instance.web.View.include({
+        start: function() {
+            /*
+              Undo suppressing once a view is loaded
+            */
+            res = this._super();
+            if (this.__parentedParent && this.__parentedParent.flags !== undefined) {
+                this.__parentedParent.flags.suppress_autoswitch = false;
+            }
+            return res;
+        },
+    });        
+        
+
+    instance.web.ListView.include({
+        do_search: function(domain, context, group_by) {
+            /* 
+               Switch from list view to form view in case of a single
+               record when do_search's deferred is resolved
+            */
+            var res = this._super(domain, context, group_by)
+            if ( ! (this.__parentedParent
+                    && this.__parentedParent.flags
+                    && this.__parentedParent.flags.autoswitch)) {
+                return res;
+            }
+            if (this.__parentedParent.flags.suppress_autoswitch) {
+                this.__parentedParent.flags.suppress_autoswitch = false;
+                return res;
+            }
+            var self = this;
+            return res.done(
+                function() {
+                    if (self.records.length === 1) {
+                        self.trigger('switch_mode', 'form');
+                    }
+                });
+        },
+    });
+
+    instance.web_kanban.KanbanView.include({
+        on_groups_started: function() {
+            /* 
+               Switch from kanban view to form view in case of a single
+               record after calling the super of this method.
+            */
+            var res = this._super();
+            if ( ! (this.__parentedParent
+                    && this.__parentedParent.flags
+                    && this.__parentedParent.flags.autoswitch)) {
+                return res;
+            }
+            if (this.__parentedParent.flags.suppress_autoswitch) {
+                this.__parentedParent.flags.suppress_autoswitch = false;
+                return res;
+            }
+            if (this.dataset.size() === 1) {
+                this.dataset.select_id(this.dataset.ids[0]);
+                this.do_switch_view('form', null, { mode: undefined });
+            }
+            return res;
+        },
+    });
+
+};