Migrate WorksheetTemplates to DX

CHANGES.rst

@@ -4,6 +4,7 @@ Changelog
 2.6.0 (unreleased)
 ------------------
 
+- #2599 Migrate WorksheetTemplates to Dexterity
 - #2632 Refactor Catalog Indexing
 - #2630 Fix references from sample templates are not kept when partitioning
 - #2634 Pin et-xmlfile to a Python 2 compatible version

src/bika/lims/browser/worksheet/templates/results.pt

@@ -252,11 +252,6 @@
       </div>
       <!-- /Remarks Widget -->
 
-      <!-- XXX: Where is this used? -->
-      <input type="hidden"
-             id="instrument_multiple_use"
-             tal:attributes="value python:context.getWorksheetTemplate().getEnableMultipleUseOfInstrument() if context.getWorksheetTemplate() else 'True';"/>
-
     </metal:content-core>
 
   </body>

src/bika/lims/browser/worksheet/views/add_analyses.py

@@ -167,7 +167,7 @@ def update(self):
         new_states = []
         if wst:
 
-            wst_service_uids = wst.getRawService()
+            wst_service_uids = wst.getRawServices()
             # restrict to the selected template services
             if wst_service_uids:
                 new_states.append({
@@ -222,8 +222,8 @@ def handle_submit(self):
     def worksheet_template_setup_url(self):
         """Returns the Worksheet Template Setup URL
         """
-        setup = api.get_setup()
-        return "{}/{}".format(api.get_url(setup), "bika_worksheettemplates")
+        setup = api.get_senaite_setup()
+        return "{}/{}".format(api.get_url(setup), "worksheettemplates")
 
     @view.memoize
     def is_edit_allowed(self):

src/bika/lims/content/worksheet.py

@@ -567,7 +567,7 @@ def get_suitable_slot_for_duplicate(self, src_slot):
         # If there is a match with the layout defined in the Worksheet
         # Template, use that slot instead of adding a new one at the end of
         # the worksheet
-        layout = wst.getLayout()
+        layout = wst.getTemplateLayout()
         for pos in layout:
             if pos['type'] != 'd' or to_int(pos['dup']) != slot_from:
                 continue
@@ -612,7 +612,7 @@ def get_suitable_slot_for_reference(self, reference):
         # If there is a match with the layout defined in the Worksheet Template,
         # use that slot instead of adding a new one at the end of the worksheet
         slot_type = reference.getBlank() and 'b' or 'c'
-        layout = wst.getLayout()
+        layout = wst.getTemplateLayout()
 
         for pos in layout:
             if pos['type'] != slot_type:
@@ -795,7 +795,7 @@ def resolve_available_slots(self, worksheet_template, type='a'):
             return list()
 
         ws_slots = self.get_slot_positions(type)
-        layout = worksheet_template.getLayout()
+        layout = worksheet_template.getTemplateLayout()
         slots = list()
 
         for row in layout:
@@ -832,7 +832,7 @@ def _apply_worksheet_template_routine_analyses(self, wst):
         :returns: None
         """
         # Get the services from the Worksheet Template
-        service_uids = wst.getRawService()
+        service_uids = wst.getRawServices()
         if not service_uids:
             # No service uids assigned to this Worksheet Template, skip
             logger.warn("Worksheet Template {} has no services assigned"
@@ -918,7 +918,7 @@ def _apply_worksheet_template_duplicate_analyses(self, wst):
         :param wst: worksheet template used as the layout
         :returns: None
         """
-        wst_layout = wst.getLayout()
+        wst_layout = wst.getTemplateLayout()
 
         for row in wst_layout:
             if row['type'] != 'd':
@@ -994,7 +994,7 @@ def _resolve_reference_samples(self, wst, type):
 
         slots_sample = list()
         available_slots = self.resolve_available_slots(wst, type)
-        wst_layout = wst.getLayout()
+        wst_layout = wst.getTemplateLayout()
         for row in wst_layout:
             slot = int(row['pos'])
             if slot not in available_slots:
@@ -1013,7 +1013,7 @@ def _resolve_reference_samples(self, wst, type):
 
             # We only want the reference samples that fit better with the type
             # and with the analyses defined in the Template
-            services = wst.getService()
+            services = wst.getServices()
             services = [s.UID() for s in services]
             candidates = list()
             for sample in samples:

src/bika/lims/content/worksheettemplate.py

@@ -152,6 +152,7 @@
 schema["description"].widget.description = ""
 
 
+# TODO: Migrated to DX - https://github.com/senaite/senaite.core/pull/2599
 class WorksheetTemplate(BaseContent):
     """Worksheet Templates
     """

src/bika/lims/controlpanel/bika_worksheettemplates.py

@@ -18,131 +18,20 @@
 # Copyright 2018-2024 by it's authors.
 # Some rights reserved, see README and LICENSE.
 
-import collections
-
-from bika.lims import api
-from bika.lims import bikaMessageFactory as _
-from bika.lims.browser.bika_listing import BikaListingView
 from bika.lims.config import PROJECTNAME
 from bika.lims.interfaces import IWorksheetTemplates
-from bika.lims.utils import get_link
 from plone.app.folder.folder import ATFolder
 from plone.app.folder.folder import ATFolderSchema
 from Products.Archetypes import atapi
 from Products.ATContentTypes.content import schemata
 from senaite.core.interfaces import IHideActionsMenu
-from senaite.core.permissions import AddWorksheetTemplate
 from zope.interface.declarations import implements
 
 
-class WorksheetTemplatesView(BikaListingView):
-    """Listing View for Worksheet Templates
-    """
-
-    def __init__(self, context, request):
-        super(WorksheetTemplatesView, self).__init__(context, request)
-
-        self.catalog = "senaite_catalog_setup"
-
-        self.contentFilter = {
-            "portal_type": "WorksheetTemplate",
-            "sort_on": "sortable_title",
-            "sort_order": "ascending",
-        }
-
-        self.context_actions = {
-            _("Add"):
-            {
-                "url": "createObject?type_name=WorksheetTemplate",
-                "permission": AddWorksheetTemplate,
-                "icon": "++resource++bika.lims.images/add.png"
-            }
-        }
-
-        self.title = self.context.translate(_("Worksheet Templates"))
-        self.icon = "{}/{}".format(
-            self.portal_url,
-            "/++resource++bika.lims.images/worksheettemplate_big.png"
-        )
-
-        self.show_select_row = False
-        self.show_select_column = True
-
-        self.columns = collections.OrderedDict((
-            ("Title", {
-                "title": _("Title"),
-                "index": "sortable_title",
-            }),
-            ("Description", {
-                "title": _("Description"),
-                "index": "description",
-                "toggle": True,
-            }),
-            ("Method", {
-                "title": _("Method"),
-                "toggle": True}),
-            ("Instrument", {
-                "title": _("Instrument"),
-                "index": "instrument_title",
-                "toggle": True,
-            }),
-        ))
-
-        self.review_states = [
-            {
-                "id": "default",
-                "title": _("Active"),
-                "contentFilter": {"is_active": True},
-                "columns": self.columns.keys(),
-            }, {
-                "id": "inactive",
-                "title": _("Inactive"),
-                "contentFilter": {'is_active': False},
-                "columns": self.columns.keys()
-            }, {
-                "id": "all",
-                "title": _("All"),
-                "contentFilter": {},
-                "columns": self.columns.keys(),
-            },
-        ]
-
-    def folderitem(self, obj, item, index):
-        """Service triggered each time an item is iterated in folderitems.
-        The use of this service prevents the extra-loops in child objects.
-        :obj: the instance of the class to be foldered
-        :item: dict containing the properties of the object to be used by
-            the template
-        :index: current index of the item
-        """
-        obj = api.get_object(obj)
-        item["Description"] = obj.Description()
-        item["replace"]["Title"] = get_link(item["url"], item["Title"])
-
-        instrument = obj.getInstrument()
-        if instrument:
-            instrument_url = api.get_url(instrument)
-            instrument_title = api.get_title(instrument)
-            item["Instrument"] = instrument_title
-            item["replace"]["Instrument"] = get_link(
-                instrument_url, value=instrument_title)
-
-        # Method
-        method_uid = obj.getMethodUID()
-        if method_uid:
-            method = api.get_object_by_uid(method_uid)
-            method_url = api.get_url(method)
-            method_title = api.get_title(method)
-            item["Method"] = method_title
-            item["replace"]["Method"] = get_link(
-                method_url, value=method_title)
-
-        return item
-
-
 schema = ATFolderSchema.copy()
 
 
+# TODO: Migrated to DX - https://github.com/senaite/senaite.core/pull/2599
 class WorksheetTemplates(ATFolder):
     implements(IWorksheetTemplates, IHideActionsMenu)
     displayContentsTab = False

src/bika/lims/controlpanel/configure.zcml

@@ -76,12 +76,4 @@
       layer="bika.lims.interfaces.IBikaLIMS"
     />
 
-    <browser:page
-      for="bika.lims.interfaces.IWorksheetTemplates"
-      name="folder_view"
-      class=".bika_worksheettemplates.WorksheetTemplatesView"
-      permission="senaite.core.permissions.ManageBika"
-      layer="bika.lims.interfaces.IBikaLIMS"
-    />
-
 </configure>

src/bika/lims/profiles/default/factorytool.xml

@@ -28,6 +28,5 @@
   <type portal_type="Pricelist"/>
   <type portal_type="SampleType"/>
   <type portal_type="SupplierContact"/>
-  <type portal_type="WorksheetTemplate"/>
  </factorytypes>
 </object>

src/bika/lims/profiles/default/propertiestool.xml

@@ -68,7 +68,6 @@
     <element value="SampleType"/>
     <element value="BatchLabel"/>
     <element value="Worksheet"/>
-    <element value="WorksheetTemplate"/>
     <element value="ATBooleanCriterion"/>
     <element value="ATDateCriteria"/>
     <element value="ATDateRangeCriterion"/>

src/bika/lims/profiles/default/structure/bika_setup/.objects

@@ -5,5 +5,4 @@ bika_calculations,Calculations
 bika_instruments,Instruments
 bika_labcontacts,LabContacts
 bika_referencedefinitions,ReferenceDefinitions
-bika_worksheettemplates,WorksheetTemplates
 laboratory,Laboratory

src/bika/lims/profiles/default/structure/bika_setup/.preserve

@@ -6,5 +6,4 @@ bika_calculations
 bika_instruments
 bika_labcontacts
 bika_referencedefinitions
-bika_worksheettemplates
 laboratory

src/bika/lims/profiles/default/types.xml

@@ -46,8 +46,6 @@
  <object name="SupplierContact" meta_type="Factory-based Type Information with dynamic views"/>
  <object name="Worksheet" meta_type="Factory-based Type Information with dynamic views"/>
  <object name="WorksheetFolder" meta_type="Factory-based Type Information with dynamic views"/>
- <object name="WorksheetTemplate" meta_type="Factory-based Type Information with dynamic views"/>
- <object name="WorksheetTemplates" meta_type="Factory-based Type Information with dynamic views"/>
  <object name="AutoImportLog" meta_type="Factory-based Type Information with dynamic views"/>
 
 </object>

src/senaite/core/browser/controlpanel/configure.zcml

@@ -44,5 +44,6 @@
   <include package=".storagelocations" />
   <include package=".subgroups" />
   <include package=".suppliers" />
+  <include package=".worksheettemplates" />
 
 </configure>