Refactored Remarks and created RemarksField and RemarksWidget

CHANGES.rst

@@ -26,6 +26,7 @@ Changelog
 - #906 DateTime Widget does not display the Time
 - #909 List of clients cannot sort by Client ID
 - #921 Missing interim fields in worksheet/analyses_transposed view
+- #920 Refactored Remarks and created RemarksField and RemarksWidget
 
 **Security**
 

bika/lims/browser/analysisrequest/add2.py

@@ -32,7 +32,7 @@
 from zope.publisher.interfaces import IPublishTraverse
 
 AR_CONFIGURATION_STORAGE = "bika.lims.browser.analysisrequest.manage.add"
-SKIP_FIELD_ON_COPY = ["Sample"]
+SKIP_FIELD_ON_COPY = ["Sample", "Remarks"]
 
 
 def returns_json(func):

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

@@ -115,15 +115,13 @@
 
     </form>
 
-    <tal:hasremarks tal:condition="python:hasattr(context, 'Remarks')">
-        <p style="margin-top:2em;"/>
-        <tal:remarks define="
-            field python:context.Schema()['Remarks'];
-            errors python:{};">
-        <p style="margin-top:2em;"/>
-             <metal:widget use-macro="python:context.widget('Remarks', mode='edit')" />
-        </tal:remarks>
-    </tal:hasremarks>
+    <tal:remarks tal:condition="python:hasattr(context.aq_inner, 'schema') and 'Remarks' in context.schema"
+                 define="checkPermission nocall: context/portal_membership/checkPermission;
+                         mode python:'edit' if checkPermission('Modify portal content', context) else 'view';
+                         field python:context.Schema()['Remarks'];
+                         errors python:{};">
+        <metal:widget use-macro="python:context.widget('Remarks', mode=mode)"/>
+    </tal:remarks>
 
     <tal:rejection define="
         field python:context.Schema()['RejectionReasons'];

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

@@ -137,14 +137,15 @@
 
 	</form>
 
-	<tal:remarks define="
-		field python:context.Schema()['Remarks'];
-		errors python:{};">
-		<p style="margin-top:2em;"/>
-		 <metal:widget use-macro="python:context.widget('Remarks', mode='edit')" />
-	</tal:remarks>
-
-    <tal:rejection define="
+  <tal:remarks tal:condition="python:hasattr(context.aq_inner, 'schema') and 'Remarks' in context.schema"
+               tal:define="checkPermission nocall: context/portal_membership/checkPermission;
+                           mode python:'edit' if checkPermission('Modify portal content', context) else 'view';
+                           field python:context.Schema()['Remarks'];
+                           errors python:{};">
+    <metal:widget use-macro="python:context.widget('Remarks', mode=mode)"/>
+  </tal:remarks>
+
+  <tal:rejection define="
         field python:context.Schema()['RejectionReasons'];
         widget python:field.widget;
         errors python:{};">

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

@@ -46,11 +46,12 @@
         <span tal:replace="structure python: table[1]"/>
     </tal:tables>
 
-	<tal:remarks define="
-		field python:context.Schema()['Remarks'];
-		errors python:{};">
-		<p style="margin-top:2em;"/>
-		 <metal:widget use-macro="python:context.widget('Remarks', mode='edit')" />
+	<tal:remarks tal:condition="python:hasattr(context.aq_inner, 'schema') and 'Remarks' in context.schema"
+               tal:define="checkPermission nocall: context/portal_membership/checkPermission;
+                           mode python:'edit' if checkPermission('Modify portal content', context) else 'view';
+                           field python:context.Schema()['Remarks'];
+                           errors python:{};">
+		<metal:widget use-macro="python:context.widget('Remarks', mode=mode)"/>
 	</tal:remarks>
 
     <tal:rejection define="

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

@@ -111,13 +111,14 @@
     <tal:parts replace="structure view/riview"/>
 
 
-    <tal:remarks define="
-        field python:context.Schema()['Remarks'];
-        errors python:{};">
-        <p style="margin-top:2em;"/>
-         <metal:widget use-macro="python:context.widget('Remarks', mode='edit')" />
+    <tal:remarks tal:condition="python:hasattr(context.aq_inner, 'schema') and 'Remarks' in context.schema"
+                 tal:define="checkPermission nocall: context/portal_membership/checkPermission;
+                             mode python:'edit' if checkPermission('Modify portal content', context) else 'view';
+                             field python:context.Schema()['Remarks'];
+                             errors python:{};">
+      <metal:widget use-macro="python:context.widget('Remarks', mode=mode)"/>
     </tal:remarks>
 
-</metal:content-core>
+  </metal:content-core>
 </body>
 </html>

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

@@ -55,14 +55,6 @@
 	    <div id="folderlisting-main-table"
            tal:content="structure view/contents_table"/>
 
-      <!-- Remarks -->
-	    <tal:hasremarks tal:condition="python:hasattr(context, 'Remarks')">
-		    <tal:remarks define="field python:context.Schema()['Remarks'];
-			                       errors python:{};">
-			    <metal:widget use-macro="python:context.widget('Remarks', mode='edit')" />
-		    </tal:remarks>
-	    </tal:hasremarks>
-
     </metal:content-core>
 
   </body>

bika/lims/browser/configure.zcml

@@ -27,7 +27,6 @@
   <include file="manufacturer.zcml"/>
   <include file="menu.zcml"/>
   <include file="method.zcml"/>
-  <include file="remarks.zcml"/>
   <include file="referenceanalysis.zcml"/>
   <include file="referencesample.zcml"/>
   <include file="pricelist.zcml"/>

bika/lims/browser/fields/remarksfield.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of SENAITE.CORE
+#
+# Copyright 2018 by it's authors.
+# Some rights reserved. See LICENSE.rst, CONTRIBUTORS.rst.
+
+from AccessControl import ClassSecurityInfo
+from AccessControl import getSecurityManager
+from DateTime import DateTime
+from Products.Archetypes.Field import ObjectField
+from Products.Archetypes.Registry import registerField
+from bika.lims.browser.widgets import RemarksWidget
+from bika.lims.interfaces import IRemarksField
+from zope.interface import implements
+
+
+class RemarksField(ObjectField):
+    """A field that stores remarks.  The value submitted to the setter
+    will always be appended to the actual value of the field.
+    A divider will be included with extra information about the text.
+    """
+
+    _properties = ObjectField._properties.copy()
+    _properties.update({
+        'type': 'remarks',
+        'widget': RemarksWidget,
+        'default': '',
+    })
+
+    implements(IRemarksField)
+
+    security = ClassSecurityInfo()
+
+    security.declarePrivate('set')
+
+    def set(self, instance, value, **kwargs):
+        """Adds the value to the existing text stored in the field,
+        along with a small divider showing username and date of this entry.
+        """
+        if not value:
+            return
+        value = value.strip()
+        date = DateTime().rfc822()
+        user = getSecurityManager().getUser()
+        username = user.getUserName()
+        divider = "=== {} ({})".format(date, username)
+        existing_remarks = instance.getRawRemarks()
+        remarks = '\n'.join([divider, value, existing_remarks])
+        return ObjectField.set(self, instance, remarks)
+
+    def get_cooked_remarks(self, instance):
+        text = self.get(instance)
+        if not text:
+            return ""
+        return text.replace('\n', '<br/>')
+
+    def get(self, instance, **kwargs):
+        """Returns raw field value.
+        """
+        return self.getRaw(instance, **kwargs)
+
+    def getRaw(self, instance, **kwargs):
+        """Returns raw field value (possible wrapped in BaseUnit)
+        """
+        value = ObjectField.get(self, instance, **kwargs)
+        # getattr(instance, "Remarks") returns a BaseUnit
+        if callable(value):
+            value = value()
+        return value
+
+
+registerField(RemarksField, title='Remarks', description='')

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

@@ -204,6 +204,10 @@ window.bika.lims.controllers =  {
     ".portaltype-reportfolder":
         ['ReportFolderView'],
 
+    // If RemarksWidget is in use on this page,
+    // load RemarksWIdgetview
+    ".ArchetypesRemarksWidget": ["RemarksWidgetView"],
+
     // Add here your view-controller/s assignment
 
 };

bika/lims/browser/js/bika.lims.site.js

@@ -109,7 +109,7 @@
         config: {
           closeOnEsc: false,
           onLoad: function() {
-            this.getOverlay().find('#archetypes-fieldname-Remarks').remove();
+            this.getOverlay().find('.ArchetypesRemarksWidget').remove();
           },
           onClose: function() {}
         }

bika/lims/browser/js/coffee/bika.lims.site.coffee

@@ -118,7 +118,7 @@ class window.SiteView
         closeOnEsc: false
         onLoad: ->
           # manually remove remarks
-          @getOverlay().find('#archetypes-fieldname-Remarks').remove()
+          @getOverlay().find('.ArchetypesRemarksWidget').remove()
           return
         onClose: ->
           # here is where we'd populate the form controls, if we cared to.