feat(ontology): added tests for the ontology editor

.pylintrc

@@ -3,15 +3,15 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code
-extension-pkg-whitelist=
+extension-pkg-whitelist=PySide6
 
 # Add files or directories to the blacklist. They should be base names, not
 # paths.
 ignore=CVS
 
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
-ignore-patterns=
+ignore-patterns=ontology_configuration.py,create_type_dialog.py
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().

pasta_eln/GUI/ontology_configuration/__init__.py

@@ -0,0 +1,8 @@
+#  PASTA-ELN and all its sub-parts are covered by the MIT license.
+#
+#  Copyright (c) 2023
+#
+#  Author: Jithu Murugan
+#  Filename: __init__.py
+#
+#  You should have received a copy of the license with this file. Please refer the license file for more information.

pasta_eln/GUI/ontology_configuration/create_type_dialog.py

@@ -0,0 +1,80 @@
+# Form implementation generated from reading ui file 'create_type_dialog.ui'
+#
+# Created by: PyQt6 UI code generator 6.4.2
+#
+# WARNING: Any manual changes made to this file will be lost when pyuic6 is
+# run again.  Do not edit this file unless you know what you are doing.
+
+
+from PySide6 import QtCore, QtGui, QtWidgets
+
+
+class Ui_CreateTypeDialog(object):
+  def setupUi(self, CreateTypeDialog):
+    CreateTypeDialog.setObjectName("CreateTypeDialog")
+    CreateTypeDialog.resize(459, 301)
+    self.buttonBox = QtWidgets.QDialogButtonBox(parent=CreateTypeDialog)
+    self.buttonBox.setGeometry(QtCore.QRect(30, 240, 341, 32))
+    self.buttonBox.setOrientation(QtCore.Qt.Orientation.Horizontal)
+    self.buttonBox.setStandardButtons(QtWidgets.QDialogButtonBox.StandardButton.Cancel|QtWidgets.QDialogButtonBox.StandardButton.Ok)
+    self.buttonBox.setObjectName("buttonBox")
+    self.verticalLayoutWidget = QtWidgets.QWidget(parent=CreateTypeDialog)
+    self.verticalLayoutWidget.setGeometry(QtCore.QRect(-1, -1, 461, 221))
+    self.verticalLayoutWidget.setObjectName("verticalLayoutWidget")
+    self.mainVerticalLayout = QtWidgets.QVBoxLayout(self.verticalLayoutWidget)
+    self.mainVerticalLayout.setContentsMargins(20, 0, 20, 0)
+    self.mainVerticalLayout.setObjectName("mainVerticalLayout")
+    self.tileHorizontalLayout = QtWidgets.QHBoxLayout()
+    self.tileHorizontalLayout.setObjectName("tileHorizontalLayout")
+    self.titleLabel = QtWidgets.QLabel(parent=self.verticalLayoutWidget)
+    self.titleLabel.setObjectName("titleLabel")
+    self.tileHorizontalLayout.addWidget(self.titleLabel)
+    spacerItem = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Policy.Minimum, QtWidgets.QSizePolicy.Policy.Minimum)
+    self.tileHorizontalLayout.addItem(spacerItem)
+    self.titleLineEdit = QtWidgets.QLineEdit(parent=self.verticalLayoutWidget)
+    self.titleLineEdit.setToolTip("")
+    self.titleLineEdit.setObjectName("titleLineEdit")
+    self.tileHorizontalLayout.addWidget(self.titleLineEdit)
+    self.mainVerticalLayout.addLayout(self.tileHorizontalLayout)
+    self.horizontalLayout = QtWidgets.QHBoxLayout()
+    self.horizontalLayout.setObjectName("horizontalLayout")
+    self.typeLabel = QtWidgets.QLabel(parent=self.verticalLayoutWidget)
+    self.typeLabel.setObjectName("typeLabel")
+    self.horizontalLayout.addWidget(self.typeLabel)
+    spacerItem1 = QtWidgets.QSpacerItem(40, 20, QtWidgets.QSizePolicy.Policy.Minimum, QtWidgets.QSizePolicy.Policy.Minimum)
+    self.horizontalLayout.addItem(spacerItem1)
+    self.labelLineEdit = QtWidgets.QLineEdit(parent=self.verticalLayoutWidget)
+    self.labelLineEdit.setObjectName("labelLineEdit")
+    self.horizontalLayout.addWidget(self.labelLineEdit)
+    self.mainVerticalLayout.addLayout(self.horizontalLayout)
+    self.horizontalLayout_2 = QtWidgets.QHBoxLayout()
+    self.horizontalLayout_2.setObjectName("horizontalLayout_2")
+    self.structuralLevelCheckBox = QtWidgets.QCheckBox(parent=self.verticalLayoutWidget)
+    self.structuralLevelCheckBox.setObjectName("structuralLevelCheckBox")
+    self.horizontalLayout_2.addWidget(self.structuralLevelCheckBox)
+    self.mainVerticalLayout.addLayout(self.horizontalLayout_2)
+
+    self.retranslateUi(CreateTypeDialog)
+    self.buttonBox.accepted.connect(CreateTypeDialog.accept) # type: ignore
+    self.buttonBox.rejected.connect(CreateTypeDialog.reject) # type: ignore
+    QtCore.QMetaObject.connectSlotsByName(CreateTypeDialog)
+
+  def retranslateUi(self, CreateTypeDialog):
+    _translate = QtCore.QCoreApplication.translate
+    CreateTypeDialog.setWindowTitle(_translate("CreateTypeDialog", "Create New Type"))
+    self.titleLabel.setText(_translate("CreateTypeDialog", "Enter Type title"))
+    self.titleLineEdit.setPlaceholderText(_translate("CreateTypeDialog", "Enter the title for the new type"))
+    self.typeLabel.setText(_translate("CreateTypeDialog", "Enter Type Label"))
+    self.labelLineEdit.setPlaceholderText(_translate("CreateTypeDialog", "Enter the label for the new type"))
+    self.structuralLevelCheckBox.setToolTip(_translate("CreateTypeDialog", "If this is a structural type, then title will be automatically populated as (x0, x1...xn). Next number will be chosen for xn from the existing list of structural items."))
+    self.structuralLevelCheckBox.setText(_translate("CreateTypeDialog", "Is this a structural Type?"))
+
+
+if __name__ == "__main__":
+    import sys
+    app = QtWidgets.QApplication(sys.argv)
+    CreateTypeDialog = QtWidgets.QDialog()
+    ui = Ui_CreateTypeDialog()
+    ui.setupUi(CreateTypeDialog)
+    CreateTypeDialog.show()
+    sys.exit(app.exec())

pasta_eln/GUI/ontology_configuration/create_type_dialog.ui

@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>CreateTypeDialog</class>
+ <widget class="QDialog" name="CreateTypeDialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>459</width>
+    <height>301</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Create New Type</string>
+  </property>
+  <widget class="QDialogButtonBox" name="buttonBox">
+   <property name="geometry">
+    <rect>
+     <x>30</x>
+     <y>240</y>
+     <width>341</width>
+     <height>32</height>
+    </rect>
+   </property>
+   <property name="orientation">
+    <enum>Qt::Horizontal</enum>
+   </property>
+   <property name="standardButtons">
+    <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+   </property>
+  </widget>
+  <widget class="QWidget" name="verticalLayoutWidget">
+   <property name="geometry">
+    <rect>
+     <x>-1</x>
+     <y>-1</y>
+     <width>461</width>
+     <height>221</height>
+    </rect>
+   </property>
+   <layout class="QVBoxLayout" name="mainVerticalLayout">
+    <property name="leftMargin">
+     <number>20</number>
+    </property>
+    <property name="rightMargin">
+     <number>20</number>
+    </property>
+    <item>
+     <layout class="QHBoxLayout" name="tileHorizontalLayout">
+      <item>
+       <widget class="QLabel" name="titleLabel">
+        <property name="text">
+         <string>Enter Type title</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <spacer name="horizontalSpacer">
+        <property name="orientation">
+         <enum>Qt::Horizontal</enum>
+        </property>
+        <property name="sizeType">
+         <enum>QSizePolicy::Minimum</enum>
+        </property>
+        <property name="sizeHint" stdset="0">
+         <size>
+          <width>40</width>
+          <height>20</height>
+         </size>
+        </property>
+       </spacer>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="titleLineEdit">
+        <property name="toolTip">
+         <string/>
+        </property>
+        <property name="placeholderText">
+         <string>Enter the title for the new type</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </item>
+    <item>
+     <layout class="QHBoxLayout" name="horizontalLayout">
+      <item>
+       <widget class="QLabel" name="typeLabel">
+        <property name="text">
+         <string>Enter Type Label</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <spacer name="horizontalSpacer_2">
+        <property name="orientation">
+         <enum>Qt::Horizontal</enum>
+        </property>
+        <property name="sizeType">
+         <enum>QSizePolicy::Minimum</enum>
+        </property>
+        <property name="sizeHint" stdset="0">
+         <size>
+          <width>40</width>
+          <height>20</height>
+         </size>
+        </property>
+       </spacer>
+      </item>
+      <item>
+       <widget class="QLineEdit" name="labelLineEdit">
+        <property name="placeholderText">
+         <string>Enter the label for the new type</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </item>
+    <item>
+     <layout class="QHBoxLayout" name="horizontalLayout_2">
+      <item>
+       <widget class="QCheckBox" name="structuralLevelCheckBox">
+        <property name="toolTip">
+         <string>If this is a structural type, then title will be automatically populated as (x0, x1...xn). Next number will be chosen for xn from the existing list of structural items.</string>
+        </property>
+        <property name="text">
+         <string>Is this a structural Type?</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </item>
+   </layout>
+  </widget>
+ </widget>
+ <resources/>
+ <connections>
+  <connection>
+   <sender>buttonBox</sender>
+   <signal>accepted()</signal>
+   <receiver>CreateTypeDialog</receiver>
+   <slot>accept()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>248</x>
+     <y>254</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>157</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>buttonBox</sender>
+   <signal>rejected()</signal>
+   <receiver>CreateTypeDialog</receiver>
+   <slot>reject()</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>316</x>
+     <y>260</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>286</x>
+     <y>274</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>

pasta_eln/GUI/ontology_configuration/create_type_dialog_extended.py

@@ -0,0 +1,116 @@
+""" CreateTypeDialog used for the create type dialog """
+#  PASTA-ELN and all its sub-parts are covered by the MIT license.
+#
+#  Copyright (c) 2023.
+#
+#  Author: Jithu Murugan
+#  Filename: create_type_dialog_extended.py
+#
+#  You should have received a copy of the license with this file. Please refer the license file for more information.
+
+#  PASTA-ELN and all its sub-parts are covered by the MIT license.
+#
+#
+#  Author: Jithu Murugan
+#  Filename: create_type_dialog_extended.py
+#
+#  You should have received a copy of the license with this file. Please refer the license file for more information.
+import logging
+from collections.abc import Callable
+from typing import Any
+
+from PySide6 import QtCore
+from PySide6.QtWidgets import QDialog
+
+from pasta_eln.GUI.ontology_configuration.create_type_dialog import Ui_CreateTypeDialog
+
+
+class CreateTypeDialog(Ui_CreateTypeDialog):
+  """
+  Abstracted dialog for the create type
+  """
+
+  def __new__(cls, *_: Any, **__: Any) -> Any:
+    """
+    Instantiates the create type dialog
+    """
+    return super(CreateTypeDialog, cls).__new__(cls)
+
+  def __init__(self,
+               accepted_callback: Callable[[], None],
+               rejected_callback: Callable[[], None]) -> None:
+    """
+    Initializes the create type dialog
+    Args:
+      accepted_callback (Callable): Accepted button parent callback.
+      rejected_callback (Callable): Rejected button parent callback.
+    """
+    self.logger = logging.getLogger(__name__ + "." + self.__class__.__name__)
+    self.next_struct_level: str | None = ""
+    self.instance = QDialog()
+    super().setupUi(self.instance)
+    self.setup_slots(accepted_callback, rejected_callback)
+
+  def setup_slots(self,
+                  accepted_callback: Callable[[], None],
+                  rejected_callback: Callable[[], None]) -> None:
+    """
+    Sets up the slots for the dialog
+    Args:
+      accepted_callback (Callable): Accepted button parent callback.
+      rejected_callback (Callable): Rejected button parent callback.
+
+    Returns: None
+
+    """
+    self.buttonBox.accepted.connect(accepted_callback)
+    self.buttonBox.rejected.connect(rejected_callback)
+    self.structuralLevelCheckBox.stateChanged.connect(self.structural_level_checkbox_callback)
+
+  def structural_level_checkbox_callback(self) -> None:
+    """
+    Callback invoked when the state changes for structuralLevelCheckBox
+
+    Returns: Nothing
+    """
+    if self.structuralLevelCheckBox.isChecked():
+      self.titleLineEdit.setText(self.next_struct_level if self.next_struct_level else "")
+      self.titleLineEdit.setDisabled(True)
+    else:
+      self.titleLineEdit.clear()
+      self.titleLineEdit.setDisabled(False)
+
+  def show(self) -> None:
+    """
+    Displays the dialog
+
+    Returns: None
+
+    """
+    self.instance.setWindowModality(QtCore.Qt.ApplicationModal)
+    self.instance.show()
+
+  def clear_ui(self) -> None:
+    """
+    Clear the Dialog UI
+
+    Returns: Nothing
+
+    """
+    self.labelLineEdit.clear()
+    self.titleLineEdit.clear()
+    self.structuralLevelCheckBox.setChecked(False)
+
+  def set_structural_level_title(self,
+                                 structural_level: str | None) -> None:
+    """
+    Set the next possible structural type level title
+
+    Args:
+      structural_level (str): Passed in structural level of the format (x0, x1, x2 ...)
+
+    Returns: Nothing
+
+    """
+    self.logger.info("Next structural level set: {%s}...", structural_level)
+    self.next_struct_level = structural_level