New backup

The backup is now always the whole store file from before pressing the delete button.
Sore class has been refactored a bit - it is now split into:
1) store
2) store_loader
3) store_writer

Still to do:
1) store loader needs more unit tests
2) store unit test need fixing after the refactor

Author: UrszulaNeuman

dls_barcode/data_store/comms_manager.py

@@ -1,9 +1,8 @@
 import uuid
-import os
 import time
 
 from dls_barcode.data_store.backup import Backup
-from dls_barcode.data_store.comms_manager import CommsManager
+from dls_barcode.data_store.store_writer import StoreWriter
 from .record import Record
 
 
@@ -13,15 +12,11 @@ class Store:
     or deletions) are automatically written to the backing file.
     """
 
-    def __init__(self, comms_manager):
+    def __init__(self, store_writer, records):
         """ Initializes a new instance of Store.
         """
-        self._comms_manager = comms_manager
-        self._comms_manager.make_img_dir()
-        self._img_dir = self._comms_manager.get_img_dir()
-        records = self._comms_manager.load_records_from_file()
+        self._store_writer = store_writer
         self.records = records
-        self._sort_records()
 
     def size(self):
         """ Returns the number of records in the store
@@ -31,17 +26,17 @@ def size(self):
     def get_record(self, index):
         """ Get record by index where the 0th record is the most recent
         """
+        self._sort_records()
         return self.records[index] if self.records else None
 
     def _add_record(self, holder_barcode, plate, holder_img, pins_img):
         """ Add a new record to the store and save to the backing file.
         """
         merged_img = self._merge_holder_image_into_pins_image(holder_img, pins_img)
         guid = str(uuid.uuid4())
-        filename = os.path.abspath(os.path.join(self._img_dir, guid + '.png'))
-        merged_img.save_as(filename)
+        self._store_writer.to_image(merged_img, guid)
 
-        record = Record.from_plate(holder_barcode, plate, filename)
+        record = Record.from_plate(holder_barcode, plate, self._store_writer.get_img_path())
 
         self.records.append(record)
         self._process_change()
@@ -57,8 +52,8 @@ def merge_record(self, holder_barcode, plate, holder_img, pins_img):
     def backup_records(self, directory):
         ts = time.localtime()
         file_name = time.strftime("%Y-%m-%d_%H-%M-%S", ts)
-        backup_manger = CommsManager(directory, file_name)
-        backup = Backup(backup_manger)
+        backup_writer = StoreWriter(directory, file_name)
+        backup = Backup(backup_writer)
         backup.backup_records(self.records)
 
     def delete_records(self, records_to_delete):
@@ -67,17 +62,16 @@ def delete_records(self, records_to_delete):
         """
         for record in records_to_delete:
             self.records.remove(record)
-            self._comms_manager.remove_img_file(record)
+            self._store_writer.remove_img_file(record)
 
         self._process_change()
 
-
     def _process_change(self):
         """ Sort the records and save to file.
         """
         self._sort_records()
-        self._comms_manager.to_file(self.records)
-        self._comms_manager.to_csv_file(self.records)
+        self._store_writer.to_file(self.records)
+        self._store_writer.to_csv_file(self.records)
 
     def _sort_records(self):
         """ Sort the records in descending date order (most recent first).
@@ -93,5 +87,6 @@ def _merge_holder_image_into_pins_image(self, holder_img, pins_img):
         return merged_img
 
     def is_latest_holder_barcode(self, holder_barcode):
+        self._sort_records()
         latest_record = self.get_record(0)
         return latest_record is not None and holder_barcode == latest_record.holder_barcode

dls_barcode/data_store/store.py

@@ -0,0 +1,39 @@
+import os
+
+from dls_barcode.data_store.record import Record
+from dls_util.file import FileManager
+
+
+class StoreLoader:
+
+    def __init__(self, directory, file_name, file_manager=FileManager()):
+        self._directory = directory
+        self._file_name = file_name
+        self._file_manager= file_manager
+        self._path = None
+        self._records = []
+
+    def load_records_from_file(self):
+        """ Clear the current record store and load a new set of records from the specified file. """
+        self._build_file_path()
+        if not self._check_if_file():
+            return self._records
+        self._build_records_from_lines(self._read_lines())
+        return self._records
+
+    def _build_file_path(self):
+        self._path =  os.path.join(self._directory, self._file_name + '.txt')
+
+    def _check_if_file(self):
+        return self._file_manager.is_file(self._path)
+
+    def _read_lines(self):
+        return self._file_manager.read_lines(self._path)
+
+    def _build_records_from_lines(self, lines):
+        for line in lines:
+            try:
+                record = Record.from_string(line)
+                self._records.append(record)
+            except Exception:
+                print("Failed to parse store Record: {}".format(line))

dls_barcode/data_store/store_loader.py

@@ -0,0 +1,49 @@
+import os
+
+from dls_barcode.data_store.record import Record
+from dls_util.file import FileManager
+
+
+class StoreWriter:
+    """ Maintains writing records to file and saving png images in a sub-folder
+    """
+
+    def __init__(self, directory, file_name, file_manager=FileManager()):
+        self._file_manager = file_manager
+        self._directory = directory
+        self._file_name = file_name
+        self._image_path = None
+
+    def to_file(self, records):
+        """ Save the contents of the store to the backing file
+        """
+        self._file_manager.make_dir_when_no_dir(self._directory)
+        file = os.path.join(self._directory, self._file_name + '.txt')
+        record_lines = [rec.to_string() + "\n" for rec in records]
+        self._file_manager.write_lines(file, record_lines)
+
+    def to_csv_file(self, records):
+        """ Save the contents of the store to the backing csv file
+        """
+        self._file_manager.make_dir_when_no_dir(self._directory)
+        csv_file = os.path.join(self._directory, self._file_name + ".csv")
+        record_lines = [rec.to_csv_string() + "\n" for rec in records]
+        self._file_manager.write_lines(csv_file, record_lines)
+
+    def to_image(self, image, name):
+        dr = self._make_img_dir()
+        self._image_path = os.path.abspath(os.path.join(dr, name + '.png'))
+        image.save_as(self._image_path)
+
+    def get_img_path(self):
+        return self._image_path
+
+    def _make_img_dir(self):
+        self._file_manager.make_dir_when_no_dir(self._directory)
+        img_dir = os.path.join(self._directory, "img_dir")
+        self._file_manager.make_dir_when_no_dir(img_dir)
+        return img_dir
+
+    def remove_img_file(self, record):
+        if self._file_manager.is_file(record.image_path):
+            self._file_manager.remove(record.image_path)

dls_barcode/data_store/store_writer.py

@@ -5,7 +5,8 @@
 from PyQt5.QtWidgets import QGroupBox, QVBoxLayout, QHBoxLayout, QTableWidget, QMessageBox
 
 from dls_barcode.data_store import Store
-from dls_barcode.data_store.comms_manager import CommsManager
+from dls_barcode.data_store.store_loader import StoreLoader
+from dls_barcode.data_store.store_writer import StoreWriter
 
 # todo: allow delete key to be used for deletion
 # todo: allow record selection with arrow keys
@@ -22,8 +23,10 @@ def __init__(self, barcode_table, image_frame, options):
         super(ScanRecordTable, self).__init__()
 
         # Read the store from file
-        comms_manger = CommsManager(options.get_store_directory(), "store")
-        self._store = Store(comms_manger)
+        store_writer = StoreWriter(options.get_store_directory(), "store")
+        store_loader = StoreLoader(options.get_store_directory(), "store")
+
+        self._store = Store(store_writer, store_loader.load_records_from_file())
         self._options = options
 
         self._barcodeTable = barcode_table

dls_barcode/gui/record_table.py

@@ -29,4 +29,8 @@ def make_dir(self, path):
         os.makedirs(path)
 
     def remove(self, path):
-        os.remove(path)
+        os.remove(path)
+
+    def make_dir_when_no_dir(self, dr):
+        if not self.is_dir(dr):
+            self.make_dir(dr)

dls_util/file/file_manager.py

@@ -2,7 +2,7 @@
 
 from dls_barcode.config.barcode_config import BarcodeConfig
 from dls_barcode.data_store import Store
-from dls_barcode.data_store.store_manager import StoreManager
+from dls_barcode.data_store.store_writer import StoreWriter
 from dls_barcode.scan import GeometryScanner
 from dls_util.image import Image
 from dls_util.file import FileManager
@@ -20,7 +20,8 @@
 if os.path.isdir(store_dir.value()):
     shutil.rmtree(store_dir.value())
 
-STORE = StoreManager(store_dir, OPTIONS.store_capacity, OPTIONS.backup_time).create_store()
+comms_manger = StoreWriter(OPTIONS.get_store_directory(), "store")
+STORE = Store(comms_manger)
 
 
 def test_generator():

tests/system_tests/test_unipuck_scan.py

@@ -5,7 +5,7 @@
 
 from dls_barcode.config.barcode_config import BarcodeConfig
 from dls_barcode.data_store import Store
-from dls_barcode.data_store.store_manager import StoreManager
+from dls_barcode.data_store.store_writer import StoreWriter
 from dls_barcode.geometry.unipuck import Unipuck
 from dls_barcode.scan import GeometryScanner
 from dls_util import Color
@@ -26,9 +26,8 @@
 store_dir = OPTIONS.store_directory
 if os.path.isdir(store_dir.value()):
     shutil.rmtree(store_dir.value())
-
-STORE = StoreManager(store_dir, OPTIONS.store_capacity, OPTIONS.backup_time).create_store()
-
+comms_manger = StoreWriter(OPTIONS.get_store_directory(), "store")
+STORE = Store(comms_manger)
 def test_generator():
     TEST_CASES = generate_test_cases()
     for params in TEST_CASES:

tests/system_tests/test_unipuck_scan_locator.py

@@ -20,69 +20,14 @@ def setUp(self):
         record_three.to_string.return_value = 'string_three'
         self.records = [record_one, record_two, record_three]
 
-    def test_truncate_removes_all_old_records(self):
-        # Arrange
-        self.comms_man.load_records_from_file.return_value = self.records
-
-        # Act
-        backup = Backup(self.comms_man, self.backup_time)
-        orig_size = len(backup._records)
-        backup._truncate_record_list()
-
-        # Assert
-        new_size = len(backup._records)
-        self.assertNotEqual(orig_size, new_size)
-        self.assertEqual(new_size, 2)
-
-    def test_backup_records_adds_new_records_to_existing_list(self):
-        # Arrange
-        self.comms_man.load_records_from_file.return_value = self.records
-
-        # Act
-        backup = Backup(self.comms_man, self.backup_time)
-        backup.backup_records(self.records)
-
-        # Assert
-        self.assertEqual(len(backup._records), 4) #old truncated
-
-    def test_backup_records_removes_old_records_from_the_passed_when_its_called(self):
-        # Arrange
-        self.comms_man.load_records_from_file.return_value = []
-
-        # Act
-        backup = Backup(self.comms_man, self.backup_time)
-        backup.backup_records(self.records)
-
-        # Assert
-        self.assertEqual(len(backup._records), 2)
-
     def test_backup_records_to_csv_file(self):
         #Arrange
         self.comms_man.to_csv_file = MagicMock()
-        backup = Backup(self.comms_man, self.backup_time)
+        backup = Backup(self.comms_man)
 
         # Act
         backup.backup_records([])
 
         #Assert
         self.comms_man.to_csv_file.assert_called_once()
 
-    def test_is_old_returns_true_for_records_older_than_assumed_number_of_weeks(self):
-        # Arrange
-        record = self.records[2]
-
-        # Act
-        backup = Backup(self.comms_man, self.backup_time)
-
-        # Assert
-        self.assertTrue(backup._is_old(record))
-
-    def test_is_old_returns_false_for_records_younger_than_assumed_number_of_weeks(self):
-        # Arrange
-        record = self.records[0]
-
-        # Act
-        backup = Backup(self.comms_man, self.backup_time)
-
-        # Assert
-        self.assertFalse(backup._is_old(record))