PR-1942 Feature/Instrument certification interval + Traceback after adding calibration certificate (#459)

* Refactoring isCalibrationInProgress

implemented method to InstrumentCalibration.
Added Doctest.
Use this method in Instruments

Conflicts:
	bika/lims/content/instrument.py
	bika/lims/content/instrumentcalibration.py
	bika/lims/tests/test_textual_doctests.py

* Added isValid method to instrument certification

instruments use this method now as well

Conflicts:
	bika/lims/content/instrumentcertification.py

* Added helpers to get the days/weeks until expiration

Conflicts:
	bika/lims/content/instrumentcertification.py

* Improved Instrument Listing Table

wrapped strings into messagefactory.
Return immediately weeks and dates from the certificate.

Conflicts:
	bika/lims/controlpanel/bika_instruments.py

* Refactored getLatestValidCalibration

Conflicts:
	bika/lims/content/instrument.py
	bika/lims/content/instrumentcalibration.py

* Refactored instrument1.getLatestValidCertification

Conflicts:
	bika/lims/content/instrument.py

* PEP8 for instruments

Conflicts:
	bika/lims/content/instrument.py

* better expiration and validity calculation

Conflicts:
	bika/lims/content/instrumentcalibration.py
	bika/lims/content/instrumentcertification.py

* Added interval field to instrument certification

Instrument Certificaitons can now have an expiration interval,
which automatically calculates the ValidTo field value.

Added doctest to test the new behavior.

Conflicts:
	bika/lims/content/instrumentcertification.py

* PEP8 for instrument validations

Also added missing interface IInstrumentValidation

Conflicts:
	bika/lims/content/instrumentvalidation.py

* Added missing zope interfaces

Test for implemented interface in doctest

Conflicts:
	bika/lims/content/instrumentcalibration.py
	bika/lims/interfaces/__init__.py

* Docstring formatting only

* Refactored isValidationInProgress + tests

Conflicts:
	bika/lims/content/instrumentvalidation.py

* test always with new DateTime's

* Doctested instrument validations

Conflicts:
	bika/lims/content/instrument.py

* renamed doctest

Conflicts:
	bika/lims/tests/test_textual_doctests.py

* Fixed ValidTo setter method

wipe out the original value of the 'ValidTo' field to ensure the calculated
valued don't get overwritten later in the edit process.

Conflicts:
	bika/lims/content/instrumentcertification.py

* Remove duplicated imports

* Moved instrument certs and validations test and remove old instrument doctest

* Changelog

* Better changelog

Author: xispa

CHANGES.rst

@@ -12,10 +12,12 @@ Changelog
 
 **Changed**
 
+- #459 PR-1942 Feature/instrument certification interval refactoring
 - #431 Make ARAnalysesField setter to accept Analysis/Service objects
 
 **Fixed**
 
+- #459 Traceback in Instruments list after adding a calibration certificate
 - #454 Click on some analyses pops up a new page instead of object log
 - #452 Traceback error when deleting attachment from Analysis Request
 - #450 Traceback after clicking "Manage Results" in a WS w/o Analyses assigned

bika/lims/content/instrument.py

@@ -55,7 +55,6 @@
 from bika.lims.content.bikaschema import BikaSchema
 from bika.lims.content.bikaschema import BikaFolderSchema
 from bika.lims import bikaMessageFactory as _
-from bika.lims import deprecated
 
 schema = BikaFolderSchema.copy() + BikaSchema.copy() + Schema((
 
@@ -514,7 +513,7 @@ def getCertifications(self):
         """ Returns the certifications of the instrument. Both internal
             and external certifitions
         """
-        return [c for c in self.objectValues('InstrumentCertification') if c]
+        return self.objectValues('InstrumentCertification')
 
     def getValidCertifications(self):
         """ Returns the certifications fully valid
@@ -616,128 +615,111 @@ def isOutOfDate(self):
         """ Returns if the current instrument is out-of-date regards to
             its certifications
         """
-        cert = self.getLatestValidCertification()
-        today = date.today()
-        if cert and cert.getValidTo():
-            validto = cert.getValidTo().asdatetime().date();
-            if validto > today:
-                return False
+        certification = self.getLatestValidCertification()
+        if certification:
+            return not certification.isValid()
         return True
 
     def isValidationInProgress(self):
         """ Returns if the current instrument is under validation progress
         """
         validation = self.getLatestValidValidation()
-        today = date.today()
-        if validation and validation.getDownTo():
-            validfrom = validation.getDownFrom().asdatetime().date()
-            validto = validation.getDownTo().asdatetime().date()
-            if validfrom <= today <= validto:
-                return True
+        if validation:
+            return validation.isValidationInProgress()
         return False
 
     def isCalibrationInProgress(self):
         """ Returns if the current instrument is under calibration progress
         """
-        for calibration in self.getCalibrations():
-            if calibration.isCalibrationInProgress():
-                return True
+        calibration = self.getLatestValidCalibration()
+        if calibration is not None:
+            return calibration.isCalibrationInProgress()
         return False
 
     def getCertificateExpireDate(self):
         """ Returns the current instrument's data expiration certificate
         """
-        cert = self.getLatestValidCertification()
-        if cert == None:
-            return ''
-        date = cert.getValidTo()
-        return date
+        certification = self.getLatestValidCertification()
+        if certification:
+            return certification.getValidTo()
+        return None
 
     def getWeeksToExpire(self):
-        """ Returns the amount of weeks untils it's certification expire
+        """ Returns the amount of weeks and days untils it's certification expire
         """
-        cert = self.getLatestValidCertification()
-        if cert == None:
-            return ''
-        date = cert.getValidTo().asdatetime().date();
-        return date - date.today()
+        certification = self.getLatestValidCertification()
+        if certification:
+            return certification.getWeeksAndDaysToExpire()
+        return 0, 0
 
     def getLatestValidCertification(self):
-        """ Returns the latest valid certification. If no latest valid
-            certification found, returns None
+        """Returns the certification with the most remaining days until expiration.
+           If no certification was found, it returns None.
         """
-        saved_cert = None
-        lastfrom = None
-        lastto = None
-        for cert in self.getCertifications():
-            if not cert.isValid():
-                continue
-            validfrom = cert.getValidFrom() if cert else None
-            validto = cert.getValidTo() if validfrom else None
-            if not validfrom or not validto:
-                continue
-            validfrom = validfrom.asdatetime().date()
-            validto = validto.asdatetime().date()
-            if not saved_cert \
-                or validto > lastto \
-                or (validto == lastto and validfrom > lastfrom):
-                saved_cert = cert
-                lastfrom = validfrom
-                lastto = validto
-        return saved_cert
+
+        # 1. get all certifications
+        certifications = self.getCertifications()
+
+        # 2. filter out certifications, which are invalid
+        valid_certifications = filter(lambda x: x.isValid(), certifications)
+
+        # 3. sort by the remaining days to expire, e.g. [10, 7, 6, 1]
+        def sort_func(x, y):
+            return cmp(x.getDaysToExpire(), y.getDaysToExpire())
+        sorted_certifications = sorted(valid_certifications, cmp=sort_func, reverse=True)
+
+        # 4. return the certification with the most remaining days
+        if len(sorted_certifications) > 0:
+            return sorted_certifications[0]
+        return None
 
     def getLatestValidValidation(self):
-        """ Returns the latest *done* validation. If no latest *done*
-            validation found, returns None
+        """Returns the validation with the most remaining days in validation.
+           If no validation was found, it returns None.
         """
-        validation = None
-        lastfrom = None
-        lastto = None
-        for v in self.getValidations():
-            if v.isValidationInProgress() or v.isFutureValidation():
-                continue
-            validfrom = v.getDownFrom() if v else None
-            validto = v.getDownTo() if validfrom else None
-            if not validfrom or not validto:
-                continue
-            validfrom = validfrom.asdatetime().date()
-            validto = validto.asdatetime().date()
-            if not validation \
-                or validto > lastto \
-                or (validto == lastto and validfrom > lastfrom):
-                validation = v
-                lastfrom = validfrom
-                lastto = validto
-        return validation
+        # 1. get all validations
+        validations = self.getValidations()
+
+        # 2. filter out validations, which are not in progress
+        active_validations = filter(lambda x: x.isValidationInProgress(), validations)
+
+        # 3. sort by the remaining days in validation, e.g. [10, 7, 6, 1]
+        def sort_func(x, y):
+            return cmp(x.getRemainingDaysInValidation(), y.getRemainingDaysInValidation())
+        sorted_validations = sorted(active_validations, cmp=sort_func, reverse=True)
+
+        # 4. return the validation with the most remaining days
+        if len(sorted_validations) > 0:
+            return sorted_validations[0]
+        return None
 
     def getLatestValidCalibration(self):
-        """ Returns the latest *done* calibration. If no latest *done*
-            calibration found, returns None
+        """Returns the calibration with the most remaining days in calibration.
+           If no calibration was found, it returns None.
         """
-        calibration = None
-        lastto = None
-        for cal in self.getCalibrations():
-            if cal.isCalibrationInProgress() or cal.isFutureCalibration():
-                continue
-            validfrom = cal.getDownFrom() if cal else None
-            validto = cal.getDownTo() if validfrom else None
-            if not validfrom or not validto:
-                continue
-            validto = validto.asdatetime().date()
-            if calibration is None or validto > lastto:
-                calibration = cal
-                lastto = validto
-        return calibration
+        # 1. get all calibrations
+        calibrations = self.getCalibrations()
+
+        # 2. filter out calibrations, which are not in progress
+        active_calibrations = filter(lambda x: x.isCalibrationInProgress(), calibrations)
+
+        # 3. sort by the remaining days in calibration, e.g. [10, 7, 6, 1]
+        def sort_func(x, y):
+            return cmp(x.getRemainingDaysInCalibration(), y.getRemainingDaysInCalibration())
+        sorted_calibrations = sorted(active_calibrations, cmp=sort_func, reverse=True)
+
+        # 4. return the calibration with the most remaining days
+        if len(sorted_calibrations) > 0:
+            return sorted_calibrations[0]
+        return None
 
     def getValidations(self):
-        """
-        Return all the validations objects related with the instrument
+        """ Return all the validations objects related with the instrument
         """
         return self.objectValues('InstrumentValidation')
 
     def getDocuments(self):
-        """
-        Return all the multifile objects related with the instrument
+        """ Return all the multifile objects related with the instrument
         """
         return self.objectValues('Multifile')
 
@@ -839,6 +821,8 @@ def addReferences(self, reference, service_uids):
                 wf.doActionFor(ref_analysis, 'assign')
             addedanalyses.append(ref_analysis)
 
+        self.setAnalyses(self.getAnalyses() + addedanalyses)
+
         # Initialize LatestReferenceAnalyses cache
         self.cleanReferenceAnalysesCache()
 

bika/lims/content/instrumentcalibration.py

@@ -14,7 +14,6 @@
 from Products.Archetypes.atapi import DisplayList
 from Products.Archetypes.atapi import registerType
 from Products.CMFCore.utils import getToolByName
-from Products.CMFCore.utils import getToolByName
 
 from zope.interface import implements
 

bika/lims/content/instrumentcertification.py

@@ -29,10 +29,10 @@
 from Products.CMFCore.utils import getToolByName
 from bika.lims import bikaMessageFactory as _
 # bika.lims imports
-from bika.lims import logger
 from bika.lims.browser.widgets import ComboBoxWidget
 from bika.lims.browser.widgets import DateTimeWidget
 from bika.lims.browser.widgets import ReferenceWidget
+from bika.lims import logger
 from bika.lims.config import PROJECTNAME
 from bika.lims.content.bikaschema import BikaSchema
 from bika.lims.interfaces import IInstrumentCertification

bika/lims/controlpanel/bika_instruments.py

@@ -110,7 +110,7 @@ def folderitems(self):
             items[x]['Model'] = obj.getModel()
 
             data = obj.getCertificateExpireDate()
-            if not data:
+            if data is None:
                 items[x]['ExpiryDate'] = _("No date set")
             else:
                 items[x]['ExpiryDate'] = data.asdatetime().strftime(self.date_format_short)
@@ -123,7 +123,6 @@ def folderitems(self):
                 items[x]['WeeksToExpire'] = weeks_to_expire
 
             methods = obj.getMethods()
-            items[x]["Methods"] = methods
             urls = []
             titles = []
             for method in methods:

bika/lims/docs/Instruments.rst

@@ -314,6 +314,10 @@ class IInstrumentCertification(Interface):
     """Instrument Certification
     """
 
+class IInstrumentValidation(Interface):
+    """Instrument Validation
+    """
+
 class IAnalysisSpecs(Interface):
     ""