- difflib merge_strings refactored - if there is an external update, diff calculated only for the active section, other sections are reloaded from the disk

- minor adjustments

Author: Pprud

notes_app.svg

@@ -1,4 +1,3 @@
-from notes_app.diff import merge_strings
 from notes_app.view.notes_view import NotesView
 
 
@@ -56,21 +55,10 @@ def read_file_data(self, file_path=None):
         f.close()
         return s
 
-    def save_file_data(self, data):
+    def save_file_data(self, data) -> None:
         """
-        save_file_data saves provided data to the file with location set in model.file_path,
-        if the file was updated by another instance of the notes app, check if model property external_update
-        evaluates to True, the code-path goes through difflib merge_string to save the merged string data to the file
+        save_file_data saves provided data to the file with location set in model.file_path
         """
-        if self.model.external_update:
-            f = open(self.model.file_path, "r")
-            # in case deleted file content fallback to empty string
-            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")
         f.write(data)
         f.close()
@@ -79,5 +67,7 @@ def save_file_data(self, data):
         self.model.dump()
 
     def get_screen(self):
-        """The method creates get the view."""
+        """
+        The method creates get the view.
+        """
         return self.view

notes_app/controller/notes_controller.py

@@ -51,7 +51,7 @@ def __init__(self, file_path, controller, defaults):
         ] = self._get_section_identifiers_from_raw_data_content()
 
         self._data_by_sections: Dict[
-            SectionIdentifier, AnyStr
+            AnyStr, AnyStr
         ] = self._transform_raw_data_content_to_data_by_sections()
 
     @staticmethod
@@ -101,7 +101,8 @@ def default_section_identifier(self) -> SectionIdentifier:
         return self._section_identifiers[0]
 
     @property
-    def section_identifiers(self) -> List[SectionIdentifier]:
+    def section_identifiers_sorted_by_name(self) -> List[SectionIdentifier]:
+        self._section_identifiers.sort(key=lambda x: x.section_name)
         return self._section_identifiers
 
     def add_section_identifier(self, section_file_separator) -> None:
@@ -136,26 +137,30 @@ def rename_section(
     ) -> None:
         """
         rename_section method abstracts all section renaming actions
-        by renaming the section identifier in the _section_identifiers list
+        by replacing 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
+        # need to preserve the order of the _section_identifiers list item
+        # and the _data_by_sections dict items so that new items are placed at the end
+        self._section_identifiers.pop(idx)
+        self._section_identifiers.append(
+            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]:
+    def _transform_raw_data_content_to_data_by_sections(self) -> Dict[AnyStr, AnyStr]:
         dict_data = dict()
         for item in zip(
             self._section_identifiers,
@@ -165,7 +170,6 @@ def _transform_raw_data_content_to_data_by_sections(
             )[1:],
         ):
             dict_data[item[0].section_file_separator] = item[1]
-
         return dict_data
 
     def transform_data_by_sections_to_raw_data_content(self) -> AnyStr:

notes_app/file.py

@@ -6,8 +6,8 @@
 # method). For this, observers must be descendants of an abstract class,
 # inheriting which, the `notify_model_is_changed` method must be overridden.
 import json
-from os import linesep, path
 import time
+from os import linesep, path
 from typing import AnyStr
 
 GENERAL_DATE_TIME_FORMAT = "%Y-%m-%d %H:%M:%S"
@@ -126,7 +126,9 @@ def formatted(self):
     @property
     def external_update(self):
         return (
-            get_file_updated_timestamp_as_epoch(self.file_path) > self.last_updated_on
+            get_file_updated_timestamp_as_epoch(self.file_path)
+            > self.last_updated_on
+            > 0
         )
 
     def add_observer(self, observer):

notes_app/model/notes_model.py

@@ -83,7 +83,7 @@ def search_for_occurrences(self, pattern, file, current_section_identifier):
         found_occurrences = dict()
 
         if self.search_all_sections:
-            sections_to_search_in = file.section_identifiers
+            sections_to_search_in = file.section_identifiers_sorted_by_name
         else:
             sections_to_search_in = [current_section_identifier]
 

notes_app/search.py

@@ -24,6 +24,7 @@
 from kivymd.uix.snackbar import BaseSnackbar
 
 from notes_app import __version__
+from notes_app.diff import merge_strings
 from notes_app.observer.notes_observer import Observer
 
 from notes_app.color import (
@@ -192,7 +193,9 @@ def __init__(self, **kw):
         )
         self.current_section_identifier = self.file.default_section_identifier
         self.filter_data_split_by_section()
-        self.set_drawer_items(section_identifiers=self.file.section_identifiers)
+        self.set_drawer_items(
+            section_identifiers=self.file.section_identifiers_sorted_by_name
+        )
 
     @property
     def is_unsaved_change(self):
@@ -388,7 +391,9 @@ def execute_open_file(self, file_path):
                 controller=self.controller,
                 defaults=self.defaults,
             )
-            self.set_drawer_items(section_identifiers=self.file.section_identifiers)
+            self.set_drawer_items(
+                section_identifiers=self.file.section_identifiers_sorted_by_name
+            )
             self.filter_data_split_by_section(
                 section_identifier=self.file.default_section_identifier
             )
@@ -510,7 +515,8 @@ def execute_add_section(self, *args):
             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]
+            or section_name
+            in [si.section_name for si in self.file.section_identifiers_sorted_by_name]
         ):
             self.dialog.content_cls.add_section_result_message = "Invalid name"
             return
@@ -529,7 +535,9 @@ def execute_add_section(self, *args):
 
         self.filter_data_split_by_section(section_identifier=section_identifier)
 
-        self.set_drawer_items(section_identifiers=self.file.section_identifiers)
+        self.set_drawer_items(
+            section_identifiers=self.file.section_identifiers_sorted_by_name
+        )
 
         self.cancel_dialog()
 
@@ -541,7 +549,7 @@ def execute_edit_section(self, *args):
             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]
+            in [si.section_name for si in self.file.section_identifiers_sorted_by_name]
             or old_section_name == new_section_name
         ):
             self.dialog.content_cls.edit_section_result_message = "Invalid name"
@@ -562,7 +570,11 @@ def execute_edit_section(self, *args):
 
         self.filter_data_split_by_section(section_identifier=new_section_identifier)
 
-        self.set_drawer_items(section_identifiers=self.file.section_identifiers)
+        self.set_drawer_items(
+            section_identifiers=self.file.section_identifiers_sorted_by_name
+        )
+
+        self.current_section_identifier = new_section_identifier
 
         self.cancel_dialog()
 
@@ -574,22 +586,46 @@ def cancel_dialog(self, *args):
         self.dialog = MDDialog()
 
     def save_current_section_to_file(self):
+        merged_current_section_text_data = None
+
+        if self.model.external_update:
+            self.file.reload()
+            try:
+                current_section_text_before = self.file.get_section_content(
+                    section_file_separator=self.text_section_view.section_file_separator
+                )
+            # KeyError raised if the current section was removed or renamed by a external update
+            except KeyError:
+                # merge_strings prioritizes current_section_text_after over current_section_text_before
+                # so empty string placeholder is set to current_section_text_before
+                current_section_text_before = ""
+                # self.file.reload() will remove the current section identifier from self.file.section_identifiers
+                # in case it was deleted or renamed so the current section identifier is added back
+                self.file.add_section_identifier(
+                    section_file_separator=self.text_section_view.section_file_separator
+                )
+
+            current_section_text_after = self.text_section_view.text
+
+            merged_current_section_text_data = merge_strings(
+                before=current_section_text_before, after=current_section_text_after
+            )
+
+            self.text_section_view.text = merged_current_section_text_data
+            self.set_drawer_items(
+                section_identifiers=self.file.section_identifiers_sorted_by_name
+            )
+
         self.file.set_section_content(
             section_file_separator=self.text_section_view.section_file_separator,
-            section_content=self.text_section_view.text,
+            section_content=merged_current_section_text_data
+            or self.text_section_view.text,
         )
 
         text_data = self.file.transform_data_by_sections_to_raw_data_content()
 
         self.controller.save_file_data(data=text_data)
 
-        if self.model.external_update:
-            self.file.reload()
-            self.text_section_view.text = self.file.get_section_content(
-                section_file_separator=self.text_section_view.section_file_separator
-            )
-            self.set_drawer_items(section_identifiers=self.file.section_identifiers)
-
     def press_menu_item_save_file(self, *args):
         self.save_current_section_to_file()
 
@@ -656,7 +692,7 @@ def press_edit_section(self, section_item):
         self.dialog.open()
 
     def press_delete_section(self, section_item):
-        if len(self.file.section_identifiers) == 1:
+        if len(self.file.section_identifiers_sorted_by_name) == 1:
             self.show_error_bar(error_message="Cannot delete last section")
             return
 

notes_app/view/notes_view.py

@@ -89,34 +89,47 @@ def test__get_section_identifiers_from_raw_data_content(self, get_file):
     def test_default_section_identifier(self, get_file):
         assert isinstance(get_file.default_section_identifier, SectionIdentifier)
 
-    def test_section_identifiers(self, get_file):
+    def test_section_identifiers_sorted_by_name(self, get_file):
         assert all(
-            [isinstance(x, SectionIdentifier) for x in get_file.section_identifiers]
+            [
+                isinstance(x, SectionIdentifier)
+                for x in get_file.section_identifiers_sorted_by_name
+            ]
         )
 
+        assert [
+            x.section_name for x in get_file.section_identifiers_sorted_by_name
+        ] == ["first", "second"]
+
     def test_add_section_identifier(self, get_file):
         assert (
             get_file.add_section_identifier(section_file_separator="<section=a> ")
             is None
         )
-        assert len(get_file.section_identifiers) == 3
+        assert len(get_file.section_identifiers_sorted_by_name) == 3
         assert all(
-            [isinstance(x, SectionIdentifier) for x in get_file.section_identifiers]
+            [
+                isinstance(x, SectionIdentifier)
+                for x in get_file.section_identifiers_sorted_by_name
+            ]
         )
 
     def test_delete_section_identifier(self, get_file):
         assert (
             get_file.delete_section_identifier(section_file_separator="<section=a> ")
             is None
         )
-        assert len(get_file.section_identifiers) == 2
+        assert len(get_file.section_identifiers_sorted_by_name) == 2
         assert all(
-            [isinstance(x, SectionIdentifier) for x in get_file.section_identifiers]
+            [
+                isinstance(x, SectionIdentifier)
+                for x in get_file.section_identifiers_sorted_by_name
+            ]
         )
 
     def test_delete_all_section_identifiers(self, get_file):
         assert get_file.delete_all_section_identifiers() is None
-        assert get_file.section_identifiers == []
+        assert get_file.section_identifiers_sorted_by_name == []
 
     def test_set_get_section_content(self, get_file):
         assert not get_file.set_section_content(

notes_app_recording.gif

@@ -79,6 +79,10 @@ def test_external_update(self, get_model):
         get_model._last_updated_on = time.time()
         assert get_model.external_update is False
 
+        # now set model.last_updated_on to 0
+        get_model._last_updated_on = 0
+        assert get_model.external_update is False
+
     def test_set_get_observers(self, get_model):
         observer = dict()
         get_model.add_observer(observer=observer)