Points in QC Charts are not displayed in accordance with results capture date (senaite#653)

* Unexpected date format of results capture date for QC Charts

* Added senaite#653 entry in CHANGES.rst

* Added is_date and get_date functions in the api

* Use api.is_date to check if getResultCaptureDate is a valid date

* api.get_date() -> api.to_date() with default value as fallback

* Added tests for api.to_date in API.rst

* Redux isinstance for DateTime + datetime in api.is_date

Author: xispa

CHANGES.rst

@@ -25,6 +25,7 @@ Changelog
 
 **Fixed**
 
+- #653 Points in QC Charts are not displayed in accordance with capture date
 - #662 Viewing Cancelled AR's fails
 - #550 Wrong Listings of Analyses called from Dashboard
 - #666 "Rejected" filter is displayed in AR lists regardless of Setup setting

bika/lims/api.py

@@ -8,6 +8,9 @@
 from Acquisition import aq_base
 from AccessControl.PermissionRole import rolesForPermissionOn
 
+from datetime import datetime
+from DateTime import DateTime
+
 from Products.CMFPlone.utils import base_hasattr
 from Products.CMFCore.interfaces import ISiteRoot
 from Products.CMFCore.interfaces import IFolderish
@@ -1143,6 +1146,7 @@ def normalize_filename(string):
     normalizer = getUtility(IFileNameNormalizer).normalize
     return normalizer(string)
 
+
 def is_uid(uid, validate=False):
     """Checks if the passed in uid is a valid UID
 
@@ -1166,3 +1170,38 @@ def is_uid(uid, validate=False):
     if brains:
         assert (len(brains) == 1)
     return len(brains) > 0
+
+
+def is_date(date):
+    """Checks if the passed in value is a valid Zope's DateTime
+
+    :param date: The date to check
+    :type date: DateTime
+    :return: True if a valid date
+    :rtype: bool
+    """
+    if not date:
+        return False
+    return isinstance(date, (DateTime, datetime))
+
+
+def to_date(value, default=None):
+    """Tries to convert the passed in value to Zope's DateTime
+
+    :param value: The value to be converted to a valid DateTime
+    :type value: str, DateTime or datetime
+    :return: The DateTime representation of the value passed in or default
+    """
+    if isinstance(value, DateTime):
+        return value
+    if not value:
+        if default is None:
+            return None
+        return to_date(default)
+    try:
+        if isinstance(value, str) and '.' in value:
+            # https://docs.plone.org/develop/plone/misc/datetime.html#datetime-problems-and-pitfalls
+            return DateTime(value, datefmt='international')
+        return DateTime(value)
+    except:
+        return to_date(default)

bika/lims/browser/instrument.py

@@ -12,7 +12,7 @@
 from Products.CMFCore.utils import getToolByName
 from Products.CMFPlone.utils import safe_unicode
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
-from bika.lims import bikaMessageFactory as _
+from bika.lims import bikaMessageFactory as _, api
 from bika.lims.browser import BrowserView
 from bika.lims.browser.analyses import AnalysesView
 from bika.lims.browser.bika_listing import BikaListingView
@@ -532,9 +532,11 @@ def folderitems(self):
                     error_amount = ((target / 100) * error) if target > 0 else 0
                     upper = smax + error_amount
                     lower = smin - error_amount
-
+                    cap_date = obj.getResultCaptureDate()
+                    cap_date = api.is_date(cap_date) and \
+                               cap_date.strftime('%Y-%m-%d %I:%M %p') or ''
                     anrow = {
-                        'date': item['CaptureDate'],
+                        'date': cap_date,
                         'min': smin,
                         'max': smax,
                         'target': target,

bika/lims/browser/referencesample.py

@@ -198,7 +198,9 @@ def addToJSON(self, analysis, service_uid, item):
         trows = self.anjson.get(serviceref, {})
         anrows = trows.get(qcid, [])
         rr = parent.getResultsRangeDict()
-        cap_date = item.get('CaptureDate', None)
+        cap_date = item['obj'].getResultCaptureDate
+        cap_date = api.is_date(cap_date) and \
+                   cap_date.strftime('%Y-%m-%d %I:%M %p') or ''
         if service_uid in rr:
             specs = rr.get(service_uid, None)
             try:

bika/lims/tests/doctests/API.rst

@@ -1177,3 +1177,127 @@ Checks if an UID is a valid 23 alphanumeric uid and with a brain:
     >>> uid = serv.UID()
     >>> api.is_uid(uid, validate=True)
     True
+
+Check if a Date is valid
+------------------------
+
+Do some imports first:
+
+    >>> from datetime import datetime
+    >>> from DateTime import DateTime
+
+Checks if a DateTime is valid:
+
+    >>> now = DateTime()
+    >>> api.is_date(now)
+    True
+
+    >>> now = datetime.now()
+    >>> api.is_date(now)
+    True
+
+    >>> now = DateTime(now)
+    >>> api.is_date(now)
+    True
+
+    >>> api.is_date(None)
+    False
+
+    >>> api.is_date('2018-04-23')
+    False
+
+Try conversions to Date
+-----------------------
+
+Try to convert to DateTime:
+
+    >>> now = DateTime()
+    >>> zpdt = api.to_date(now)
+    >>> zpdt.ISO8601() == now.ISO8601()
+    True
+
+    >>> now = datetime.now()
+    >>> zpdt = api.to_date(now)
+    >>> pydt = zpdt.asdatetime()
+
+Note that here, for the comparison between dates, we convert DateTime to python
+datetime, cause DateTime.strftime() is broken for timezones (always looks at
+system time zone, ignores the timezone and offset of the DateTime instance
+itself):
+
+    >>> pydt.strftime('%Y-%m-%dT%H:%M:%S') == now.strftime('%Y-%m-%dT%H:%M:%S')
+    True
+
+Try the same, but with utcnow() instead:
+
+    >>> now = datetime.utcnow()
+    >>> zpdt = api.to_date(now)
+    >>> pydt = zpdt.asdatetime()
+    >>> pydt.strftime('%Y-%m-%dT%H:%M:%S') == now.strftime('%Y-%m-%dT%H:%M:%S')
+    True
+
+Now we convert just a string formatted date:
+
+    >>> strd = "2018-12-01 17:50:34"
+    >>> zpdt = api.to_date(strd)
+    >>> zpdt.ISO8601()
+    '2018-12-01T17:50:34'
+
+Now we convert just a string formatted date, but with timezone:
+
+    >>> strd = "2018-12-01 17:50:34 GMT+1"
+    >>> zpdt = api.to_date(strd)
+    >>> zpdt.ISO8601()
+    '2018-12-01T17:50:34+01:00'
+
+We also check a bad date here (note the month is 13):
+
+    >>> strd = "2018-13-01 17:50:34"
+    >>> zpdt = api.to_date(strd)
+    >>> api.is_date(zpdt)
+    False
+
+And with European format:
+
+    >>> strd = "01.12.2018 17:50:34"
+    >>> zpdt = api.to_date(strd)
+    >>> zpdt.ISO8601()
+    '2018-12-01T17:50:34'
+
+    >>> zpdt = api.to_date(None)
+    >>> zpdt is None
+    True
+
+Use a string formatted date as fallback:
+
+    >>> strd = "2018-13-01 17:50:34"
+    >>> default_date = "2018-01-01 19:30:30"
+    >>> zpdt = api.to_date(strd, default_date)
+    >>> zpdt.ISO8601()
+    '2018-01-01T19:30:30'
+
+Use a DateTime object as fallback:
+
+    >>> strd = "2018-13-01 17:50:34"
+    >>> default_date = "2018-01-01 19:30:30"
+    >>> default_date = api.to_date(default_date)
+    >>> zpdt = api.to_date(strd, default_date)
+    >>> zpdt.ISO8601() == default_date.ISO8601()
+    True
+
+Use a datetime object as fallback:
+
+    >>> strd = "2018-13-01 17:50:34"
+    >>> default_date = datetime.now()
+    >>> zpdt = api.to_date(strd, default_date)
+    >>> dzpdt = api.to_date(default_date)
+    >>> zpdt.ISO8601() == dzpdt.ISO8601()
+    True
+
+Use a non-conversionable value as fallback:
+
+    >>> strd = "2018-13-01 17:50:34"
+    >>> default_date = "something wrong here"
+    >>> zpdt = api.to_date(strd, default_date)
+    >>> zpdt is None
+    True