Indexes and metadata cleanup from setup_catalog

CHANGES.rst

@@ -14,6 +14,7 @@ Changelog
 
 **Changed**
 
+- #1486 Clean-up of indexes and metadata from `setup_catalog`
 
 **Removed**
 

CODE_CONVENTIONS.md

@@ -10,8 +10,33 @@ any add-ons for `senaite` too.
 Names for catalog indexes don't follow the `CamelCase` naming convention, rather
 all in lowercase and words separated by `_`:
 
-- Wrong: `getSampleTypeUID`
-- Good: `sampletype_uids`
+- Bad: `getSampleTypeUID`
+- Good: `sampletype_uid`
+
+#### Plural and singular forms
+
+Indexes will be written in singular form. There are a few exceptions, mostly
+those that come from `Plone` or `Zope` (e.g. `allowedRolesAndUsers`). Quite
+frequently, the plural form is used wrongly because the name of the meta-type
+index to use leads us to think about the plural form: e.g. `KeywordIndex`, that
+indexes a sequence of keywords. Is better to think about how the searches
+against the index work.
+
+For instance, for a given object, a `KeywordIndex` will store a sequence of
+keywords, but if we do a search for single or multiple keywords against this
+index, the search will only return those items that have at least one of the
+keywords. And if there are multiple keyword matches for same item, the system
+will only return the item once. Since we can query for any index (`FieldIndex`,
+`KeywordIndex`, etc.) using a list, it does not make sense to use the plural
+form. In fact, if you are forced to add an index in plural form because a given
+index with same name, but in singular already exists, probably the index in
+singular is a `FieldIndex`, that don't allow you to store multiple values. In
+such case, the best approach is to change the meta-type of the existing index
+from `FieldIndex` to `KeywordIndex`.
+
+- Bad: `sampletype_titles`
+- Good: `sampletype_title`
+
 
 ### Metadata fields naming
 
@@ -22,6 +47,10 @@ convention. Since one would expect the name of the metadata field to match
 with the name of the function from the object, we keep same convention. This
 might change in future when we move to `Dexterity`.
 
-- Wrong: `SampleTypeUID`
+- Bad: `SampleTypeUID`
 - Good: `getSampleTypeUID`
 
+#### Plural and singular forms
+
+For metadata fields, use plural forms when the field returns a list and use
+singular when the field returns a single value.

bika/lims/api/__init__.py

@@ -1320,13 +1320,15 @@ def to_searchable_text_metadata(value):
     if isinstance(value, (bool)):
         return u""
     if isinstance(value, (list, tuple)):
-        for v in value:
-            return to_searchable_text_metadata(v)
-    if isinstance(value, (dict)):
-        for k, v in value.items():
-            return to_searchable_text_metadata(v)
+        values = map(to_searchable_text_metadata, value)
+        values = filter(None, values)
+        return " ".join(values)
+    if isinstance(value, dict):
+        return to_searchable_text_metadata(value.values())
     if is_date(value):
         return value.strftime("%Y-%m-%d")
+    if is_at_content(value):
+        return to_searchable_text_metadata(get_title(value))
     if not isinstance(value, basestring):
         value = str(value)
     return safe_unicode(value)

bika/lims/browser/accreditation.py

@@ -19,11 +19,13 @@
 # Some rights reserved, see README and LICENSE.
 
 from Products.CMFPlone.utils import safe_unicode
+from plone.app.content.browser.interfaces import IFolderContentsView
+from zope.interface import implements
+
+from bika.lims import api
 from bika.lims import bikaMessageFactory as _
 from bika.lims.controlpanel.bika_analysisservices import AnalysisServicesView
 from bika.lims.utils import t
-from plone.app.content.browser.interfaces import IFolderContentsView
-from zope.interface import implements
 
 
 class AccreditationView(AnalysisServicesView):
@@ -34,7 +36,6 @@ def __init__(self, context, request):
         self.contentFilter = {
             'portal_type': 'AnalysisService',
             'sort_on': 'sortable_title',
-            'getAccredited': True,
             'is_active': True}
         self.context_actions = {}
         self.title = self.context.translate(_("Accreditation"))
@@ -102,3 +103,17 @@ def selected_cats(self, items):
             if 'category' in item and item['category'] not in cats:
                 cats.append(item['category'])
         return cats
+
+    def search(self, searchterm="", ignorecase=True):
+        # Boil out those that are not accredited
+        # There is no need to keep a `getAccredited` index in the catalog only
+        # for this view. Since we don't expect a lot of items from this content
+        # type (AnalysisService), is fine to wake-up them
+        brains = super(AccreditationView, self).search(searchterm, ignorecase)
+
+        def is_accredited(brain):
+            obj = api.get_object(brain)
+            return obj.getAccredited()
+
+        return filter(is_accredited, brains)
+

bika/lims/browser/analysisrequest/add2.py

@@ -538,7 +538,7 @@ def get_services(self, poc="lab"):
         bsc = api.get_tool("bika_setup_catalog")
         query = {
             "portal_type": "AnalysisService",
-            "getPointOfCapture": poc,
+            "point_of_capture": poc,
             "is_active": True,
             "sort_on": "sortable_title",
         }
@@ -1018,18 +1018,18 @@ def get_sampletype_info(self, obj):
             # Display Sample Points that have this sample type assigned plus
             # those that do not have a sample type assigned
             "SamplePoint": {
-                "sampletype_uids": [sample_type_uid, None],
+                "sampletype_uid": [sample_type_uid, None],
                 "getClientUID": [client_uid, ""],
             },
             # Display Specifications that have this sample type assigned only
             "Specification": {
-                "sampletype_uids": sample_type_uid,
+                "sampletype_uid": sample_type_uid,
                 "getClientUID": [client_uid, ""],
             },
             # Display AR Templates that have this sample type assigned plus
             # those that do not have a sample type assigned
             "Template": {
-                "sampletype_uids": [sample_type_uid, None],
+                "sampletype_uid": [sample_type_uid, None],
                 "getClientUID": [client_uid, ""],
             }
         }

bika/lims/browser/analysisrequest/templates/ar_add2.pt

@@ -412,7 +412,6 @@
                   <tal:services tal:repeat="service python:services[category_title];">
                     <tr tal:define="service_uid service/UID;
                                     service_id service/getId;
-                                    service_acc service/getAccredited;
                                     service_keyword service/getKeyword;
                                     service_title service/Title;"
                         tal:attributes="id string:${service_id};

bika/lims/browser/clientfolder.py

@@ -19,20 +19,19 @@
 # Some rights reserved, see README and LICENSE.
 
 import collections
-import json
 
 from Products.CMFCore.permissions import ModifyPortalContent
-from bika.lims import api, logger
+from plone.app.content.browser.interfaces import IFolderContentsView
+from zope.interface import implements
+
 from bika.lims import bikaMessageFactory as _
-from bika.lims.browser import BrowserView
 from bika.lims.browser.bika_listing import BikaListingView
 from bika.lims.permissions import AddClient
 from bika.lims.permissions import ManageAnalysisRequests
-from bika.lims.utils import (check_permission, get_email_link, get_link,
-                             get_registry_value)
-from plone import protect
-from plone.app.content.browser.interfaces import IFolderContentsView
-from zope.interface import implements
+from bika.lims.utils import check_permission
+from bika.lims.utils import get_email_link
+from bika.lims.utils import get_link
+from bika.lims.utils import get_registry_value
 
 
 class ClientFolderContentsView(BikaListingView):
@@ -199,61 +198,3 @@ def client_match(client, search_term):
     if search_term in client.Description().lower():
         return True
     return False
-
-
-class ajaxGetClients(BrowserView):
-    """Vocabulary source for jquery combo dropdown box
-    """
-
-    def __call__(self):
-        protect.CheckAuthenticator(self.request)
-        searchTerm = self.request.get("searchTerm", "").lower()
-        page = self.request.get("page", 1)
-        nr_rows = self.request.get("rows", 20)
-        sort_order = self.request.get("sord") or "ascending"
-        sort_index = self.request.get("sidx") or "sortable_title"
-
-        if sort_order == "desc":
-            sort_order = "descending"
-
-        # Use the catalog to speed things up and also limit the results
-        catalog = api.get_tool("portal_catalog")
-        catalog_query = {
-            "portal_type": "Client",
-            "review_state": "active",
-            "sort_on": sort_index,
-            "sort_order": sort_order,
-            "sort_limit": 500
-        }
-        # Inject the searchTerm to narrow the results further
-        if searchTerm:
-            catalog_query["SearchableText"] = searchTerm
-        logger.debug("ajaxGetClients::catalog_query=%s" % catalog_query)
-        brains = catalog(catalog_query)
-        rows = []
-
-        for brain in brains:
-            client = brain.getObject()
-            # skip clients where the search term does not match
-            if searchTerm and not client_match(client, searchTerm):
-                continue
-            rows.append(
-                {
-                    "ClientID": client.getClientID(),
-                    "Title": client.Title(),
-                    "ClientUID": client.UID(),
-                }
-            )
-
-        pages = len(rows) / int(nr_rows)
-        pages += divmod(len(rows), int(nr_rows))[1] and 1 or 0
-        ret = {
-            "page": page,
-            "total": pages,
-            "records": len(rows),
-            "rows": rows[
-                (int(page) - 1) * int(nr_rows): int(page) * int(nr_rows)
-            ]
-        }
-
-        return json.dumps(ret)

bika/lims/browser/clientfolder.zcml

@@ -12,12 +12,4 @@
       layer="bika.lims.interfaces.IBikaLIMS"
     />
 
-    <browser:page
-      for="*"
-      name="getClients"
-      class="bika.lims.browser.clientfolder.ajaxGetClients"
-      permission="zope.Public"
-      layer="bika.lims.interfaces.IBikaLIMS"
-    />
-
 </configure>

bika/lims/browser/department/labcontacts.py

@@ -41,12 +41,12 @@ def __init__(self, context, request):
         self.context_actions = {}
         self.contentFilter = {
             'portal_type': 'LabContact',
-            'sort_on': 'getFirstname',
+            'sort_on': 'sortable_title',
             'sort_order': 'ascending'
         }
         self.columns = {
             'Fullname': {'title': _('Name'),
-                         'index': 'getFullname'},
+                         'index': 'sortable_title'},
             'Department': {'title': _('Department')},
             'BusinessPhone': {'title': _('Phone')},
             'MobilePhone': {'title': _('Mobile Phone')},

bika/lims/browser/js/bika.lims.loader.js

@@ -131,9 +131,6 @@ window.bika.lims.controllers =  {
     ".portaltype-worksheetfolder":
         ['WorksheetFolderView'],
 
-    ".portaltype-worksheet.template-add_analyses":
-        ['WorksheetAddAnalysesView'],
-
     ".portaltype-worksheet.template-add_blank":
         ['WorksheetAddQCAnalysesView'],