Merge pull request robotframework#2881 from HelioGuilherme66/improve_…

…code

Improve code

README.adoc

@@ -40,7 +40,7 @@ Likewise, the current version of wxPython, is 4.2.1, but RIDE is known to work w
 
 `pip install -U robotframework-ride`
 
-(3.8 <= python <= 3.12) Install current development version (**2.1dev77**) with:
+(3.8 <= python <= 3.12) Install current development version (**2.1dev78**) with:
 
 `pip install -U https://github.com/robotframework/RIDE/archive/master.zip`
 

src/robotide/editor/texteditor.py

@@ -88,13 +88,17 @@ def obtain_language(existing, content):
     except AttributeError:  # Unittests fails here
         set_lang = []
     doc_lang = read_language(content)
-    # print(f"DEBUG: textedit.py validate_and_update obtain_language={doc_lang}")
+    # print(f"DEBUG: textedit.py validate_and_update EMTER obtain_language={doc_lang}")
+    adoc_lang = []
     if doc_lang is not None:
-        try:
-            mlang = Language.from_name(doc_lang.replace('_', '-'))
-        except ValueError as e:
-            raise e
-        set_lang[0] = get_rf_lang_code(mlang.code)  # .code.replace('-','_')
+        if isinstance(doc_lang, str):
+            adoc_lang.append(doc_lang)
+        for idx, lang in enumerate(adoc_lang):
+            try:
+                mlang = Language.from_name(lang.replace('_', '-').strip())
+            except ValueError as e:
+                raise e
+            set_lang[idx] = get_rf_lang_code(mlang.code)  # .code.replace('-','_')
     elif len(set_lang) > 0:
         if existing is not None:
             if isinstance(existing, list):
@@ -108,6 +112,7 @@ def obtain_language(existing, content):
                 set_lang[0] = 'en'
     else:
         set_lang[0] = 'en'
+    # print(f"DEBUG: textedit.py validate_and_update obtain_language RETURN ={[set_lang[0]]}")
     return [set_lang[0]]
 
 
@@ -229,12 +234,6 @@ def transform_doc_language(old_lang, new_lang, m_text, node_info: tuple = ('', )
     old_false_strings = old_lang_class.false_strings
     new_true_strings = new_lang_class.true_strings
     new_false_strings = new_lang_class.false_strings
-    en_lang_class = Language.from_name('English')
-    en_lang_given_prefixes = en_lang_class.given_prefixes
-    en_lang_when_prefixes = en_lang_class.when_prefixes
-    en_lang_then_prefixes = en_lang_class.then_prefixes
-    en_lang_and_prefixes = en_lang_class.and_prefixes
-    en_lang_but_prefixes = en_lang_class.but_prefixes
     sinal_correct_language = False  # If error in Language, do final replacement
     if node_info != ('', ):
         if node_info[0] == 'ERROR':
@@ -314,20 +313,6 @@ def transform_doc_language(old_lang, new_lang, m_text, node_info: tuple = ('', )
     for old, new in zip(old_lang_but_prefixes, new_lang_but_prefixes):
         m_text = re.sub(r"\s{2}"+fr"{old}"+r"\s", fr"  {new} ", m_text)
 
-    """
-    # Final translation from English
-    for en, new in zip(en_lang_given_prefixes, new_lang_given_prefixes):
-        m_text = re.sub(r"\s{2}"+fr"{en}"+r"\s", fr"  {new} ", m_text, flags=re.I)
-    for en, new in zip(en_lang_when_prefixes, new_lang_when_prefixes):
-        m_text = re.sub(r"\s{2}"+fr"{en}"+r"\s", fr"  {new} ", m_text, flags=re.I)
-    for en, new in zip(en_lang_then_prefixes, new_lang_then_prefixes):
-        m_text = re.sub(r"\s{2}"+fr"{en}"+r"\s", fr"  {new} ", m_text, flags=re.I)
-    for en, new in zip(en_lang_and_prefixes, new_lang_and_prefixes):
-        m_text = re.sub(r"\s{2}"+fr"{en}"+r"\s", fr"  {new} ", m_text, flags=re.I)
-    for en, new in zip(en_lang_but_prefixes, new_lang_but_prefixes):
-        m_text = re.sub(r"\s{2}"+fr"{en}"+r"\s", fr"  {new} ", m_text, flags=re.I)
-    """
-
     # Before ending, we replace broken keywords from excluded known bad tanslations
     m_text = transform_standard_keywords(new_lang_name, m_text)
     # print(f"DEBUG: texteditor.py transform_doc_language {m_text=}")
@@ -458,14 +443,40 @@ def _open(self):
             self._save_flag = 0
             if hasattr(datafile_controller, 'language'):
                 if datafile_controller.language is not None:
-                    self._doc_language = self._editor.language = datafile_controller.language
+                    self._set_shared_doc_lang(datafile_controller.language)
                     # print(f"DEBUG: texteditor _open  SET FROM CONTROLLER language={self._doc_language}")
                 else:
-                    self._doc_language = self._editor.language = ['en']
+                    self._set_shared_doc_lang('en')
+                self._editor.language = self._doc_language
             # print(f"DEBUG: texteditor _open language={self._doc_language}")
             self._open_data_for_controller(datafile_controller)
             self._editor.store_position()
 
+    def _get_shared_doc_lang(self):
+        try:
+            set_lang = shared_memory.ShareableList(name="language")
+        except AttributeError:  # Unittests fails here
+            set_lang = []
+        if set_lang is not None:
+            self._doc_language = set_lang[0]
+        else:
+            self._doc_language = 'en'
+        return self._doc_language
+
+    def _set_shared_doc_lang(self, lang='en'):
+        # print(f"DEBUG: textedit.py TextEditorPlugin _set_shared_doc_lang ENTER"
+        #       f" params: {lang=}")
+        if isinstance(lang, list):
+            lang = lang[0]
+        # Shared memory to store language definition
+        try:
+            set_lang = shared_memory.ShareableList([lang], name="language")
+        except FileExistsError:  # Other instance created file
+            set_lang = shared_memory.ShareableList(name="language")
+        except AttributeError:  # Unittests fails here
+            set_lang = []
+        self._doc_language = set_lang[0] = lang
+
     def on_data_changed(self, message):
         """ This block is now inside try/except to avoid errors from unit test """
         try:
@@ -622,24 +633,45 @@ def __init__(self, plugin, lang=None):
         self._last_answer = None
         self._last_answer_time = 0
         self._editor = None
+        if lang is not None:
+            self._doc_language = lang
+        else:
+            self._get_shared_doc_lang()
+
+    def _get_shared_doc_lang(self):
         try:
             set_lang = shared_memory.ShareableList(name="language")
         except AttributeError:  # Unittests fails here
             set_lang = []
         if set_lang is not None:
             self._doc_language = set_lang[0]
-        elif lang is not None:
-            self._doc_language = lang
         else:
             self._doc_language = 'en'
+        return self._doc_language
+
+    def _set_shared_doc_lang(self, lang='en'):
+        # print(f"DEBUG: textedit.py _set_shared_doc_lang ENTER"
+        #       f" params: {lang=}")
+        if isinstance(lang, list):
+            lang = lang[0]
+        # Shared memory to store language definition
+        try:
+            set_lang = shared_memory.ShareableList([lang], name="language")
+        except FileExistsError:  # Other instance created file
+            set_lang = shared_memory.ShareableList(name="language")
+        except AttributeError:  # Unittests fails here
+            set_lang = []
+        self._doc_language = set_lang[0] = lang
 
     def set_editor(self, editor):
         self._editor = editor
 
     def validate_and_update(self, data, text, lang='en'):
         from robotide.lib.robot.errors import DataError
         m_text = text.decode("utf-8")
-        initial_lang = lang if lang is not None else self._doc_language  # self._doc_language or
+        # print(f"DEBUG: textedit.py validate_and_update ENTER"
+        #       f" params: {lang=} doc_language={self._doc_language}")
+        initial_lang = lang  # if lang is not None else self._doc_language self._doc_language or
         if LANG_SETTING in m_text:
             try:
                 self._doc_language = obtain_language(lang, text)
@@ -659,8 +691,11 @@ def validate_and_update(self, data, text, lang='en'):
         except DataError as err:
             result = (err.message, err.details)
 
+        # print(f"DEBUG: textedit.py validate_and_update Language after sanity_check result={result}\n"
+        #       f" lang params: {initial_lang=}, {self._doc_language=}")
         if isinstance(result, tuple):
             m_text = transform_doc_language(initial_lang, self._doc_language, m_text, node_info=result)
+        __ = self._get_shared_doc_lang()
         try:
             result = self._sanity_check(data, m_text)  # Check if language changed and is valid content
         except DataError as err:
@@ -669,6 +704,8 @@ def validate_and_update(self, data, text, lang='en'):
             handled = self._handle_sanity_check_failure(result)
             if not handled:
                 return False
+        # Save language
+        self._set_shared_doc_lang(self._doc_language)
         if self._editor.reformat:
             data.update_from(data.format_text(m_text))
         else:
@@ -1346,9 +1383,10 @@ def content_save(self, **args):
         if self.dirty and not self.is_saving:
             self.is_saving = True
             # print(f"DEBUG: TextEditor.py SourceEditor content_save content={self.source_editor.utf8_text}\n"
-            #       f"self.language={self.language} data={self._data}")
+            #       f"self.language={self.language} data={self._data}"
+            #       f" calling validate_and_update with lang={args['lang']}")
             if not self._data_validator.validate_and_update(self._data, self.source_editor.utf8_text,
-                                                            lang=args['lang']):  #self.language)
+                                                            lang=self.language):  # args['lang']
                 self.is_saving = False
                 return False
         return True

src/robotide/lib/compat/parsing/language.py

@@ -108,6 +108,9 @@ def read(path):
                 else:
                     content = row
                 lang = content[len('Language:'):].strip()
+                mlang = lang.split(',')
+                if len(mlang) > 1:
+                    lang = mlang[:]
     return lang
 
 

src/robotide/lib/robot/parsing/model.py

@@ -600,6 +600,7 @@ def __init__(self, parent, tasks):
         _Table.__init__(self, parent)
         self.tasks = tasks
         self.doc = Documentation(self.get_localized_setting_name('Documentation'), self)
+        self.suite_name = Documentation(self.get_localized_setting_name('Name'), self)
         self.suite_setup = Fixture(self.get_localized_setting_name('Suite Setup'), self)
         self.suite_teardown = Fixture(self.get_localized_setting_name('Suite Teardown'), self)
         self.test_setup = Fixture(self.get_localized_setting_name('Task Setup'
@@ -670,7 +671,8 @@ class TestCaseFileSettingTable(_SettingTable):
                 'Library': lambda s: s.imports.populate_library,
                 'Resource': lambda s: s.imports.populate_resource,
                 'Variables': lambda s: s.imports.populate_variables,
-                'Metadata': lambda s: s.metadata.populate}
+                'Metadata': lambda s: s.metadata.populate,
+                'Name': lambda s: s.suite_name.populate}
     _aliases = {'Task Setup': 'Test Setup',
                 'Task Teardown': 'Test Teardown',
                 'Task Template': 'Test Template',
@@ -689,7 +691,7 @@ def __init__(self, parent, tasks, language=None):
                                                    'Task Tags', 'Test Tags',
                                                    'Task Template', 'Test Template',
                                                    'Task Timeout', 'Test Timeout',  'Library',
-                                                   'Resource', 'Variables', 'Metadata'])
+                                                   'Resource', 'Variables', 'Metadata', 'Name'])
         """
         'Task Setup' if self.tasks else 'Test Setup',
                                                    'Task Teardown' if self.tasks else 'Test Teardown',
@@ -702,7 +704,7 @@ def __init__(self, parent, tasks, language=None):
         # print(f"DEBUG: model.py TestCaseFileSettings INIT ENTER language={language} aliases={self._aliases}")
 
     def __iter__(self):
-        for setting in [self.doc, self.suite_setup, self.suite_teardown,
+        for setting in [self.doc, self.suite_name, self.suite_setup, self.suite_teardown,
                         self.test_setup, self.test_teardown, self.force_tags,
                         self.default_tags, self.test_tags, self.test_template, self.test_timeout] \
                         + self.metadata.data + self.imports.data:
@@ -743,7 +745,8 @@ class InitFileSettingTable(_SettingTable):
                 'Library': lambda s: s.imports.populate_library,
                 'Resource': lambda s: s.imports.populate_resource,
                 'Variables': lambda s: s.imports.populate_variables,
-                'Metadata': lambda s: s.metadata.populate}
+                'Metadata': lambda s: s.metadata.populate,
+                'Name': lambda s: s.suite_name.populate}
 
     def __init__(self, parent, tasks=False, language=None):
         self.tasks = tasks
@@ -756,7 +759,7 @@ def __init__(self, parent, tasks=False, language=None):
                                                              'Task Timeout', 'Test Timeout',
                                                              'Force Tags',
                                                              'Task Tags', 'Test Tags', 'Library',
-                                                             'Resource', 'Variables', 'Metadata'])
+                                                             'Resource', 'Variables', 'Metadata', 'Name'])
         """
                                                                      'Task Setup' if self.tasks else 'Test Setup',
                                                              'Task Teardown' if self.tasks else 'Test Teardown',
@@ -767,7 +770,7 @@ def __init__(self, parent, tasks=False, language=None):
         _SettingTable.__init__(self, parent, tasks)
 
     def __iter__(self):
-        for setting in [self.doc, self.suite_setup, self.suite_teardown,
+        for setting in [self.doc, self.suite_name, self.suite_setup, self.suite_teardown,
                         self.test_setup, self.test_teardown, self.force_tags, self.test_tags,
                         self.test_timeout] + self.metadata.data + self.imports.data:
             yield setting

src/robotide/version.py

@@ -15,4 +15,4 @@
 #
 # Automatically generated by `tasks.py`.
 
-VERSION = 'v2.1dev77'
+VERSION = 'v2.1dev78'