Kweditor tests (#2595)

* Experimental unit test for kweditor

* Increase unit tests, fix 2 issues

* Increases tests. One test fails with invoke but not with PyCharm

* Try to fix running all tests (no success)

* Improve code and unit tests

* Increase unit tests

* Increase tests, increase fails

* Remove debug info

Author: HelioGuilherme66

.coveragerc

@@ -15,6 +15,8 @@ omit =
 
 [report]
 skip_empty = True
+exclude_lines =
+    if __name__ == '__main__':
 
 [xml]
 output = ./.coverage-reports/coverage.xml

src/robotide/__init__.py

@@ -44,7 +44,7 @@
     import wx
     import wx.lib.inspection
     from wx import Colour
-except ImportError:
+except ModuleNotFoundError:
     print(errorMessageTemplate.substitute(reason="wxPython not found."))
     sys.exit(1)
 
@@ -86,6 +86,7 @@ def _parse_args(args):
 
 
 def _run(inpath=None, updatecheck=True, debug_console=False):
+    # print(f"DEBUG: ENTER _run {inpath=}, {updatecheck=}, {debug_console=}")
     try:
         from robotide.application import RIDE
         from robotide.application import debugconsole
@@ -132,6 +133,7 @@ def writelines(self, sequence):
 
 
 def _show_old_wxpython_warning_if_needed(parent=None):
+    # print("DEBUG: ENTER _show_old_wxpython_warning_if_needed")
     if wx.VERSION <= (4, 0, 4, '', ''):
         title = "Please upgrade your wxPython installation"
         message = ("RIDE needs a newer wxPython version. Your current "

src/robotide/controller/filecontrollers.py

@@ -323,6 +323,19 @@ def remove_readonly(self, path=None):
         path = path or self.filename
         os.chmod(path, stat.S_IWRITE)
 
+    @staticmethod
+    def _explorer_linux(path):
+        try:
+            subprocess.Popen(["nautilus", "{}".format(os.path.dirname(path))])
+        except OSError:
+            try:
+                subprocess.Popen(["dolphin", "{}".format(os.path.dirname(path))])
+            except OSError:
+                try:
+                    subprocess.Popen(["konqueror", "{}".format(os.path.dirname(path))])
+                except OSError:
+                    print("Could not launch explorer. Tried nautilus, dolphin and konqueror.")
+
     def open_filemanager(self, path=None):
         # tested on Win7 x64
         path = path or self.filename
@@ -336,28 +349,12 @@ def open_filemanager(self, path=None):
                 # nautilus, dolphin, konqueror
                 # DEBUG: check if explorer exists
                 # DEBUG: get prefered explorer from preferences
-                try:
-                    subprocess.Popen(["nautilus", "{}".format(
-                        os.path.dirname(path))])
-                except OSError:
-                    try:
-                        subprocess.Popen(
-                            ["dolphin", "{}".format(os.path.dirname(path))])
-                    except OSError:
-                        try:
-                            subprocess.Popen(
-                               ["konqueror", "{}".format(
-                                   os.path.dirname(path))])
-                        except OSError:
-                            print("Could not launch explorer. Tried nautilus, "
-                                  "dolphin and konqueror.")
+                self._explorer_linux(path)
             else:
                 try:
-                    subprocess.Popen(["finder", "{}".format(
-                        os.path.dirname(path))])
+                    subprocess.Popen(["finder", "{}".format(os.path.dirname(path))])
                 except OSError:
-                    subprocess.Popen(["open", "{}".format(
-                        os.path.dirname(path))])
+                    subprocess.Popen(["open", "{}".format(os.path.dirname(path))])
 
     def remove_from_filesystem(self, path=None):
         path = path or self.filename

src/robotide/controller/settingcontrollers.py

@@ -15,13 +15,12 @@
 
 import re
 from itertools import chain
-from os import linesep
 
 from .. import robotapi, utils
 from ..robotapi import ALIAS_MARKER
 from ..publish.messages import (RideImportSettingChanged, RideImportSettingRemoved, RideVariableUpdated,
                                 RideItemSettingsChanged, RideImportSettingAdded)
-from ..utils import variablematcher
+from ..utils import variablematcher, unescape_newlines_and_whitespaces
 from .basecontroller import ControllerWithParent
 from .tags import Tag, ForcedTag, DefaultTag
 
@@ -138,7 +137,7 @@ def contains_keyword(self, name):
         return False
 
     def _get_editable_value(self):
-        return self._unescape_newlines_and_whitespaces(self.value)
+        return unescape_newlines_and_whitespaces(self.value)
 
     def _set_editable_value(self, value):
         self.set_value(self._escape_newlines_and_leading_hash(value))
@@ -149,27 +148,6 @@ def _set_editable_value(self, value):
     def visible_value(self):
         return utils.html_format(utils.unescape(self.value))
 
-    def _unescape_newlines_and_whitespaces(self, item):
-        for regexp in self._regexps:
-            if regexp.pattern.endswith(' '):
-                item = regexp.sub(self._whitespace_replacer, item)
-            else:
-                item = regexp.sub(self._newline_replacer, item)
-        return item
-
-    def _whitespace_replacer(self, match):
-        return self._replacer(' ', match)
-
-    def _newline_replacer(self, match):
-        return self._replacer(linesep, match)
-
-    @staticmethod
-    def _replacer(char, match):
-        slashes = len(match.group(1))
-        if slashes % 2 == 1:
-            return '\\' * (slashes - 1) + char
-        return match.group()
-
     @staticmethod
     def _escape_newlines_and_leading_hash(item):
         for newline in ('\r\n', '\n', '\r'):

src/robotide/editor/gridbase.py

@@ -13,18 +13,14 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-import re
-from os import linesep
-
 import wx
 from wx import grid, Colour
 
 from .clipboard import ClipboardHandler
 from ..context import IS_WINDOWS
+from ..utils import unescape_newlines_and_whitespaces
 from ..widgets import PopupCreator, PopupMenuItems
 
-# FILTER_NEWLINES = True
-
 
 class GridEditor(grid.Grid):
     _col_add_threshold = 6
@@ -33,10 +29,6 @@ class GridEditor(grid.Grid):
         'Insert Rows\tCtrl-I', 'Delete Rows\tCtrl-D', '---',
         'Select All\tCtrl-A', '---', 'Cut\tCtrl-X', 'Copy\tCtrl-C',
         'Paste\tCtrl-V', 'Insert\tCtrl-Shift-V', '---', 'Delete\tDel']
-    _regexps = (re.compile(r'(\\+)r\\n'),
-                re.compile(r'(\\+)n'),
-                re.compile(r'(\\+)r'),
-                re.compile(r'(\\+) '))
 
     def __init__(self, parent, num_rows, num_cols, popup_creator=None):
         grid.Grid.__init__(self, parent)
@@ -86,35 +78,15 @@ def write_cell(self, row, col, value, update_history=True):
         self._expand_if_necessary(row, col)
         if self.filter_newlines:
             # unescape \n to support multi lines display in grid cells
-            value = self._unescape_newlines_and_whitespaces(value)
+            value = unescape_newlines_and_whitespaces(value)
         self.SetCellValue(row, col, value)
 
-    def _unescape_newlines_and_whitespaces(self, item):
-        for regexp in self._regexps:
-            if regexp.pattern.endswith(' '):
-                item = regexp.sub(self._whitespace_replacer, item)
-            else:
-                item = regexp.sub(self._newline_replacer, item)
-        return item
-
-    def _whitespace_replacer(self, match):
-        return self._replacer(' ', match)
-
-    def _newline_replacer(self, match):
-        return self._replacer(linesep, match)
-
-    def _replacer(self, char, match):
-        slashes = len(match.group(1))
-        if slashes % 2 == 1:
-            return '\\' * (slashes - 1) + char
-        return match.group()
-
     def _expand_if_necessary(self, row, col):
         # Changed col and row fill because of blank spacing not changing color
         # print(f"DEBUG: GridEditor ENTER_expand_if_necessary row={row}, col={col}")
-        while self.NumberRows <= max(1, row+1, 10-row): # DEBUG 25 makes slower rendering
+        while self.NumberRows <= max(1, row+1, 10-row):  # DEBUG 25 makes slower rendering
             self.AppendRows(1)
-        while self.NumberCols <= max(1, col+1, 10-col): # DEBUG 40 makes slower rendering
+        while self.NumberCols <= max(1, col+1, 10-col):  # DEBUG 40 makes slower rendering
             self.AppendCols(max(1, self._col_add_threshold))  # DEBUG: was infinite when value was 0
 
     def has_focus(self):
@@ -192,9 +164,10 @@ def _current_cell_value(self):
 
     def _get_block_content(self, row_range, col_range):
         return [[self.GetCellValue(row, col) for col in col_range]
-                 for row in row_range]
+                for row in row_range]
 
-    def _strip_trailing_empty_cells(self, rowdata):
+    @staticmethod
+    def _strip_trailing_empty_cells(rowdata):
         while rowdata and not rowdata[-1]:
             rowdata.pop()
         return rowdata
@@ -234,23 +207,23 @@ def OnRangeSelect(self, event):
             self._ensure_selected_row_is_visible(event.BottomRow)
 
     def _ensure_selected_row_is_visible(self, bottom_row):
-        if not self.IsVisible(bottom_row , 0) and bottom_row < self.NumberRows and \
+        if not self.IsVisible(bottom_row, 0) and bottom_row < self.NumberRows and \
                 self._is_whole_row_selection():
             self.MakeCellVisible(bottom_row, 0)
 
     def OnCellRightClick(self, event):
         if hasattr(event, 'Row') and hasattr(event, 'Col'):
-            if not (event.Row, event.Col) in self.selection.cells():
+            if (event.Row, event.Col) not in self.selection.cells():
                 self.select(event.Row, event.Col)
                 self.selection.set_from_single_selection(event)
         self._popup_creator.show(self, PopupMenuItems(self, self._popup_items),
                                  self.get_selected_content())
 
-    # TODO This code is overriden at fieldeditors
+    # DEBUG: This code is overriden at fieldeditors
     def OnInsertCells(self, event):
         self._insert_or_delete_cells(self._insert_cells, event)
 
-    # TODO This code is overriden at fieldeditors
+    # DEBUG:This code is overriden at fieldeditors
     def OnDeleteCells(self, event):
         # print("DEBUG delete cells %s" % event)
         self._insert_or_delete_cells(self._delete_cells, event)
@@ -291,13 +264,13 @@ def _refresh_layout(self):
         self.GetParent().Sizer.Layout()
 
 
-# TODO: refactor this internal state away if possible
+# DEBUG: refactor this internal state away if possible
 class _GridSelection(object):
     cell = property(lambda self: (self.topleft.row, self.topleft.col))
 
-    def __init__(self, grid):
+    def __init__(self, gridd):
         self._set((0, 0))
-        self._grid = grid
+        self._grid = gridd
 
     def _set(self, topleft, bottomright=None):
         self.topleft = _Cell(topleft[0], topleft[1])
@@ -312,18 +285,19 @@ def _count_bottomright(self, topleft, bottomright):
     def set_from_single_selection(self, event):
         self._set((event.Row, event.Col))
 
-    def set_from_range_selection(self, grid, event):
-        self._set(*self._get_bounding_coordinates(grid, event))
+    def set_from_range_selection(self, gridd, event):
+        self._set(*self._get_bounding_coordinates(gridd, event))
 
     def clear(self):
         selection = (self._grid.GetGridCursorRow(), self._grid.GetGridCursorCol())
         self._set(selection)
 
-    def _get_bounding_coordinates(self, grid, event):
-        whole_row_selection = sorted(grid.SelectedRows)
+    @staticmethod
+    def _get_bounding_coordinates(gridd, event):
+        whole_row_selection = sorted(gridd.SelectedRows)
         if whole_row_selection:
             return (whole_row_selection[0], 0), \
-                   (whole_row_selection[-1], grid.NumberCols - 1)
+                   (whole_row_selection[-1], gridd.NumberCols - 1)
         return (event.TopLeftCoords.Row, event.TopLeftCoords.Col), \
                (event.BottomRightCoords.Row, event.BottomRightCoords.Col)
 
@@ -338,7 +312,7 @@ def cols(self):
     def cells(self):
         """Return selected cells as a list of tuples (row, column)."""
         return [(row, col) for col in self.cols()
-                           for row in self.rows()]
+                for row in self.rows()]
 
 
 class _Cell(object):

src/robotide/editor/kweditor.py

@@ -20,9 +20,10 @@
 from wx import grid
 from wx.grid import GridCellEditor
 
+from os import linesep
 from .contentassist import ExpandingContentAssistTextCtrl
 from .editordialogs import UserKeywordNameDialog, ScalarVariableDialog, ListVariableDialog
-from .gridbase import GridEditor, linesep
+from .gridbase import GridEditor
 from .gridcolorizer import Colorizer
 from .tooltips import GridToolTips
 from .. import robotapi
@@ -42,7 +43,6 @@
 from ..widgets import RIDEDialog, PopupMenu, PopupMenuItems
 
 _DEFAULT_FONT_SIZE = 11
-# FILTER_NEWLINES = True
 
 
 def requires_focus(function):

src/robotide/utils/__init__.py

@@ -14,6 +14,7 @@
 #  limitations under the License.
 
 import os
+import re
 import sys
 import inspect
 import subprocess
@@ -106,7 +107,7 @@ def is_same_drive(path1, path2):
 
 def run_python_command(command, mode='c'):
     cmd = [sys.executable, '-{0}'.format(mode)] + command
-    # TODO Let the user select which robot to use
+    # DEBUG: Let the user select which robot to use
     process = subprocess.Popen(
         cmd,
         stdout=subprocess.PIPE,
@@ -132,3 +133,33 @@ def converttypes(data, prefer_str=True):
     if data_type == dict:
         data = data.items()
     return data_type(map(converttypes, data))
+
+
+_regexps = (re.compile(r'(\\+)r\\n'),
+            re.compile(r'(\\+)n'),
+            re.compile(r'(\\+)r'),
+            re.compile(r'(\\+) '))
+
+
+def unescape_newlines_and_whitespaces(item):
+    for regexp in _regexps:
+        if regexp.pattern.endswith(' '):
+            item = regexp.sub(_whitespace_replacer, item)
+        else:
+            item = regexp.sub(_newline_replacer, item)
+    return item
+
+
+def _whitespace_replacer(match):
+    return _replacer(' ', match)
+
+
+def _newline_replacer(match):
+    return _replacer(os.linesep, match)
+
+
+def _replacer(char, match):
+    slashes = len(match.group(1))
+    if slashes % 2 == 1:
+        return '\\' * (slashes - 1) + char
+    return match.group()

src/robotide/version.py

@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.6dev3'
+VERSION = 'v2.0.6dev4'