Features/bcs metaborders

docs/diagnostics/MetadataBorders.md

@@ -0,0 +1,75 @@
+# Границы метаданных (MetadataBorders)
+
+|      Тип      |    Поддерживаются<br>языки    |     Важность     |    Включена<br>по умолчанию    |    Время на<br>исправление (мин)    |   Теги   |
+|:-------------:|:-----------------------------:|:----------------:|:------------------------------:|:-----------------------------------:|:--------:|
+| `Дефект кода` |         `BSL`<br>`OS`         | `Информационный` |             `Нет`              |                 `1`                 | `design` |
+
+## Параметры
+
+
+|             Имя             |   Тип    |                                        Описание                                         |    Значение<br>по умолчанию    |
+|:---------------------------:|:--------:|:---------------------------------------------------------------------------------------:|:------------------------------:|
+| `metadataBordersParameters` | `Строка` | `{"регулярное выражение для операторов":"регулярное выражение для имени файла модуля"}` |               ``               |
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Описание диагностики
+Диагностика обращения к метаданным за пределами разрешенных границ. Нужна, если в компании установлены,
+например, правила обращения к каким-то метаданным только из определенного общего модуля.
+
+## Примеры
+Получение контактной информации по внутренним правилам должно происходить только через функции
+общего модуля РаботаСКонтактами. Тогда заданные настройки вида
+
+```json
+{"Регистры?Сведений.КонтактнаяИнформация":"CommonModules/РаботаСКонтактами"}
+```
+
+вызовут срабатывание диагностики на запросе с текстом
+
+```
+"ВЫБРАТЬ
+    ...
+ИЗ
+    РегистрСведений.КонтактнаяИнформация КАК КИ"
+```
+
+если этот запрос будет НЕ в общем модуле РаботаСКонтактами.
+Так же эта диагностика с такой настройкой сработает и на оператор
+
+```НаборЗаписей = РегистрыСведений.КонтактнаяИнформация.СоздатьНаборЗаписей();```
+
+В настройках обе части - это регулярные выражения java.
+Вторая часть настройки сравнивается с путем к файлу выгрузки конфигурации.
+
+Можно запретить использование нескольких метаданных:
+
+```json
+{"Регистры?Сведений.КонтактнаяИнформация|Справочники?.Контакты":"CommonModules/РаботаСКонтактами"}
+```
+
+Настройки задаются в виде json-строки:
+```json
+{ 
+   "Регистры?Сведений.КонтактнаяИнформация":"CommonModules/РаботаСКонтактами",
+   "Справочники?.СтрокиСоединения":"DataProcessors/ВнешниеСоединения|CommonModules/ПодключениеК.*"
+}
+```
+
+## Источники
+
+## Сниппеты
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Экранирование кода
+
+```bsl
+// BSLLS:MetadataBorders-off
+// BSLLS:MetadataBorders-on
+```
+
+### Параметр конфигурационного файла
+
+```json
+"MetadataBorders": {
+    "metadataBordersParameters": ""
+}
+```

docs/en/diagnostics/MetadataBorders.md

@@ -0,0 +1,44 @@
+# Metadata borders (MetadataBorders)
+
+|     Type     |        Scope        | Severity |    Activated<br>by default    |    Minutes<br>to fix    |   Tags   |
+|:------------:|:-------------------:|:--------:|:-----------------------------:|:-----------------------:|:--------:|
+| `Code smell` |    `BSL`<br>`OS`    |  `Info`  |             `No`              |           `1`           | `design` |
+
+## Parameters
+
+
+|            Name             |   Type   |                     Description                     | Default value |
+|:---------------------------:|:--------:|:---------------------------------------------------:|:-------------:|
+| `metadataBordersParameters` | `String` | `{"regex for statements":"regex for module names"}` |      ``       |
+<!-- Блоки выше заполняются автоматически, не трогать -->
+## Description
+<!-- Описание диагностики заполняется вручную. Необходимо понятным языком описать смысл и схему работу -->
+
+## Examples
+<!-- В данном разделе приводятся примеры, на которые диагностика срабатывает, а также можно привести пример, как можно исправить ситуацию -->
+
+## Sources
+<!-- Необходимо указывать ссылки на все источники, из которых почерпнута информация для создания диагностики -->
+<!-- Примеры источников
+
+* Источник: [Стандарт: Тексты модулей](https://its.1c.ru/db/v8std#content:456:hdoc)
+* Полезная информация: [Отказ от использования модальных окон](https://its.1c.ru/db/metod8dev#content:5272:hdoc)
+* Источник: [Cognitive complexity, ver. 1.4](https://www.sonarsource.com/docs/CognitiveComplexity.pdf) -->
+
+## Snippets
+
+<!-- Блоки ниже заполняются автоматически, не трогать -->
+### Diagnostic ignorance in code
+
+```bsl
+// BSLLS:MetadataBorders-off
+// BSLLS:MetadataBorders-on
+```
+
+### Parameter for config
+
+```json
+"MetadataBorders": {
+    "metadataBordersParameters": ""
+}
+```

src/main/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic.java

@@ -0,0 +1,109 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <nixel2007@gmail.com> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.type.MapType;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticMetadata;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticParameter;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticSeverity;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticTag;
+import com.github._1c_syntax.bsl.languageserver.diagnostics.metadata.DiagnosticType;
+import com.github._1c_syntax.bsl.parser.BSLParser;
+import com.github._1c_syntax.utils.CaseInsensitivePattern;
+import org.antlr.v4.runtime.tree.ParseTree;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+@DiagnosticMetadata(
+  type = DiagnosticType.CODE_SMELL,
+  severity = DiagnosticSeverity.INFO,
+  minutesToFix = 1,
+  activatedByDefault = false,
+  tags = {
+    DiagnosticTag.DESIGN
+  }
+
+)
+public class MetadataBordersDiagnostic extends AbstractVisitorDiagnostic {
+
+  private static final String METADATA_BORDERS_DEFAULT = "";
+
+  @DiagnosticParameter(
+    type = String.class,
+    defaultValue = ""
+  )
+  private Map<Pattern, Pattern> metadataBordersParameters = mapFromJSON(METADATA_BORDERS_DEFAULT);
+
+  private List<Pattern> statementPatterns = Collections.emptyList();
+
+  private static Map<Pattern, Pattern> mapFromJSON(String userSettings) {
+    ObjectMapper mapper = new ObjectMapper();
+    MapType mapType = mapper.getTypeFactory().constructMapType(HashMap.class, String.class, String.class);
+    try {
+      Map<String, String> stringMap = mapper.readValue(userSettings, mapType);
+      return stringMap.entrySet().stream()
+        .filter(entry -> !entry.getKey().isBlank() && !entry.getValue().isBlank())
+        .collect(Collectors.toMap(
+          entry -> CaseInsensitivePattern.compile(entry.getKey()),
+          entry -> CaseInsensitivePattern.compile(entry.getValue())));
+    } catch (JsonProcessingException e) {
+      return Collections.emptyMap();
+    }
+  }
+
+  @Override
+  public void configure(Map<String, Object> configuration) {
+    metadataBordersParameters = mapFromJSON(
+              (String) configuration.getOrDefault("metadataBordersParameters", METADATA_BORDERS_DEFAULT));
+  }
+
+  @Override
+  public ParseTree visitFile(BSLParser.FileContext ctx) {
+    statementPatterns = metadataBordersParameters.entrySet().stream()
+                      .filter(entry -> ! entry.getValue().matcher(documentContext.getUri().getPath()).find())
+                      .map(Map.Entry::getKey)
+                      .collect(Collectors.toList());
+
+    return super.visitFile(ctx);
+  }
+
+  @Override
+  public ParseTree visitStatement(BSLParser.StatementContext ctx){
+
+    statementPatterns.forEach(pattern -> {
+      Matcher matcher = pattern.matcher(ctx.getText());
+      while (matcher.find()) {
+        diagnosticStorage.addDiagnostic(ctx);
+      }
+    });
+
+    return super.visitStatement(ctx);
+  }
+}

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/parameters-schema.json

@@ -1138,6 +1138,24 @@
             },
             "$id": "#/definitions/MagicNumber"
         },
+        "MetadataBorders": {
+            "description": "Metadata borders",
+            "default": false,
+            "type": [
+                "boolean",
+                "object"
+            ],
+            "title": "Metadata borders",
+            "properties": {
+                "metadataBordersParameters": {
+                    "description": "{\"regex for statements\":\"regex for module names\"}",
+                    "default": "",
+                    "type": "string",
+                    "title": "{\"regex for statements\":\"regex for module names\"}"
+                }
+            },
+            "$id": "#/definitions/MetadataBorders"
+        },
         "MetadataObjectNameLength": {
             "description": "Metadata object names must not exceed the allowed length",
             "default": true,

src/main/resources/com/github/_1c_syntax/bsl/languageserver/configuration/schema.json

@@ -29,9 +29,6 @@
                 "AssignAliasFieldsInQuery": {
                     "$ref": "parameters-schema.json#/definitions/AssignAliasFieldsInQuery"
                 },
-                "BadWords": {
-                    "$ref": "parameters-schema.json#/definitions/BadWords"
-                },
                 "BeginTransactionBeforeTryCatch": {
                     "$ref": "parameters-schema.json#/definitions/BeginTransactionBeforeTryCatch"
                 },
@@ -278,6 +275,9 @@
                 "MagicNumber": {
                     "$ref": "parameters-schema.json#/definitions/MagicNumber"
                 },
+                "MetadataBorders": {
+                    "$ref": "parameters-schema.json#/definitions/MetadataBorders"
+                },
                 "MetadataObjectNameLength": {
                     "$ref": "parameters-schema.json#/definitions/MetadataObjectNameLength"
                 },

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_en.properties

@@ -0,0 +1,4 @@
+diagnosticMessage=Use metadata outside the borders
+diagnosticName=Metadata borders
+metadataBordersParameters={"regex for statements":"regex for module names"}
+

src/main/resources/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnostic_ru.properties

@@ -0,0 +1,3 @@
+diagnosticMessage=Обращение к метаданным за пределами разрешенных границ
+diagnosticName=Границы метаданных
+metadataBordersParameters={"регулярное выражение для операторов":"регулярное выражение для имени файла модуля"}

src/test/java/com/github/_1c_syntax/bsl/languageserver/diagnostics/MetadataBordersDiagnosticTest.java

@@ -0,0 +1,86 @@
+/*
+ * This file is a part of BSL Language Server.
+ *
+ * Copyright (c) 2018-2021
+ * Alexey Sosnoviy <labotamy@gmail.com>, Nikita Gryzlov <nixel2007@gmail.com> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * BSL Language Server is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3.0 of the License, or (at your option) any later version.
+ *
+ * BSL Language Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with BSL Language Server.
+ */
+package com.github._1c_syntax.bsl.languageserver.diagnostics;
+
+import org.eclipse.lsp4j.Diagnostic;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.Map;
+
+import static com.github._1c_syntax.bsl.languageserver.util.Assertions.assertThat;
+
+class MetadataBordersDiagnosticTest extends AbstractDiagnosticTest<MetadataBordersDiagnostic> {
+  MetadataBordersDiagnosticTest() {
+    super(MetadataBordersDiagnostic.class);
+  }
+
+  @Test
+  void testWithoutSettings() {
+    List<Diagnostic> diagnostics = getDiagnostics();
+    assertThat(diagnostics).hasSize(0);
+  }
+
+  @Test
+  void testMatchesInProperModule() {
+
+    Map<String, Object> configuration = diagnosticInstance.info.getDefaultConfiguration();
+    configuration.put("metadataBordersParameters",
+                      "{\"Регистры?Сведений.КонтактнаяИнформация|Справочники?.Контакты\":\"fake-uri\"}");
+    diagnosticInstance.configure(configuration);
+    List<Diagnostic> diagnostics = getDiagnostics();
+
+    assertThat(diagnostics).hasSize(0);
+  }
+
+  @Test
+  void testMatchesInWrongModule() {
+
+    Map<String, Object> configuration = diagnosticInstance.info.getDefaultConfiguration();
+    configuration.put("metadataBordersParameters",
+                      "{\"Регистры?Сведений.КонтактнаяИнформация|Справочники?.Контакты\":\"MetadataBordersDiagnostic\"}");
+    diagnosticInstance.configure(configuration);
+    List<Diagnostic> diagnostics = getDiagnostics();
+
+    assertThat(diagnostics).hasSize(3);
+    assertThat(diagnostics, true)
+      .hasRange(3, 0, 6, 49)
+      .hasRange(8, 0, 8, 69)
+      .hasRange(10, 0, 10, 103);
+  }
+
+  @Test
+  void testSeveralSettings() {
+
+    Map<String, Object> configuration = diagnosticInstance.info.getDefaultConfiguration();
+    configuration.put("metadataBordersParameters",
+      "{\"Регистры?Сведений.КонтактнаяИнформация\":\"fake-uri\"," +
+          "\"Справочники?.Контакты\":\"MetadataBordersDiagnostic\"}");
+    diagnosticInstance.configure(configuration);
+
+    List<Diagnostic> diagnostics = getDiagnostics();
+
+    assertThat(diagnostics).hasSize(1);
+    assertThat(diagnostics, true)
+      .hasRange(10, 0, 10, 103);
+  }
+}

src/test/resources/diagnostics/MetadataBordersDiagnostic.bsl

@@ -0,0 +1,11 @@
+// в комментарии срабатываний быть не должно РегистрыСведений.КонтактнаяИнформация
+
+Запрос = Новый Запрос;
+Запрос.Текст = "ВЫБРАТЬ
+|   КИ.ЗначениеКонтакта КАК Адрес
+|ИЗ
+|   РегистрСведений.КонтактнаяИнформация КАК КИ";                     //срабатывание
+
+Адреса = РегистрыСведений.КонтактнаяИнформация.СоздатьНаборЗаписей();  //срабатывание
+
+АдресИзСправочника = ЗначениеРеквизитаОбъекта(Справочники.Контакты.НайтиПоКоду(1), "ЗначениеКонтакта"); // срабатывание