#20 Add updateable map

Author: pockerman

src/tests/test_serial_hierarchy.py

@@ -0,0 +1,20 @@
+"""
+Unit tests for SerialHierarchy
+"""
+import unittest
+from src.utils.serial_hierarchy import SerialHierarchy
+
+
+class TestSerialHierarchy(unittest.TestCase):
+
+
+    def test_add_values(self):
+
+        hierarchy = SerialHierarchy()
+        hierarchy.add("val1", "val2", "val3")
+        self.assertEqual(1, len(hierarchy))
+        self.assertEqual(list, type(hierarchy[0]))
+
+
+if __name__ == '__main__':
+    unittest.main()

src/tests/test_updateable_map.py

@@ -0,0 +1,56 @@
+import unittest
+import pytest
+
+from src.utils.updateable_map import  UpdateableMap
+
+
+class TestUpdateableMap(unittest.TestCase):
+
+    def setUp(self) -> None:
+
+        self.map = UpdateableMap(list_size=3)
+        values = ["val1", "val2", "val3", "val10"]
+        key = "key1"
+        self.map.insert(key=key, values=values)
+
+        values = ["val4", "val5", "val6", "val10"]
+        key = "key2"
+        self.map.insert(key=key, values=values)
+
+    def test_invalid_list_size(self):
+        map = UpdateableMap(list_size=2)
+        values = ["val1", "val2", "val3"]
+        key = "key"
+
+        with pytest.raises(ValueError) as e_info:
+            # this should throw
+            map.insert(key=key, values=values)
+
+    def test_get_value(self):
+
+        value = self.map.get_value("key1")
+        self.assertEqual("val1", value)
+
+        # the key should be updated
+        value = self.map.get_value(key=value)
+        self.assertEqual("val2", value)
+
+        keys = list(self.map.keys())
+        self.assertEqual(["val2"], keys)
+
+        values = self.map.values()
+        self.assertEqual(["key1", "val1", "val3"], list(values)[0])
+
+        print(self.map.current_pos)
+
+
+
+
+
+
+
+
+
+
+if __name__ == '__main__':
+    unittest.main()

src/utils/updateable_map.py

@@ -0,0 +1,68 @@
+"""
+Wrapper class over the traditional dict class.
+Every time the get_value function is called,
+the key is updated with the current value that
+the counter points to
+"""
+from typing import Any, List, KeysView, ValuesView
+from src.exceptions.exceptions import InvalidStateException
+
+
+class UpdateableMap(object):
+
+    def __init__(self, list_size: int) -> None:
+        self.current_pos = {}
+        self._values = {}
+        self.list_size: int = list_size
+
+    def __getitem__(self, item) -> Any:
+        return self._values[item]
+
+    def __len__(self):
+        return len(self._values)
+
+    def keys(self) -> KeysView:
+        """
+        Returns the current keys
+        :return:
+        """
+        return self._values.keys()
+
+    def values(self) -> ValuesView:
+        """
+        Returns the current values in the map
+        :return:
+        """
+        return self._values.values()
+
+    def get_value(self, key: Any) -> Any:
+
+        values = self._values[key]
+        current_pos = self.current_pos[key]
+
+        val = values[current_pos]
+
+        # update keys
+        self._values[val] = self._values[key]
+        self._values[val][current_pos] = key
+        del self._values[key]
+
+        current_pos += 1
+        self.current_pos[val] = current_pos
+        return val
+
+    def insert(self, key: Any, values: List[Any]) -> None:
+
+        if len(values) != self.list_size:
+            raise ValueError("Invalid list size. Size={0} should be equal to {1}".format(len(values), self.list_size))
+
+        self._values[key] = values
+        self.current_pos[key] = 0
+
+    def is_exhausted(self) -> bool:
+        """
+        Return true if all keys are self.tail_value
+        :return:
+        """
+        counters = self.current_pos.values()
+        return all(counter >= self.list_size for counter in counters)