diff --git a/openlp/core/ui/lib/pathedit.py b/openlp/core/ui/lib/pathedit.py new file mode 100755 index 000000000..167be5357 --- /dev/null +++ b/openlp/core/ui/lib/pathedit.py @@ -0,0 +1,197 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2017 OpenLP Developers # +# --------------------------------------------------------------------------- # +# This program is free software; you can redistribute it and/or modify it # +# under the terms of the GNU General Public License as published by the Free # +# Software Foundation; version 2 of the License. # +# # +# This program 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. See the GNU General Public License for # +# more details. # +# # +# You should have received a copy of the GNU General Public License along # +# with this program; if not, write to the Free Software Foundation, Inc., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +from enum import Enum +import os.path + +from PyQt5 import QtCore, QtWidgets + +from openlp.core.common import UiStrings, translate +from openlp.core.lib import build_icon + + +class PathType(Enum): + Files = 1 + Directories = 2 + + +class PathEdit(QtWidgets.QWidget): + """ + The :class:`~openlp.core.ui.lib.pathedit.PathEdit` class subclasses QWidget to create a custom widget for use when + a file or directory needs to be selected. + """ + pathChanged = QtCore.pyqtSignal(str) + + def __init__(self, parent=None, show_revert=True): + """ + Initalise the PathEdit widget + + :param parent: The parent of the widget. This is just passed to the super method. + :type parent: QWidget or None + + :param show_revert: Used to determin if the 'revert button' should be visible. + :type show_revert: bool + + :ivar default_path: The default path. This is set as the path when the revert button is clicked + :vartype default_path: str + + :ivar dialog_caption: Used to customise the caption in the QFileDialog. + :vartype dialog_caption: str + """ + super().__init__(parent) + self.default_path = '' + self.dialog_caption = '' + self._path_type = PathType.Files + self._path = '' + self.filters = '{all_files} (*.*)'.format(all_files=UiStrings().AllFiles) + self._setup(show_revert) + + def _setup(self, show_revert): + + widget_layout = QtWidgets.QHBoxLayout() + widget_layout.setContentsMargins(0, 0, 0, 0) + self.line_edit = QtWidgets.QLineEdit(self) + self.line_edit.setText(self._path) + widget_layout.addWidget(self.line_edit) + self.browse_button = QtWidgets.QToolButton(self) + self.browse_button.setIcon(build_icon(':/general/general_open.png')) + widget_layout.addWidget(self.browse_button) + self.revert_button = QtWidgets.QToolButton(self) + self.revert_button.setIcon(build_icon(':/general/general_revert.png')) + self.revert_button.setVisible(show_revert) + widget_layout.addWidget(self.revert_button) + self.setLayout(widget_layout) + + # Signals and Slots + self.browse_button.clicked.connect(self.on_browse_button_clicked) + self.revert_button.clicked.connect(self.on_revert_button_clicked) + self.line_edit.editingFinished.connect(self.on_line_edit_editing_finished) + + self.update_button_tool_tips() + + @property + def path(self): + """ + A property getter method to return the selected path. + + :return: The selected path + :rtype: str + """ + return self._path + + @path.setter + def path(self, path): + """ + A Property setter method to set the selected path + + :param path: The path to set the widget to + :type path: str + """ + self._path = path + self.line_edit.setText(path) + self.line_edit.setToolTip(path) + + @property + def path_type(self): + """ + A property getter method to return the path_type. Path type allows you to sepecify if the user is restricted to + selecting a file or directory. + + :return: The type selected + :rtype: Enum of PathEdit + """ + return self._path_type + + @path_type.setter + def path_type(self, path_type): + """ + A Property setter method to set the path type + + :param path: The type of path to select + :type path: Enum of PathEdit + """ + self._path_type = path_type + self.update_button_tool_tips() + + def update_button_tool_tips(self): + """ + Called to update the tooltips on the buttons. This is changing path types, and when the widget is initalised + :return: None + """ + if self._path_type == PathType.Directories: + self.browse_button.setToolTip(translate('OpenLP.PathEdit', 'Browse for directory.')) + self.revert_button.setToolTip(translate('OpenLP.PathEdit', 'Revert to default directory.')) + else: + self.browse_button.setToolTip(translate('OpenLP.PathEdit', 'Browse for file.')) + self.revert_button.setToolTip(translate('OpenLP.PathEdit', 'Revert to default file.')) + + def on_browse_button_clicked(self): + """ + A handler to handle a click on the browse button. + + Show the QFileDialog and process the input from the user + :return: None + """ + caption = self.dialog_caption + path = '' + if self._path_type == PathType.Directories: + if not caption: + caption = translate('OpenLP.PathEdit', 'Select Directory') + path = QtWidgets.QFileDialog.getExistingDirectory(self, caption, + self._path, QtWidgets.QFileDialog.ShowDirsOnly) + elif self._path_type == PathType.Files: + if not caption: + caption = self.dialog_caption = translate('OpenLP.PathEdit', 'Select File') + path, filter_used = QtWidgets.QFileDialog.getOpenFileName(self, caption, self._path, self.filters) + if path: + path = os.path.normpath(path) + self.on_new_path(path) + + def on_revert_button_clicked(self): + """ + A handler to handle a click on the revert button. + + Set the new path to the value of the default_path instance variable. + :return: None + """ + self.on_new_path(self.default_path) + + def on_line_edit_editing_finished(self): + """ + A handler to handle when the line edit has finished being edited. + :return: None + """ + self.on_new_path(self.line_edit.text()) + + def on_new_path(self, path): + """ + A method called to validate and set a new path. + + Emits the pathChanged Signal + + :param path: The new path + :type path: str + + :return: None + """ + if self._path != path: + self.path = path + self.pathChanged.emit(path) diff --git a/tests/functional/openlp_core_ui_lib/test_path_edit.py b/tests/functional/openlp_core_ui_lib/test_path_edit.py new file mode 100755 index 000000000..01ca55759 --- /dev/null +++ b/tests/functional/openlp_core_ui_lib/test_path_edit.py @@ -0,0 +1,312 @@ +# -*- coding: utf-8 -*- +# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4 + +############################################################################### +# OpenLP - Open Source Lyrics Projection # +# --------------------------------------------------------------------------- # +# Copyright (c) 2008-2017 OpenLP Developers # +# --------------------------------------------------------------------------- # +# This program is free software; you can redistribute it and/or modify it # +# under the terms of the GNU General Public License as published by the Free # +# Software Foundation; version 2 of the License. # +# # +# This program 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. See the GNU General Public License for # +# more details. # +# # +# You should have received a copy of the GNU General Public License along # +# with this program; if not, write to the Free Software Foundation, Inc., 59 # +# Temple Place, Suite 330, Boston, MA 02111-1307 USA # +############################################################################### +""" +This module contains tests for the openlp.core.ui.lib.pathedit module +""" +from unittest import TestCase + +from PyQt5 import QtWidgets + +from openlp.core.ui.lib import PathEdit, PathType +from unittest.mock import MagicMock, PropertyMock, patch + + +class TestPathEdit(TestCase): + """ + Test the :class:`~openlp.core.lib.pathedit.PathEdit` class + """ + def setUp(self): + with patch('openlp.core.ui.lib.pathedit.PathEdit._setup'): + self.widget = PathEdit() + + def test_path_getter(self): + """ + Test the `path` property getter. + """ + # GIVEN: An instance of PathEdit with the `_path` instance variable set + self.widget._path = 'getter/test/pat.h' + + # WHEN: Reading the `path` property + # THEN: The value that we set should be returned + self.assertEqual(self.widget.path, 'getter/test/pat.h') + + def test_path_setter(self): + """ + Test the `path` property setter. + """ + # GIVEN: An instance of the PathEdit object and a mocked `line_edit` + self.widget.line_edit = MagicMock() + + # WHEN: Writing to the `path` property + self.widget.path = 'setter/test/pat.h' + + # THEN: The `_path` instance variable should be set with the test data. The `line_edit` text and tooltip + # should have also been set. + self.assertEqual(self.widget._path, 'setter/test/pat.h') + self.widget.line_edit.setToolTip.assert_called_once_with('setter/test/pat.h') + self.widget.line_edit.setText.assert_called_once_with('setter/test/pat.h') + + def test_path_type_getter(self): + """ + Test the `path_type` property getter. + """ + # GIVEN: An instance of PathEdit + # WHEN: Reading the `path` property + # THEN: The default value should be returned + self.assertEqual(self.widget.path_type, PathType.Files) + + def test_path_type_setter(self): + """ + Test the `path_type` property setter. + """ + # GIVEN: An instance of the PathEdit object and a mocked `update_button_tool_tips` method. + with patch.object(self.widget, 'update_button_tool_tips') as mocked_update_button_tool_tips: + + # WHEN: Writing to a different value than default to the `path_type` property + self.widget.path_type = PathType.Directories + + # THEN: The `_path_type` instance variable should be set with the test data and not the default. The + # update_button_tool_tips should have been called. + self.assertEqual(self.widget._path_type, PathType.Directories) + mocked_update_button_tool_tips.assert_called_once_with() + + def test_update_button_tool_tips_directories(self): + """ + Test the `update_button_tool_tips` method. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Directories` + self.widget.browse_button = MagicMock() + self.widget.revert_button = MagicMock() + self.widget._path_type = PathType.Directories + + # WHEN: Calling update_button_tool_tips + self.widget.update_button_tool_tips() + + self.widget.browse_button.setToolTip.assert_called_once_with('Browse for directory.') + self.widget.revert_button.setToolTip.assert_called_once_with('Revert to default directory.') + + def test_update_button_tool_tips_files(self): + """ + Test the `update_button_tool_tips` method. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Files` + self.widget.browse_button = MagicMock() + self.widget.revert_button = MagicMock() + self.widget._path_type = PathType.Files + + # WHEN: Calling update_button_tool_tips + self.widget.update_button_tool_tips() + + self.widget.browse_button.setToolTip.assert_called_once_with('Browse for file.') + self.widget.revert_button.setToolTip.assert_called_once_with('Revert to default file.') + + + def test_on_browse_button_clicked_directory(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the `path_type` is set to Directories. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Directories` and a mocked + # QFileDialog.getExistingDirectory + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getExistingDirectory', return_value='') as \ + mocked_get_existing_directory, \ + patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName') as \ + mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath: + self.widget._path_type = PathType.Directories + self.widget._path = 'test/path/' + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: The FileDialog.getExistingDirectory should have been called with the default caption + mocked_get_existing_directory.assert_called_once_with(self.widget, 'Select Directory', 'test/path/', + QtWidgets.QFileDialog.ShowDirsOnly) + self.assertFalse(mocked_get_open_file_name.called) + self.assertFalse(mocked_normpath.called) + + def test_on_browse_button_clicked_directory_custom_caption(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the `path_type` is set to Directories, + and `dialog_caption` is set. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Directories` and a mocked + # QFileDialog.getExistingDirectory with `default_caption` set. + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getExistingDirectory', return_value='') as \ + mocked_get_existing_directory, \ + patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName') as \ + mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath: + self.widget._path_type = PathType.Directories + self.widget._path = 'test/path/' + self.widget.dialog_caption = 'Directory Caption' + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: The FileDialog.getExistingDirectory should have been called with the custom caption + mocked_get_existing_directory.assert_called_once_with(self.widget, 'Directory Caption', 'test/path/', + QtWidgets.QFileDialog.ShowDirsOnly) + self.assertFalse(mocked_get_open_file_name.called) + self.assertFalse(mocked_normpath.called) + + def test_on_browse_button_clicked_file(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the `path_type` is set to Files. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Files` and a mocked QFileDialog.getOpenFileName + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getExistingDirectory') as \ + mocked_get_existing_directory, \ + patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName', return_value=('', '')) as \ + mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath: + self.widget._path_type = PathType.Files + self.widget._path = 'test/pat.h' + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: The FileDialog.getOpenFileName should have been called with the default caption + mocked_get_open_file_name.assert_called_once_with(self.widget, 'Select File', 'test/pat.h', + self.widget.filters) + self.assertFalse(mocked_get_existing_directory.called) + self.assertFalse(mocked_normpath.called) + + def test_on_browse_button_clicked_file_custom_caption(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the `path_type` is set to Files and + `dialog_caption` is set. + """ + # GIVEN: An instance of PathEdit with the `path_type` set to `Files` and a mocked QFileDialog.getOpenFileName + # with `default_caption` set. + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getExistingDirectory') as \ + mocked_get_existing_directory, \ + patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName', return_value=('', '')) as \ + mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath: + self.widget._path_type = PathType.Files + self.widget._path = 'test/pat.h' + self.widget.dialog_caption = 'File Caption' + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: The FileDialog.getOpenFileName should have been called with the custom caption + mocked_get_open_file_name.assert_called_once_with(self.widget, 'File Caption', 'test/pat.h', + self.widget.filters) + self.assertFalse(mocked_get_existing_directory.called) + self.assertFalse(mocked_normpath.called) + + def test_on_browse_button_clicked_user_cancels(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the user cancels the FileDialog (an + empty str is returned) + """ + # GIVEN: An instance of PathEdit with a mocked QFileDialog.getOpenFileName which returns an empty str for the + # file path. + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName', return_value=('', '')) as \ + mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath: + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: normpath should not have been called + self.assertTrue(mocked_get_open_file_name.called) + self.assertFalse(mocked_normpath.called) + + def test_on_browse_button_clicked_user_accepts(self): + """ + Test the `browse_button` `clicked` handler on_browse_button_clicked when the user accepts the FileDialog (a path + is returned) + """ + # GIVEN: An instance of PathEdit with a mocked QFileDialog.getOpenFileName which returns a str for the file + # path. + with patch('openlp.core.ui.lib.pathedit.QtWidgets.QFileDialog.getOpenFileName', + return_value=('/test/pat.h', '')) as mocked_get_open_file_name, \ + patch('openlp.core.ui.lib.pathedit.os.path.normpath') as mocked_normpath, \ + patch.object(self.widget, 'on_new_path'): + + # WHEN: Calling on_browse_button_clicked + self.widget.on_browse_button_clicked() + + # THEN: normpath and `on_new_path` should have been called + self.assertTrue(mocked_get_open_file_name.called) + mocked_normpath.assert_called_once_with('/test/pat.h') + self.assertTrue(self.widget.on_new_path.called) + + def test_on_revert_button_clicked(self): + """ + Test that the default path is set as the path when the `revert_button.clicked` handler is called. + """ + # GIVEN: An instance of PathEdit with a mocked `on_new_path`, and the `default_path` set. + with patch.object(self.widget, 'on_new_path') as mocked_on_new_path: + self.widget.default_path = '/default/pat.h' + + # WHEN: Calling `on_revert_button_clicked` + self.widget.on_revert_button_clicked() + + # THEN: on_new_path should have been called with the default path + mocked_on_new_path.assert_called_once_with('/default/pat.h') + + def test_on_line_edit_editing_finished(self): + """ + Test that the new path is set as the path when the `line_edit.editingFinished` handler is called. + """ + # GIVEN: An instance of PathEdit with a mocked `line_edit` and `on_new_path`. + with patch.object(self.widget, 'on_new_path') as mocked_on_new_path: + self.widget.line_edit = MagicMock(**{'text.return_value':'/test/pat.h'}) + + # WHEN: Calling `on_line_edit_editing_finished` + self.widget.on_line_edit_editing_finished() + + # THEN: on_new_path should have been called with the path enetered in `line_edit` + mocked_on_new_path.assert_called_once_with('/test/pat.h') + + def test_on_new_path_no_change(self): + """ + Test `on_new_path` when called with a path that is the same as the existing path. + """ + # GIVEN: An instance of PathEdit with a test path and mocked `pathChanged` signal + with patch('openlp.core.ui.lib.pathedit.PathEdit.path', new_callable=PropertyMock): + self.widget._path = '/old/test/pat.h' + self.widget.pathChanged = MagicMock() + + # WHEN: Calling `on_new_path` with the same path as the existing path + self.widget.on_new_path('/old/test/pat.h') + + # THEN: The `pathChanged` signal should not be emitted + self.assertFalse(self.widget.pathChanged.emit.called) + + def test_on_new_path_change(self): + """ + Test `on_new_path` when called with a path that is the different to the existing path. + """ + # GIVEN: An instance of PathEdit with a test path and mocked `pathChanged` signal + with patch('openlp.core.ui.lib.pathedit.PathEdit.path', new_callable=PropertyMock): + self.widget._path = '/old/test/pat.h' + self.widget.pathChanged = MagicMock() + + # WHEN: Calling `on_new_path` with the a new path + self.widget.on_new_path('/new/test/pat.h') + + # THEN: The `pathChanged` signal should be emitted + self.widget.pathChanged.emit.assert_called_once_with('/new/test/pat.h')