- adding support for section renaming

Author: Pprud

README.md

@@ -5,7 +5,7 @@ Notes application written in Python 3.8 & KivyMD
 
 ## application description
 - OS independent
-- Notes can be grouped in separate sections, these sections can be further added and removed
+- Notes can be grouped in separate sections, these sections can be added, renamed or removed
 - Notes storage file can be placed anywhere on the local drive but can also be placed in a DropBox shared folder for example to synchronize notes across devices
 - Full-text or word-based search capability across the current section or all sections
 - Customizable fonts and colors, settings can be persisted
@@ -112,13 +112,14 @@ change in the spec file the line datas=[], to datas=[("notes_app/view/notes_view
 ```
 
 ## useful links
-- development 
+- app development 
   - https://kivymd.readthedocs.io/en/latest/components/
   - https://www.tutorialspoint.com/design_pattern/mvc_pattern.htm
   - https://github.com/HeaTTheatR/Kivy_MVC_Template/tree/main
   - https://github.com/thebjorn/pydeps
+  - https://github.com/kivymd/KivyMD/blob/master/kivymd/icon_definitions.py
 
-- app building
+- building the app
   - https://pyinstaller.org/en/stable/when-things-go-wrong.html
   - https://dev.to/ngonidzashe/using-pyinstaller-to-package-kivy-and-kivymd-desktop-apps-2fmj
   - https://github.com/devgiordane/kivy-md-build

notes_app/controller/notes_controller.py

@@ -68,6 +68,7 @@ def save_file_data(self, data):
             before = f.read() or ""
             f.close()
 
+            # TODO try merge strings one section loaded from file at a time
             data = merge_strings(before=before, after=data)
 
         f = open(self.model.file_path, "w")

notes_app/file.py

@@ -131,6 +131,28 @@ def delete_all_sections_content(self) -> None:
     def delete_section_content(self, section_file_separator) -> None:
         self._data_by_sections.pop(section_file_separator)
 
+    def rename_section(
+        self, old_section_file_separator, new_section_file_separator
+    ) -> None:
+        """
+        rename_section method abstracts all section renaming actions
+        by renaming the section identifier in the _section_identifiers list
+        and by replacing the key in the _data_by_sections dict
+        """
+        idx = 0
+        for idx, section_identifier in enumerate(self._section_identifiers):
+            if section_identifier.section_file_separator == old_section_file_separator:
+                break
+
+        self._section_identifiers[idx] = SectionIdentifier(
+            defaults=self.defaults, section_file_separator=new_section_file_separator
+        )
+
+        self._data_by_sections[new_section_file_separator] = self._data_by_sections[
+            old_section_file_separator
+        ]
+        del self._data_by_sections[old_section_file_separator]
+
     def _transform_raw_data_content_to_data_by_sections(
         self,
     ) -> Dict[SectionIdentifier, AnyStr]:

notes_app/version.py

@@ -1 +1 @@
-__version__ = "1.0.1"
+__version__ = "0.1.0"

notes_app/view/notes_view.kv

@@ -19,16 +19,22 @@
     text: root.text
     theme_text_color: "Custom"
     on_release: self.parent.set_color_item(self)
+    on_size:
+        self.ids._right_container.width = icons_container.width
+        self.ids._right_container.x = icons_container.width
 
-    IconLeftWidget:
-        id: icon
-        icon: root.icon
-        theme_text_color: "Custom"
+    IconsContainer:
+        id: icons_container
+
+        MDIconButton:
+            icon: 'file-document-edit-outline'
+            on_release: root.edit(section_item)
+            theme_text_color: "Custom"
 
-    IconRightWidget:
-        icon: 'trash-can-outline'
-        on_release: root.delete(section_item)
-        theme_text_color: "Custom"
+        MDIconButton:
+            icon: 'trash-can-outline'
+            on_release: root.delete(section_item)
+            theme_text_color: "Custom"
 
 <NotesView>:
     orientation: "vertical"
@@ -219,7 +225,7 @@
 
         MDTextField:
             id: section_name_input_value
-            hint_text: "What section name to add?"
+            hint_text: "Enter section name"
             max_text_length: 20
 
         BoxLayout:
@@ -231,5 +237,39 @@
                 on_release: root.cancel()
             MDRectangleFlatButton:
                 size_hint: (.5, .8)
-                text: "Add"
+                text: "Save"
                 on_release: root.execute_add_section(section_name_input_value.text)
+
+<EditSectionDialogContent>
+    orientation: "vertical"
+    spacing: "12dp"
+    size_hint_y: None
+    height: "500dp"
+
+    MDBoxLayout:
+        size: root.size
+        pos: root.pos
+        orientation: "vertical"
+
+        MDLabel:
+            font_style: "H6"
+            halign: "center"
+            valign: "center"
+            text: root.edit_section_result_message
+
+        MDTextField:
+            id: section_name_input_value
+            hint_text: "Enter new section name"
+            max_text_length: 20
+
+        BoxLayout:
+            size_hint_y: None
+            height: 40
+            MDFlatButton:
+                size_hint: (.5, .8)
+                text: "Cancel"
+                on_release: root.cancel()
+            MDRectangleFlatButton:
+                size_hint: (.5, .8)
+                text: "Save"
+                on_release: root.execute_edit_section(root.old_section_name, section_name_input_value.text)

notes_app/view/notes_view.py

@@ -13,7 +13,12 @@
 from kivymd.uix.boxlayout import MDBoxLayout
 from kivymd.uix.dialog import MDDialog
 from kivymd.uix.filemanager import MDFileManager
-from kivymd.uix.list import MDList, OneLineAvatarIconListItem, ThreeLineListItem
+from kivymd.uix.list import (
+    MDList,
+    OneLineAvatarIconListItem,
+    ThreeLineListItem,
+    IRightBodyTouch,
+)
 from kivymd.uix.menu import MDDropdownMenu
 from kivymd.uix.screen import MDScreen
 from kivymd.uix.snackbar import BaseSnackbar
@@ -56,11 +61,15 @@
 EXTERNAL_REPOSITORY_URL = "https://www.github.com/datahappy1/notes_app/"
 
 
+class IconsContainer(IRightBodyTouch, MDBoxLayout):
+    pass
+
+
 class ItemDrawer(OneLineAvatarIconListItem):
-    icon = StringProperty()
-    id = StringProperty()
-    text = StringProperty()
-    delete = ObjectProperty()
+    id = StringProperty(None)
+    text = StringProperty(None)
+    edit = ObjectProperty(None)
+    delete = ObjectProperty(None)
 
 
 class ContentNavigationDrawer(MDBoxLayout):
@@ -101,6 +110,13 @@ class AddSectionDialogContent(MDBoxLayout):
     cancel = ObjectProperty(None)
 
 
+class EditSectionDialogContent(MDBoxLayout):
+    old_section_name = StringProperty(None)
+    edit_section_result_message = StringProperty(None)
+    execute_edit_section = ObjectProperty(None)
+    cancel = ObjectProperty(None)
+
+
 class SearchDialogContent(MDBoxLayout):
     get_search_switch_state = ObjectProperty(None)
     search_switch_callback = ObjectProperty(None)
@@ -216,12 +232,12 @@ def set_drawer_items(self, section_identifiers):
         for section_identifier in section_identifiers:
             self.ids.md_list.add_widget(
                 ItemDrawer(
-                    icon="bookmark-outline",
                     id=section_identifier.section_file_separator,
-                    text=f"section: {section_identifier.section_name}",
+                    text=section_identifier.section_name,
                     on_release=lambda x=f"{section_identifier.section_file_separator}": self.press_drawer_item_callback(
                         x
                     ),
+                    edit=self.press_edit_section,
                     delete=self.press_delete_section,
                 )
             )
@@ -488,24 +504,21 @@ def execute_search(self, *args):
         )
 
     def execute_add_section(self, *args):
+        section_name = args[0]
+
         if (
-            not args[0]
-            or len(args[0]) < SECTION_FILE_NAME_MINIMAL_CHAR_COUNT
-            or args[0].isspace()
-            or args[0] in [si.section_name for si in self.file.section_identifiers]
+            not section_name
+            or len(section_name) < SECTION_FILE_NAME_MINIMAL_CHAR_COUNT
+            or section_name.isspace()
+            or section_name in [si.section_name for si in self.file.section_identifiers]
         ):
             self.dialog.content_cls.add_section_result_message = "Invalid name"
             return
 
-        section_name = args[0]
         section_identifier = SectionIdentifier(
             defaults=self.defaults, section_name=section_name
         )
 
-        if section_identifier.section_file_separator in self.file.section_identifiers:
-            self.dialog.content_cls.add_section_result_message = "Name already exists"
-            return
-
         self.file.add_section_identifier(
             section_file_separator=section_identifier.section_file_separator
         )
@@ -520,6 +533,39 @@ def execute_add_section(self, *args):
 
         self.cancel_dialog()
 
+    def execute_edit_section(self, *args):
+        old_section_name, new_section_name = args
+
+        if (
+            not new_section_name
+            or len(new_section_name) < SECTION_FILE_NAME_MINIMAL_CHAR_COUNT
+            or new_section_name.isspace()
+            or new_section_name
+            in [si.section_name for si in self.file.section_identifiers]
+            or old_section_name == new_section_name
+        ):
+            self.dialog.content_cls.edit_section_result_message = "Invalid name"
+            return
+
+        new_section_identifier = SectionIdentifier(
+            defaults=self.defaults, section_name=new_section_name
+        )
+
+        old_section_identifier = SectionIdentifier(
+            defaults=self.defaults, section_name=old_section_name
+        )
+
+        self.file.rename_section(
+            old_section_file_separator=old_section_identifier.section_file_separator,
+            new_section_file_separator=new_section_identifier.section_file_separator,
+        )
+
+        self.filter_data_split_by_section(section_identifier=new_section_identifier)
+
+        self.set_drawer_items(section_identifiers=self.file.section_identifiers)
+
+        self.cancel_dialog()
+
     def execute_goto_external_url(self):
         return webbrowser.open(EXTERNAL_REPOSITORY_URL)
 
@@ -592,6 +638,23 @@ def press_add_section(self, *args):
         self.dialog = MDDialog(title="Add section:", type="custom", content_cls=content)
         self.dialog.open()
 
+    def press_edit_section(self, section_item):
+        section_name = SectionIdentifier(
+            section_file_separator=section_item.id, defaults=self.defaults
+        ).section_name
+
+        content = EditSectionDialogContent(
+            old_section_name=section_name,
+            edit_section_result_message="",
+            execute_edit_section=self.execute_edit_section,
+            cancel=self.cancel_dialog,
+        )
+
+        self.dialog = MDDialog(
+            title=f"Edit section {section_name}:", type="custom", content_cls=content
+        )
+        self.dialog.open()
+
     def press_delete_section(self, section_item):
         if len(self.file.section_identifiers) == 1:
             self.show_error_bar(error_message="Cannot delete last section")

tests/test_unit_file.py

@@ -141,6 +141,37 @@ def test_delete_all_sections_content(self, get_file):
         assert not get_file.delete_all_sections_content()
         assert not get_file.transform_data_by_sections_to_raw_data_content()
 
+    def test_rename_section(self, get_file):
+        assert (
+            get_file.add_section_identifier(section_file_separator="<section=a> ")
+            is None
+        )
+
+        assert not get_file.set_section_content(
+            section_file_separator="<section=a> ", section_content="some content"
+        )
+
+        assert [si.section_name for si in get_file._section_identifiers] == [
+            "first",
+            "second",
+            "a",
+        ]
+
+        assert not get_file.rename_section(
+            old_section_file_separator="<section=a> ",
+            new_section_file_separator="<section=b> ",
+        )
+        assert (
+            get_file.get_section_content(section_file_separator="<section=b> ")
+            == "some content"
+        )
+
+        assert [si.section_name for si in get_file._section_identifiers] == [
+            "first",
+            "second",
+            "b",
+        ]
+
     def test__transform_raw_data_content_to_data_by_sections(self, get_file):
         assert get_file._transform_raw_data_content_to_data_by_sections() == {
             "<section=first> ": "Quod equidem non reprehendo\n",