[widgets/test] added library re-usable component. Fixes #204

beat/editor/test/test_libraries.py

+# vim: set fileencoding=utf-8 :
+###############################################################################
+#                                                                             #
+# Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.editor module of the BEAT platform.           #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+from PyQt5 import QtCore
+
+from PyQt5.QtWidgets import QVBoxLayout
+
+from ..widgets.editor import AbstractAssetEditor
+from ..widgets.libraries import LibrariesWidget
+
+
+class EditorTest(AbstractAssetEditor):
+    """
+    Test editor that incorporates the library widget
+    """
+
+    def __init__(self, parent=None):
+        super(EditorTest, self).__init__(parent)
+        self.libraries = LibrariesWidget()
+        layout = QVBoxLayout(self)
+        layout.addWidget(self.libraries)
+
+    def available_libraries(self):
+        json_data = {}
+        json_data["libraries"] = self.libraries.get_available_libraries()
+        return json_data
+
+    def load_json(self, json_object):
+        """Load the json object passed as parameter"""
+        self.libraries.set_available_libraries(json_object["libraries"])
+
+    def dump_json(self):
+        """Returns the json representation of the asset"""
+
+        json_data = {}
+        json_data["libraries"] = self.libraries.get_used_libraries()
+        return json_data
+
+
+class TestEditorLibrary:
+    """Test that the library widget in a test editor works correctly"""
+
+    def test_json_dumps_used_libraries(self):
+        json_reference = {"libraries": {}}
+        widget = EditorTest()
+        assert widget.dump_json() == json_reference
+
+    def test_json_load_available_libraries(self):
+        json_reference = {
+            "libraries": {"lib1": "lib1/a/b", "lib2": "lib2/a/b", "lib3": "lib3/a/b"}
+        }
+        widget = EditorTest()
+        widget.load_json(json_reference)
+        assert widget.available_libraries() == json_reference
+
+    def test_json_load_use_dump_libraries(self, qtbot):
+        json_reference_load = {
+            "libraries": {"lib1": "lib1/a/b", "lib2": "lib2/a/b", "lib3": "lib3/a/b"}
+        }
+        json_reference_first_dump = {"libraries": {"lib1": "lib1/a/b"}}
+        json_reference_second_dump = {
+            "libraries": {"lib1": "lib1/a/b", "lib3": "lib3/a/b"}
+        }
+        widget = EditorTest()
+        widget.load_json(json_reference_load)
+        # Add lib1 from the available libraries
+        widget.libraries.libraries_available.setCurrentRow(0)
+        qtbot.mouseClick(widget.libraries.add_library_button, QtCore.Qt.LeftButton)
+        # Add lib3 item from the available libraries
+        widget.libraries.libraries_available.setCurrentRow(1)
+        assert widget.dump_json() == json_reference_first_dump
+        qtbot.mouseClick(widget.libraries.add_library_button, QtCore.Qt.LeftButton)
+        assert widget.dump_json() == json_reference_second_dump
+        # Remove lib3 from the used libraries
+        widget.libraries.libraries_used.selectRow(1)
+        qtbot.mouseClick(widget.libraries.remove_library_button, QtCore.Qt.LeftButton)
+        assert widget.dump_json() == json_reference_first_dump

beat/editor/widgets/libraries.py

+# vim: set fileencoding=utf-8 :
+###############################################################################
+#                                                                             #
+# Copyright (c) 2019 Idiap Research Institute, http://www.idiap.ch/           #
+# Contact: beat.support@idiap.ch                                              #
+#                                                                             #
+# This file is part of the beat.editor module of the BEAT platform.           #
+#                                                                             #
+# Commercial License Usage                                                    #
+# Licensees holding valid commercial BEAT licenses may use this file in       #
+# accordance with the terms contained in a written agreement between you      #
+# and Idiap. For further information contact tto@idiap.ch                     #
+#                                                                             #
+# Alternatively, this file may be used under the terms of the GNU Affero      #
+# Public License version 3 as published by the Free Software and appearing    #
+# in the file LICENSE.AGPL included in the packaging of this file.            #
+# The BEAT platform is distributed in the hope that it will be useful, but    #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                        #
+#                                                                             #
+# You should have received a copy of the GNU Affero Public License along      #
+# with the BEAT platform. If not, see http://www.gnu.org/licenses/.           #
+#                                                                             #
+###############################################################################
+
+from PyQt5.QtCore import pyqtSignal
+
+from PyQt5.QtWidgets import QPushButton
+from PyQt5.QtWidgets import QHBoxLayout
+from PyQt5.QtWidgets import QVBoxLayout
+from PyQt5.QtWidgets import QListWidget
+from PyQt5.QtWidgets import QTableView
+from PyQt5.QtWidgets import QTableWidget
+from PyQt5.QtWidgets import QTableWidgetItem
+from PyQt5.QtWidgets import QHeaderView
+from PyQt5.QtWidgets import QWidget
+from PyQt5.QtWidgets import QLabel
+
+
+class LibrariesWidget(QWidget):
+    """Class holder for the various libraries"""
+
+    dataChanged = pyqtSignal()
+
+    def __init__(self, parent=None):
+        """Constructor"""
+
+        super(LibrariesWidget, self).__init__(parent)
+
+        self.json_data = {}
+
+        # Widgets
+        self.label_libraries_available = QLabel(self.tr("Available Libraries"))
+        self.label_libraries_used = QLabel(self.tr("Used Libraries"))
+        self.libraries_available = QListWidget()
+        self.libraries_used = QTableWidget()
+        self.libraries_used.setColumnCount(2)
+        header = self.libraries_used.horizontalHeader()
+        header.setSectionResizeMode(QHeaderView.Stretch)
+        self.libraries_used.setHorizontalHeaderLabels(
+            [self.tr("Library name"), self.tr("Library alias")]
+        )
+        self.libraries_used.setSelectionBehavior(QTableView.SelectRows)
+        self.add_library_button = QPushButton(self.tr(">"))
+        self.remove_library_button = QPushButton(self.tr("<"))
+
+        # Layouts
+        layout = QHBoxLayout(self)
+
+        # QVBoxLayout for available libraries
+        libraries_available_layout = QVBoxLayout()
+        libraries_available_layout.addWidget(self.label_libraries_available)
+        libraries_available_layout.addWidget(self.libraries_available)
+
+        # QVBoxLayout for used libraries
+        libraries_used_layout = QVBoxLayout()
+        libraries_used_layout.addWidget(self.label_libraries_used)
+        libraries_used_layout.addWidget(self.libraries_used)
+
+        # QVBoxLayout for buttons >/<
+        buttons_layout = QVBoxLayout()
+        buttons_layout.addStretch(1)
+        buttons_layout.addWidget(self.add_library_button)
+        buttons_layout.addWidget(self.remove_library_button)
+        buttons_layout.addStretch(1)
+
+        # Layouts Design
+        layout.addLayout(libraries_available_layout)
+        layout.addLayout(buttons_layout)
+        layout.addLayout(libraries_used_layout)
+
+        # Signal/Slots connections
+        self.add_library_button.clicked.connect(self.__add_library)
+        self.remove_library_button.clicked.connect(self.__remove_library)
+
+        self.add_library_button.clicked.connect(self.dataChanged)
+        self.remove_library_button.clicked.connect(self.dataChanged)
+
+    def __add_library(self):
+        selected_libraries = self.libraries_available.selectedItems()
+        if selected_libraries:
+            for library in selected_libraries:
+                library_name = library.text()
+                library_alias = [
+                    key for key in self.json_data if self.json_data[key] == library_name
+                ][0]
+                self.libraries_available.takeItem(self.libraries_available.row(library))
+                # add to table
+                row = self.libraries_used.rowCount()
+                self.libraries_used.insertRow(row)
+                self.libraries_used.setItem(row, 0, QTableWidgetItem(library_name))
+                self.libraries_used.setItem(row, 1, QTableWidgetItem(library_alias))
+        else:
+            return
+
+    def __remove_library(self):
+        # Get reverse order for deletion and set for possible rowcolumn selection
+        rows = sorted(
+            set(list(index.row() for index in self.libraries_used.selectedIndexes())),
+            reverse=True,
+        )
+        for row in rows:
+            library_name = self.libraries_used.item(row, 0).text()
+            self.libraries_available.addItem(library_name)
+            self.libraries_used.removeRow(row)
+
+    def get_used_libraries(self):
+        """Returns the libraries used"""
+        # {key:value} for {library_alias:library_name}
+        libraries = {}
+
+        for row in range(0, self.libraries_used.rowCount()):
+            libraries[
+                self.libraries_used.item(row, 1).text()
+            ] = self.libraries_used.item(row, 0).text()
+
+        return libraries
+
+    def get_available_libraries(self):
+        """Returns the available libraries"""
+        # {key:value} for {library_alias:library_name}
+        return self.json_data
+
+    def set_available_libraries(self, json_data):
+        """Set the available libraries"""
+        # {key:value} for {library_alias:library_name}
+        self.json_data = json_data
+        for key in self.json_data.keys():
+            self.libraries_available.addItem(self.json_data[key])