Browse Source

[MIG] base_name_search_improved: Migration to 11.0

- Descriptor: change __openerp__.py file to __manifest__.py also update module
  version from 9.0.1.0.0 to 11.0.1.0.0
- Update README using guideline
- Views: replace view tag openerp to odoo and rename files to match guideline
- Models

  - update imports from openerp to odoo
  - remove enconding line # -*- coding: utf-8 -*-
  - update to make it compatible
  - remove use of SUPERUSER_ID use sudo instead.
  - rename class name to make it match with guideline.
  - update methods to match api used in version 11.0
  - fix pylint errors
  - replace use of non exist self._model with self._name
  - use `Model `is not None instead of if `Model` this becuase the last one is
    a empty recordset and this one was evaluate to False and never was
    patching the method.

- apply changes resquested/suggested in the PR by the reviewers.
pull/1325/head
Katherine Zaoral 6 years ago
parent
commit
947e68b804
  1. 90
      base_name_search_improved/README.rst
  2. 3
      base_name_search_improved/__init__.py
  3. 9
      base_name_search_improved/__manifest__.py
  4. 3
      base_name_search_improved/models/__init__.py
  5. 35
      base_name_search_improved/models/ir_model.py
  6. 10
      base_name_search_improved/readme/CONFIGURE.rst
  7. 1
      base_name_search_improved/readme/CONTRIBUTORS.rst
  8. 3
      base_name_search_improved/readme/CREDITS.rst
  9. 35
      base_name_search_improved/readme/DESCRIPTION.rst
  10. 4
      base_name_search_improved/readme/ROADMAP.rst
  11. 1
      base_name_search_improved/readme/USAGE.rst
  12. 3
      base_name_search_improved/tests/__init__.py
  13. 5
      base_name_search_improved/tests/test_name_search.py
  14. 6
      base_name_search_improved/views/ir_model_views.xml

90
base_name_search_improved/README.rst

@ -1,11 +1,30 @@
.. 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 Improved Name Search
==================== ====================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/11.0/base_name_search_improved
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_name_search_improved
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/149/11.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
Extends the name search feature to use additional, more relaxed Extends the name search feature to use additional, more relaxed
matching methods, and to allow searching into configurable additional matching methods, and to allow searching into configurable additional
record fields. record fields.
@ -19,12 +38,12 @@ so "John M. Brown" would be a match.
It also tolerates words in a different order, so searching It also tolerates words in a different order, so searching
for "brown john" also works. for "brown john" also works.
.. image:: images/image0.png
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image0.png
Additionally, an Administrator can configure other fields to also lookup into. Additionally, an Administrator can configure other fields to also lookup into.
For example, Customers could be additionally searched by City or Phone number. For example, Customers could be additionally searched by City or Phone number.
.. image:: images/image2.png
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image2.png
How it works: How it works:
@ -42,12 +61,10 @@ The specific methods used are:
All results found are presented in that order, All results found are presented in that order,
hopefully presenting them in order of relevance. hopefully presenting them in order of relevance.
**Table of contents**
Installation
============
No specific requirements.
.. contents::
:local:
Configuration Configuration
============= =============
@ -59,22 +76,15 @@ The regular ``search()``, used in the top right search box, is not affected.
Additional search fields can be configured at Settings > Technical > Database > Models, Additional search fields can be configured at Settings > Technical > Database > Models,
using the "Name Search Fields" field. using the "Name Search Fields" field.
.. image:: images/image1.png
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png
:alt: Name Search Fields
:width: 600 px
Usage Usage
===== =====
Just type into any related field, such as Customer on a Sale Order. 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/9.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 Known issues / Roadmap
====================== ======================
@ -83,39 +93,49 @@ Known issues / Roadmap
* The list of additional fields to search could benefit from caching, for efficiency. * 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. * This feature could also be implemented for regular ``search`` on the ``name`` field.
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-tools/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.
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/issues/new?body=module:%20base_name_search_improved%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits Credits
======= =======
Images
------
Authors
~~~~~~~
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
* Daniel Reis
Contributors Contributors
------------
~~~~~~~~~~~~
* Daniel Reis <https://github.com/dreispt> * Daniel Reis <https://github.com/dreispt>
Maintainer
----------
Other credits
~~~~~~~~~~~~~
The development of this module has been financially supported by:
* Odoo Community Association
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit https://odoo-community.org.
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/base_name_search_improved>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

3
base_name_search_improved/__init__.py

@ -1,2 +1,3 @@
# -*- coding: utf-8 -*-
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import models from . import models

9
base_name_search_improved/__openerp__.py → base_name_search_improved/__manifest__.py

@ -1,16 +1,15 @@
# -*- coding: utf-8 -*-
# © 2016 Daniel Reis
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{ {
'name': 'Improved Name Search', 'name': 'Improved Name Search',
'summary': 'Friendlier search when typing in relation fields', 'summary': 'Friendlier search when typing in relation fields',
'version': '9.0.1.0.0',
'version': '11.0.1.0.0',
'category': 'Uncategorized', 'category': 'Uncategorized',
'website': 'https://odoo-community.org/',
'website': 'https://github.com/OCA/server-tools',
'author': 'Daniel Reis, Odoo Community Association (OCA)', 'author': 'Daniel Reis, Odoo Community Association (OCA)',
'license': 'AGPL-3', 'license': 'AGPL-3',
'data': [ 'data': [
'views/ir_model.xml',
'views/ir_model_views.xml',
], ],
'depends': [ 'depends': [
'base', 'base',

3
base_name_search_improved/models/__init__.py

@ -1,2 +1,3 @@
# -*- coding: utf-8 -*-
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import ir_model from . import ir_model

35
base_name_search_improved/models/ir_model.py

@ -1,22 +1,18 @@
# -*- coding: utf-8 -*-
# © 2016 Daniel Reis
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). # 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
from odoo import models, fields, api, tools
# Extended name search is only used on some operators # Extended name search is only used on some operators
ALLOWED_OPS = set(['ilike', 'like'])
ALLOWED_OPS = {'ilike', 'like'}
@tools.ormcache(skiparg=0) @tools.ormcache(skiparg=0)
def _get_rec_names(self): def _get_rec_names(self):
"List of fields to search into" "List of fields to search into"
model = self.env['ir.model'].search( model = self.env['ir.model'].search(
[('model', '=', str(self._model))])
rec_name = [self._rec_name] or []
[('model', '=', self._name)])
rec_name = [self._rec_name] if bool(self._rec_name) else []
other_names = model.name_search_ids.mapped('name') other_names = model.name_search_ids.mapped('name')
return rec_name + other_names return rec_name + other_names
@ -30,14 +26,15 @@ def _extend_name_results(self, domain, results, limit):
return results return results
class ModelExtended(models.Model):
class IrModel(models.Model):
_inherit = 'ir.model' _inherit = 'ir.model'
name_search_ids = fields.Many2many( name_search_ids = fields.Many2many(
'ir.model.fields', 'ir.model.fields',
string='Name Search Fields') string='Name Search Fields')
def _register_hook(self, cr, ids=None):
@api.model_cr
def _register_hook(self):
def make_name_search(): def make_name_search():
@ -46,7 +43,8 @@ class ModelExtended(models.Model):
operator='ilike', limit=100): operator='ilike', limit=100):
# Perform standard name search # Perform standard name search
res = name_search.origin( res = name_search.origin(
self, name=name, args=args, operator=operator, limit=limit)
self, name=name, args=args, operator=operator,
limit=limit)
enabled = self.env.context.get('name_search_extended', True) enabled = self.env.context.get('name_search_extended', True)
# Perform extended name search # Perform extended name search
# Note: Empty name causes error on # Note: Empty name causes error on
@ -62,7 +60,8 @@ class ModelExtended(models.Model):
self, base_domain + domain, res, limit) self, base_domain + domain, res, limit)
# Try ordered word search on each of the search fields # Try ordered word search on each of the search fields
for rec_name in all_names: for rec_name in all_names:
domain = [(rec_name, operator, name.replace(' ', '%'))]
domain = [
(rec_name, operator, name.replace(' ', '%'))]
res = _extend_name_results( res = _extend_name_results(
self, base_domain + domain, res, limit) self, base_domain + domain, res, limit)
# Try unordered word search on each of the search fields # Try unordered word search on each of the search fields
@ -74,10 +73,8 @@ class ModelExtended(models.Model):
return res return res
return name_search 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:
for model in self.sudo().search(self.ids or []):
Model = self.env.get(model.model)
if Model is not None:
Model._patch_method('name_search', make_name_search()) Model._patch_method('name_search', make_name_search())
return super(ModelExtended, self)._register_hook(cr)
return super(IrModel, self)._register_hook()

10
base_name_search_improved/readme/CONFIGURE.rst

@ -0,0 +1,10 @@
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.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/images/image1.png
:alt: Name Search Fields
:width: 600 px

1
base_name_search_improved/readme/CONTRIBUTORS.rst

@ -0,0 +1 @@
* Daniel Reis <https://github.com/dreispt>

3
base_name_search_improved/readme/CREDITS.rst

@ -0,0 +1,3 @@
The development of this module has been financially supported by:
* Odoo Community Association

35
base_name_search_improved/readme/DESCRIPTION.rst

@ -0,0 +1,35 @@
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.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/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.
.. figure:: https://raw.githubusercontent.com/OCA/server-tools/11.0/base_name_search_improved/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.

4
base_name_search_improved/readme/ROADMAP.rst

@ -0,0 +1,4 @@
* 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.

1
base_name_search_improved/readme/USAGE.rst

@ -0,0 +1 @@
Just type into any related field, such as Customer on a Sale Order.

3
base_name_search_improved/tests/__init__.py

@ -1,5 +1,4 @@
# -*- coding: utf-8 -*-
# © 2016 Daniel Reis
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from . import test_name_search from . import test_name_search

5
base_name_search_improved/tests/test_name_search.py

@ -1,8 +1,7 @@
# -*- coding: utf-8 -*-
# © 2016 Daniel Reis
# Copyright 2016 Daniel Reis
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from openerp.tests.common import TransactionCase, at_install, post_install
from odoo.tests.common import TransactionCase, at_install, post_install
@at_install(False) @at_install(False)

6
base_name_search_improved/views/ir_model.xml → base_name_search_improved/views/ir_model_views.xml

@ -1,8 +1,8 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<!-- © 2016 Daniel Reis
<!-- Copyright 2016 Daniel Reis
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). --> License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<openerp>
<odoo>
<record id="view_model_form" model="ir.ui.view"> <record id="view_model_form" model="ir.ui.view">
<field name="name">Add Name Searchable to Models</field> <field name="name">Add Name Searchable to Models</field>
@ -18,4 +18,4 @@
</field> </field>
</record> </record>
</openerp>
</odoo>
Loading…
Cancel
Save