Merge pull request #2921 from HelioGuilherme66/localized_bdd

Localized bdd improvements

Author: HelioGuilherme66

CHANGELOG.adoc

@@ -9,7 +9,11 @@ and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioni
 == https://github.com/robotframework/RIDE[Unreleased]
 
 === Added
-- Added syntax colorization for the ``GROUP`` marker. Improved colorization for multiple Gherkin words, for example in the French language.
+- Added syntax colorization for the ``GROUP`` marker.
+
+=== Changed
+- Improved the recognition of BDD/Gherkin prefixes when localized in autocomplete on Grid Editor.
+- Improved colorization for multiple Gherkin words, for example in the French language.
 
 === Fixed
 

README.adoc

@@ -40,7 +40,7 @@ Likewise, the current version of wxPython, is 4.2.2, but RIDE is known to work w
 
 `pip install -U robotframework-ride`
 
-(3.8 <= python <= 3.13) Install current development version (**2.2dev6**) with:
+(3.8 <= python <= 3.13) Install current development version (**2.2dev7**) with:
 
 `pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`
 

src/robotide/application/CHANGELOG.html

@@ -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>Improved the recognition of BDD/Gherkin prefixes when localized in autocomplete on Grid Editor.</li>
 <li>Added syntax colorization for the <em>GROUP</em> marker. Improved colorization for multiple Gherkin words, for 
 example in the French language.</li>
 <li>Fixed multiple scroll bars in Grid Editor when editing Test Cases or Keywords. This caused bad navigation on cells.</li>
@@ -227,7 +228,7 @@ def set_content(self, html_win, content):
 <pre class="literal-block">python -m robotide.postinstall -install</pre>
 <p>or</p>
 <pre class="literal-block">ride_postinstall.py -install</pre>
-<p>RIDE {VERSION} was released on 14/February/2025.</p>
+<p>RIDE {VERSION} was released on 16/February/2025.</p>
 <!-- <br/>
 <h3>May The Fourth Be With You!</h3>
 <h3>Celebrate the bank holiday, 10th June, Day of Portugal, Portuguese Communities and Camões!!</h3>

src/robotide/application/releasenotes.py

@@ -26,6 +26,16 @@
 from ..utils import variablematcher
 
 
+BDD_ENGLISH = 'Given|When|Then|And|But'
+
+def obtain_bdd_prefixes(language):
+    from robotide.lib.compat.parsing.language import Language
+    lang = Language.from_name(language[0] if isinstance(language, list) else language)
+    bdd_prefixes = [f"{x}|" for x in lang.bdd_prefixes]
+    bdd_prefixes = "".join(bdd_prefixes).strip('|')
+    return bdd_prefixes
+
+
 class Occurrence(object):
 
     def __init__(self, item, value):
@@ -279,17 +289,22 @@ class NullObserver(object):
 
 
 class RenameKeywordOccurrences(_ReversibleCommand):
-    # TODO: Consider localization language Gherkin
-    _gherkin_prefix = re.compile('^(Given|When|Then|And|But) ', re.IGNORECASE)
 
-    def __init__(self, original_name, new_name, observer, keyword_info=None):
+    def __init__(self, original_name, new_name, observer, keyword_info=None, language='En'):
+        self._language = language[0] if isinstance(language, list) else language
+        if self._language.lower() not in ['en', 'english']:
+            bdd_prefix = f"{obtain_bdd_prefixes(self._language)}|{BDD_ENGLISH}"
+        else:
+            bdd_prefix = BDD_ENGLISH
+        self._gherkin_prefix = re.compile(f'^({bdd_prefix}) ', re.IGNORECASE)
         self._original_name, self._new_name = self._check_gherkin(new_name, original_name)
         self._observer = observer
         self._keyword_info = keyword_info
         self._occurrences = None
         # print(f"DEBUG: ctrlcommands.py RenameKeywordOccurrences INIT\n"
-        #     f"{original_name=}, {new_name=}, self._original_name={self._original_name} "
-        #     f"self._new_name={self._new_name} self._keyword_info={self._keyword_info} ")
+        #      f"{original_name=}, {new_name=}, self._original_name={self._original_name} "
+        #      f"self._new_name={self._new_name} self._keyword_info={self._keyword_info}"
+        #      f" self._gherkin_prefix={self._gherkin_prefix} ")
 
     def _check_gherkin(self, new_name, original_name):
         was_gherkin, keyword_name = self._get_gherkin(original_name)

src/robotide/controller/ctrlcommands.py

@@ -33,6 +33,12 @@
 TESTCASE_NAME_FIELD = 'Test Case Name'
 
 
+def obtain_bdd_prefixes(language):
+    from robotide.lib.compat.parsing.language import Language
+    lang = Language.from_name(language[0] if isinstance(language, list) else language)
+    bdd_prefixes = lang.bdd_prefixes
+    return list(bdd_prefixes)
+
 def _empty_step():
     return robotapi.Step([])
 
@@ -239,10 +245,15 @@ def create_keyword(self, name, argstr):
             raise ValueError(validation.error_message)
         return self.datafile_controller.create_keyword(name, argstr)
 
-    @staticmethod
-    def _remove_bdd_prefix(name):
+    def _remove_bdd_prefix(self, name):
+        bdd_prefix = []
+        language = self.language[0] if isinstance(self.language, list) else self.language
+        if language and language.lower() not in ['en', 'english']:
+            bdd_prefix = [f"{x.lower()} " for x in obtain_bdd_prefixes(language)]
+        bdd_prefix += ['given ', 'when ', 'then ', 'and ', 'but ']
+        # print(f"DEBUG: macrocontrollers.py WithStepsController _remove_bdd_prefix bdd_prefix={bdd_prefix}")
         matcher = name.lower()
-        for match in ['given ', 'when ', 'then ', 'and ', 'but ']:
+        for match in bdd_prefix:
             if matcher.startswith(match):
                 return name[len(match):]
         return name

src/robotide/controller/macrocontrollers.py

@@ -22,15 +22,33 @@
 from ..namespace.local_namespace import local_namespace
 from ..utils import variablematcher
 
+BDD_ENGLISH = 'given|when|then|and|but'
+
+def obtain_bdd_prefixes(language):
+    from robotide.lib.compat.parsing.language import Language
+    lang = Language.from_name(language[0] if isinstance(language, list) else language)
+    bdd_prefixes = [f"{x}|" for x in lang.bdd_prefixes]
+    bdd_prefixes = "".join(bdd_prefixes).strip('|')
+    return bdd_prefixes
+
 
 class StepController(_BaseController):
 
-    _GIVEN_WHEN_THEN_MATCHER = re.compile(r'^(given|when|then|and|but)\s*', re.I)
     indent = None
 
     def __init__(self, parent, step):
         self.continuing_kw = None
         self._init(parent, step)
+        if hasattr(self.parent, 'language'):
+            self._language = self.parent.language[0] if isinstance(self.parent.language, list) else self.parent.language
+        else:
+            self._language = 'en'
+        if self._language and self._language.lower() not in ['en', 'english']:
+            bdd_prefix = f"{obtain_bdd_prefixes(self._language)}|{BDD_ENGLISH}"
+        else:
+            bdd_prefix = BDD_ENGLISH
+        self._GIVEN_WHEN_THEN_MATCHER = re.compile(fr'^({bdd_prefix})\s*', re.IGNORECASE)
+        # print(f"DEBUG: stepcontrollers.py StepController INIT {self.parent.language}")
         self.step_controller_step.args = self._change_last_empty_to_empty_var(
             self.step_controller_step.args, self.step_controller_step.comment)
 

src/robotide/controller/stepcontrollers.py

@@ -28,13 +28,20 @@
 from ..publish.messages import RideSettingsChanged
 
 
+def obtain_bdd_prefixes(language):
+    from robotide.lib.compat.parsing.language import Language
+    lang = Language.from_name(language[0] if isinstance(language, list) else language)
+    bdd_prefixes = lang.bdd_prefixes
+    return list(bdd_prefixes)
+
+
 _PREFERRED_POPUP_SIZE = (200, 400)
 _AUTO_SUGGESTION_CFG_KEY = "enable auto suggestions"
 
 
 class _ContentAssistTextCtrlBase(wx.TextCtrl):
 
-    def __init__(self, suggestion_source, **kw):
+    def __init__(self, suggestion_source, language='En', **kw):
         super().__init__(**kw)
         from ..preferences import RideSettings
         _settings = RideSettings()
@@ -45,6 +52,7 @@ def __init__(self, suggestion_source, **kw):
         self.color_secondary_foreground = self.general_settings['secondary foreground']
         self.color_background_help = self.general_settings['background help']
         self.color_foreground_text = self.general_settings['foreground text']
+        self.language = language
         self._popup = ContentAssistPopup(self, suggestion_source)
         self.Bind(wx.EVT_KEY_DOWN, self.on_key_down)
         self.Bind(wx.EVT_CHAR, self.on_char)
@@ -308,9 +316,13 @@ def _populate_content_assist(self):
         (self.gherkin_prefix, value) = self._remove_bdd_prefix(value)
         return self._popup.content_assist_for(value, row=self._row)
 
-    @staticmethod
-    def _remove_bdd_prefix(name):
-        for match in ['given ', 'when ', 'then ', 'and ', 'but ']:
+    def _remove_bdd_prefix(self, name):
+        bdd_prefix = []
+        if self.language.lower() not in ['en', 'english']:
+            bdd_prefix = [f"{x.lower()} " for x in obtain_bdd_prefixes(self.language)]
+        bdd_prefix += ['given ', 'when ', 'then ', 'and ', 'but ']
+        # print(f"DEBUG: contentassist.py ContentAssistTextCtrlBase _remove_bdd_prefix bdd_prefix={bdd_prefix}")
+        for match in bdd_prefix:
             if name.lower().startswith(match):
                 return name[:len(match)], name[len(match):]
         return '', name
@@ -341,11 +353,11 @@ def dismiss(self):
 
 class ExpandingContentAssistTextCtrl(_ContentAssistTextCtrlBase, ExpandoTextCtrl):
 
-    def __init__(self, parent, plugin, controller):
+    def __init__(self, parent, plugin, controller, language='En'):
         """ According to class MRO, super().__init__ in  _ContentAssistTextCtrlBase will init ExpandoTextCtrl
         instance """
 
-        _ContentAssistTextCtrlBase.__init__(self, SuggestionSource(plugin, controller),
+        _ContentAssistTextCtrlBase.__init__(self, SuggestionSource(plugin, controller), language=language,
                                             parent=parent, size=wx.DefaultSize,
                                             style=wx.WANTS_CHARS | wx.TE_NOHIDESEL)
         self.SetBackgroundColour(context.POPUP_BACKGROUND)
@@ -356,8 +368,8 @@ def __init__(self, parent, plugin, controller):
 
 class ContentAssistTextCtrl(_ContentAssistTextCtrlBase):
 
-    def __init__(self, parent, suggestion_source, size=wx.DefaultSize):
-        super().__init__(suggestion_source, parent=parent,
+    def __init__(self, parent, suggestion_source, language='En', size=wx.DefaultSize):
+        super().__init__(suggestion_source, language=language, parent=parent,
                          size=size, style=wx.WANTS_CHARS | wx.TE_NOHIDESEL)
         self.SetBackgroundColour(Colour(self.color_background_help))
         # self.SetOwnBackgroundColour(Colour(self.color_background_help))
@@ -367,8 +379,8 @@ def __init__(self, parent, suggestion_source, size=wx.DefaultSize):
 
 class ContentAssistTextEditor(_ContentAssistTextCtrlBase):
 
-    def __init__(self, parent, suggestion_source, pos, size=wx.DefaultSize):
-        super().__init__(suggestion_source,
+    def __init__(self, parent, suggestion_source, pos, language='En', size=wx.DefaultSize):
+        super().__init__(suggestion_source, language=language,
                          parent=parent, id=-1, value="", pos=pos, size=size,
                          style=wx.WANTS_CHARS | wx.BORDER_NONE | wx.WS_EX_TRANSIENT | wx.TE_PROCESS_ENTER |
                          wx.TE_NOHIDESEL)

src/robotide/editor/contentassist.py

@@ -16,6 +16,7 @@
 import builtins
 import json
 from json.decoder import JSONDecodeError
+from multiprocessing import shared_memory
 
 import wx
 from wx import grid
@@ -74,7 +75,6 @@ def decorated_function(self, *args):
 
     return decorated_function
 
-
 class KeywordEditor(GridEditor, Plugin):
     _no_cell = (-1, -1)
     _popup_menu_shown = False
@@ -163,6 +163,17 @@ def __init__(self, parent, controller, tree):
         self._cell_selected = False
         self._colorizer = Colorizer(self, controller)
         self._controller = controller
+        try:
+            set_lang = shared_memory.ShareableList(name="language")
+            self._language = [set_lang[0]]
+            # print(f"DEBUG: settings.py SettingEditor __init__ SHAREDMEM language={self._language}")
+        except AttributeError:
+            try:
+                self._language = self._controller.language
+                # print(f"DEBUG: settings.py SettingEditor __init__ CONTROLLER language={self._language}")
+            except AttributeError:
+                self._language = ['en']
+        self._language = self._language[0] if isinstance(self._language, list) else self._language
         self._configure_grid()
         self._updating_namespace = False
         self._controller.datafile_controller.register_for_namespace_updates(
@@ -247,7 +258,7 @@ def _set_cells(self):
 
     def _configure_grid(self):
         self._set_cells()
-        self.SetDefaultEditor(ContentAssistCellEditor(self._plugin, self._controller))
+        self.SetDefaultEditor(ContentAssistCellEditor(self._plugin, self._controller, self._language))
         self._set_fonts()
         wx.CallAfter(self.SetGridCursor, (0, 0))  # To make cells colorized as soon we select keywords or tests
         wx.CallAfter(self.highlight, '')
@@ -1150,7 +1161,7 @@ def on_rename_keyword(self, event):
         new_name = wx.GetTextFromUser(_('New name'), _(REN_KW), default_value=old_name)
         if new_name:
             self._execute(RenameKeywordOccurrences(
-                old_name, new_name, RenameProgressObserver(self.GetParent())))
+                old_name, new_name, RenameProgressObserver(self.GetParent()), language=self._language))
 
     # Add one new Dialog to edit pretty json String TODO: use better editor with more functions
     def on_json_editor(self, event=None):
@@ -1205,7 +1216,7 @@ def is_json(json_str):
 
 class ContentAssistCellEditor(GridCellEditor):
 
-    def __init__(self, plugin, controller):
+    def __init__(self, plugin, controller, language='En'):
         self.settings = plugin.global_settings['Grid']
         self.general_settings = plugin.global_settings['General']
         self.filter_newlines = self.settings.get("filter newlines", True)
@@ -1214,6 +1225,7 @@ def __init__(self, plugin, controller):
         GridCellEditor.__init__(self)
         self._plugin = plugin
         self._controller = controller
+        self._language = language
         self._grid = None
         self._original_value = None
         self._value = None
@@ -1244,7 +1256,7 @@ def execute_sharp_uncomment(self):
         self._tc.execute_sharp_uncomment()
 
     def Create(self, parent, idd, evthandler):
-        self._tc = ExpandingContentAssistTextCtrl(parent, self._plugin, self._controller)
+        self._tc = ExpandingContentAssistTextCtrl(parent, self._plugin, self._controller, self._language)
         self.SetControl(self._tc)
         if evthandler:
             self._tc.PushEventHandler(evthandler)
@@ -1316,7 +1328,7 @@ def StartingKey(self, event):
         self._tc.SetInsertionPointEnd()
 
     def Clone(self):
-        return ContentAssistCellEditor(self._plugin, self._controller)
+        return ContentAssistCellEditor(self._plugin, self._controller, self._language)
 
 
 class ChooseUsageSearchStringDialog(wx.Dialog):

src/robotide/editor/kweditor.py

@@ -559,7 +559,8 @@ class Fr(Language):
     template_setting = 'Modèle'
     timeout_setting = "Délai d'attente"
     arguments_setting = 'Arguments'
-    given_prefixes = ['Soit', 'Sachant', 'Sachant que', "Sachant qu'", 'Étant donné', 'Étant donné que', "Etant donné qu'"]
+    given_prefixes = ['Soit', 'Sachant', 'Sachant que', "Sachant qu'", 'Étant donné', 'Étant donné que',
+                      "Etant donné qu'"]
     when_prefixes = ['Quand', 'Lorsque', "Lorsqu'"]
     then_prefixes = ['Alors', 'Donc']
     and_prefixes = ['Et', 'Et que', "Et qu'"]