F Added logging of different types of events and setting of event logging to be toggleable

Author: Pipeline

Frames/MobTimerController.py

@@ -9,6 +9,7 @@
 from Frames.ScreenBlockerFrame import ScreenBlockerFrame
 from Frames.TransparentCountdownFrame import TransparentCountdownFrame
 from Infrastructure.CountdownManager import CountdownManager
+from Infrastructure.DateTimeUtility import DateTimeUtility
 from Infrastructure.DojoManager import DojoManager
 from Infrastructure.MobberManager import MobberManager
 from Infrastructure.PlatformUtility import PlatformUtility
@@ -31,11 +32,12 @@ def __init__(self, *args, **kwargs):
         self.settings_manager = SettingsManager()
         self.tips_manager = TipsManager()
         self.time_options_manager = TimeSettingsManager()
+        self.date_time_utility = DateTimeUtility()
+        self.file_utilities = FileUtilities()
+        self.event_logging_manager = EventLoggingManager(self.file_utilities, self.date_time_utility)
         self.mobber_manager = MobberManager(self.settings_manager.get_randomize_randomize_next_driver())
         self.countdown_manager = CountdownManager(self)
         self.session_manager = SessionManager(uuid)
-        self.file_utilities = FileUtilities()
-        self.event_logging_manager = EventLoggingManager(self.file_utilities)
         self.timer_extension_count = self.settings_manager.get_timer_extension_count()
         self.extensions_used = 0
         atexit.register(self.session_manager.clear_sessions)
@@ -74,7 +76,8 @@ def __init__(self, *args, **kwargs):
             container.grid_columnconfigure(0, weight=1)
             for frame_type in self.frame_types:
                 frame_instance = frame_type(container, self, self.time_options_manager, self.mobber_manager,
-                                            self.countdown_manager, self.settings_manager, self.tips_manager, self.theme_manager)
+                                            self.countdown_manager, self.settings_manager, self.tips_manager,
+                                            self.theme_manager)
                 self.frames[frame_type].append(frame_instance)
                 frame_instance.grid(row=0, column=0, sticky=(N, S, E, W))
                 frame_instance.grid_rowconfigure(0, weight=1)
@@ -86,12 +89,22 @@ def __init__(self, *args, **kwargs):
         self.transparent_frame_position = 0
         self.title("Mob Timer")
         self.bind_all("<Control-Return>", self.launch_transparent_countdown_if_blocking)
-        self.time_options_manager.set_countdown_time(self.settings_manager.get_timer_minutes(), self.settings_manager.get_timer_seconds())
+        self.time_options_manager.set_countdown_time(self.settings_manager.get_timer_minutes(),
+                                                     self.settings_manager.get_timer_seconds())
 
         self.dojo_manager = DojoManager(self)
 
+        if self.settings_manager.get_event_logging_enabled():
+            self.mobber_manager.subscribe_to_mobber_add(self.add_mobber_callback)
+            self.mobber_manager.subscribe_to_mobber_remove(self.remove_mobber_callback)
+
+    def remove_mobber_callback(self, mobber_name):
+        self.event_logging_manager.log(f'Removed: {mobber_name}')
 
-    def launch_transparent_countdown_if_blocking(self, event = None):
+    def add_mobber_callback(self, mobber_name):
+        self.event_logging_manager.log(f'Added: {mobber_name}')
+
+    def launch_transparent_countdown_if_blocking(self, event=None):
         if self.frame_is_screen_blocking():
             self.show_transparent_countdown_frame()
 
@@ -158,7 +171,7 @@ def show_transparent_countdown_frame(self, extend_minutes=None, extend_seconds=N
 
     def get_current_window_geometry(self):
         return "{0}x{1}+0+0".format(
-                self.winfo_screenwidth(), self.winfo_screenheight())
+            self.winfo_screenwidth(), self.winfo_screenheight())
 
     def disable_resizing(self):
         for container in self.containers:
@@ -190,7 +203,8 @@ def set_full_screen_always_on_top(self):
             monitor_string = "{}x{}+{}+{}".format(monitor.width, monitor.height, monitor.x, monitor.y)
             container.master.geometry(monitor_string)
             if not PlatformUtility.platform_is_mac():
-                container.master.wait_visibility(container.master)  # Mac removing this prevented the issue with the continue screen visibility
+                container.master.wait_visibility(
+                    container.master)  # Mac removing this prevented the issue with the continue screen visibility
             container.master.attributes("-alpha", 1)
 
     def set_partial_screen_transparent(self):
@@ -212,7 +226,8 @@ def set_partial_screen_transparent(self):
 
     def fade_app(self):
         for controller in self.containers:
-            controller.master.attributes("-alpha", self.settings_manager.get_continue_screen_blocker_window_alpha_percent())
+            controller.master.attributes("-alpha",
+                                         self.settings_manager.get_continue_screen_blocker_window_alpha_percent())
 
     def unfade_app(self):
         for controller in self.containers:
@@ -255,11 +270,10 @@ def toggle_transparent_frame_position_enabled(self):
                                                   screenheight - window_height)
         self.geometry(bottom_left_screen)
 
-    def rewind_and_extend(self,minutes, seconds):
+    def rewind_and_extend(self, minutes, seconds):
         self.extensions_used += 1
         self.mobber_manager.rewind_driver()
         result = self.show_transparent_countdown_frame(minutes, seconds)
         for minimal_frame in self.frames[MinimalScreenBlockerFrame]:
             minimal_frame.show_extend_time_button()
         return result
-

Infrastructure/MobberManager.py

@@ -21,6 +21,22 @@ def add_mobber(self, mobber_name):
             self.fire_mobber_add_callbacks(mobber_name)
             self.fire_mobber_list_change_callbacks()
 
+    def remove_mobber(self, remove_mobber_index):
+        if self.mobber_count() == 0:
+            return
+        self.fire_mobber_remove_callbacks(self.mobber_list[remove_mobber_index])
+        del self.mobber_list[remove_mobber_index]
+        self.fire_mobber_list_change_callbacks()
+
+    def set_mobber_list(self, mobber_list):
+        if self.mobber_list != mobber_list:
+            for index in range(0, mobber_list.__len__()):
+                self.remove_mobber(0)
+            for mobber_name in mobber_list:
+                clean_mobber_name = str(mobber_name).strip()
+                if clean_mobber_name != "" and not self.mobber_list.__contains__(clean_mobber_name):
+                    self.add_mobber(clean_mobber_name)
+
     def subscribe_to_mobber_add(self, mobber_add_callback):
         self.mobber_add_callbacks.append(mobber_add_callback)
 
@@ -32,12 +48,7 @@ def fire_mobber_add_callbacks(self, mobber_name):
     def get_mobbers(self):
         return self.mobber_list
 
-    def remove_mobber(self, remove_mobber_index):
-        if self.mobber_count() == 0:
-            return
-        self.fire_mobber_remove_callbacks(self.mobber_list[remove_mobber_index])
-        del self.mobber_list[remove_mobber_index]
-        self.fire_mobber_list_change_callbacks()
+
 
     def subscribe_to_mobber_remove(self, mobber_remove_callback):
         self.mobber_remove_callbacks.append(mobber_remove_callback)
@@ -107,12 +118,5 @@ def rewind_driver(self):
         self.update_next_driver_index()
         self.fire_mobber_list_change_callbacks()
 
-    def set_mobber_list(self, mobber_list):
-        if self.mobber_list != mobber_list:
-            self.mobber_list = []
-            for mobber_name in mobber_list:
-                clean_mobber_name = str(mobber_name).strip()
-                if clean_mobber_name != "" and not self.mobber_list.__contains__(clean_mobber_name):
-                    self.mobber_list.append(mobber_name)
-            self.fire_mobber_list_change_callbacks()
+
 

Infrastructure/SettingsManager.py

@@ -8,6 +8,7 @@ class SettingsManager(object):
     CONTINUE_SCREEN_BLOCKER_SETTINGS = "CONTINUE SCREEN BLOCKER SETTINGS"
     SCREEN_BLOCKER_SETTINGS = "SCREEN BLOCKER SETTINGS"
     CODE_DOJO = "CODE DOJO"
+    EVENT_LOGGING = "EVENT LOGGING"
 
     def __init__(self):
         self.config = configparser.ConfigParser()
@@ -18,6 +19,7 @@ def __init__(self):
         self.general_settings_ = self.config[SettingsManager.GENERAL_SETTINGS]
         self.timer_settings_ = self.config[SettingsManager.TIMER_SETTINGS]
         self.code_dojo = self.config[SettingsManager.CODE_DOJO]
+        self.event_logging = self.config[SettingsManager.EVENT_LOGGING]
 
     def get_transparent_window_screen_size_percent(self):
         return self.window_settings_.getfloat("size percentage", 0.3)
@@ -109,5 +111,8 @@ def get_dojo_session_id(self):
     def get_dojo_topic_root(self):
         return self.code_dojo.get("topic root", "MobTimer")
 
+    def get_event_logging_enabled(self):
+        return self.event_logging.getboolean("enabled", True)
+
     def get_general_enable_unobtrusive_mode_bouncing_screen(self):
         return self.general_settings_.getboolean("enable unobtrusive mode bouncing screen", False)

MobTimer.cfg

@@ -42,5 +42,4 @@ session id = 1337
 topic root = MobTimer
 
 [EVENT LOGGING]
-enabled = True
-log file name = MobTimer.log
+enabled = False

tests/Infrastructure/MobberManager/TestsMobberManager.test_subscribe_to_mobber_list_changes_random.approved.txt

@@ -1,24 +1,47 @@
 Mobbers in List for Each Change
 Action 1:
-Action 2:Joe (Driver) (Next), 
-Action 3:Joe (Driver), Chris (Next), 
-Action 4:Joe (Driver), Chris, Sam (Next), 
-Action 5:Joe (Driver), Chris, Sam, John (Next), 
-Action 6:Joe, Chris (Next), Sam, John (Driver), 
-Action 7:Joe, Chris (Next), Sam, John (Driver), Bill, 
-Action 8:Joe, Chris (Driver), Sam (Next), John, Bill, 
-Action 9:Joe, Chris, Sam (Driver), John (Next), Bill, 
-Action 10:Joe, Chris (Next), Sam, John (Driver), Bill, 
-Action 11:Hello, Eric (Next), Joe, 
-Action 12:Hello, Eric (Driver), Joe (Next), 
-Action 13:Hello, Eric (Next), Joe (Driver), 
-Action 14:Hello (Driver), Eric (Next), 
-Action 15:Eric (Driver) (Next), 
-Action 16:Eric (Driver) (Next), 
-Action 17:Eric (Driver), Seth (Next), 
-Action 18:Seth (Driver), Eric (Next), 
-Action 19:Seth (Driver), Eric, Fredrick (Next), 
-Action 20:Seth (Driver), Fredrick (Next), Eric, 
-Action 21:Seth (Driver), Eric (Next), 
-Action 22:Eric (Driver) (Next), 
-Action 23:
+Action 2:Joe added
+Action 3:Joe (Driver) (Next), 
+Action 4:Chris added
+Action 5:Joe (Driver), Chris (Next), 
+Action 6:Sam added
+Action 7:Joe (Driver), Chris, Sam (Next), 
+Action 8:John added
+Action 9:Joe (Driver), Chris, Sam, John (Next), 
+Action 10:Joe, Chris (Next), Sam, John (Driver), 
+Action 11:Bill added
+Action 12:Joe, Chris (Next), Sam, John (Driver), Bill, 
+Action 13:Joe, Chris (Driver), Sam (Next), John, Bill, 
+Action 14:Joe, Chris, Sam (Driver), John (Next), Bill, 
+Action 15:Joe, Chris (Next), Sam, John (Driver), Bill, 
+Action 16:Joe removed
+Action 17:Chris, Sam (Next), John, Bill (Driver), 
+Action 18:Chris removed
+Action 19:Sam, John (Next), Bill, 
+Action 20:Sam removed
+Action 21:John (Next), Bill (Driver), 
+Action 22:Hello added
+Action 23:John, Bill (Driver), Hello (Next), 
+Action 24:Eric added
+Action 25:John, Bill (Driver), Hello (Next), Eric, 
+Action 26:Joe added
+Action 27:John, Bill (Driver), Hello, Eric (Next), Joe, 
+Action 28:John, Bill (Next), Hello, Eric (Driver), Joe, 
+Action 29:John, Bill (Driver), Hello, Eric, Joe (Next), 
+Action 30:Hello removed
+Action 31:John, Bill (Driver), Eric, Joe (Next), 
+Action 32:John removed
+Action 33:Bill, Eric (Driver), Joe (Next), 
+Action 34:Bill (Next), Eric, Joe (Driver), 
+Action 35:Seth added
+Action 36:Bill, Eric, Joe (Driver), Seth (Next), 
+Action 37:Eric, Bill (Next), Joe (Driver), Seth, 
+Action 38:Fredrick added
+Action 39:Eric (Next), Bill, Joe (Driver), Seth, Fredrick, 
+Action 40:Eric, Joe, Bill (Driver), Seth (Next), Fredrick, 
+Action 41:Joe removed
+Action 42:Eric, Bill, Seth (Driver), Fredrick (Next), 
+Action 43:Eric removed
+Action 44:Bill, Seth (Next), Fredrick (Driver), 
+Action 45:Bill removed
+Action 46:Seth (Driver), Fredrick (Next), 

tests/Infrastructure/MobberManager/test_MobberManager.py

@@ -176,6 +176,20 @@ def time_change_callback(mobber_list, driver_index, navigator_index):
 
             result["result"] += "\n"
 
+        def on_mobber_add(mobber_name):
+            result["increment"] += 1
+            result["result"] += "Action " + result["increment"].__str__() + ":" + mobber_name + " added\n"
+
+        mobber_manager.subscribe_to_mobber_add(on_mobber_add)
+
+
+        def on_mobber_remove(mobber_name):
+            result["increment"] += 1
+            result["result"] += "Action " + result["increment"].__str__() + ":" + mobber_name + " removed\n"
+
+        mobber_manager.subscribe_to_mobber_remove(on_mobber_remove)
+
+
         mobber_manager.subscribe_to_mobber_list_change(time_change_callback)
 
         mobber_manager.add_mobber("Joe")