Version 2.0.8.1

robotframework · Nov 1, 2023 · 368123a · 368123a
1 parent b01a3b2
commit 368123a
Show file tree

Hide file tree

Showing 8 changed files with 189 additions and 19 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -8,7 +8,7 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 
 // == https://github.com/robotframework/RIDE[Unreleased]
 
-== https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.rst[2.0.8] - 2023-11-01
+== https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.1.rst[2.0.8.1] - 2023-11-01
 
 === Added
 

diff --git a/README.adoc b/README.adoc
@@ -16,19 +16,19 @@ You can use the tag *robotframework-ide* to search and ask on https://stackoverf
 
 == **Welcome to the development version of RIDE - next major release will be version 2.1**
 
-If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.0.8[release/2.0.8]**
+If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.0.8.1[release/2.0.8.1]**
 
-See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.rst[release notes] for latest release version 2.0.8.
+See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.1.rst[release notes] for latest release version 2.0.8.1
 
 **Version https://github.com/robotframework/RIDE/tree/release/1.7.4.2[1.7.4.2] was the last release supporting Python 2.7**
 
 
-**The current development version is based on 2.0.8, supports Python from 3.6 up to 3.11 (1st November 2023).**
+**The current development version is based on 2.0.8.1, supports Python from 3.6 up to 3.11 (1st November 2023).**
 
 Currently the unit tests are tested on Python 3.10, and 3.11 (which is the recommended version).
 Likewise, the current version of wxPython, is 4.2.1, but RIDE is known to work with 4.0.7 and 4.1.1 versions.
 
-(3.6 < python <= 3.11) Install current released version (*2.0.8*) with:
+(3.6 < python <= 3.11) Install current released version (*2.0.8.1*) with:
 
 `pip install -U robotframework-ride`
 

diff --git a/doc/releasenotes/ride-2.0.8.1.rst b/doc/releasenotes/ride-2.0.8.1.rst
@@ -0,0 +1,169 @@
+.. container:: document
+
+   `RIDE (Robot Framework
+   IDE) <https://github.com/robotframework/RIDE/>`__ v2.0.8.1 is a new
+   release with minor enhancements and bug fixes. The reference for
+   valid arguments is `Robot Framework <https://robotframework.org/>`__
+   installed version, which is at this moment 6.1.1. However, internal
+   library is based on version 3.1.2, to keep compatibility with old
+   formats.
+
+   -  This version supports Python 3.6 up to 3.11.
+   -  There are some changes, or known issues:
+
+      -  On Text Editor, pressing **Ctrl** when the caret/cursor is near
+         a Keyword will show a detachable window with the documentation,
+         at Mouse Pointer position.
+      -  RIDE tray icon now shows a context menu with options Show, Hide
+         and Close.
+      -  Highlighting and navigation of selected Project Explorer items,
+         in Text Editor.
+      -  When editing in Grid Editor with content assistance, the
+         selected content can be edited by escaping the list of
+         suggestions with keys ARROW_LEFT or ARROW_RIGHT.
+      -  Newlines in Grid Editor can be made visible with the **filter
+         newlines** set to False.
+      -  On Text Editor when Saving the selection of tests in Test
+         Suites (Tree) is cleared.
+      -  Test Suite with *\**\* Comments \**\** can be edited but
+         newlines are introduced.
+      -  Problems with COPY/PASTE in Text Editor have been reported when
+         using wxPython 4.2.0, but not with version 4.2.1, which we now
+         *recommend*.
+      -  Some argument types detection (and colorization) is not correct
+         in Grid Editor.
+      -  RIDE **DOES NOT KEEP** Test Suites formatting or structure,
+         causing differences in files when used on other IDE or Editors.
+
+   **New Features and Fixes Highlights**
+
+   -  Fixed escaped spaces showing in Text Editor on commented cells
+   -  Improved keywords documentation search, by adding current dir to
+      search
+   -  Improved Move up/down, **Alt-UpArrow**/**Alt-DownArrow** in Text
+      Editor, to have proper indentation and selection
+   -  Added auto update check when development version is installed
+   -  Added menu option **Help->Check for Upgrade** which allows to
+      force update check and install development version
+   -  Added **Upgrade Now** action to update dialog.
+   -  Added **Test Tags** field (new, since Robot Framework 6.0) to Test
+      Suites settings. This field will replace **Default** and **Force
+      Tags** settings, after Robot Framework 7.0
+   -  Improved **RIDE Log** and **Parser Log** windows to allow Zoom
+      In/Out with **Ctrl-Mouse Wheel**
+   -  Hide continuation markers in Project Tree
+   -  Improved content assistance in Text Editor by allowing to filter
+      list as we type
+   -  Fixed resource files disappearing from Project tree on Windows
+   -  Fixed missing indication of link for User Keyword, when pressing
+      **Ctrl** in Grid Editor
+   -  Added content help pop-up on Text Editor by pressing **Ctrl** for
+      text at cursor position or selected autocomplete list item
+   -  Added Exclude option in context nenu for Test files, previously
+      was only possible for Test Suites folders
+   -  Added exclusion of monitoring filesystem changes for files and
+      directories excluded in Preferences
+   -  Fixed exception when finding GREY color for excluded files and
+      directories in Project Tree
+   -  Added support for JSON variables, by using the installed Robot
+      Framework import method
+   -  Colorization of Grid Editor cells after the continuation marker
+      **...** and correct parsing of those lines
+   -  Colorization of Grid Editor cells when contents is list or
+      dictionary variables
+   -  Added indication of matching brackets, **()**, **{}**, **[]**, in
+      Text Editor
+   -  Fixed non synchronized expanding/collapse of Settings panel in
+      Grid Editor, on Linux
+   -  Fixed not working the deletion of cells commented with **#** in
+      Grid Editor with **Ctrl-Shift-D**
+   -  Fixed empty line being always added to the Variables section in
+      Text Editor
+   -  Improved project file system changes and reloading
+   -  Added context menu to RIDE tray icon. Options Show, Hide and Close
+   -  Added synchronization with Project Explorer to navigate to
+      selected item, Test Case, Keyword, Variable, in Text Editor
+   -  Control commands (**FOR**, **IF**, **TRY**, etc) will only be
+      colorized as valid keywords when typed in all caps in Grid Editor
+   -  Newlines in Grid Editor can be made visible with the **filter
+      newlines** set to False, by editing *settings.cfg*
+   -  Improve auto-suggestions of keywords in Grid Editor by allowing to
+      close suggestions list with keys ARROW_LEFT or ARROW_RIGHT
+   -  Improve Text Editor auto-suggestions by using: selected text, text
+      at left or at right of cursor
+
+   We hope to implement or complete features and make fixes on next
+   major version 2.1 (in the end of 2023).
+
+   **The minimal wxPython version is, 4.0.7, and RIDE supports the
+   current version, 4.2.1.**
+
+   *Linux users are advised to install first wxPython from .whl package
+   at*
+   `wxPython.org <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`__,
+   or by using the system package manager.
+
+   The
+   `CHANGELOG.adoc <https://github.com/robotframework/RIDE/blob/master/CHANGELOG.adoc>`__
+   lists the changes done on the different versions.
+
+   All issues targeted for RIDE v2.1 can be found from the `issue
+   tracker
+   milestone <https://github.com/robotframework/RIDE/issues?q=milestone%3Av2.1>`__.
+
+   Questions and comments related to the release can be sent to the
+   `robotframework-users <https://groups.google.com/group/robotframework-users>`__
+   mailing list or to the channel #ride on `Robot Framework
+   Slack <https://robotframework-slack-invite.herokuapp.com>`__, and
+   possible bugs submitted to the `issue
+   tracker <https://github.com/robotframework/RIDE/issues>`__. You
+   should see `Robot Framework
+   Forum <https://forum.robotframework.org/c/tools/ride/>`__ if your
+   problem is already known.
+
+   To install with `pip <https://pypi.org/project/pip/>`__ installed,
+   just run
+
+   .. code:: literal-block
+
+      pip install --upgrade robotframework-ride==v2.0.8.1
+
+   to install exactly this release, which is the same as using
+
+   .. code:: literal-block
+
+      pip install --upgrade robotframework-ride
+
+   Alternatively you can download the source distribution from
+   `PyPI <https://pypi.python.org/pypi/robotframework-ride>`__ and
+   install it manually. For more details and other installation
+   approaches, see the `installation
+   instructions <https://github.com/robotframework/RIDE/wiki/Installation-Instructions>`__.
+   If you want to help in the development of RIDE, by reporting issues
+   in current development version, you can install with:
+
+   .. code:: literal-block
+
+      pip install -U https://github.com/robotframework/RIDE/archive/master.zip
+
+   Important document for helping with development is the
+   `CONTRIBUTING.adoc <https://github.com/robotframework/RIDE/blob/master/CONTRIBUTING.adoc>`__.
+
+   See the `FAQ <https://github.com/robotframework/RIDE/wiki/F.A.Q.>`__
+   for important info about : FOR changes and other known issues and
+   workarounds.
+
+   A possible way to start RIDE is:
+
+   .. code:: literal-block
+
+      python -m robotide.__init__
+
+   You can then go to Tools>Create RIDE Desktop Shortcut, or run the
+   shortcut creation script with:
+
+   .. code:: literal-block
+
+      python -m robotide.postinstall -install
+
+   RIDE v2.0.8.1 was released on 1/Nov/2023.
diff --git a/setup.py b/setup.py
@@ -42,6 +42,8 @@
 Robot Framework is a generic test automation framework for acceptance
 level testing. RIDE is a lightweight and intuitive editor for Robot
 Framework test data.
+
+Project: https://github.com/robotframework/RIDE#readme
 """.strip()
 
 CLASSIFIERS = """
@@ -51,6 +53,9 @@
 Programming Language :: Python :: 3.6
 Programming Language :: Python :: 3.7
 Programming Language :: Python :: 3.8
+Programming Language :: Python :: 3.9
+Programming Language :: Python :: 3.10
+Programming Language :: Python :: 3.11
 Topic :: Software Development :: Testing
 """.strip().splitlines()
 
@@ -76,6 +81,7 @@ def run(self):
     version=main_ns['VERSION'],
     description='RIDE :: Robot Framework Test Data Editor',
     long_description=LONG_DESCRIPTION,
+    long_description_content_type='text/markdown',
     license='Apache License 2.0',
     keywords='robotframework testing testautomation',
     platforms='any',

diff --git a/src/robotide/application/CHANGELOG.html b/src/robotide/application/CHANGELOG.html
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Changelog</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="id1337"></a>Changelog</h2></div></div><hr /></div><p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a class="ulink" href="http://keepachangelog.com/en/1.0.0/" target="_top">Keep a Changelog</a>
-and this project adheres to <a class="ulink" href="http://semver.org/spec/v2.0.0.html" target="_top">Semantic Versioning</a>.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ulink_url_https_github_com_robotframework_ride_unreleased_ulink"></a>1. <a class="ulink" href="https://github.com/robotframework/RIDE" target="_top">Unreleased</a></h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_added"></a>1.1. Added</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
+and this project adheres to <a class="ulink" href="http://semver.org/spec/v2.0.0.html" target="_top">Semantic Versioning</a>.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_ulink_url_https_github_com_robotframework_ride_blob_master_doc_releasenotes_ride_2_0_8_1_rst_2_0_8_1_ulink_2023_11_01"></a>1. <a class="ulink" href="https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.0.8.1.rst" target="_top">2.0.8.1</a> - 2023-11-01</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_added"></a>1.1. Added</h3></div></div></div><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 Added auto update check when development version is installed
 </li><li class="listitem">
 Added menu option ``Help→Check for Upgrade`` which allows to force update check and install development version

diff --git a/src/robotide/editor/texteditor.py b/src/robotide/editor/texteditor.py
@@ -133,7 +133,8 @@ def on_data_changed(self, message):
                     self._editor.set_editor_caret_position()
                 if isinstance(message, RideNotebookTabChanging):  # Not reached
                     return
-                if self.is_focused() and self._save_flag == 0 and isinstance(message, RideSaving):  # Workaround for remarked dirty with Ctrl-S
+                # Workaround for remarked dirty with Ctrl-S
+                if self.is_focused() and self._save_flag == 0 and isinstance(message, RideSaving):
                     self._save_flag = 1
                 if self.is_focused() and self._save_flag == 1 and isinstance(message, RideDataDirtyCleared):
                     self._save_flag = 2
@@ -210,7 +211,6 @@ def on_tab_change(self, message):
         if message.newtab == self.title:
             self._open()
             self._editor.set_editor_caret_position()
-            # self._editor._dirty = 1
             try:
                 self._set_read_only(self._editor.source_editor.readonly)
             except Exception as e:  # DEBUG: When using only Text Editor exists error in message topic
@@ -219,7 +219,6 @@ def on_tab_change(self, message):
             self._editor.remove_and_store_state()
             self._editor_component.is_saving = False
             self._editor_component.content_save()
-            # self._editor._dirty = 0
 
     def on_tab_changed(self, event):
         _ = event
@@ -397,7 +396,6 @@ def __init__(self, plugin, parent, title, data_validator):
         self.reformat = self.source_editor_parent.app.settings.get('reformat', False)
         self._create_ui(title)
         self._data = None
-        # self._dirty = 1  # 0 is False and 1 is True, when changed on this editor
         self._position = 0  # Start at 0 if first time access
         self.restore_start_pos = self._position
         self.restore_end_pos = self._position
@@ -535,9 +533,7 @@ def set_editor_caret_position(self):
 
     @property
     def dirty(self):
-        # return self._dirty == 1 and (self._data.wrapper_data.is_dirty or self.source_editor.GetModify())
-        # return self._dirty == 1  # self.source_editor.GetModify() and self._dirty == 1
-        return self._data.wrapper_data.is_dirty  # or self.source_editor.GetModify()
+        return self._data.wrapper_data.is_dirty if self._data else False
 
     @property
     def datafile_controller(self):
@@ -820,7 +816,6 @@ def write_ident(self):
         self.source_editor.WriteText(spaces)
 
     def reset(self):
-        # self._dirty = 0
         if self._data and not self._data.wrapper_data.is_dirty:
             self.mark_file_dirty(False)
 
@@ -995,7 +990,6 @@ def on_editor_key(self, event):
             return
         keycode = event.GetKeyCode()
         keyvalue = event.GetUnicodeKey()
-        # self._dirty = 1
         # print(f"DEBUG: TextEditor key up focused={self.is_focused()} modify {self.source_editor.GetModify()}")
         if keycode == wx.WXK_DELETE:  # DEBUG on Windows we only get here, single Text Editor
             selected = self.source_editor.GetSelection()
@@ -1029,7 +1023,6 @@ def on_key_down(self, event):
             return
         keycode = event.GetUnicodeKey()
         raw_key = event.GetKeyCode()
-        # self._dirty = 1
         # print(f"DEBUG: TextEditor on_key_down event={event} raw_key={raw_key} wx.WXK_C ={wx.WXK_CONTROL}")
         if event.GetKeyCode() == wx.WXK_DELETE:
             self.mark_file_dirty(self.source_editor.GetModify())

diff --git a/src/robotide/version.py b/src/robotide/version.py
@@ -14,4 +14,4 @@
 #  limitations under the License.
 #
 # Automatically generated by `tasks.py`.
-VERSION = 'v2.0.8'
+VERSION = 'v2.0.8.1'
diff --git a/utest/zulu_misc/test_version.py b/utest/zulu_misc/test_version.py
@@ -26,8 +26,10 @@
     r'^(?P<major>0|[1-9]\d*)'
     r'\.'
     r'(?P<minor>0|[1-9]\d*)'
-    r'\.'
-    r'(?P<patch>0|[1-9]\d*)'
+    r'(?:\.'
+    r'(?P<patch>0|[1-9]\d*))?'
+    r'(?:\.'
+    r'(?P<fix>0|[1-9]\d*))?'
     r'(?:-'
     r'(?P<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)'
     r'(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?'