#22 Поддержка функции ОбщегоНазначенияКлиентСервер.СвернутьМассив() (#42

)

Возвращать типизированный массив как входящий тип

CHANGELOG.md

@@ -8,6 +8,7 @@
 * Поддержка функции ОбщегоНазначения.ОписаниеСвойствОбъекта()
 * Поддержка функции ОбщегоНазначения.СкопироватьРекурсивно()
 * Документация Markdown в составе плагина
+* Поддержка функции ОбщегоНазначенияКлиентСервер.СвернутьМассив()
 * Поддержка функции ОбщегоНазначенияКлиентСервер.РазностьМассивов()
 * Поддержка функции ОбщегоНазначенияКлиентСервер.ЗначениеВМассиве()
 * Поддержка функции ОбщегоНазначения.ВыгрузитьКолонку()

README.md

@@ -45,6 +45,7 @@
 
 Позволяет налету вычислять функции общего модуля `ОбщегоНазначенияКлиентСервер` (`CommonClientServer`), которые возвращают тип в зависимости от переданных параметров.
 
+* `СвернутьМассив`(`CollapseArray`) - возвращает типизированный массив на основе типа расчитанного по первому параметру
 * `РазностьМассивов`(`ArraysDifference`) - возвращает типизированный массив на основе типа расчитанного по первому параметру
 * `ЗначениеВМассиве`(`ValueInArray`) - возвращает типизированный массив с типом первого параметра
 

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

@@ -66,6 +66,11 @@
             name="ObjectPropertiesDetails"
             nameRu="ОписаниеСвойствОбъекта">
       </computers>
+      <computers
+            computer="com.e1c.ssl.bsl.internal.ExecutableExtensionFactory:com.e1c.ssl.bsl.CommonFunctionCollapseArrayTypesComputer"
+            name="CollapseArray"
+            nameRu="СвернутьМассив">
+      </computers>
       <computers
             computer="com.e1c.ssl.bsl.internal.ExecutableExtensionFactory:com.e1c.ssl.bsl.CommonFunctionArraysDifferenceTypesComputer"
             name="ArraysDifference"

bundles/com.e1c.ssl.bsl/src/com/e1c/ssl/bsl/CommonFunctionCollapseArrayTypesComputer.java

@@ -0,0 +1,56 @@
+/*******************************************************************************
+ * Copyright (C) 2021, 1C-Soft LLC and others.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     1C-Soft LLC - initial API and implementation
+ *******************************************************************************/
+package com.e1c.ssl.bsl;
+
+import java.util.Collections;
+import java.util.List;
+
+import org.eclipse.xtext.EcoreUtil2;
+
+import com._1c.g5.v8.dt.bsl.model.Expression;
+import com._1c.g5.v8.dt.bsl.model.Invocation;
+import com._1c.g5.v8.dt.mcore.Environmental;
+import com._1c.g5.v8.dt.mcore.TypeItem;
+
+/**
+ * Extension computer of invocation types of 1C:SSL API module function {@code CommonClientServer.CollapseArray()} that
+ * returns the typed array.
+ *
+ * @author Artem Iliukhin
+ *
+ */
+public class CommonFunctionCollapseArrayTypesComputer
+    extends AbstractCommonModuleObjectAttributeValueTypesComputer
+{
+
+    @Override
+    public List<TypeItem> getTypes(Invocation inv)
+    {
+        if (inv.getParams().size() != 1)
+            return Collections.emptyList();
+
+        if (!isValidClientServerModuleNameInvocation(inv))
+            return Collections.emptyList();
+
+        Expression expr = inv.getParams().get(0);
+        if (expr != null)
+        {
+            Environmental envs = EcoreUtil2.getContainerOfType(expr, Environmental.class);
+            return this.getTypesComputer().computeTypes(expr, envs.environments());
+        }
+
+        return Collections.emptyList();
+
+    }
+
+}

docs/README.md

@@ -38,6 +38,7 @@
 
 * [`РазностьМассивов` (`ArraysDifference`)](common-client-server-arrays-difference.md)
 * [`ЗначениеВМассиве` (`ValueInArray`)](common-client-server-value-in-array.md)
+* [`СвернутьМассив` (`CollapseArray`)](common-client-server-collapse-array.md)
 
 Позволяет на лету вычислять функции общего модуля `ОбщегоНазначенияКлииент` (`CommonClient`)
 

docs/common-client-server-collapse-array.md

@@ -0,0 +1,21 @@
+# `ОбщегоНазначенияКлиентСервер.СвернутьМассив` (`CommonClientServer.CollapseArray`)
+
+Описание функции:
+
+> Возвращает копию исходного массива с уникальными значениями.
+
+## Типизация возвращаемых значений
+
+Функция возвращает типизированный массив как входящий тип.
+
+Пример:
+
+```bsl
+Процедура Тест()
+
+    Товары = Новый Массив; // Массив из СправочникСсылка.Товары -
+    УникальныеТовары = ОбщегоНазначенияКлиентСервер.СвернутьМассив(Товары);
+    УникальныйТовар = УникальныеТовары.Получить(0);
+    
+КонецПроцедуры
+```

docs/toc.xml

@@ -45,6 +45,9 @@
       <topic href="html/common-client-subsystem-exist.html" label="ОбщегоНазначенияКлиент.ПодсистемаСуществует">
          <anchor id="common-client-subsystem-exist"/>
       </topic>
+      <topic href="html/common-client-server-collapse-array.html" label="ОбщегоНазначенияКлиентСервер.СвернутьМассив">
+         <anchor id="common-client-server-collapse-array"/>
+      </topic>
       <topic href="html/common-client-arrays-difference.html" label="ОбщегоНазначенияКлиентСервер.РазностьМассивов">
          <anchor id="common-client-arrays-difference"/>
       </topic>

tests/com.e1c.ssl.bsl.itests/resources/common-functions/collapse-array.bsl

@@ -0,0 +1,8 @@
+
+Процедура Тест()
+
+    Товары = Новый Массив; // Массив из СправочникСсылка.Товары -
+    УникальныеТовары = ОбщегоНазначенияКлиентСервер.СвернутьМассив(Товары);
+    УникальныйТовар = УникальныеТовары.Получить(0);
+
+КонецПроцедуры

tests/com.e1c.ssl.bsl.itests/src/com/e1c/ssl/bsl/itests/BslCommonFunctionsTest.java

@@ -1086,6 +1086,40 @@ public void testFunctionObjectPropertiesDetails() throws Exception
         restoreState(oldFileContent, oldFile);
     }
 
+    @Test
+    public void testFunctionCollapseArray() throws Exception
+    {
+        this.oldFile = project.getFile(Path.fromPortableString(PATH_COMMON_MODULE_TEST));
+        BufferedReader reader =
+            new BufferedReader(new InputStreamReader(oldFile.getContents(true), StandardCharsets.UTF_8));
+        this.oldFileContent = reader.lines().collect(Collectors.joining(System.lineSeparator()));
+        File newFile = new File(FOLDER_NAME + "common-functions/collapse-array.bsl"); //$NON-NLS-1$
+        replaceFileContent(oldFile, newFile);
+
+        Module module = getBslModule(PROJECT_NAME, PATH_COMMON_MODULE_TEST);
+        assertEquals(1, module.allMethods().size());
+        Method method = module.allMethods().get(0);
+        assertEquals(3, method.getStatements().size());
+        Expression array = getRightExpr(method.getStatements().get(2));
+        Environmental envs = EcoreUtil2.getContainerOfType(array, Environmental.class);
+
+        List<TypeItem> types = typesComputer.computeTypes(array, envs.environments())
+            .stream()
+            .filter(t -> !IEObjectTypeNames.ARBITRARY.equalsIgnoreCase(McoreUtil.getTypeName(t)))
+            .collect(Collectors.toList());
+
+        assertEquals(1, types.size());
+
+        TypeItem type = types.get(0);
+
+        assertTrue(type instanceof Type);
+
+        assertEquals("CatalogRef.Товары", McoreUtil.getTypeName(type)); //$NON-NLS-1$
+
+        restoreState(oldFileContent, oldFile);
+
+    }
+
     @Test
     public void testFunctionArraysDifference() throws Exception
     {

tests/com.e1c.ssl.bsl.itests/workspace/CommonFunctions/src/CommonModules/ОбщегоНазначенияКлиентСервер/Module.bsl

@@ -1,4 +1,52 @@
 
+// Возвращает копию исходного массива с уникальными значениями.
+//
+// Параметры:
+//  Массив - Массив - массив произвольных значений.
+//
+// Возвращаемое значение:
+//  Массив - массив уникальных элементов.
+//
+Функция СвернутьМассив(Знач Массив) Экспорт
+	Результат = Новый Массив;
+	ДополнитьМассив(Результат, Массив, Истина);
+	Возврат Результат;
+КонецФункции
+
+// Дополняет массив МассивПриемник значениями из массива МассивИсточник.
+//
+// Параметры:
+//  МассивПриемник - Массив - массив, в который необходимо добавить значения.
+//  МассивИсточник - Массив - массив значений для заполнения.
+//  ТолькоУникальныеЗначения - Булево - если истина, то в массив будут включены только уникальные значения.
+//
+Процедура ДополнитьМассив(МассивПриемник, МассивИсточник, ТолькоУникальныеЗначения = Ложь) Экспорт
+
+	Если ТолькоУникальныеЗначения Тогда
+
+		УникальныеЗначения = Новый Соответствие;
+
+		Для Каждого Значение Из МассивПриемник Цикл
+			УникальныеЗначения.Вставить(Значение, Истина);
+		КонецЦикла;
+
+		Для Каждого Значение Из МассивИсточник Цикл
+			Если УникальныеЗначения[Значение] = Неопределено Тогда
+				МассивПриемник.Добавить(Значение);
+				УникальныеЗначения.Вставить(Значение, Истина);
+			КонецЕсли;
+		КонецЦикла;
+
+	Иначе
+
+		Для Каждого Значение Из МассивИсточник Цикл
+			МассивПриемник.Добавить(Значение);
+		КонецЦикла;
+
+	КонецЕсли;
+
+КонецПроцедуры
+
 // Возвращает разность массивов. Разностью двух массивов является массив, содержащий
 // все элементы первого массива, не существующие во втором массиве.
 //