diff --git a/base_name_search_improved/README.rst b/base_name_search_improved/README.rst new file mode 100644 index 000000000..07998cbb2 --- /dev/null +++ b/base_name_search_improved/README.rst @@ -0,0 +1,121 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +==================== +Improved Name Search +==================== + +Extends the name search feature to use additional, more relaxed +matching methods, and to allow searching into configurable additional +record fields. + +The name search is the lookup feature to select a related record. +For example, selecting a Customer on a new Sales order. + +For example, typing "john brown" doesn't match "John M. Brown". +The relaxed search also looks up for records containing all the words, +so "John M. Brown" would be a match. +It also tolerates words in a different order, so searching +for "brown john" also works. + +.. image:: images/image0.png + +Additionally, an Administrator can configure other fields to also lookup into. +For example, Customers could be additionally searched by City or Phone number. + +.. image:: images/image2.png + +How it works: + +Regular name search is performed, and the additional search logic is only +triggered if not enough results are found. +This way, no overhead is added on searches that would normally yield results. + +But if not enough results are found, then additional search methods are tried. +The specific methods used are: + +- Try regular search on each of the additional fields +- Try ordered word search on each of the search fields +- Try unordered word search on each of the search fields + +All results found are presented in that order, +hopefully presenting them in order of relevance. + + +Installation +============ + +No specific requirements. + + +Configuration +============= + +The fuzzy search is automatically enabled on all Models. +Note that this only affects typing in related fields. +The regular ``search()``, used in the top right search box, is not affected. + +Additional search fields can be configured at Settings > Technical > Database > Models, +using the "Name Search Fields" field. + +.. image:: images/image1.png + + +Usage +===== + +Just type into any related field, such as Customer on a Sale Order. + + +.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas + :alt: Try me on Runbot + :target: https://runbot.odoo-community.org/runbot/149/8.0 + +.. repo_id is available in https://github.com/OCA/maintainer-tools/blob/master/tools/repos_with_ids.txt +.. branch is "8.0" for example + +Known issues / Roadmap +====================== + +* Also use fuzzy search, such as the Levenshtein distance: + https://www.postgresql.org/docs/9.5/static/fuzzystrmatch.html +* The list of additional fields to search could benefit from caching, for efficiency. +* This feature could also be implemented for regular ``search`` on the ``name`` field. + + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues +`_. In case of trouble, please +check there if your issue has already been reported. If you spotted it first, +help us smashing it by providing a detailed and welcomed feedback. + +Credits +======= + +Images +------ + +* Odoo Community Association: `Icon `_. + +Contributors +------------ + +* Daniel Reis + +Maintainer +---------- + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +This module is maintained by the OCA. + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +To contribute to this module, please visit https://odoo-community.org. diff --git a/base_name_search_improved/__init__.py b/base_name_search_improved/__init__.py new file mode 100644 index 000000000..a0fdc10fe --- /dev/null +++ b/base_name_search_improved/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from . import models diff --git a/base_name_search_improved/__openerp__.py b/base_name_search_improved/__openerp__.py new file mode 100644 index 000000000..11df47076 --- /dev/null +++ b/base_name_search_improved/__openerp__.py @@ -0,0 +1,19 @@ +# -*- coding: utf-8 -*- +# © 2016 Daniel Reis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + 'name': 'Improved Name Search', + 'summary': 'Friendlier search when typing in relation fields', + 'version': '8.0.1.0.0', + 'category': 'Uncategorized', + 'website': 'https://odoo-community.org/', + 'author': 'Daniel Reis, Odoo Community Association (OCA)', + 'license': 'AGPL-3', + 'data': [ + 'views/ir_model.xml', + ], + 'installable': True, + 'depends': [ + 'base', + ], +} diff --git a/base_name_search_improved/images/image0.png b/base_name_search_improved/images/image0.png new file mode 100644 index 000000000..f6bbf6459 Binary files /dev/null and b/base_name_search_improved/images/image0.png differ diff --git a/base_name_search_improved/images/image1.png b/base_name_search_improved/images/image1.png new file mode 100644 index 000000000..855dbb1a2 Binary files /dev/null and b/base_name_search_improved/images/image1.png differ diff --git a/base_name_search_improved/images/image2.png b/base_name_search_improved/images/image2.png new file mode 100644 index 000000000..ef5ecac43 Binary files /dev/null and b/base_name_search_improved/images/image2.png differ diff --git a/base_name_search_improved/models/__init__.py b/base_name_search_improved/models/__init__.py new file mode 100644 index 000000000..58755e280 --- /dev/null +++ b/base_name_search_improved/models/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from . import ir_model diff --git a/base_name_search_improved/models/ir_model.py b/base_name_search_improved/models/ir_model.py new file mode 100644 index 000000000..66b00b3ea --- /dev/null +++ b/base_name_search_improved/models/ir_model.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# © 2016 Daniel Reis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from openerp import models, fields, api +from openerp import SUPERUSER_ID +from openerp import tools + + +# Extended name search is only used on some operators +ALLOWED_OPS = set(['ilike', 'like']) + + +@tools.ormcache(skiparg=0) +def _get_rec_names(self): + model = self.env['ir.model'].search( + [('model', '=', str(self._model))]) + rec_name = [self._rec_name] or [] + other_names = model.name_search_ids.mapped('name') + return rec_name + other_names + + +def _extend_name_results(self, domain, results, limit): + result_count = len(results) + if result_count < limit: + domain += [('id', 'not in', [x[0] for x in results])] + recs = self.search(domain, limit=limit - result_count) + results.extend(recs.name_get()) + return results + + +class ModelExtended(models.Model): + _inherit = 'ir.model' + + name_search_ids = fields.Many2many( + 'ir.model.fields', + string='Name Search Fields') + + def _register_hook(self, cr, ids=None): + + def make_name_search(): + + @api.model + def name_search(self, name='', args=None, + operator='ilike', limit=100): + # Perform standard name search + res = name_search.origin( + self, name=name, args=args, operator=operator, limit=limit) + enabled = self.env.context.get('name_search_extended', True) + # Perform extended name search + if enabled and operator in ALLOWED_OPS: + # Support a list of fields to search on + all_names = _get_rec_names(self) + # Try regular search on each additional search field + for rec_name in all_names[1:]: + domain = [(rec_name, operator, name)] + res = _extend_name_results(self, domain, res, limit) + # Try ordered word search on each of the search fields + for rec_name in all_names: + domain = [(rec_name, operator, name.replace(' ', '%'))] + res = _extend_name_results(self, domain, res, limit) + # Try unordered word search on each of the search fields + for rec_name in all_names: + domain = [(rec_name, operator, x) + for x in name.split() if x] + res = _extend_name_results(self, domain, res, limit) + return res + return name_search + + if ids is None: + ids = self.search(cr, SUPERUSER_ID, []) + for model in self.browse(cr, SUPERUSER_ID, ids): + Model = self.pool.get(model.model) + if Model: + Model._patch_method('name_search', make_name_search()) + return super(ModelExtended, self)._register_hook(cr) diff --git a/base_name_search_improved/static/description/icon.png b/base_name_search_improved/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/base_name_search_improved/static/description/icon.png differ diff --git a/base_name_search_improved/tests/__init__.py b/base_name_search_improved/tests/__init__.py new file mode 100644 index 000000000..4ea57064e --- /dev/null +++ b/base_name_search_improved/tests/__init__.py @@ -0,0 +1,5 @@ +# -*- coding: utf-8 -*- +# © 2016 Daniel Reis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from . import test_name_search diff --git a/base_name_search_improved/tests/test_name_search.py b/base_name_search_improved/tests/test_name_search.py new file mode 100644 index 000000000..408db3eb5 --- /dev/null +++ b/base_name_search_improved/tests/test_name_search.py @@ -0,0 +1,44 @@ +# -*- coding: utf-8 -*- +# © 2016 Daniel Reis +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from openerp.tests.common import TransactionCase, at_install, post_install + + +@at_install(False) +@post_install(True) +class NameSearchCase(TransactionCase): + + def setUp(self): + super(NameSearchCase, self).setUp() + phone_field = self.env.ref('base.field_res_partner_phone') + model_partner = self.env.ref('base.model_res_partner') + model_partner.name_search_ids = phone_field + self.Partner = self.env['res.partner'] + self.partner1 = self.Partner.create( + {'name': 'Luigi Verconti', + 'phone': '+351 555 777 333'}) + self.partner2 = self.Partner.create( + {'name': 'Ken Shabby', + 'phone': '+351 555 333 777'}) + self.partner3 = self.Partner.create( + {'name': 'Johann Gambolputty of Ulm', + 'phone': '+351 777 333 555'}) + + def test_RelevanceOrderedResults(self): + """Return results ordered by relevance""" + res = self.Partner.name_search('555 777') + self.assertEqual( + res[0][0], self.partner1.id, + 'Match full string honoring spaces') + self.assertEqual( + res[1][0], self.partner2.id, + 'Match words honoring order of appearance') + self.assertEqual( + res[2][0], self.partner3.id, + 'Match all words, regardless of order of appearance') + + def test_NameSearchMustMatchAllWords(self): + """Must Match All Words""" + res = self.Partner.name_search('ulm 555 777') + self.assertFalse(res) diff --git a/base_name_search_improved/views/ir_model.xml b/base_name_search_improved/views/ir_model.xml new file mode 100644 index 000000000..fbc3ff7b7 --- /dev/null +++ b/base_name_search_improved/views/ir_model.xml @@ -0,0 +1,25 @@ + + + + + + + + Add Name Searchable to Models + ir.model + + + + + + + + + + + +