Проверка модификации ключей структуры вне функции-конструктора #1054

CHANGELOG.md

@@ -19,6 +19,8 @@
 #### Код модулей
 
 - Проверка на уникальность имени поля в doc-comment-field-name #1392
+- Проверка модификации ключей структуры вне функции-конструктора #1054
+
 
 #### Запросы
 

bundles/com.e1c.v8codestyle.bsl/markdown/ru/structure-key-modification.md

@@ -0,0 +1,68 @@
+# Модификация ключа структуры вне функции-конструктора
+
+Если Структура создана функцией-конструктором, то изменение состава ключей структуры методами 
+`Структура.Вставить("Ключ", ...); Структура.Удалить("Ключ"); Структура.Очистить();` 
+может приводить к ошибкам из-за неопределенности состава данных.
+
+## Неправильно
+
+Неправильно удалять все ключи структуры, удалять ключ или заменять ключ внешней структуры.
+
+```bsl
+// @strict-types
+
+Процедура Неправильно1() Экспорт
+
+	ТестоваяСтруктура = Конструктор();
+	ТестоваяСтруктура.Очистить(); 
+	ТестоваяСтруктура.Вставить("Ключ1", 10); 
+	ТестоваяСтруктура.Удалить("Ключ2"); 
+
+КонецПроцедуры
+
+// Возвращаемое значение:
+//  Структура:
+// * Ключ1 - Булево - 
+// * Ключ2 - Число - 
+Функция Конструктор() Экспорт
+
+	ТестоваяСтруктура = новый Структура("Ключ1, Ключ2", Истина, 10);
+	ТестоваяСтруктура.Вставить("Ключ2", 20);
+
+	Возврат ТестоваяСтруктура; 
+
+КонецФункции
+```
+
+## Правильно
+
+Обращаться к существующему ключу необходимо напрямую и устанавливать новое значение.
+Вместо удаления ключа необходимо устанавливать значение, которое представляет пустое или начальное значение.
+
+```bsl
+// @strict-types
+
+Процедура Правильно1() Экспорт
+
+	ТестоваяСтруктура = Конструктор();
+	ТестоваяСтруктура.Ключ1 = false; 
+	ТестоваяСтруктура.Ключ2 = -1; 
+
+КонецПроцедуры
+
+// Возвращаемое значение:
+//  Структура:
+// * Ключ1 - Булево - 
+// * Ключ2 - Число - 
+Функция Конструктор() Экспорт
+
+	ТестоваяСтруктура = новый Структура("Ключ1, Ключ2", Истина, 10);
+	ТестоваяСтруктура.Вставить("Ключ2", 20);
+
+	Возврат ТестоваяСтруктура; 
+
+КонецФункции
+```
+
+## См.
+

bundles/com.e1c.v8codestyle.bsl/markdown/structure-key-modification.md

@@ -0,0 +1,69 @@
+# Structure key modification outside constructor function
+
+If Structure was created by constructor function then changing the composition of the structure keys using methods
+`Structure.Insert("Key", ...); Structure.Delete("Key"); Structure.Clear();` 
+can lead to errors due to the uncertainty of data composition.
+
+
+## Noncompliant Code Example
+
+Should not clear all structure keys, delete key or replace key of external structure.
+
+```bsl
+// @strict-types
+
+Procedure Incorrect1() Export
+
+	TestStucture = Constructor();
+	TestStucture.Clear(); 
+	TestStucture.Insert("Key1", 10); 
+	TestStucture.Delete("Key2"); 
+
+EndProcedure
+
+// Returns:
+//  Structure:
+// * Key1 - Boolean - 
+// * Key2 - Number - 
+Function Constructor() Export
+
+	TestStucture = new Structure("Key1, Key2", true, 10);
+	TestStucture.Insert("Key2", 20);
+
+	Return TestStucture; 
+
+EndFunction
+```
+
+## Compliant Solution
+
+Access to existing key directly and set new value. 
+Instead of delete key should set a value that represents blank or initial value.
+
+```bsl
+// @strict-types
+
+Procedure Correct1() Export
+
+	TestStucture = Constructor();
+	TestStucture.Key1 = false; 
+	TestStucture.Key2 = -1; 
+
+EndProcedure
+
+// Returns:
+//  Structure:
+// * Key1 - Boolean - 
+// * Key2 - Number - 
+Function Constructor() Export
+
+	TestStucture = new Structure("Key1, Key2", true, 10);
+	TestStucture.Insert("Key2", 10);
+
+	Return TestStucture; 
+
+EndFunction
+```
+
+## See
+

bundles/com.e1c.v8codestyle.bsl/plugin.xml

@@ -132,6 +132,10 @@
             category="com.e1c.v8codestyle.bsl.strict"
             class="com.e1c.v8codestyle.internal.bsl.ExecutableExtensionFactory:com.e1c.v8codestyle.bsl.strict.check.TypedValueAddingToUntypedCollectionCheck">
       </check>
+      <check
+            category="com.e1c.v8codestyle.bsl.strict"
+            class="com.e1c.v8codestyle.internal.bsl.ExecutableExtensionFactory:com.e1c.v8codestyle.bsl.strict.check.StructureKeyModificationCheck">
+      </check>
       <check
             category="com.e1c.v8codestyle.bsl"
             class="com.e1c.v8codestyle.internal.bsl.ExecutableExtensionFactory:com.e1c.v8codestyle.bsl.check.EventHandlerBooleanParamCheck">

bundles/com.e1c.v8codestyle.bsl/src/com/e1c/v8codestyle/bsl/strict/check/Messages.java

@@ -58,6 +58,14 @@ final class Messages
     public static String StructureCtorValueTypeCheck_Structure_key__N__K__has_no_default_value_initializer;
     public static String StructureCtorValueTypeCheck_Structure_key__N__K__value_initialized_with_empty_types;
     public static String StructureCtorValueTypeCheck_title;
+    public static String StructureKeyModificationCheck_Check_Clear_method;
+    public static String StructureKeyModificationCheck_Check_Delete_method;
+    public static String StructureKeyModificationCheck_Check_Insert_method;
+    public static String StructureKeyModificationCheck_description;
+    public static String StructureKeyModificationCheck_error_message_Clear;
+    public static String StructureKeyModificationCheck_error_message_Delete;
+    public static String StructureKeyModificationCheck_error_message_Insert;
+    public static String StructureKeyModificationCheck_title;
     public static String TypedValueAddingToUntypedCollectionCheck_description;
     public static String TypedValueAddingToUntypedCollectionCheck_title;
     public static String VariableTypeCheck_description;