Use preset_path instead of building path from preset's name and repo (#658)

The repo refactor unfortunately reintroduced the above bug, certain
preset names (like "Classic" and "classic-light.json", or "Kate" and
"kate-light.json") that did not match the actual file paths from the
downloaded files would result in being unable to apply or delete them.
To fix this, Presets should only load and remember the path they were
loaded from, rather than building one each time with the preset and repo
name.

The preset and repo name can still be used when creating a new file from
a resource or from scratch, but after that the path should be used to
ensure we have the right file.

Author: tfuxu

gradience/ui/preset_row.py

@@ -41,7 +41,7 @@ class GradiencePresetRow(Adw.ExpanderRow):
     badge_list = Gtk.Template.Child("badge_list")
     no_badges = Gtk.Template.Child("no_badges")
 
-    def __init__(self, name, win, repo_name, author="", **kwargs):
+    def __init__(self, name, preset_path, win, repo_name, author="", **kwargs):
         super().__init__(**kwargs)
 
         self.name = name
@@ -57,7 +57,7 @@ def __init__(self, name, win, repo_name, author="", **kwargs):
         self.win = win
         self.toast_overlay = self.win.toast_overlay
 
-        self.preset = Preset(name, repo_name)
+        self.preset = Preset(preset_path)
 
         if self.preset.badges:
             self.has_badges = True
@@ -107,13 +107,7 @@ def on_star_button_clicked(self, *_args):
     def on_apply_button_clicked(self, *_args):
         buglog("apply")
 
-        self.app.load_preset_from_file(
-            os.path.join(
-                presets_dir,
-                self.prefix,
-                to_slug_case(to_slug_case(self.name)) + ".json",
-            )
-        )
+        self.app.load_preset_from_file(self.preset.preset_path)
 
     def on_undo_button_clicked(self, *_args):
         buglog("undo")
@@ -131,7 +125,7 @@ def on_name_entry_toggled(self, *_args):
         if self.name_entry_toggle.get_active():
             self.value_stack.set_visible_child(self.name_entry)
         else:
-            self.update_value()
+            self.preset.rename_preset(self.name_entry.get_text())
             self.value_stack.set_visible_child(self.apply_button)
 
     def on_report_btn_clicked(self, *_args):
@@ -163,16 +157,8 @@ def on_remove_button_clicked(self, *_args):
 
         try:
             os.rename(
-                os.path.join(
-                    presets_dir,
-                    self.prefix,
-                    to_slug_case(self.preset.filename) + ".json",
-                ),
-                os.path.join(
-                    presets_dir,
-                    self.prefix,
-                    to_slug_case(self.preset.filename) + ".json.to_delete",
-                ),
+                self.preset.preset_path,
+                self.preset.preset_path + ".to_delete",
             )
 
             self.set_name(self.name + "(" + _("Pending Deletion") + ")")
@@ -183,40 +169,13 @@ def on_remove_button_clicked(self, *_args):
         finally:
             self.delete_preset = True
 
-    def update_value(self):
-        print(self.name_entry.get_text())
-        old = self.preset.filename
-        self.preset.save_preset(self.name_entry.get_text())
-        print(os.path.join(
-                presets_dir,
-                self.prefix,
-                to_slug_case(old) + ".json",
-            ))
-        os.remove(
-            os.path.join(
-                presets_dir,
-                self.prefix,
-                to_slug_case(old) + ".json",
-            )
-        )
-
     def on_delete_toast_dismissed(self, widget):
         buglog("dismissed")
         if self.delete_preset:
             buglog("delete")
             try:
-                buglog(os.path.join(
-                        presets_dir,
-                        self.prefix,
-                        to_slug_case(self.preset.filename) + ".json.to_delete",
-                    ))
-                os.remove(
-                    os.path.join(
-                        presets_dir,
-                        self.prefix,
-                        to_slug_case(self.preset.filename) + ".json.to_delete",
-                    )
-                )
+                buglog(self.preset.preset_path + ".to_delete")
+                os.remove(self.preset.preset_path + ".to_delete")
             except Exception as exception:
                 buglog(exception)
                 self.toast_overlay.add_toast(
@@ -228,16 +187,8 @@ def on_delete_toast_dismissed(self, widget):
             buglog("undo")
             try:
                 os.rename(
-                    os.path.join(
-                        presets_dir,
-                        self.prefix,
-                        to_slug_case(self.preset.filename) + ".json.to_delete",
-                    ),
-                    os.path.join(
-                        presets_dir,
-                        self.prefix,
-                        to_slug_case(self.preset.filename) + ".json",
-                    ),
+                    self.preset.preset_path + ".to_delete",
+                    self.preset.preset_path
                 )
             except Exception as exception:
                 buglog(exception)

gradience/ui/presets_manager_window.py

@@ -276,7 +276,7 @@ def on_file_chooser_response(self, widget, response):
         if response == Gtk.ResponseType.ACCEPT:
             if preset_file.endswith(".json"):
 
-                if preset_file.strip(".json") in self.custom_presets:
+                if preset_file in self.custom_presets:
                     self.toast_overlay.add_toast(
                         Adw.Toast(title=_("Preset already exists"))
                     )
@@ -285,6 +285,7 @@ def on_file_chooser_response(self, widget, response):
                         self.preset_path.get_path(),
                         os.path.join(
                             presets_dir,
+                            "user",
                             preset_file,
                         ),
                     )
@@ -311,6 +312,7 @@ def reload_pref_group(self):
         }
 
         for repo in Path(presets_dir).iterdir():
+            buglog(f"presets_dir.iterdir: {repo}")
             if repo.is_dir():  # repo
                 presets_list = {}
                 for file_name in repo.iterdir():
@@ -328,10 +330,11 @@ def reload_pref_group(self):
                                 raise KeyError("variables")
                             if preset.get("palette") is None:
                                 raise KeyError("palette")
-                            presets_list[file_name.replace(".json", "")] = preset[
+                            presets_list[file_name] = preset[
                                 "name"
                             ]
-                        except Exception:
+                        except Exception as e:
+                            buglog(f"reload_pref_group exception: {e}")
                             self.toast_overlay.add_toast(
                                 Adw.Toast(title=_("Failed to load preset"))
                             )
@@ -358,10 +361,11 @@ def reload_pref_group(self):
                             raise KeyError("variables")
                         if preset.get("palette") is None:
                             raise KeyError("palette")
-                        presets_list["user"][file_name.replace(".json", "")] = preset[
+                        presets_list["user"][file_name] = preset[
                             "name"
                         ]
-                    except Exception:
+                    except Exception as e:
+                        buglog(f"reload_pref_group exception: {e}")
                         self.toast_overlay.add_toast(
                             Adw.Toast(title=_("Failed to load preset"))
                         )
@@ -399,7 +403,7 @@ def reload_pref_group(self):
             for repo, presets in self.custom_presets.items():
                 for preset_file, preset_name in presets.items():
                     row = GradiencePresetRow(
-                        preset_name, self, repo)
+                        preset_name, preset_file, self, repo)
                     self.preset_list.add(row)
 
         else:

gradience/utils/preset.py

@@ -37,40 +37,36 @@ class Preset:
         "gtk3": "",
     }
     plugins = {}
-    repo = "user"
     display_name = "New Preset"
-    filename = "new_preset"
+    preset_path = "new_preset"
     badges = {}
 
-    def __init__(self, name=None, repo=None, preset_path=None, text=None, preset=None):
-        if text:  # load from resource
+    def __init__(self, preset_path=None, text=None, preset=None):
+        if preset_path:
+            self.load_preset(preset_path=preset_path)
+        elif text:  # load from resource
             self.load_preset(text=text)
         elif preset:  # css or dict
             self.load_preset(preset=preset)
         else:
-            if name is not None:
-                self.filename = to_slug_case(name)
-            if repo is not None:
-                self.repo = repo
-            if preset_path is None:
-                self.preset_path = os.path.join(
-                    presets_dir, repo, self.filename + ".json")
-            else:
-                self.preset_path = preset_path
-            self.load_preset()
+            raise Exception("Failed to create a new Preset object: Preset created without content")
 
-    def load_preset(self, text=None, preset=None):
+    def load_preset(self, preset_path=None, text=None, preset=None):
         try:
             if not preset:
                 if text:
                     preset_text = text
-                else:
+                elif preset_path:
+                    self.preset_path = preset_path
                     with open(self.preset_path, "r", encoding="utf-8") as file:
                         preset_text = file.read()
+                        file.close()
+                else:
+                    raise Exception("load_preset must be called with a path, text, or preset")
+
                 preset = json.loads(preset_text)
 
             self.display_name = preset["name"]
-            self.filename = to_slug_case(self.display_name)
             self.variables = preset["variables"]
             self.palette = preset["palette"]
 
@@ -84,18 +80,34 @@ def load_preset(self, text=None, preset=None):
             else:
                 for app_type in settings_schema["custom_css_app_types"]:
                     self.custom_css[app_type] = ""
-        except Exception as error:
-            buglog(error, " -> preset : ", self.preset_path)
+        except Exception as e:
+            if self.preset_path:
+                buglog(f"Failed to load preset {self.preset_path}. Exc: {e}")
+            else:
+                buglog(f"Failed to load preset with unknown path. Exc: {e}")
+
+    # Rename an existing preset
+    def rename_preset(self, name):
+        self.display_name = name
+        old_path = self.preset_path
+        self.preset_path = os.path.join(
+                os.path.dirname(self.preset_path),
+                to_slug_case(name) + ".json")
 
+        self.save_preset(to=self.preset_path)
+        os.remove(old_path)
+
+    # Save a new user preset (or overwrite one)
     def save_preset(self, name=None, plugins_list=None, to=None):
         self.display_name = name if name else self.display_name
-        self.filename = to_slug_case(name) if name else self.filename
 
         if to is None:
+            filename = to_slug_case(name) if name else "new_preset"
             self.preset_path = os.path.join(
-                presets_dir, self.repo, self.filename + ".json")
+                presets_dir, "user", filename + ".json")
         else:
             self.preset_path = to
+
         if not os.path.exists(
             os.path.join(
                 presets_dir,
@@ -114,13 +126,7 @@ def save_preset(self, name=None, plugins_list=None, to=None):
         else:
             plugins_list = plugins_list.save()
 
-        print(self.preset_path)
-
-        with open(
-            self.preset_path,
-            "w",
-            encoding="utf-8",
-        ) as file:
+        with open(self.preset_path, "w", encoding="utf-8") as file:
             object_to_write = {
                 "name": self.display_name,
                 "variables": self.variables,
@@ -129,12 +135,7 @@ def save_preset(self, name=None, plugins_list=None, to=None):
                 "plugins": plugins_list,
             }
             file.write(json.dumps(object_to_write, indent=4))
+            file.close()
 
     def validate(self):
         return True
-
-
-if __name__ == "__main__":
-    p = Preset("test", "user")
-    buglog(p.variables)
-    buglog(p.palette)

gradience/utils/repo.py

@@ -33,5 +33,5 @@ def get_presets(self):
         presets = {}
         for preset in os.listdir(self.path):
             if preset.endswith(".json"):
-                presets[preset[:-5]] = Preset(preset[:-5], self.name)
+                presets[preset[:-5]] = Preset(os.path.join(self.path, preset))
         return presets

po/Gradience.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-11-20 12:14+0000\n"
+"POT-Creation-Date: 2022-11-20 12:26+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -585,19 +585,19 @@ msgstr ""
 msgid "Add to Favorites"
 msgstr ""
 
-#: gradience/ui/preset_row.py:156
+#: gradience/ui/preset_row.py:150
 msgid "Preset removed"
 msgstr ""
 
-#: gradience/ui/preset_row.py:157
+#: gradience/ui/preset_row.py:151
 msgid "Undo"
 msgstr ""
 
-#: gradience/ui/preset_row.py:178
+#: gradience/ui/preset_row.py:164
 msgid "Pending Deletion"
 msgstr ""
 
-#: gradience/ui/preset_row.py:223
+#: gradience/ui/preset_row.py:182
 msgid "Unable to delete preset"
 msgstr ""