Fix worksheet count on dashboard when filtering by department (#696)

* Follow PEP8 style guidelines

* Add getDepartmentUIDs keyword index to worksheet catalog

This is to make filtering by department work with worksheets catalog.

* Update CHANGES.rst

Author: juangallostra

CHANGES.rst

@@ -15,6 +15,7 @@ Changelog
 
 **Fixed**
 
+- #696 Filter worksheets by department. The worksheet count in the dashboard is now properly updated accordingly to the selected departments
 
 **Security**
 

bika/lims/browser/dashboard/dashboard.py

@@ -38,8 +38,8 @@
 # Supported periodicities for evolution charts
 PERIODICITY_DAILY = "d"
 PERIODICITY_WEEKLY = "w"
-PERIODICITY_MONTHLY= "m"
-PERIODICITY_QUARTERLY= "q"
+PERIODICITY_MONTHLY = "m"
+PERIODICITY_QUARTERLY = "q"
 PERIODICITY_BIANNUAL = "b"
 PERIODICITY_YEARLY = "y"
 PERIODICITY_ALL = "a"
@@ -182,7 +182,7 @@ def __call__(self):
             return
 
         self.member = mtool.getAuthenticatedMember()
-        self.periodicity =  self.request.get('p', PERIODICITY_WEEKLY)
+        self.periodicity = self.request.get('p', PERIODICITY_WEEKLY)
         self.dashboard_cookie = self.check_dashboard_cookie()
         date_range = self.get_date_range(self.periodicity)
         self.date_from = date_range[0]
@@ -260,47 +260,47 @@ def get_date_range(self, periodicity=PERIODICITY_WEEKLY):
         :rtype: [(DateTime, DateTime)]
         """
         today = datetime.date.today()
-        if (periodicity == PERIODICITY_DAILY):
+        if periodicity == PERIODICITY_DAILY:
             # Daily, load last 30 days
             date_from = DateTime() - 30
             date_to = DateTime() + 1
-            return (date_from, date_to)
+            return date_from, date_to
 
-        if (periodicity == PERIODICITY_MONTHLY):
+        if periodicity == PERIODICITY_MONTHLY:
             # Monthly, load last 2 years
             min_year = today.year - 1 if today.month == 12 else today.year - 2
             min_month = 1 if today.month == 12 else today.month
             date_from = DateTime(min_year, min_month, 1)
             date_to = DateTime(today.year, today.month,
                                monthrange(today.year, today.month)[1],
                                23, 59, 59)
-            return (date_from, date_to)
+            return date_from, date_to
 
-        if (periodicity == PERIODICITY_QUARTERLY):
+        if periodicity == PERIODICITY_QUARTERLY:
             # Quarterly, load last 4 years
             m = (((today.month - 1) / 3) * 3) + 1
             min_year = today.year - 4 if today.month == 12 else today.year - 5
             date_from = DateTime(min_year, m, 1)
             date_to = DateTime(today.year, m + 2,
                                monthrange(today.year, m + 2)[1], 23, 59,
                                59)
-            return (date_from, date_to)
-        if (periodicity == PERIODICITY_BIANNUAL):
+            return date_from, date_to
+        if periodicity == PERIODICITY_BIANNUAL:
             # Biannual, load last 10 years
             m = (((today.month - 1) / 6) * 6) + 1
             min_year = today.year - 10 if today.month == 12 else today.year - 11
             date_from = DateTime(min_year, m, 1)
             date_to = DateTime(today.year, m + 5,
                                monthrange(today.year, m + 5)[1], 23, 59,
                                59)
-            return (date_from, date_to)
+            return date_from, date_to
 
-        if (periodicity in [PERIODICITY_YEARLY, PERIODICITY_ALL]):
+        if periodicity in [PERIODICITY_YEARLY, PERIODICITY_ALL]:
             # Yearly or All time, load last 15 years
             min_year = today.year - 15 if today.month == 12 else today.year - 16
             date_from = DateTime(min_year, 1, 1)
             date_to = DateTime(today.year, 12, 31, 23, 59, 59)
-            return (date_from, date_to)
+            return date_from, date_to
 
         # Default Weekly, load last six months
         year, weeknum, dow = today.isocalendar()
@@ -309,7 +309,7 @@ def get_date_range(self, periodicity=PERIODICITY_WEEKLY):
             else (today.month - 6) + 12
         date_from = DateTime(min_year, min_month, 1)
         date_to = DateTime() - dow + 7
-        return (date_from, date_to)
+        return date_from, date_to
 
     def get_sections(self):
         """ Returns an array with the sections to be displayed.
@@ -356,7 +356,7 @@ def _getStatistics(self, name, description, url, catalog, criterias, total):
             results = results if total >= results else total
             ratio = (float(results)/float(total))*100 if results > 0 else 0
         ratio = str("%%.%sf" % 1) % ratio
-        out['legend'] = _('of') + " " + str(total) + ' (' + ratio +'%)'
+        out['legend'] = _('of') + " " + str(total) + ' (' + ratio + '%)'
         out['number'] = results
         out['percentage'] = float(ratio)
         return out
@@ -373,7 +373,7 @@ def get_analysisrequests_section(self):
         filtering_allowed = self.context.bika_setup.getAllowDepartmentFiltering()
         if filtering_allowed:
             cookie_dep_uid = self.request.get(FILTER_BY_DEPT_COOKIE_ID, '').split(',') if filtering_allowed else ''
-            query['getDepartmentUIDs'] = { "query": cookie_dep_uid,"operator":"or" }
+            query['getDepartmentUIDs'] = {"query": cookie_dep_uid, "operator": "or"}
 
         # Check if dashboard_cookie contains any values to query
         # elements by
@@ -383,70 +383,70 @@ def get_analysisrequests_section(self):
         total = self.search_count(query, catalog.id)
 
         # Sampling workflow enabled?
-        if (self.context.bika_setup.getSamplingWorkflowEnabled()):
+        if self.context.bika_setup.getSamplingWorkflowEnabled():
             # Analysis Requests awaiting to be sampled or scheduled
             name = _('Analysis Requests to be sampled')
             desc = _("To be sampled")
             purl = 'samples?samples_review_state=to_be_sampled'
             query['review_state'] = ['to_be_sampled', ]
-            query['cancellation_state'] = ['active',]
+            query['cancellation_state'] = ['active', ]
             out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
             # Analysis Requests awaiting to be preserved
             name = _('Analysis Requests to be preserved')
             desc = _("To be preserved")
             purl = 'samples?samples_review_state=to_be_preserved'
             query['review_state'] = ['to_be_preserved', ]
-            query['cancellation_state'] = ['active',]
+            query['cancellation_state'] = ['active', ]
             out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
             # Analysis Requests scheduled for Sampling
             name = _('Analysis Requests scheduled for sampling')
             desc = _("Sampling scheduled")
             purl = 'samples?samples_review_state=scheduled_sampling'
             query['review_state'] = ['scheduled_sampling', ]
-            query['cancellation_state'] = ['active',]
+            query['cancellation_state'] = ['active', ]
             out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests awaiting for reception
         name = _('Analysis Requests to be received')
         desc = _("Reception pending")
         purl = 'analysisrequests?analysisrequests_review_state=sample_due'
         query['review_state'] = ['sample_due', ]
-        query['cancellation_state'] = ['active',]
+        query['cancellation_state'] = ['active', ]
         out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests under way
         name = _('Analysis Requests with results pending')
         desc = _("Results pending")
         purl = 'analysisrequests?analysisrequests_review_state=sample_received'
         query['review_state'] = ['attachment_due',
-                                 'sample_received',]
-        query['cancellation_state'] = ['active',]
+                                 'sample_received', ]
+        query['cancellation_state'] = ['active', ]
         out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests to be verified
         name = _('Analysis Requests to be verified')
         desc = _("To be verified")
         purl = 'analysisrequests?analysisrequests_review_state=to_be_verified'
         query['review_state'] = ['to_be_verified', ]
-        query['cancellation_state'] = ['active',]
+        query['cancellation_state'] = ['active', ]
         out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests verified (to be published)
         name = _('Analysis Requests verified')
         desc = _("Verified")
         purl = 'analysisrequests?analysisrequests_review_state=verified'
         query['review_state'] = ['verified', ]
-        query['cancellation_state'] = ['active',]
+        query['cancellation_state'] = ['active', ]
         out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests published
         name = _('Analysis Requests published')
         desc = _("Published")
         purl = 'analysisrequests?analysisrequests_review_state=published'
         query['review_state'] = ['published', ]
-        query['cancellation_state'] = ['active',]
+        query['cancellation_state'] = ['active', ]
         out.append(self._getStatistics(name, desc, purl, catalog, query, total))
 
         # Analysis Requests to be printed
@@ -456,7 +456,7 @@ def get_analysisrequests_section(self):
             purl = 'analysisrequests?analysisrequests_getPrinted=0'
             query['getPrinted'] = '0'
             query['review_state'] = ['published', ]
-            query['cancellation_state'] = ['active',]
+            query['cancellation_state'] = ['active', ]
             out.append(
                 self._getStatistics(name, desc, purl, catalog, query, total))
 
@@ -481,11 +481,11 @@ def get_worksheets_section(self):
         """
         out = []
         bc = getToolByName(self.context, CATALOG_WORKSHEET_LISTING)
-        query = {'portal_type':"Worksheet",}
+        query = {'portal_type': "Worksheet", }
         filtering_allowed = self.context.bika_setup.getAllowDepartmentFiltering()
         if filtering_allowed:
             cookie_dep_uid = self.request.get(FILTER_BY_DEPT_COOKIE_ID, '').split(',') if filtering_allowed else ''
-            query['getDepartmentUIDs'] = { "query": cookie_dep_uid,"operator":"or" }
+            query['getDepartmentUIDs'] = {"query": cookie_dep_uid, "operator": "or"}
 
         # Check if dashboard_cookie contains any values to query
         # elements by
@@ -503,14 +503,14 @@ def get_worksheets_section(self):
 
         # Worksheets to be verified
         name = _('To be verified')
-        desc =_('To be verified')
+        desc = _('To be verified')
         purl = 'worksheets?list_review_state=to_be_verified'
         query['review_state'] = ['to_be_verified', ]
         out.append(self._getStatistics(name, desc, purl, bc, query, total))
 
         # Worksheets verified
         name = _('Verified')
-        desc =_('Verified')
+        desc = _('Verified')
         purl = 'worksheets?list_review_state=verified'
         query['review_state'] = ['verified', ]
         out.append(self._getStatistics(name, desc, purl, bc, query, total))
@@ -793,7 +793,7 @@ def fill_dates_evo(self, catalog, query):
     def _fill_dates_evo_cachekey(method, self, query_json, catalog_name,
                                  periodicity):
         hour = time() // (60 * 60 * 2)
-        return (hour, catalog_name, query_json, periodicity)
+        return hour, catalog_name, query_json, periodicity
 
     @ram.cache(_fill_dates_evo_cachekey)
     def _fill_dates_evo(self, query_json, catalog_name, periodicity):
@@ -834,14 +834,14 @@ def _fill_dates_evo(self, query_json, catalog_name, periodicity):
         stats = statesmap.values()
         stats.sort()
         stats.append(otherstate)
-        statscount = {s:0 for s in stats}
+        statscount = {s: 0 for s in stats}
         # Add first all periods, cause we want all segments to be displayed
         curr = date_from.asdatetime()
         end = date_to.asdatetime()
         while curr < end:
             currstr = self._getDateStr(periodicity, DateTime(curr))
             if currstr not in outevoidx:
-                outdict = {'date':currstr}
+                outdict = {'date': currstr}
                 for k in stats:
                     outdict[k] = 0
                 outevo.append(outdict)
@@ -866,11 +866,11 @@ def _fill_dates_evo(self, query_json, catalog_name, periodicity):
             else:
                 # Create new row
                 currow = {'date': created,
-                          state: 1 }
+                          state: 1}
                 outevo.append(currow)
 
         # Remove all those states for which there is no data
-        rstates = [k for k,v in statscount.items() if v==0]
+        rstates = [k for k, v in statscount.items() if v == 0]
         for o in outevo:
             for r in rstates:
                 if r in o:

bika/lims/catalog/worksheet_catalog.py

@@ -23,6 +23,7 @@
     'getAnalyst': 'FieldIndex',
     'getWorksheetTemplateTitle': 'FieldIndex',
     'getAnalysesUIDs': 'KeywordIndex',
+    'getDepartmentUIDs': 'KeywordIndex',
 }
 # Defining the columns for this catalog
 _columns_list = [

bika/lims/upgrade/v01_02_004.py

@@ -8,6 +8,7 @@
 from bika.lims.config import PROJECTNAME as product
 from bika.lims.upgrade import upgradestep
 from bika.lims.upgrade.utils import UpgradeUtils
+from bika.lims.catalog.worksheet_catalog import CATALOG_WORKSHEET_LISTING
 
 version = '1.2.4'  # Remember version number in metadata.xml and setup.py
 profile = 'profile-{0}:default'.format(product)
@@ -26,7 +27,9 @@ def upgrade(tool):
 
     logger.info("Upgrading {0}: {1} -> {2}".format(product, ver_from, version))
 
-    # -------- ADD YOUR STUFF HERE --------
+    # Required to make filtering by department in worksheets work
+    ut.addIndex(CATALOG_WORKSHEET_LISTING, 'getDepartmentUIDs', 'KeywordIndex')
+    ut.refreshCatalogs()
 
     logger.info("{0} upgraded to version {1}".format(product, version))