Merge pull request #91 from 1c-syntax/develop

Релиз 0.5

Author: otymko

.github/workflows/qa.yml

@@ -0,0 +1,28 @@
+name: QA
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+
+jobs:
+  QA:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.event.repository.full_name
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: ''
+      - run: |
+          git fetch --prune --unshallow
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: SonarCloud Scan
+        run: ./gradlew check sonarqube
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

build.gradle.kts

@@ -22,9 +22,12 @@ repositories {
 val junitVersion = "5.5.2"
 dependencies {
 
+    // https://mvnrepository.com/artifact/io.vavr/vavr
+    implementation("io.vavr", "vavr", "0.10.2")
+    implementation("org.apache.commons", "commons-collections4", "4.4")
+
     implementation("com.fasterxml.jackson.dataformat", "jackson-dataformat-xml", "2.10.3")
     implementation("com.fasterxml.jackson.module", "jackson-module-parameter-names", "2.10.3")
-
     // логирование
     implementation("org.slf4j", "slf4j-api", "1.8.0-beta4")
     implementation("org.slf4j", "slf4j-simple", "1.8.0-beta4")
@@ -68,6 +71,17 @@ tasks.test {
     }
 }
 
+tasks.check {
+    dependsOn(tasks.jacocoTestReport)
+}
+
+tasks.jacocoTestReport {
+    reports {
+        xml.isEnabled = true
+        xml.destination = File("$buildDir/reports/jacoco/test/jacoco.xml")
+    }
+}
+
 tasks.withType<JavaCompile> {
     options.encoding = "UTF-8"
     options.compilerArgs.add("-Xlint:unchecked")
@@ -82,6 +96,7 @@ sonarqube {
         property("sonar.projectKey", "1c-syntax_mdclasses")
         property("sonar.projectName", "MDClasses")
         property("sonar.exclusions", "**/gen/**/*.*")
+        property("sonar.coverage.jacoco.xmlReportPaths", "$buildDir/reports/jacoco/test/jacoco.xml")
     }
 }
 
@@ -108,3 +123,10 @@ license {
             "**/*.os",
             "**/*.bsl"))
 }
+
+tasks.register("precommit") {
+    description = "Run all precommit tasks"
+    group = "Developer tools"
+    dependsOn(":test")
+    dependsOn(":licenseFormat")
+}

src/main/java/com/github/_1c_syntax/mdclasses/deserialize/AbstractDeserializer.java

@@ -0,0 +1,137 @@
+/*
+ * This file is a part of MDClasses.
+ *
+ * Copyright © 2019 - 2020
+ * Tymko Oleg <[email protected]>, Maximov Valery <[email protected]> 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.mdclasses.deserialize;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonToken;
+import com.fasterxml.jackson.core.TreeNode;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.node.NullNode;
+import com.github._1c_syntax.mdclasses.utils.ObjectMapperFactory;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Класс реализация кастомной десериализации XML файлов конфигурации.
+ * В дочерних классах необходимо реализовать только метод чтение свойства readToken
+ */
+abstract class AbstractDeserializer extends JsonDeserializer<Object> {
+
+  protected final String rootKey;
+
+  protected AbstractDeserializer(String key) {
+    rootKey = key;
+  }
+
+  @Override
+  public Map<String, Object> deserialize(
+    JsonParser parser,
+    DeserializationContext context
+  ) throws IOException {
+    Map<String, Object> childObjects = new HashMap<>();
+
+    if (parser.getCurrentToken() != JsonToken.START_OBJECT) {
+      return childObjects;
+    }
+
+    int level = 1;
+    while (parser.nextToken() != null) {
+      var token = parser.getCurrentToken();
+      var name = parser.getCurrentName();
+
+      // скрректируем уровень, для того, чтобы вовремя выйти
+      level = correctLevel(name, token, level);
+      if (level == 0) {
+        break;
+      }
+
+      // обрабатываем только свойства
+      if (token == JsonToken.FIELD_NAME) {
+        readToken(parser, childObjects, name, context);
+      }
+    }
+    return childObjects;
+  }
+
+  protected abstract void readToken(JsonParser parser,
+                                    Map<String, Object> childObjects,
+                                    String name,
+                                    DeserializationContext context) throws IOException;
+
+  private int correctLevel(String name, JsonToken token, int level) {
+    var isRoot = rootKey.equals(name);
+    if (isRoot && token == JsonToken.END_OBJECT) {
+      level--;
+    } else if (isRoot && token == JsonToken.START_OBJECT) {
+      level++;
+    }
+
+    return level;
+  }
+
+  protected boolean isEndToken(String name, JsonParser parser) throws IOException {
+    return parser.getCurrentToken() == JsonToken.END_OBJECT && name.equals(parser.getCurrentName());
+  }
+
+  protected String getValueFromNode(TreeNode node) {
+    if (node instanceof NullNode) {
+      return null;
+    }
+    return getValueFromNode(node, String.class);
+  }
+
+  protected <T> T getValueFromNode(TreeNode node, Class<T> classValue) {
+    return ObjectMapperFactory.getXmlMapper().convertValue(node, classValue);
+  }
+
+  protected <T> T readValueByType(JsonParser parser, Class<T> classValue) throws IOException {
+    return ObjectMapperFactory.getXmlMapper().readValue(parser, classValue);
+  }
+
+  protected void addProperty(Map<String, Object> childObjects, String name, Object newValue) {
+    var value = childObjects.get(name);
+    if (value == null) {
+      childObjects.put(name, newValue);
+    } else if (value instanceof List) {
+      List<Object> values = new ArrayList<>((Collection<?>) value);
+      values.add(newValue);
+      childObjects.put(name, values);
+    } else {
+      List<Object> values = new ArrayList<>();
+      values.add(value);
+      values.add(newValue);
+      childObjects.put(name, values);
+    }
+  }
+
+  protected void readAndAddProperty(Map<String, Object> childObjects, String name, JsonParser parser) throws IOException {
+    var newValue = getValueFromNode(parser.readValueAsTree());
+    addProperty(childObjects, name, newValue);
+  }
+
+}

src/main/java/com/github/_1c_syntax/mdclasses/deserialize/ChildObjectsDeserializer.java

@@ -0,0 +1,80 @@
+/*
+ * This file is a part of MDClasses.
+ *
+ * Copyright © 2019 - 2020
+ * Tymko Oleg <[email protected]>, Maximov Valery <[email protected]> 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.mdclasses.deserialize;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.github._1c_syntax.mdclasses.mdo.Attribute;
+import com.github._1c_syntax.mdclasses.mdo.Command;
+import com.github._1c_syntax.mdclasses.mdo.Dimension;
+import com.github._1c_syntax.mdclasses.mdo.Resource;
+import com.github._1c_syntax.mdclasses.mdo.TabularSection;
+import com.github._1c_syntax.mdclasses.metadata.additional.MDOType;
+
+import java.io.IOException;
+import java.util.Map;
+
+public class ChildObjectsDeserializer extends AbstractDeserializer {
+
+  private static final String COMMAND_KEY = "Command";
+  private static final String SUBSYSTEM_KEY = "Subsystem";
+  private static final String DIMENSION_KEY = "Dimension";
+  private static final String RESOURCE_KEY = "Resource";
+  private static final String ATTRIBUTE_KEY = "Attribute";
+  private static final String TABULAR_SECTION_KEY = "TabularSection";
+
+  public ChildObjectsDeserializer() {
+    super("ChildObjects");
+  }
+
+  @Override
+  protected void readToken(JsonParser parser,
+                           Map<String, Object> childObjects,
+                           String name,
+                           DeserializationContext context) throws IOException {
+    if (name.equals(COMMAND_KEY)) {
+      parser.nextToken();
+      var newValue = getValueFromNode(parser.readValueAsTree(), Command.class);
+      addProperty(childObjects, name, newValue);
+    } else if (name.equals(SUBSYSTEM_KEY)) {
+      parser.nextToken();
+      var newValue = MDOType.SUBSYSTEM.getName() + "." + getValueFromNode(parser.readValueAsTree());
+      addProperty(childObjects, name, newValue);
+    } else if (name.equals(DIMENSION_KEY)) {
+      parser.nextToken();
+      var newValue = getValueFromNode(parser.readValueAsTree(), Dimension.class);
+      addProperty(childObjects, ATTRIBUTE_KEY, newValue);
+    } else if (name.equals(RESOURCE_KEY)) {
+      parser.nextToken();
+      var newValue = getValueFromNode(parser.readValueAsTree(), Resource.class);
+      addProperty(childObjects, ATTRIBUTE_KEY, newValue);
+    } else if (name.equals(ATTRIBUTE_KEY)) {
+      parser.nextToken();
+      var newValue = getValueFromNode(parser.readValueAsTree(), Attribute.class);
+      addProperty(childObjects, ATTRIBUTE_KEY, newValue);
+    } else if (name.equals(TABULAR_SECTION_KEY)) {
+      parser.nextToken();
+      var newValue = readValueByType(parser, TabularSection.class);
+      addProperty(childObjects, ATTRIBUTE_KEY, newValue);
+    }
+  }
+}

src/main/java/com/github/_1c_syntax/mdclasses/deserialize/PropertiesDeserializer.java

@@ -0,0 +1,74 @@
+/*
+ * This file is a part of MDClasses.
+ *
+ * Copyright © 2019 - 2020
+ * Tymko Oleg <[email protected]>, Maximov Valery <[email protected]> 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.mdclasses.deserialize;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonToken;
+import com.fasterxml.jackson.databind.DeserializationContext;
+
+import java.io.IOException;
+import java.util.Map;
+
+public class PropertiesDeserializer extends AbstractDeserializer {
+
+  private static final String CONTENT_KEY = "Content";
+
+  protected PropertiesDeserializer() {
+    super("Properties");
+  }
+
+  @Override
+  protected void readToken(JsonParser parser,
+                           Map<String, Object> childObjects,
+                           String name,
+                           DeserializationContext context) throws IOException {
+
+    parser.nextToken(); // вошли во внутрь
+
+    if (parser.getCurrentToken() == JsonToken.START_OBJECT) {
+      if (name.equals(CONTENT_KEY)) {
+        readContent(parser, childObjects, name);
+      } else {
+        // объекты пропускаем
+        while (parser.nextToken() != null) {
+          if (isEndToken(name, parser)) {
+            break;
+          }
+        }
+      }
+    } else {
+      readAndAddProperty(childObjects, name, parser);
+    }
+  }
+
+  private void readContent(JsonParser parser, Map<String, Object> childObjects, String name) throws IOException {
+    while (parser.nextToken() != null) {
+      if (isEndToken(name, parser)) {
+        break;
+      }
+      parser.nextToken();
+      var value = parser.readValueAsTree();
+      var newValue = getValueFromNode(value.get(""));
+      addProperty(childObjects, name, newValue);
+    }
+  }
+}