Merge pull request #19 from apoddubny/rpiontik-main

Rpiontik main

Author: rpiontik

README.md

@@ -20,12 +20,11 @@
 7. [Управление процессом развертывания систем в кластерах](src/deployment_units_management)
 8. [Примеры запросов JSONata](src/jsonata_query_examples)
 9. [Пример структуры репозитория для управления архитектурой](src/repository_structure_example)
-10. [Формирования L1 контекста](src/l1_drilldown)
-11. [Кликабельные линки и пользовательский DSL](src/customdsl)
+10. [Пример формирования L1 контекста](src/l1_drilldown)
+11. [Примеры для кликабельных линков и пользовательского DSL](src/customdsl)
 12. [Развертывания DocHub](https://github.com/cu3blukekc/SwampHub)
 13. [Модификация метамодели для описания связей в собственном формате](src/new_links_format)
 
-
 ## Разворачивание
 
 1. Установите IntelliJ IDEA. Рекомендуется [Community Edition](https://www.jetbrains.com/idea/download/);

src/new_links_format/README.md

@@ -26,20 +26,40 @@ links:
       - orders.gateway
     title: Передача заказа
 ```
-Обязательными являются только параметры from/to. Новый параметр via позволяет отметить шлюз, через который работает связь между компонентами не создавая при этом двух отдельных сущностей.
+Обязательными являются только параметры from/to. Новый параметр via позволяет отметить шлюзы, через которые работает связь между компонентами.
+
+Также улучшена поддержка контекстов, добавлены свойства group.by и group.except. С помощью этих свойств можно несколько компонентов низкого уровня объеденить в один компонент более выского. Очень хорошо может помочь при рендеринге больших схем. В примере ниже компоненты orders.db, orders.backend будут отображены на схеме как один компонент orders. Внутри этого компонента отдельно будет отрисован компонент orders.gateway, т.к. он был исключен из группировки с помощью свойства except.
+
+```yaml
+contexts:
+  L2:
+    title: L2 уровень
+    location: L2
+    components:
+      - customer.*
+      - payments.*
+      - front.*
+    group:
+      by:
+        - orders
+      except:
+        - orders.gateway
+
+```
 
 # Особенности
 1. Связь между компонентами - это отдельный объект, который можно расширить.
 2. Несколько связей между компонентами на схемах группируется в одну. При клике по такой связи мы попадаем на страницу со списком.
 3. В SELF контексте компонента будут отображены все связи, которые у него существуют. Неважно при этом где они описаны. Также будут показаны связи, которые проходят через шлюзы. 
 4. Все связи всплывают наверх, если вы используете модель DDD, при всплытии также происходит группировка.
 5. Работает ТОЛЬКО с plantUML представлением.
-6. Корректно работает в случае указания элемнтов разного уровня на контекстной диаграмме. При этом прозводительность упадет.
+6. Реализована возможнсть упрощать схему с помощью объединения компонентов низкого уровня в один компонент уровнем выше.
+7. Корректно работает в случае указания элемнтов разного уровня на контекстной диаграмме. При этом прозводительность упадет.
 
 # Подключение:
 1. Заменить файлы, находящиеся в папке metamodel/dochub/entities/contexts на файлы в соотвествующей папке из примера.
 2. Использовать converter.json, которые сделает первичную конвертацию из формата старых ссылок в новый формат.
 3. Подключить файлы entities/links.yaml и datasets/links.yaml в архитектуру
-4. Добавить полученные данные в свойство "links:"
+4. Подключить файл с новыми данными.
 5. Старые связи можно не удалять
 

src/new_links_format/converter.jsonata

@@ -17,10 +17,10 @@
         }
       )
     );
-    $links{from & "-" & to:{
+    {"links": $links{from & "-" & to:{
       "from": from,
       "to": to,
       "title": title,
       "contract": contract
-    }}
+    }}}
 )

src/new_links_format/example.yaml

@@ -132,12 +132,18 @@ contexts:
     title: L2 уровень
     location: L2
     components:
-      - "*.*" # Отбираем все компоненты второго уровня
+      - customer.*
+      - payments.*
+      - front.*
+    group:
+      by:
+        - orders
+      except:
+        - orders.gateway
   L1:
     title: L1 уровень
     location: L1
     components:
       - front
       - auth
-      - orders
       - payments

src/new_links_format/metamodel/dochub/entities/contexts/base.yaml

@@ -126,7 +126,7 @@ entities:
             ? [$params.componentId]
             /* Если нет берем все компоненты указанные в контексте */
             : $context.components; 
-  
+        
           /* Если в контексте переопределена функция получения компонентов, используем ее*/
           $r := $context.api.fetchComponents ? (
             $eval($context.api.fetchComponents, $params)
@@ -158,29 +158,16 @@ entities:
           ))^($);
         )
 
-      oldFormToNew: >
-        (
-            $.components.$spread().(
-                $from := $keys();
-                $l := *.$;
-                $l.links.(
-                    $f := direction = "<--" or direction = "<-" or direction = "<---" or direction = "<-----" ? id : $from;
-                    $t := $f = id ? $from : id;
-                    {"from": $f, "to":$t, "contract":$.contract, "title": $.title, "direction": "-->"}
-                )
-            )
-        )
-
       # Генерирует список отображаемых связей
       # Входящие параметры:
       #   components - список компонентов в формате fetchComponents
       #   links - список ссылок
       #   required - список компонентов, явно добавленных в контекст
       fetchComponentsFromLinks: >
         (
-          $requiredComponents := required;
-          $components := components;
-          $links := links;
+          $requiredComponents := $.required;
+          $components := $.components;
+          $links := $.links;
           $neededComponents := $distinct($append($links.from, $links.to) ~> $append($requiredComponents.$keys()));
           $neededComponents.(
             $id := $;
@@ -189,8 +176,9 @@ entities:
               "entity": entity,
               "aspects": aspects
             }};          
-          )
+          );
         )
+      # нужно сделать правило, которые бы выводило ссылки с отствующим from или to, чтобы разбирать причины появления таких ссылок
       fetchLinks: >
         (
           $manifest := manifest;
@@ -213,7 +201,7 @@ entities:
             "title": *.title,
             "via": *.via,
             "contract": *.contract
-          };
+          }[from != ""];
 
           $c := $components.$spread().$keys().{"key":$};
 
@@ -306,14 +294,35 @@ entities:
               "contract": $contract,
               "title": $title
             }
-          )][from != to];
+          )];
+
+          $groupExternal := $.groups;
+          $except := $.exceptGroups;
+        
+          $s := $distinct($mainRes.(
+              [to, from]
+          ));
+          $grouped := $groupExternal.(
+              $e := $;
+              $s.(
+                  $r := $contains($, $e) and $not($ in $except);
+                  $r ? {"group": $e, "element":$, "is":$r}
+              )
+          );
+
+          $result := $mainRes.(
+              $data := $;
+              $from := $grouped[element = $data.from] ? $grouped[element = $data.from].group : $data.from;
+              $to := $grouped[element = $data.to] ? $grouped[element = $data.to].group : $data.to;
+              $merge([$data, {"from": $from, "to":$to}])
+          );
 
           $getMatched := function($array){(
               $v1 := ($array)[0];
               $sv1 := $split($v1, ".");
               $cnt := $count($sv1);
               $rf := $array;
-  
+        
               $rfr := $sv1#$i.(
                   $matcher := $join($split($v1, ".", $cnt-$i),".");
                   $res := $count([$filter($rf, function($v){
@@ -331,7 +340,7 @@ entities:
               $q;
           )};
 
-          $r:=$mainRes{from & "-" & to: (
+          $r:=$result{from & "-" & to: (
             $lFrom := $getMatched(realFrom);
             $lTo := $getMatched(realTo);
             $values := $count(from);
@@ -340,7 +349,7 @@ entities:
             $to := (to)[0];
             $title := $values > 1 ? (
               $r:=$domainLevel ? $split($to,".", $domainLevel) ~> $join(".") : ($services[$to in list])[0];
-              (fromServiceName)[0] & " -> " & ($lookup($components, $r).title)[0] & " (" & $cnt & ")"
+              ($lFrom != "" ? (fromServiceName)[0] : "*") & " -> " & ($lookup($components, $r).title)[0] & " (" & $cnt & ")"
             ) : title;
             {
               "from":(from)[0],

src/new_links_format/metamodel/dochub/entities/contexts/plantuml.yaml

@@ -20,7 +20,7 @@ entities:
           $manifest := manifest;
         
           $stopBracketsCount := function($a, $b) {$a = 0 ? "}\n" : $a & "}\n"};
-          
+        
           $join($map($areas, function($domain, $index) {(
               $result := "";
               $component := $lookup($components, $domain);
@@ -158,6 +158,8 @@ entities:
             $manifest := _source ? _source : $;
           
             $isExtraLinks := $not($string($context."extra-links") = "false");
+            $groups := [$context.group.by];
+            $exceptGroups := [$context.group.except];
           
             /* Получаем коллекцию дефолтных вспомогательных функций */
             $defFunctions := $manifest.entities.contexts.api;
@@ -185,7 +187,9 @@ entities:
             $links := $eval($context.api.fetchLinks ? $context.api.fetchLinks : $defFunctions.fetchLinks, {
               "manifest": $manifest,
               "extraLinks": $isExtraLinks,
-              "components": $components
+              "components": $components,
+              "groups": $groups,
+              "exceptGroups": $exceptGroups
             });
 
             $components := $eval($defFunctions.fetchComponentsFromLinks, {
@@ -206,7 +210,6 @@ entities:
               "components": $components
             });
 
-          
             /* Генерируем код связей */
             $linksCode := $eval($defFunctions.makePumlComponentsLinks, {
               "links": $links