Redesign RideEventHandler and file system monitoring feature (#2232)

* Added RideFSWatcherHandler for new RideEventHandler implementation

* Removed old RideEventHandler solution.

* Windows canot detect root folder rename, fix with workaround

* Using EVT_ACTIVATE_APP instead of EVT_ACTIVATE

* Add protection when sub folder is removed

* Optimize event handle logic

* Update FS event name

* Check project data file status with higher priority

* Add additional check for TestDataDirectoryController obj

* Add additional check for TestDataDirectoryController obj

* Adjust for MSW platform

* Adjust for MSW platform

* Fix typos

Author: jnhyperion

src/robotide/application/application.py

@@ -35,14 +35,14 @@
 from ..application.updatenotifier import UpdateNotifierController, UpdateDialog
 from ..ui.treeplugin import TreePlugin
 from ..ui.fileexplorerplugin import FileExplorerPlugin
-from .. import utils
+from ..utils import RideFSWatcherHandler, run_python_command
 
 
 class RIDE(wx.App):
 
     def __init__(self, path=None, updatecheck=True):
-        self._initial_path = path
         self._updatecheck = updatecheck
+        self.workspace_path = path
         context.APP = self
         wx.App.__init__(self, redirect=False)
 
@@ -86,6 +86,7 @@ def OnInit(self):
             UpdateNotifierController(self.settings).notify_update_if_needed(UpdateDialog)
         wx.CallLater(200, ReleaseNotes(self).bring_to_front)
         wx.CallLater(200, self.fileexplorerplugin._update_tree)
+        self.Bind(wx.EVT_ACTIVATE_APP, self.OnAppActivate)
         return True
 
     def _publish_system_info(self):
@@ -111,13 +112,13 @@ def _get_editor(self):
                 return maybe_editor
 
     def _load_data(self):
-        path = self._initial_path or self._get_latest_path()
-        if path:
+        self.workspace_path = self.workspace_path or self._get_latest_path()
+        if self.workspace_path:
             observer = LoadProgressObserver(self.frame)
-            self._controller.load_data(path, observer)
+            self._controller.load_data(self.workspace_path, observer)
 
     def _find_robot_installation(self):
-        output = utils.run_python_command(
+        output = run_python_command(
             ['import robot; print(robot.__file__ + \", \" + robot.__version__)'])
         robot_found = b"ModuleNotFoundError" not in output and output
         if robot_found:
@@ -178,3 +179,18 @@ def active_event_loop(self):
         wx.EventLoop.SetActive(loop)
         yield
         del loop
+
+    def OnEventLoopEnter(self, loop):
+        if loop and wx.EventLoopBase.IsMain(loop):
+            RideFSWatcherHandler.create_fs_watcher(self.workspace_path)
+
+    def OnAppActivate(self, event):
+        if RideFSWatcherHandler.is_watcher_created():
+            if event.GetActive():
+                if self._controller.is_project_changed_from_disk() or \
+                        RideFSWatcherHandler.is_workspace_dirty():
+                    self.frame.show_confirm_reload_dlg(event)
+                RideFSWatcherHandler.stop_listening()
+            else:
+                RideFSWatcherHandler.start_listening(self.workspace_path)
+        event.Skip()

src/robotide/controller/project.py

@@ -23,7 +23,7 @@
 
 from .basecontroller import WithNamespace, _BaseController
 from .dataloader import DataLoader
-from .filecontrollers import DataController, ResourceFileControllerFactory
+from .filecontrollers import DataController, ResourceFileControllerFactory, TestDataDirectoryController
 from .robotdata import NewTestCaseFile, NewTestDataDirectory
 from robotide.spec.librarydatabase import DATABASE_FILE
 from robotide.spec.librarymanager import LibraryManager
@@ -295,6 +295,17 @@ def resource_import_modified(self, path, directory):
         if resource:
             return self._create_resource_controller(resource)
 
+    def is_project_changed_from_disk(self):
+        for data_file in self.datafiles:
+            if isinstance(data_file, TestDataDirectoryController):
+                if not os.path.exists(data_file.directory):
+                    return True
+            else:
+                if data_file.has_been_modified_on_disk() or \
+                        data_file.has_been_removed_from_disk():
+                    return True
+        return False
+
 
 class Serializer(object):
 

src/robotide/editor/kweditor.py

@@ -30,8 +30,8 @@
                               RideSettingsChanged, PUBLISHER, RideBeforeSaving)
 from robotide.usages.UsageRunner import Usages, VariableUsages
 from robotide.ui.progress import RenameProgressObserver
-from robotide import robotapi, utils
-from robotide.utils import RideEventHandler, variablematcher
+from robotide import robotapi
+from robotide.utils import variablematcher
 from robotide.widgets import Dialog, PopupMenu, PopupMenuItems
 
 from .gridbase import GridEditor
@@ -40,10 +40,7 @@
     ListVariableDialog
 from .contentassist import ExpandingContentAssistTextCtrl
 from .gridcolorizer import Colorizer
-from robotide.lib.robot.utils.compat import with_metaclass
 
-# Metaclass fix from http://code.activestate.com/recipes/204197-solving-the-metaclass-conflict/
-from robotide.utils.noconflict import classmaker
 
 _DEFAULT_FONT_SIZE = 11
 
@@ -62,7 +59,7 @@ def decorated_function(self, *args):
     return decorated_function
 
 
-class KeywordEditor(with_metaclass(classmaker(), GridEditor, RideEventHandler)):
+class KeywordEditor(GridEditor):
     _no_cell = (-1, -1)
     _popup_menu_shown = False
     dirty = property(lambda self: self._controller.dirty)

src/robotide/editor/listeditor.py

@@ -14,14 +14,10 @@
 #  limitations under the License.
 
 import wx
-from robotide.lib.robot.utils.compat import with_metaclass
 from wx.lib.mixins.listctrl import ListCtrlAutoWidthMixin
 from robotide.controller.ctrlcommands import MoveUp, MoveDown, DeleteItem
-from robotide.utils import RideEventHandler
 from robotide.widgets import PopupMenu, PopupMenuItems, ButtonWithHandler, Font
 from robotide.context import ctrl_or_cmd, bind_keys_to_evt_menu, IS_WINDOWS
-# Metaclass fix from http://code.activestate.com/recipes/204197-solving-the-metaclass-conflict/
-from robotide.utils.noconflict import classmaker
 
 
 class ListEditorBase(wx.Panel):
@@ -143,7 +139,7 @@ def has_error(self, controller):
         return False
 
 
-class ListEditor(with_metaclass(classmaker(), ListEditorBase, RideEventHandler)):
+class ListEditor(ListEditorBase):
     pass
 
 

src/robotide/editor/settingeditors.py

@@ -27,7 +27,6 @@
 from robotide.publish import PUBLISHER
 from robotide import utils
 from robotide.utils.highlightmatcher import highlight_matcher
-from robotide.lib.robot.utils.compat import with_metaclass
 from .formatters import ListToStringFormatter
 from .gridcolorizer import ColorizationSettings
 from .editordialogs import EditorDialog, DocumentationDialog, MetadataDialog,\
@@ -37,11 +36,8 @@
 from .popupwindow import HtmlPopupWindow
 from .tags import TagsDisplay
 
-# Metaclass fix from http://code.activestate.com/recipes/204197-solving-the-metaclass-conflict/
-from robotide.utils.noconflict import classmaker
 
-
-class SettingEditor(with_metaclass(classmaker(), wx.Panel, utils.RideEventHandler)):
+class SettingEditor(wx.Panel):
 
     def __init__(self, parent, controller, plugin, tree):
         wx.Panel.__init__(self, parent)

src/robotide/ui/mainframe.py

@@ -17,15 +17,14 @@
 import wx
 import wx.lib.agw.aui as aui
 from wx import Icon
-from robotide.lib.robot.utils.compat import with_metaclass
 from robotide.action import ActionInfoCollection, ActionFactory, SeparatorInfo
 from robotide.context import ABOUT_RIDE, SHORTCUT_KEYS
 from robotide.controller.ctrlcommands import SaveFile, SaveAll
 from robotide.publish import RideSaveAll, RideClosing, RideSaved, PUBLISHER,\
     RideInputValidationError, RideTreeSelection, RideModificationPrevented, RideBeforeSaving
 from robotide.ui.tagdialogs import ViewAllTagsDialog
 from robotide.ui.filedialogs import RobotFilePathDialog
-from robotide.utils import RideEventHandler
+from robotide.utils import RideFSWatcherHandler
 from robotide.widgets import Dialog, ImageProvider, HtmlWindow
 from robotide.preferences import PreferenceEditor
 
@@ -71,9 +70,6 @@
 ID_CustomizeToolbar = wx.ID_HIGHEST + 1
 ID_SampleItem = ID_CustomizeToolbar + 1
 
-# Metaclass fix from http://code.activestate.com/recipes/
-# 204197-solving-the-metaclass-conflict/
-from robotide.utils.noconflict import classmaker
 
 ### DEBUG some testing
 # -- SizeReportCtrl --
@@ -139,7 +135,7 @@ def OnSize(self, event):
         self.Refresh()
 
 
-class RideFrame(with_metaclass(classmaker(), wx.Frame, RideEventHandler)):
+class RideFrame(wx.Frame):
 
     def __init__(self, application, controller):
         size = application.settings.get('mainframe size', (1100, 700))
@@ -452,6 +448,9 @@ def check_unsaved_modifications(self):
 
     def open_suite(self, path):
         self._controller.update_default_dir(path)
+        # self._controller.default_dir will only save dir path
+        # need to save path to self._application.workspace_path too
+        self._application.workspace_path = path
         try:
             err = self._controller.load_datafile(path, LoadProgressObserver(self))
         finally:
@@ -593,6 +592,37 @@ def CreateSizeReportCtrl(self, width=80, height=80):
         ctrl = SizeReportCtrl(self, -1, wx.DefaultPosition, wx.Size(width, height), self._mgr)
         return ctrl
 
+    def show_confirm_reload_dlg(self, event):
+        msg = ['Workspace modifications detected on the file system.',
+               'Do you want to reload the workspace?',
+               'Answering <No> will overwrite the changes on disk.']
+        if self._controller.is_dirty():
+            msg.insert(2, 'Answering <Yes> will discard unsaved changes.')
+        ret = wx.MessageBox('\n'.join(msg), 'Files Changed On Disk',
+                            style=wx.YES_NO | wx.ICON_WARNING)
+        confirmed = ret == wx.YES
+        if confirmed:
+            # workspace_path should update after open directory/suite
+            # There're two scenarios:
+            # 1. path is a directory
+            # 2. path is a suite file
+            new_path = RideFSWatcherHandler.get_workspace_new_path()
+            if new_path and os.path.exists(new_path):
+                wx.CallAfter(self.open_suite, new_path)
+            else:
+                # in case workspace is totally removed
+                # ask user to open new directory
+                # TODO add some notification msg to users
+                wx.CallAfter(self.OnOpenDirectory, event)
+        else:
+            for _ in self._controller.datafiles:
+                if _.has_been_modified_on_disk() or _.has_been_removed_from_disk():
+                    if not os.path.exists(_.directory):
+                        # sub folder is removed, create new one before saving
+                        os.makedirs(_.directory)
+                    _.mark_dirty()
+            self.save_all()
+
 
 # Code moved from actiontriggers
 class ToolBar(aui.AuiToolBar):

src/robotide/ui/treeplugin.py

@@ -25,11 +25,9 @@
 
 TREETEXTCOLOUR = Colour(0xA9, 0xA9, 0xA9)
 
-from robotide.lib.robot.utils.compat import with_metaclass
 from robotide.controller.ui.treecontroller import TreeController, \
     TestSelectionController
 from robotide.context import IS_WINDOWS
-from robotide.action.actioninfo import ActionInfo
 from robotide.controller.filecontrollers import ResourceFileController, TestDataDirectoryController, \
     TestCaseFileController
 from robotide.publish.messages import RideTestRunning, RideTestPaused, \
@@ -51,8 +49,7 @@
 from robotide import utils
 from .treenodehandlers import ResourceRootHandler, action_handler_class, ResourceFileHandler
 from .images import TreeImageList
-# Metaclass fix from http://code.activestate.com/recipes/204197-solving-the-metaclass-conflict/
-from robotide.utils.noconflict import classmaker
+
 
 _TREE_ARGS = {'style': wx.TR_DEFAULT_STYLE}
 _TREE_ARGS['agwStyle'] = customtreectrl.TR_DEFAULT_STYLE | customtreectrl.TR_HIDE_ROOT | \
@@ -160,9 +157,7 @@ def _update_tree(self, event=None):
         self._tree._refresh_view()
 
 
-class Tree(with_metaclass(classmaker(), treemixin.DragAndDrop,
-                          customtreectrl.CustomTreeCtrl,
-                          utils.RideEventHandler)):
+class Tree(treemixin.DragAndDrop, customtreectrl.CustomTreeCtrl):
     _RESOURCES_NODE_LABEL = 'External Resources'
 
     def __init__(self, parent, action_registerer, settings=None):

src/robotide/utils/__init__.py

@@ -25,7 +25,7 @@
     unic, asserts, unescape, html_escape, attribute_escape, robottime,\
     get_timestamp, Matcher, is_list_like, is_dict_like, system_decode,\
     ArgumentParser, get_error_details, is_unicode, is_string, py2to3
-from .eventhandler import RideEventHandler
+from .eventhandler import RideFSWatcherHandler
 from .printing import Printing