Finish v0.16.0

Author: theshadowco

.coderabbit.yaml

@@ -0,0 +1,3 @@
+reviews:
+  path_filters:
+    - "!src/test/resources/**"

.github/workflows/gh-pages.yml

@@ -31,7 +31,7 @@ jobs:
       run: ./gradlew --no-daemon javadoc
 
     - name: Set up Python
-      uses: actions/setup-python@v5.6.0
+      uses: actions/setup-python@v6.0.0
       with:
         python-version: '3.10'
         architecture: 'x64'

.gitignore

@@ -19,3 +19,4 @@ Gradle_*.xml
 *.cf
 **/ConfigDumpInfo.xml
 **/.metadata/
+benchmark-results/**

benchmark-analyze-results.py

@@ -7,14 +7,15 @@ plugins {
     jacoco
     id("org.cadixdev.licenser") version "0.6.1"
     id("me.qoomon.git-versioning") version "6.4.4"
-    id("io.freefair.lombok") version "8.14.2"
-    id("io.freefair.javadoc-links") version "8.14.2"
-    id("io.freefair.javadoc-utf-8") version "8.14.2"
-    id("io.freefair.maven-central.validate-poms") version "8.14.2"
-    id("com.github.ben-manes.versions") version "0.52.0"
+    id("io.freefair.lombok") version "9.0.0"
+    id("io.freefair.javadoc-links") version "9.0.0"
+    id("io.freefair.javadoc-utf-8") version "9.0.0"
+    id("io.freefair.maven-central.validate-poms") version "9.0.0"
+    id("com.github.ben-manes.versions") version "0.53.0"
     id("ru.vyarus.pom") version "3.0.0"
-    id("org.jreleaser") version "1.19.0"
-    id("org.sonarqube") version "6.2.0.5505"
+    id("org.jreleaser") version "1.20.0"
+    id("org.sonarqube") version "7.0.0.6105"
+    id("me.champeau.jmh") version "0.7.3"
 }
 
 group = "io.github.1c-syntax"
@@ -44,6 +45,7 @@ gitVersioning.apply {
 repositories {
     mavenLocal()
     mavenCentral()
+    maven("https://central.sonatype.com/repository/maven-snapshots")
 }
 
 dependencies {
@@ -57,9 +59,11 @@ dependencies {
 
     // прочее
     implementation("commons-io", "commons-io", "2.18.0")
-    implementation("io.github.1c-syntax", "utils", "0.6.3")
-    implementation("io.github.1c-syntax", "bsl-common-library", "0.8.1")
-    implementation("io.github.1c-syntax", "supportconf", "0.14.3")
+    implementation("io.github.1c-syntax", "bsl-common-library", "0.9.0")
+    implementation("io.github.1c-syntax", "utils", "0.6.4")
+    implementation("io.github.1c-syntax", "supportconf", "0.15.0") {
+        exclude("io.github.1c-syntax", "bsl-common-library")
+    }
 
     // быстрый поиск классов
     implementation("io.github.classgraph", "classgraph", "4.8.179")
@@ -75,6 +79,10 @@ dependencies {
 
     // логирование
     testImplementation("org.slf4j", "slf4j-reload4j", "2.1.0-alpha1")
+
+    // бенчмарк
+    jmh("org.openjdk.jmh:jmh-core:1.37")
+    jmhAnnotationProcessor("org.openjdk.jmh:jmh-generator-annprocess:1.37")
 }
 
 java {
@@ -92,6 +100,14 @@ sourceSets {
     }
 }
 
+jmh {
+    warmupIterations = 3
+    iterations = 5
+    fork = 2
+    resultFormat = "JSON"
+    resultsFile = file("build/jmh-results.json")
+}
+
 tasks.test {
     useJUnitPlatform()
     testLogging {
@@ -138,7 +154,10 @@ sonar {
         property("sonar.projectKey", "1c-syntax_mdclasses")
         property("sonar.projectName", "MDClasses")
         property("sonar.exclusions", "**/resources/**/*.*")
-        property("sonar.coverage.jacoco.xmlReportPaths", "${layout.buildDirectory.get()}/reports/jacoco/test/jacoco.xml")
+        property(
+            "sonar.coverage.jacoco.xmlReportPaths",
+            "${layout.buildDirectory.get()}/reports/jacoco/test/jacoco.xml"
+        )
     }
 }
 

benchmark-compare.sh

@@ -9,6 +9,7 @@
 - [Работа с метаданными](#работа-с-метаданными)
 - [Работа с формами](#работа-с-формами)
 - [Работа с модулями](#работа-с-модулями)
+- [Анализ типов данных](#анализ-типов-данных)
 - [Поиск и фильтрация объектов](#поиск-и-фильтрация-объектов)
 - [Практические сценарии](#практические-сценарии)
 
@@ -269,6 +270,139 @@ allModules.stream()
     });
 ```
 
+## Анализ типов данных
+
+При чтении описания метаданных для объектов и их атрибутов вычисляются описания типов. Все сущности, имеющие описания типов данных, реализуют интерфейс `ValueTypeOwner`. 
+
+Ниже приведены примеры, как можно использовать данную информацию.
+
+### Получение описания типа реквизита справочника
+
+Часть описания реквизита справочника
+
+```xml
+  <attributes uuid="dff5b5d8-762d-4490-a336-dcc8d93c17d5">
+    <name>Реквизит2</name>
+    <type>
+      <types>Number</types>
+      <numberQualifiers>
+        <precision>10</precision>
+      </numberQualifiers>
+    </type>
+    <minValue xsi:type="core:UndefinedValue"/>
+    <maxValue xsi:type="core:UndefinedValue"/>
+    <fillValue xsi:type="core:UndefinedValue"/>
+    <fullTextSearch>Use</fullTextSearch>
+  </attributes>
+```
+
+Код, которым можно посмотреть описание типа
+
+```java
+// найдем справочник из прочитанной конфигурации
+var childMDO = configuration.findChild("Catalog.Справочник1");
+
+// проверим, что это на самом деле справочник    
+if (childMDO.isPresent() && childMDO.get() instanceof Catalog catalog) {
+    
+    // убедимся, что у справочника есть дочерние
+    assertThat(catalog.getChildren()).isNotEmpty();
+    
+    // найдем нужный дочерний (реквизит)
+    var childAttribute = catalog.findChild(md -> "Реквизит2".equals(md.getName()));
+
+    // проверим, что он есть и нужного типа  
+    if (childAttribute.isPresent() && childAttribute.get() instanceof ObjectAttribute objectAttribute) {
+        
+        // проверим наименование 
+        assertThat(objectAttribute.getName()).isEqualTo("Реквизит2");
+        
+        // описание типа доступно через getValueType()
+        assertThat(objectAttribute.getValueType()).isNotNull();
+        // убедимся в наличии примитивного типа СТРОКА в составе описания
+        assertThat(objectAttribute.getValueType().contains(PrimitiveValueType.NUMBER)).isTrue();
+        // убедимся, что тип не составной
+        assertThat(objectAttribute.getValueType().isComposite()).isFalse();
+        // убедимся, что квалификаторы прочитаны
+        assertThat(objectAttribute.getValueType().getQualifiers()).hasSize(1);
+
+        // убедимся, что прочитан квалификатор числа
+        var qualifier = objectAttribute.getValueType().getQualifiers().get(0);
+        assertThat(qualifier).isInstanceOf(NumberQualifiers.class);
+
+        // убедимся, что квалификатор числа содежржит верную информацию
+        var numberQualifiers = (NumberQualifiers) qualifier;
+        assertThat(numberQualifiers.getPrecision()).isEqualTo(10); // длина 10
+        assertThat(numberQualifiers.getScale()).isEqualTo(0);      // точность 0
+        assertThat(numberQualifiers.isNonNegative()).isFalse();    // возможны любые знаки
+      }
+    }
+}
+```
+
+### Определение состава определяемого типа 
+
+Часть описания определяемого типа
+
+```xml
+  <name>ЗначениеДоступа</name>
+  <type>
+    <types>CatalogRef.ПапкиФайлов</types>
+    <types>CatalogRef.ВнешниеПользователи</types>
+    <types>CatalogRef.КлючиДоступа</types>
+    <types>CatalogRef.ИдентификаторыОбъектовРасширений</types>
+    <types>CatalogRef.ГруппыВнешнихПользователей</types>
+    <types>CatalogRef.ГруппыПользователей</types>
+    <types>EnumRef.ДополнительныеЗначенияДоступа</types>
+    <types>ChartOfCharacteristicTypesRef.ДополнительныеРеквизитыИСведения</types>
+    <types>CatalogRef.ДополнительныеОтчетыИОбработки</types>
+    <types>CatalogRef.Пользователи</types>
+    <types>CatalogRef.ГруппыИсполнителейЗадач</types>
+    <types>CatalogRef.УчетныеЗаписиЭлектроннойПочты</types>
+    <types>CatalogRef.ИдентификаторыОбъектовМетаданных</types>
+  </type>
+```
+
+Код, которым можно посмотреть описание типа
+
+```java
+
+// найдем определяемый тип прочитанной конфигурации
+var childMDO = configuration.findChild("DefinedType.ЗначениеДоступа");
+if (childMDO.isPresent() && childMDO.get() instanceof DefinedType definedType) {
+    assertThat(definedType.getName()).isEqualTo("ЗначениеДоступа");
+    // убедимся, что тип прочитан
+    assertThat(definedType.getValueType()).isNotNull();
+    // убедимся, что в составе нет ЧИСЛА
+    assertThat(definedType.getValueType().contains(PrimitiveValueType.NUMBER)).isFalse();
+    // убедимся, что описание соответствует составному типу
+    assertThat(definedType.getValueType().isComposite()).isTrue();
+    // квалификаторов нет
+    assertThat(definedType.getValueType().getQualifiers()).isEmpty();
+
+    // создадим тип по имени
+    var typeContains = MetadataValueType.fromString("EnumRef.ДополнительныеЗначенияДоступа");
+
+    assertThat(typeContains).isNotNull();
+    // полученный тип относится к перечислению
+    assertThat(typeContains.getKind()).isEqualTo(MDOType.ENUM);
+    // тип не составной
+    assertThat(typeContains.isComposite()).isFalse();
+    // есть имя на английском
+    assertThat(typeContains.getName()).isEqualTo("EnumRef.ДополнительныеЗначенияДоступа");
+    // и русском  
+    assertThat(typeContains.getNameRu()).isEqualTo("ПеречислениеСсылка.ДополнительныеЗначенияДоступа");
+
+    // второй тип
+    var typeNotContains = MetadataValueType.fromString("CatalogRef.Контрагенты");
+    assertThat(typeNotContains).isNotNull();
+    // убедимся, что первый тип входит в состав описания
+    assertThat(definedType.getValueType().contains(typeContains)).isTrue();
+    // убедимся, что второй тип не входит в состав
+    assertThat(definedType.getValueType().contains(typeNotContains)).isFalse();
+}
+```
+
 ## Поиск и фильтрация объектов
 
 ### Поиск объекта по ссылке

build.gradle.kts

@@ -22,7 +22,7 @@
 
 ## Поддерживаемые метаданные
 
-На данный момент поддерживается загрузка всех видов метаданных, существующих в версиях платформы 1С до 8.3.24. В заивисимости от типа объекта и потребностей, объем читаемой информации может различаться (реализация чтения дополнительной информации выполняется от задач).
+На данный момент поддерживается загрузка всех видов метаданных, существующих в версиях платформы 1С до 8.5. В зависимости от типа объекта и потребностей, объем читаемой информации может различаться (реализация чтения дополнительной информации выполняется от задач).
 Актуальное содержимое того или иного вида объекта метаданных можно всегда находится в классе его реализации в пакете [mdo](com.github._1c_syntax.bsl.mdo).
 
 Немного о структуре пакета:

docs/ru/examples.md

@@ -0,0 +1,89 @@
+/*
+ * This file is a part of MDClasses.
+ *
+ * Copyright (c) 2019 - 2025
+ * Tymko Oleg <olegtymko@yandex.ru>, Maximov Valery <maximovvalery@gmail.com> and contributors
+ *
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ *
+ * MDClasses 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.
+ *
+ * MDClasses 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 MDClasses.
+ */
+package com.github._1c_syntax.bsl.mdclasses.benchmark;
+
+import com.github._1c_syntax.bsl.mdclasses.MDCReadSettings;
+import com.github._1c_syntax.bsl.mdclasses.MDClasses;
+import org.openjdk.jmh.annotations.Benchmark;
+import org.openjdk.jmh.annotations.BenchmarkMode;
+import org.openjdk.jmh.annotations.Fork;
+import org.openjdk.jmh.annotations.Measurement;
+import org.openjdk.jmh.annotations.Mode;
+import org.openjdk.jmh.annotations.OutputTimeUnit;
+import org.openjdk.jmh.annotations.Scope;
+import org.openjdk.jmh.annotations.Setup;
+import org.openjdk.jmh.annotations.State;
+import org.openjdk.jmh.annotations.Warmup;
+import org.openjdk.jmh.infra.Blackhole;
+
+import java.nio.file.Path;
+import java.util.concurrent.TimeUnit;
+
+@BenchmarkMode(Mode.AverageTime)
+@OutputTimeUnit(TimeUnit.MILLISECONDS)
+@State(Scope.Thread)
+@Warmup(iterations = 3, time = 2)
+@Measurement(iterations = 5, time = 3)
+@Fork(2)
+public class MDClassesBenchmark {
+
+  private final Path configPathEDT = Path.of("src/test/resources/ext/edt/ssl_3_1/configuration");
+  private final Path configPathDesigner = Path.of("src/test/resources/ext/designer/ssl_3_1/src/cf");
+  private static final MDCReadSettings SKIP_ALL = MDCReadSettings.builder()
+    .skipSupport(true)
+    .skipRoleData(true)
+    .skipFormElementItems(true)
+    .skipXdtoPackage(true)
+    .skipDataCompositionSchema(true)
+    .build();
+
+  @Setup
+  public void setup() {
+    // Предварительная загрузка для разогрева
+    MDClasses.createConfiguration(configPathEDT);
+    MDClasses.createConfiguration(configPathDesigner);
+  }
+
+  @Benchmark
+  public void test_EDT_CreateConfiguration_SkipSupport_False(Blackhole blackhole) {
+    var model = MDClasses.createConfiguration(configPathEDT);
+    blackhole.consume(model);
+  }
+
+  @Benchmark
+  public void test_EDT_CreateConfiguration_SkipSupport_True(Blackhole blackhole) {
+    var model = MDClasses.createConfiguration(configPathEDT, SKIP_ALL);
+    blackhole.consume(model);
+  }
+
+  @Benchmark
+  public void test_Designer_CreateConfiguration_SkipSupport_False(Blackhole blackhole) {
+    var model = MDClasses.createConfiguration(configPathDesigner);
+    blackhole.consume(model);
+  }
+
+  @Benchmark
+  public void test_Designer_CreateConfiguration_SkipSupport_True(Blackhole blackhole) {
+    var model = MDClasses.createConfiguration(configPathDesigner, SKIP_ALL);
+    blackhole.consume(model);
+  }
+}