RevitPackageDocumentation: Добавлен плагин "Документация комплекта" (#473)

Author: DivinN

.github/workflows/publish.RevitPackageDocumentation.yml

@@ -0,0 +1,33 @@
+name: publish RevitPackageDocumentation
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [ closed, synchronize, review_requested ]
+    branches: [ main, master ]
+    paths:
+      - '**RevitPackageDocumentation**.cs'
+      - '**RevitPackageDocumentation**.xaml'
+
+env:
+  plugin-name: "RevitPackageDocumentation"
+  
+jobs:
+  build:
+    name: build
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      
+      # Install the .NET workload
+      - name: Install .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+      
+      - name: Run './build.cmd '
+        run: ./build.cmd publish --profile ${{ env.plugin-name }} --pull-request-merged ${{ github.event.pull_request.merged }} --extensions-app-token ${{ secrets.EXTENSIONS_APP_TOKEN }} --revit-plugins-app-token ${{ secrets.REVIT_PLUGINS_APP_TOKEN }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.nuke/parameters.RevitPackageDocumentation.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "./build.schema.json",
+  "Solution": "RevitPlugins.slnx",
+  "PluginName": "RevitPackageDocumentation",
+  "PublishDirectory": "03.KR.extension\\КР.tab\\bin",
+  "RevitVersions": [
+    "Rv2022",
+    "Rv2023",
+    "Rv2024"
+  ],
+  "IconUrl": "https://icons8.com/icon/RmqYpunlNguf/selective-highlighting",
+  "BundleName": "Документация комплекта",
+  "BundleType": "InvokeButton",
+  "BundleOutput": "03.KR.extension\\КР.tab\\Документация.panel"
+}

RevitPlugins.slnx

@@ -155,6 +155,9 @@
   <Project Path="src/RevitOverridingGraphicsInViews/RevitOverridingGraphicsInViews.csproj">
     <Platform Project="x64" />
   </Project>
+  <Project Path="src/RevitPackageDocumentation/RevitPackageDocumentation.csproj">
+    <Platform Project="x64" />
+  </Project>
   <Project Path="src/RevitParamsChecker/RevitParamsChecker.csproj">
     <Platform Project="x64" />
   </Project>

src/RevitPackageDocumentation/Models/ComponentTypeItem.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace RevitPackageDocumentation.Models;
+public class ComponentTypeItem {
+    public Type ComponentType { get; set; }
+    public string DisplayName { get; set; }
+
+    public ComponentTypeItem(Type type, string displayName) {
+        ComponentType = type;
+        DisplayName = displayName;
+    }
+}

src/RevitPackageDocumentation/Models/ConfigSerializer/PluginParamConverter.cs

@@ -0,0 +1,55 @@
+using System;
+
+using dosymep.SimpleServices;
+
+using pyRevitLabs.Json;
+using pyRevitLabs.Json.Linq;
+
+namespace RevitPackageDocumentation.Models.ConfigSerializer;
+
+/// <summary>
+/// Конвертер для полиморфной десериализации параметров плагина
+/// </summary>
+public class PluginParamConverter : JsonConverter {
+    private readonly ILocalizationService _localizationService;
+
+    private const string _pluginParamTypeProperty = "PluginParamType";
+    private const string _stringParamType = "StringParam";
+    private const string _selectElemParamType = "SelectElem";
+
+    public PluginParamConverter(ILocalizationService localizationService) {
+        _localizationService = localizationService;
+    }
+
+    public override bool CanConvert(Type objectType) {
+        return objectType == typeof(PluginParamData);
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) {
+        var jObject = JObject.Load(reader);
+        var paramType = jObject[_pluginParamTypeProperty]?.Value<string>();
+
+        if(string.IsNullOrEmpty(paramType))
+            throw new JsonSerializationException(
+                $"{_localizationService.GetLocalizedString("MainViewModel.Property")} '{_pluginParamTypeProperty}' " +
+                $"{_localizationService.GetLocalizedString("MainViewModel.NotFoundInJSON")}");
+
+        try {
+            return paramType switch {
+                _stringParamType => jObject.ToObject<StringParamData>(serializer),
+                _selectElemParamType => jObject.ToObject<SelectElemParamData>(serializer),
+                _ => throw new NotSupportedException(
+                    $"{_localizationService.GetLocalizedString("MainViewModel.UnknownPluginParamType")}: {paramType}")
+            };
+        } catch(Exception ex) {
+            throw new JsonSerializationException(
+                $"{_localizationService.GetLocalizedString("MainViewModel.ErrorDeserializingType")} '{paramType}'", ex);
+        }
+    }
+
+    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) {
+        serializer.Serialize(writer, value);
+    }
+
+    public override bool CanWrite => true;
+}

src/RevitPackageDocumentation/Models/ConfigSerializer/SheetComponentConverter.cs

@@ -0,0 +1,65 @@
+using System;
+
+using dosymep.SimpleServices;
+
+using pyRevitLabs.Json;
+using pyRevitLabs.Json.Linq;
+
+namespace RevitPackageDocumentation.Models.ConfigSerializer;
+
+/// <summary>
+/// Конвертер для полиморфной десериализации компонентов листа
+/// </summary>
+public class SheetComponentConverter : JsonConverter {
+    private readonly ILocalizationService _localizationService;
+
+    private const string _componentTypeProperty = "ComponentType";
+    private const string _structuralPlanViewType = "PlanView";
+    private const string _structuralCalloutViewType = "CalloutView";
+    private const string _sectionViewType = "SectionView";
+    private const string _scheduleViewType = "ScheduleView";
+    private const string _textNoteType = "TextNote";
+    private const string _typicalAnnotationType = "TypicalAnnotation";
+    private const string _legendViewType = "LegendView";
+
+    public SheetComponentConverter(ILocalizationService localizationService) {
+        _localizationService = localizationService;
+    }
+
+    public override bool CanConvert(Type objectType) {
+        return objectType == typeof(SheetComponentData);
+    }
+
+    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) {
+        var jObject = JObject.Load(reader);
+        var componentType = jObject[_componentTypeProperty]?.Value<string>();
+
+        if(string.IsNullOrEmpty(componentType))
+            throw new JsonSerializationException(
+                $"{_localizationService.GetLocalizedString("MainViewModel.Property")} '{_componentTypeProperty}' " +
+                $"{_localizationService.GetLocalizedString("MainViewModel.NotFoundInJSON")}");
+
+        try {
+            return componentType switch {
+                _structuralPlanViewType => jObject.ToObject<PlanViewData>(serializer),
+                _structuralCalloutViewType => jObject.ToObject<CalloutViewData>(serializer),
+                _sectionViewType => jObject.ToObject<SectionViewData>(serializer),
+                _scheduleViewType => jObject.ToObject<ScheduleViewData>(serializer),
+                _textNoteType => jObject.ToObject<TextNoteData>(serializer),
+                _typicalAnnotationType => jObject.ToObject<TypicalAnnotationData>(serializer),
+                _legendViewType => jObject.ToObject<LegendViewData>(serializer),
+                _ => throw new NotSupportedException(
+                    $"{_localizationService.GetLocalizedString("MainViewModel.UnknownComponentType")}: {componentType}")
+            };
+        } catch(Exception ex) {
+            throw new JsonSerializationException(
+                $"{_localizationService.GetLocalizedString("MainViewModel.ErrorDeserializingType")} '{componentType}'", ex);
+        }
+    }
+
+    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) {
+        serializer.Serialize(writer, value);
+    }
+
+    public override bool CanWrite => true;
+}