File: MermaidPackageSerializer.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (165 lines) | stat: -rw-r--r-- 4,724 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import struct OrderedCollections.OrderedDictionary
import class PackageModel.Package
import class PackageModel.Product
import class PackageModel.Module

struct MermaidPackageSerializer {
    let package: Package
    var shouldIncludeLegend = false

    var renderedMarkdown: String {
        var subgraphs = OrderedDictionary<String, [Edge]>()
        subgraphs[package.identity.description] = package.products.productTargetEdges
        
        for edge in package.modules.targetDependencyEdges {
            if let subgraph = edge.to.subgraph {
                subgraphs[subgraph, default: []].append(edge)
            } else {
                subgraphs[package.identity.description]?.append(edge)
            }
        }

        return """
        ```mermaid
        flowchart TB
            \(
                shouldIncludeLegend ?
                    """
                    subgraph legend
                        legend:target(target)
                        legend:product[[product]]
                        legend:dependency{{package dependency}}
                    end

                    """ : ""
            )\(
                subgraphs.map { subgraph, edges in
                    """
                    subgraph \(subgraph)
                            \(
                                edges.map(\.description).joined(separator: "\n        ")
                            )
                        end
                    """
                }.joined(separator: "\n\n    ")
            )
        ```

        """
    }

    fileprivate struct Node {
        enum Border {
            case roundedCorners
            case doubled
            case hexagon

            func added(to title: String) -> String {
                switch self {
                case .roundedCorners:
                    "(\(title))"
                case .doubled:
                    "[[\(title)]]"
                case .hexagon:
                    "{{\(title)}}"
                }
            }
        }

        let id: String
        let title: String
        let border: Border
        let subgraph: String?
    }

    fileprivate struct Edge {
        let from: Node
        let to: Node
    }
}

extension MermaidPackageSerializer.Node {
    init(id: String, title: String) {
        self.id = id
        self.border = .roundedCorners
        self.title = title
        self.subgraph = nil
    }

    init(product: Product) {
        self.init(id: "product:\(product.name)", title: product.name, border: .doubled, subgraph: nil)
    }

    init(target: Module) {
        self.init(id: "target:\(target.name)", title: target.name)
    }

    init(dependency: Module.Dependency) {
        switch dependency {
        case let .product(product, _):
            self.init(
                id: product.name,
                title: product.name,
                border: .hexagon,
                subgraph: product.package
            )
        case let .module(target, _):
            self.init(target: target)
        }
    }
}

extension MermaidPackageSerializer.Node: CustomStringConvertible {
    var description: String {
        "\(self.id)\(self.border.added(to: self.title))"
    }
}

extension MermaidPackageSerializer.Edge {
    init(product: Product, target: Module) {
        self.from = .init(product: product)
        self.to = .init(target: target)
    }
}

extension MermaidPackageSerializer.Edge: CustomStringConvertible {
    var description: String {
        "\(self.from.description)-->\(self.to.description)"
    }
}

extension [Product] {
    fileprivate var productTargetEdges: [MermaidPackageSerializer.Edge] {
        self.flatMap { product in
            product.modules.map { target in (product, target) }
        }.map(MermaidPackageSerializer.Edge.init)
    }
}

extension [Module] {
    fileprivate var targetDependencyEdges: [MermaidPackageSerializer.Edge] {
        self.flatMap { target in
            target.dependencies.map {
                let dependencyNode = MermaidPackageSerializer.Node(dependency: $0)

                return .init(
                    from: .init(target: target),
                    to: dependencyNode
                )
            }
        }
    }
}