Skip to content

Commit 625b16e

Browse files
goergisngoergisn
committed
Renaming and documentation
1 parent 7ea68bc commit 625b16e

16 files changed

+78
-127
lines changed

‎Sources/Helpers/LoggingGroup.swift‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,11 @@ struct LoggingGroup: Logging {
1717
self.logLevel = logLevel
1818
}
1919

20-
@MainActor
2120
func log(_ message: String, from subsystem: String) {
2221
guard logLevel.shouldLog else { return }
2322
logger.forEach { $0.log(message, from: subsystem) }
2423
}
2524

26-
@MainActor
2725
func debug(_ message: String, from subsystem: String) {
2826
guard logLevel.shouldDebugLog else { return }
2927
logger.forEach { $0.debug(message, from: subsystem) }

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Actor.swift‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,18 @@ import Foundation
22

33
class SwiftInterfaceActor: SwiftInterfaceElement, SwiftInterfaceExtendableElement {
44

5-
var childGroupName: String { name }
5+
var pathComponentName: String { name }
66

77
/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
88
let attributes: [String]
99

10+
/// The name of the element
1011
let name: String
1112

1213
/// e.g. <T>
1314
let genericParameterDescription: String?
1415

16+
/// Types/Protocols the element inherits from
1517
var inheritance: [String]?
1618

1719
/// e.g. public, private, package, open, internal
@@ -24,17 +26,11 @@ class SwiftInterfaceActor: SwiftInterfaceElement, SwiftInterfaceExtendableElemen
2426

2527
var parent: (any SwiftInterfaceElement)? = nil
2628

27-
var diffableSignature: String {
28-
name
29-
}
29+
var diffableSignature: String { name }
3030

31-
var consolidatableName: String {
32-
name
33-
}
31+
var consolidatableName: String { name }
3432

35-
var description: String {
36-
compileDescription()
37-
}
33+
var description: String { compileDescription() }
3834

3935
var typeName: String { name }
4036

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+AssociatedType.swift‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ class SwiftInterfaceAssociatedType: SwiftInterfaceElement {
55
/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
66
let attributes: [String]
77

8+
/// The name of the element
89
let name: String
910

11+
/// Types/Protocols the element inherits from
1012
let inheritance: [String]?
1113

1214
/// e.g. any Swift.Equatable
@@ -18,23 +20,18 @@ class SwiftInterfaceAssociatedType: SwiftInterfaceElement {
1820
/// e.g. where T : Equatable
1921
let genericWhereClauseDescription: String?
2022

21-
var childGroupName: String { "" } // Not relevant as only used to group children
23+
var pathComponentName: String { name }
2224

23-
var children: [any SwiftInterfaceElement] = []
25+
/// A associatedtype does not have children
26+
let children: [any SwiftInterfaceElement] = []
2427

2528
var parent: (any SwiftInterfaceElement)? = nil
2629

27-
var diffableSignature: String {
28-
name
29-
}
30+
var diffableSignature: String { name }
3031

31-
var consolidatableName: String {
32-
name
33-
}
32+
var consolidatableName: String { name }
3433

35-
var description: String {
36-
compileDescription()
37-
}
34+
var description: String { compileDescription() }
3835

3936
init(
4037
attributes: [String],

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Class.swift‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ class SwiftInterfaceClass: SwiftInterfaceElement, SwiftInterfaceExtendableElemen
55
/// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
66
let attributes: [String]
77

8+
/// The name of the element
89
let name: String
910

1011
/// e.g. <T>
1112
let genericParameterDescription: String?
1213

14+
/// Types/Protocols the element inherits from
1315
var inheritance: [String]?
1416

1517
/// e.g. public, private, package, open, internal
@@ -18,23 +20,17 @@ class SwiftInterfaceClass: SwiftInterfaceElement, SwiftInterfaceExtendableElemen
1820
/// e.g. where T : Equatable
1921
let genericWhereClauseDescription: String?
2022

21-
var childGroupName: String { name }
23+
var pathComponentName: String { name }
2224

2325
var children: [any SwiftInterfaceElement]
2426

2527
var parent: (any SwiftInterfaceElement)? = nil
2628

27-
var diffableSignature: String {
28-
return name
29-
}
29+
var diffableSignature: String { name }
3030

31-
var consolidatableName: String {
32-
name
33-
}
31+
var consolidatableName: String { name }
3432

35-
var description: String {
36-
compileDescription()
37-
}
33+
var description: String { compileDescription() }
3834

3935
var typeName: String { name }
4036

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Enum.swift‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,17 @@ class SwiftInterfaceEnum: SwiftInterfaceElement, SwiftInterfaceExtendableElement
1818
/// e.g. where T : Equatable
1919
let genericWhereClauseDescription: String?
2020

21-
var childGroupName: String { name }
21+
var pathComponentName: String { name }
2222

2323
var children: [any SwiftInterfaceElement]
2424

2525
var parent: (any SwiftInterfaceElement)? = nil
2626

27-
var diffableSignature: String {
28-
name
29-
}
27+
var diffableSignature: String { name }
3028

31-
var consolidatableName: String {
32-
name
33-
}
29+
var consolidatableName: String { name }
3430

35-
var description: String {
36-
compileDescription()
37-
}
31+
var description: String { compileDescription() }
3832

3933
var typeName: String { name }
4034

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+EnumCase.swift‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,18 @@ class SwiftInterfaceEnumCase: SwiftInterfaceElement {
4747

4848
let rawValue: String?
4949

50-
var childGroupName: String { "" }
50+
var pathComponentName: String { "" } // Not relevant as / no children
5151

52-
/// A typealias does not have children
53-
var children: [any SwiftInterfaceElement] = []
52+
/// An enum case does not have children
53+
let children: [any SwiftInterfaceElement] = []
5454

5555
var parent: (any SwiftInterfaceElement)? = nil
5656

57-
var diffableSignature: String {
58-
name
59-
}
57+
var diffableSignature: String { name }
6058

61-
var consolidatableName: String {
62-
name
63-
}
59+
var consolidatableName: String { name }
6460

65-
var description: String {
66-
compileDescription()
67-
}
61+
var description: String { compileDescription() }
6862

6963
init(
7064
attributes: [String],
@@ -88,7 +82,7 @@ extension SwiftInterfaceEnumCase {
8882
guard let other = otherElement as? Self else { return [] }
8983
changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
9084
changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
91-
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters?.map { $0.description }, newValues: parameters?.map { $0.description }) // TODO: Maybe have a better way to show changes
85+
changes += diffDescription(propertyType: "parameter", oldValues: other.parameters?.map { $0.description }, newValues: parameters?.map { $0.description })
9286
changes += diffDescription(propertyType: "raw value", oldValue: other.rawValue, newValue: rawValue)
9387
return changes.compactMap { $0 }
9488
}

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Extension.swift‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,18 @@ class SwiftInterfaceExtension: SwiftInterfaceElement {
1515
/// e.g. where T : Equatable
1616
let genericWhereClauseDescription: String?
1717

18-
var childGroupName: String { extendedType } // Grouping by extended type
18+
var pathComponentName: String {
19+
[extendedType, genericWhereClauseDescription.map { "[\($0)]"}].compactMap { $0 }.joined()
20+
}
1921

2022
/// The members, declarations, ... inside of the body of the struct
2123
var children: [any SwiftInterfaceElement]
2224

2325
var parent: (any SwiftInterfaceElement)? = nil
2426

25-
var diffableSignature: String {
26-
extendedType
27-
}
27+
var diffableSignature: String { extendedType }
2828

29-
var consolidatableName: String {
30-
extendedType
31-
}
29+
var consolidatableName: String { extendedType }
3230

3331
var description: String {
3432
compileDescription()

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Function.swift‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,20 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
5757
/// e.g. where T : Equatable
5858
let genericWhereClauseDescription: String?
5959

60-
var childGroupName: String { "" } // Not relevant as only used to group children
60+
var pathComponentName: String { name }
6161

62-
var children: [any SwiftInterfaceElement] = []
62+
/// A function does not have children
63+
let children: [any SwiftInterfaceElement] = []
6364

6465
var parent: (any SwiftInterfaceElement)? = nil
6566

6667
var diffableSignature: String {
6768
"\(name)(\(parameters.map { "\($0.firstName):" }.joined()))"
6869
}
6970

70-
var consolidatableName: String {
71-
name
72-
}
71+
var consolidatableName: String { name }
7372

74-
var description: String {
75-
compileDescription()
76-
}
73+
var description: String { compileDescription() }
7774

7875
init(
7976
attributes: [String],

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Initializer.swift‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,18 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
5555
/// e.g. where T : Equatable
5656
let genericWhereClauseDescription: String?
5757

58-
var childGroupName: String { "" } // Not relevant as only used to group children
58+
var pathComponentName: String { "" } // Not relevant as / no children
5959

60-
/// A function does not have children
61-
var children: [any SwiftInterfaceElement] = []
60+
/// A initializer does not have children
61+
let children: [any SwiftInterfaceElement] = []
6262

6363
var parent: (any SwiftInterfaceElement)? = nil
6464

6565
var diffableSignature: String {
6666
"init(\(parameters.map { "\($0.firstName):" }.joined()))"
6767
}
6868

69-
var consolidatableName: String {
70-
"init"
71-
}
69+
var consolidatableName: String { "init" }
7270

7371
var description: String {
7472
compileDescription()

‎Sources/Helpers/Models/SwiftInterface/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Protocol.swift‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,18 @@ class SwiftInterfaceProtocol: SwiftInterfaceElement, SwiftInterfaceExtendableEle
1717
/// e.g. where T : Equatable
1818
let genericWhereClauseDescription: String?
1919

20-
var childGroupName: String { name } // Not relevant as only used to group children
20+
var pathComponentName: String { name }
2121

2222
/// The members, declarations, ... inside of the body of the struct
2323
var children: [any SwiftInterfaceElement]
2424

2525
var parent: (any SwiftInterfaceElement)? = nil
2626

27-
var diffableSignature: String {
28-
name
29-
}
27+
var diffableSignature: String { name }
3028

31-
var consolidatableName: String {
32-
name
33-
}
29+
var consolidatableName: String { name }
3430

35-
var description: String {
36-
compileDescription()
37-
}
31+
var description: String { compileDescription() }
3832

3933
var typeName: String { name }
4034

0 commit comments

Comments
 (0)