Add return home button and validate deck name

Added base class for study and edit widgets
This class contains the return to home button
Validate deck name using regular expression

Author: lucabindini

README.md

@@ -1,3 +1,3 @@
-# <img src="src/img/favicon.ico" height=64> Study and Repeat
+# Study and Repeat
 
 This repository contains the code for an application aimed at improving the quality of the study, through the technique of spaced repetition.

src/view/editor_widget.py

@@ -1,17 +1,20 @@
 from PyQt5 import QtWidgets, QtGui
 
 from model import deck
+from view import secondary_widget
 import config
 
 
-class EditorWidget(QtWidgets.QWidget):
+class EditorWidget(secondary_widget.SecondaryWidget):
 
     question_prefix = '- '
     proportion = 6
 
     def __init__(self, d: deck.Deck, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
 
+        self.window().setWindowTitle(f'Study and Repeat - {d.name}')
+
         self._deck = d
         h_layout = QtWidgets.QHBoxLayout()
 
@@ -61,8 +64,7 @@ def __init__(self, d: deck.Deck, *args, **kwargs) -> None:
         h_layout.addWidget(left_widget, 100//self.proportion)
         h_layout.addWidget(right_widget,
                            100 * (self.proportion-1) // self.proportion)
-        self.setLayout(h_layout)
-        self.window().setCentralWidget(self)
+        self._central_widget.setLayout(h_layout)
 
         self.disable()
         self._cards_list.addItems(

src/view/home_widget.py

@@ -24,6 +24,8 @@ def __init__(self, *args, **kwargs):
 
     def populate_list(self) -> None:
         for deck_name in sorted(os.listdir(config.DECKS_DIR)):
+            if deck_name.startswith('.'):
+                continue
             widget = QtWidgets.QWidget(self._scroll_area_widget_contents)
             horizontal_layout = QtWidgets.QHBoxLayout(widget)
             horizontal_layout.setAlignment(QtCore.Qt.AlignCenter)

src/view/main_window.py

@@ -1,3 +1,5 @@
+import re
+
 from PyQt5 import QtWidgets, QtGui, QtCore
 
 from view import home_widget, editor_widget
@@ -82,6 +84,12 @@ def __init__(self, *args, **kwargs) -> None:
         layout = QtWidgets.QVBoxLayout()
         self.setLayout(layout)
 
+        self._error_label = QtWidgets.QLabel('The only permitted characters are '
+                                       + 'a..z, A..Z, 0..9 and _')
+        self._error_label.setStyleSheet("color: #ff0000")
+        layout.addWidget(self._error_label)
+        self._error_label.hide()
+
         self._line_edit = QtWidgets.QLineEdit(self)
         self._line_edit.setPlaceholderText('Insert deck name')
         layout.addWidget(self._line_edit)
@@ -93,5 +101,8 @@ def __init__(self, *args, **kwargs) -> None:
         layout.addWidget(button_box)
 
     def accept(self, *args, **kwargs) -> None:
-        super().accept()
-        self.deck = deck.Deck(self._line_edit.text())
+        if re.fullmatch('[a-zA-Z0-9_]+', self._line_edit.text()) is None:
+            self._error_label.show()
+        else:
+            super().accept()
+            self.deck = deck.Deck(self._line_edit.text())

src/view/secondary_widget.py

@@ -0,0 +1,29 @@
+
+
+from PyQt5 import QtWidgets
+from PyQt5 import QtWidgets, QtGui
+
+from view import home_widget
+import config
+
+
+class SecondaryWidget(QtWidgets.QWidget):
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+
+        self._layout = QtWidgets.QVBoxLayout()
+        self.setLayout(self._layout)
+        back_btn = QtWidgets.QPushButton(QtGui.QIcon(
+            f'{config.ICONS_DIR}home.png'), '')      
+        back_btn.setFixedWidth(32)
+        self._layout.addWidget(back_btn)
+        back_btn.released.connect(self.back_home)
+        self._central_widget = QtWidgets.QWidget()
+        self._layout.addWidget(self._central_widget)
+        self.window().setCentralWidget(self) 
+
+    def back_home(self) -> None:
+        self.window().setCentralWidget(home_widget.HomeWidget())
+        self.window().setWindowTitle('Study and Repeat')
+        self.exit()

src/view/study_widget.py

@@ -1,15 +1,17 @@
 from PyQt5 import QtWidgets, QtGui
 
 from model import deck
-from view import home_widget
+from view import home_widget, secondary_widget
 import config
 
 
-class StudyWidget(QtWidgets.QWidget):
+class StudyWidget(secondary_widget.SecondaryWidget):
 
     def __init__(self, d: deck.Deck, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
 
+        self.window().setWindowTitle(f'Study and Repeat - {d.name}')
+
         self._deck = d
         v_layout = QtWidgets.QVBoxLayout()
         self._question_text = QtWidgets.QLineEdit()
@@ -36,9 +38,8 @@ def __init__(self, d: deck.Deck, *args, **kwargs) -> None:
         v_layout.addWidget(self._correctness_btns)
         self._correctness_btns.hide()
         self._answer_text.hide()
-        self.setLayout(v_layout)
 
-        self.window().setCentralWidget(self)
+        self._central_widget.setLayout(v_layout)
         self.show_question()
 
     def show_question(self) -> None: