refactor: Separate GUI and model using MVP pattern

Related pwr-Solaar#2395

lib/solaar/ui/about/__init__.py

@@ -0,0 +1 @@
+from .about import show_window  # noqa: F401

lib/solaar/ui/about/about.py

@@ -0,0 +1,26 @@
+## Copyright (C) Solaar Contributors
+##
+## 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; either version 2 of the License, or
+## (at your option) any later version.
+##
+## 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.,
+## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from solaar.ui.about.model import AboutModel
+from solaar.ui.about.presenter import Presenter
+from solaar.ui.about.view import AboutView
+
+
+def show_window(_args):
+    model = AboutModel()
+    view = AboutView()
+    presenter = Presenter(model, view)
+    presenter.run()

lib/solaar/ui/about/model.py

@@ -0,0 +1,71 @@
+## Copyright (C) Solaar Contributors
+##
+## 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; either version 2 of the License, or
+## (at your option) any later version.
+##
+## 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.,
+## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from solaar.i18n import _
+
+
+class AboutModel:
+    def __init__(self) -> None:
+        pass
+
+    def get_authors(self) -> list[str]:
+        return [
+            "Daniel Pavel http://github.com/pwr",
+        ]
+
+    def get_comments(self) -> str:
+        return _("Manages Logitech receivers,\nkeyboards, mice, and tablets.")
+
+    def get_copyright(self) -> str:
+        return "© 2012-2023 Daniel Pavel and contributors to the Solaar project"
+
+    def get_translators(self) -> list[str]:
+        return [
+            "gogo (croatian)",
+            "Papoteur, David Geiger, Damien Lallement (français)",
+            "Michele Olivo (italiano)",
+            "Adrian Piotrowicz (polski)",
+            "Drovetto, JrBenito (Portuguese-BR)",
+            "Daniel Pavel (română)",
+            "Daniel Zippert, Emelie Snecker (svensk)",
+            "Dimitriy Ryazantcev (Russian)",
+            "El Jinete Sin Cabeza (Español)",
+            "Ferdina Kusumah (Indonesia)",
+        ]
+
+    def get_credit_sections(self) -> list[tuple[str, list[str]]]:
+        return [
+            (_("Additional Programming"), ["Filipe Laíns", "Peter F. Patel-Schneider"]),
+            (_("GUI design"), ["Julien Gascard", "Daniel Pavel"]),
+            (
+                _("Testing"),
+                [
+                    "Douglas Wagner",
+                    "Julien Gascard",
+                    "Peter Wu http://www.lekensteyn.nl/logitech-unifying.html",
+                ],
+            ),
+            (
+                _("Logitech documentation"),
+                [
+                    "Julien Danjou http://julien.danjou.info/blog/2012/logitech-unifying-upower",
+                    "Nestor Lopez Casado http://drive.google.com/folderview?id=0BxbRzx7vEV7eWmgwazJ3NUFfQ28",
+                ],
+            ),
+        ]
+
+    def get_website(self):
+        return "https://pwr-solaar.github.io/Solaar"

lib/solaar/ui/about/presenter.py

@@ -0,0 +1,92 @@
+## Copyright (C) Solaar Contributors
+##
+## 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; either version 2 of the License, or
+## (at your option) any later version.
+##
+## 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.,
+## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from __future__ import annotations
+
+import logging
+
+from typing import Protocol
+
+from solaar.ui.about.model import AboutModel
+
+
+class AboutViewProtocol(Protocol):
+    def init_ui(self, presenter: Presenter) -> None:
+        ...
+
+    def update_credit_sections(self, section_name: str, people: list[str]) -> None:
+        ...
+
+    def update_comments(self, comments: str) -> None:
+        ...
+
+    def update_authors(self, authors: list[str]) -> None:
+        ...
+
+    def update_translator_credits(self, translators: list[str]) -> None:
+        ...
+
+    def update_website(self, website):
+        ...
+
+    def mainloop(self) -> None:
+        ...
+
+
+class Presenter:
+    def __init__(self, model: AboutModel, view: AboutViewProtocol) -> None:
+        self.model = model
+        self.view = view
+
+    def handle_close(self, event=None) -> None:
+        event.hide()
+
+    def update_credit_sections(self) -> None:
+        credits_section = self.model.get_credit_sections()
+        for section_name, people in credits_section:
+            try:
+                self.view.update_credit_sections(section_name, people)
+            except TypeError:
+                # gtk3 < ~3.6.4 has incorrect gi bindings
+                logging.exception("failed to fully create the about dialog")
+            except Exception:
+                # the Gtk3 version may be too old, and the function does not exist
+                logging.exception("failed to fully create the about dialog")
+
+    def update_comments(self) -> None:
+        comments = self.model.get_comments()
+        self.view.update_comments(comments)
+
+    def update_authors(self) -> None:
+        authors = self.model.get_authors()
+        self.view.update_authors(authors)
+
+    def update_translators(self) -> None:
+        translators = self.model.get_translators()
+        self.view.update_translator_credits(translators)
+
+    def update_website(self) -> None:
+        website = self.model.get_website()
+        self.view.update_website(website)
+
+    def run(self) -> None:
+        self.view.init_ui(self)
+        self.update_credit_sections()
+        self.update_comments()
+        self.update_authors()
+        self.update_translators()
+        self.update_website()
+        self.view.mainloop()

lib/solaar/ui/about/view.py

@@ -0,0 +1,60 @@
+## Copyright (C) Solaar Contributors
+##
+## 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; either version 2 of the License, or
+## (at your option) any later version.
+##
+## 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.,
+## 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+from typing import Protocol
+from typing import Union
+
+from gi.repository import Gtk
+
+from solaar import NAME
+from solaar import __version__
+from solaar.ui.about.presenter import Presenter
+
+
+class PresenterProtocol(Protocol):
+    def handle_toggle_credits(self, event=None) -> None:
+        ...
+
+
+class AboutView:
+    def __init__(self) -> None:
+        self.about: Union[Gtk.AboutDialog, None] = None
+
+    def init_ui(self, presenter: Presenter) -> None:
+        self.about = Gtk.AboutDialog()
+        self.about.set_program_name(NAME)
+        self.about.set_version(__version__)
+        self.about.set_icon_name(NAME.lower())
+        self.about.set_license_type(Gtk.License.GPL_2_0)
+        self.about.set_website_label(NAME)
+
+        self.about.connect("response", lambda x, y: presenter.handle_close(x))
+
+    def update_comments(self, comments: str) -> None:
+        self.about.set_comments(comments)
+
+    def update_authors(self, authors: list[str]) -> None:
+        self.about.set_authors(authors)
+
+    def update_translator_credits(self, translators: list[str]) -> None:
+        translator_credits = "\n".join(translators)
+        self.about.set_translator_credits(translator_credits)
+
+    def update_website(self, website):
+        self.about.set_website(website)
+
+    def mainloop(self) -> None:
+        self.about.present()

lib/solaar/ui/tray.py

@@ -30,8 +30,8 @@
 from solaar import NAME
 from solaar.i18n import _
 
+from . import about
 from . import icons as _icons
-from .about import show_window as _show_about_window
 from .action import make as _make
 from .window import popup as _window_popup
 from .window import toggle as _window_toggle
@@ -60,7 +60,7 @@ def _create_menu(quit_handler):
     menu.append(no_receiver)
     menu.append(Gtk.SeparatorMenuItem.new())
 
-    menu.append(_make("help-about", _("About %s") % NAME, _show_about_window, stock_id="help-about").create_menu_item())
+    menu.append(_make("help-about", _("About %s") % NAME, about.show_window, stock_id="help-about").create_menu_item())
     menu.append(_make("application-exit", _("Quit %s") % NAME, quit_handler, stock_id="application-exit").create_menu_item())
 
     menu.show_all()