Fix empty line at Variable section in Text Editor. Note: unit test not done (#2616)

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -16,6 +16,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 
 == Fixed
 
+- Fixed empty line being always added to the Variables section in Text Editor
 - Fixed wrong project reloading when file system changes detected, and other related problems
 - Fixed control commands (``FOR``, ``IF``, ``TRY``, etc) being colorized as valid keywords when typed not in all caps in Grid Editor
 - Fixed title of User Keyword in Grid Editor always showing ``Find Usages`` instead of the keyword name

src/robotide/application/CHANGELOG.html

@@ -6,6 +6,8 @@
 Added sincronization with Project Explorer to navigate to selected item, Test Case, Keyword, Variable, in Text Editor
   Note: This feature is working fine in Fedora 38, but not on Windows and macOS.
 </li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_fixed"></a>2. Fixed</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+Fixed empty line being always added to the Variables section in Text Editor
+</li><li class="listitem">
 Fixed wrong project reloading when file system changes detected, and other related problems
 </li><li class="listitem">
 Fixed control commands (``FOR``, ``IF``, ``TRY``, etc) being colorized as valid keywords when typed not in all caps in Grid Editor

src/robotide/application/releasenotes.py

@@ -168,6 +168,7 @@ def set_content(self, html_win, content):
 </ul>
 <p><strong>New Features and Fixes Highlights</strong></p>
 <ul class="simple">
+<li>Fixed empty line being always added to the Variables section in Text Editor</li>
 <li>Improved project file system changes and reloading</li>
 <li>Added context menu to RIDE tray icon. Options Show, Hide and Close</li>
 <li>Added sincronization with Project Explorer to navigate to selected item, Test Case, Keyword, Variable, in Text
@@ -226,6 +227,6 @@ def set_content(self, html_win, content):
 <pre class="literal-block">
 python -m robotide.postinstall -install
 </pre>
-<p>RIDE {VERSION} was released on 09/Jul/2023.</p>
+<p>RIDE {VERSION} was released on 30/Jul/2023.</p>
 </div>
 """

src/robotide/editor/texteditor.py

@@ -275,18 +275,15 @@ def validate_and_update(self, data, text):
             if not handled:
                 return False
         self._editor.reset()
-        data.update_from(m_text)
-        """
-        # DEBUG: This is the area where we will implement to not reformat code
-        if self.source_editor._reformat:
-            data.update_from(m_text)
+        if self._editor.reformat:
+            data.update_from(data.format_text(m_text))
         else:
-            data.update_from(m_text)  # TODO: This is the same code as _reformat == True
+            # DEBUG: This is the area where we will implement to not reformat code
+            data.update_from(m_text)
             # There is no way to update the model without reformatting
-            # TODO this only updates the editor, but not the model, changes in Text Editor are not reflected in Grid or
-            # when saving
-            #  self.source_editor.source_editor.set_text(m_text)
-        """
+            # DEBUG: this only updates the editor, but not the model, changes in Text Editor are not reflected
+            # in Grid or when saving
+            # self.source_editor.source_editor.set_text(m_text)
         self._editor.set_editor_caret_position()
         return True
 
@@ -397,7 +394,7 @@ def __init__(self, parent, title, data_validator):
         self.source_editor_parent = parent
         self._title = title
         self.tab_size = self.source_editor_parent.app.settings.get(TXT_NUM_SPACES, 4)
-        self._reformat = self.source_editor_parent.app.settings.get('reformat', False)
+        self.reformat = self.source_editor_parent.app.settings.get('reformat', False)
         self._create_ui(title)
         self._data = None
         self._dirty = 0  # 0 is False and 1 is True, when changed on this editor
@@ -1463,7 +1460,7 @@ def on_settings_changed(self, message):
         if setting == TXT_NUM_SPACES:
             self.tab_size = self.source_editor_parent.app.settings.get(TXT_NUM_SPACES, 4)
         if setting == 'reformat':
-            self._reformat = self.source_editor_parent.app.settings.get('reformat', False)
+            self.reformat = self.source_editor_parent.app.settings.get('reformat', False)
 
     def _mark_file_dirty(self, dirty=True):
         if not self.is_focused():  # DEBUG: Was marking file clean from Grid Editor

src/robotide/lib/robot/version.py

@@ -22,13 +22,13 @@
 VERSION = '3.1.2'  # Original library version
 ROBOT_VERSION = getenv('ROBOT_VERSION')  # Set the version from environment, like "3.1.2"
 if not ROBOT_VERSION:
-    ROBOT_VERSION = (6, 0, 2)  # Define here or use environmnt variable. Condition library alias with AS
+    ROBOT_VERSION = (6, 1, 1)  # Define here or use environment variable. Condition library alias with AS
 else:
     if not isinstance(ROBOT_VERSION, tuple):
         try:
             ROBOT_VERSION = tuple(int(x) for x in ROBOT_VERSION.replace(',', '.').strip('()').split('.')[:])
         except (TypeError, ValueError):
-            ROBOT_VERSION = (6, 0, 2)
+            ROBOT_VERSION = (6, 1, 1)
 
 ALIAS_MARKER = 'AS' if ROBOT_VERSION >= (6, 0, 0) else 'WITH NAME'
 

src/robotide/lib/robot/writer/filewriters.py

@@ -59,6 +59,10 @@ def _write_table(self, table, is_last):
         self._write_header(table)
         self._write_rows(self._formatter.format_table(table))
         if not is_last:  # DEBUG: make this configurable
+            # print(f"DEBUG: lib.robot.writer _DataFileWritter write_table empty_row table={table.type}")
+            if table.type == 'variable' and len(list(table)[-1].as_list()) == 0:
+                # DEBUG: This is workaround for newline being added ALWAYS to VariableTable
+                return
             self._write_empty_row(table)
 
     def _write_header(self, table):
@@ -115,7 +119,8 @@ def __init__(self, configuration):
         _DataFileWriter.__init__(self, formatter, configuration)
         self._writer = self._get_writer(configuration)
 
-    def _get_writer(self, configuration):
+    @staticmethod
+    def _get_writer(configuration):
         # Custom dialect needed as a workaround for
         # http://ironpython.codeplex.com/workitem/33627
         dialect = csv.excel_tab()

src/robotide/version.py

@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.7dev7'
+VERSION = 'v2.0.7dev8'

utest/editor/test_texteditor.py

@@ -146,8 +146,11 @@ def setUp(self):
                                                                 texteditor.DataValidationHandler(self.plugin))
         self.plugin.enable()
         self.app.project.load_datafile(datafilereader.TESTCASEFILE_WITH_EVERYTHING, MessageRecordingLoadObserver())
+        self.notebook = self.app.book
         self.app.tree.set_editor(self.plugin._editor_component)
         self.app.tree.populate(self.app.project)
+        self.source = self.app.tree.controller
+        self.plugin._open_tree_selection_in_editor()
         self.app.frame.SetStatusText("File:" + self.app.project.data.source)
         # Uncomment next line (and MainLoop in tests) if you want to see the app
         # self.frame.Show()
@@ -421,8 +424,47 @@ def test_execute_sharp_uncomment_with_selection(self):
         # print(f"DEBUG: fulltext:\n{fulltext}")
         assert fulltext == spaces + '1 - Line one' + spaces + 'with cells' + spaces + 'last text\n'
         # Uncomment next lines if you want to see the app
-        wx.CallLater(5000, self.app.ExitMainLoop)
-        self.app.MainLoop()
+        # wx.CallLater(5000, self.app.ExitMainLoop)
+        # self.app.MainLoop()
+
+    def test_check_variables_section(self):
+        pos = len('1 - Line one\n')
+        spaces = ' ' * self.plugin._editor_component.tab_size
+        text = "${ARG}            value"  # Text to find (last item in Variable section)
+        with open(datafilereader.TESTCASEFILE_WITH_EVERYTHING, "r") as fp:  #, MessageRecordingLoadObserver())
+            content = fp.readlines()
+        content = "".join(content)
+        # self.plugin.on_open(None)
+        # datafilecontroller = self.app.tree.get_selected_datafile_controller()
+        # print(f"DEBUG: datafilecontroller={datafilecontroller} controller={self.app.tree.controller}")
+        # self.plugin._open_data_for_controller(self.app.tree.get_selected_datafile_controller())
+        # self.plugin.on_open(wx.EVT_FILECTRL_SELECTIONCHANGED)
+        # content = ['1 - Line one\n', '2 - Line two\n', '3 - Line three\n']
+        # self.plugin._editor_component.source_editor.set_text(
+        #     content[0] + 'Comment' + spaces + content[1] + content[2])
+        self.plugin._editor_component.source_editor.set_text(content)
+        # self.plugin._editor_component.source_editor.SetSelection(pos + 1, pos + 4)
+        # self.plugin._editor_component.execute_uncomment(None)
+        self.plugin._editor_component.store_position(True)
+        self.plugin._editor_component.set_editor_caret_position()
+        position = self.plugin._editor_component._find_text_position(True, text)
+        self.plugin._editor_component._show_search_results(position, text)
+        position = self.plugin._editor_component.source_editor.GetCurrentPos()
+        self.plugin._editor_component.source_editor.InsertText(position, "123\n\n")
+        fulltext = self.plugin._editor_component.source_editor.GetText()
+        # print(f"DEBUG: fulltext:\n{fulltext}")
+        # Activate Apply to cleanup text
+        self.plugin._editor_component._dirty = True
+        # self.plugin._apply_txt_changes_to_model()
+        # DEBUG: THIS IS THE TEST, IT FAILS BECAUSE WE DON'T HAVE data and controller
+        # result = self.plugin._editor_component.save()
+        # print(f"DEBUG: result={result} is_dirty={self.plugin._editor_component.dirty}")
+        after_apply = self.plugin._editor_component.source_editor.GetText()
+        print(f"DEBUG: after_apply len={len(after_apply)} initial content len={len(content)}:\n{after_apply}")
+        # assert fulltext == content[0] + content[1] + content[2]
+        # Uncomment next lines if you want to see the app
+        # wx.CallLater(5000, self.app.ExitMainLoop)
+        # self.app.MainLoop()
 
 
 if __name__ == '__main__':