Populate the "Attributes" section based on OAS data (#841)

rdar://121475839&121224338

Author: pdwilson12

Sources/SwiftDocC/Model/Rendering/RenderNodeTranslator.swift

@@ -1379,6 +1379,7 @@ public struct RenderNodeTranslator: SemanticVisitor {
                     HTTPBodySectionTranslator(),
                     HTTPResponsesSectionTranslator(),
                     DictionaryKeysSectionTranslator(),
+                    AttributesSectionTranslator(),
                     ReturnsSectionTranslator(),
                     MentionsSectionTranslator(referencingSymbol: identifier),
                     DiscussionSectionTranslator(),

Sources/SwiftDocC/Model/Rendering/RenderSectionTranslator/AttributesSectionTranslator.swift

@@ -0,0 +1,78 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2024 Apple Inc. and the Swift project authors
+ Licensed under Apache License v2.0 with Runtime Library Exception
+
+ See https://swift.org/LICENSE.txt for license information
+ See https://swift.org/CONTRIBUTORS.txt for Swift project authors
+*/
+
+import Foundation
+import SymbolKit
+
+/// Translates a symbol's constraints and details into a render node's Attributes section.
+struct AttributesSectionTranslator: RenderSectionTranslator {
+    func translateSection(
+        for symbol: Symbol,
+        renderNode: inout RenderNode,
+        renderNodeTranslator: inout RenderNodeTranslator
+    ) -> VariantCollection<CodableContentSection?>? {
+        translateSectionToVariantCollection(
+            documentationDataVariants: symbol.attributesVariants
+        ) { _, attributes in
+            guard !attributes.isEmpty else { return nil }
+            
+            func translateFragments(_ fragments: [SymbolGraph.Symbol.DeclarationFragments.Fragment]) -> [DeclarationRenderSection.Token] {
+                return fragments.map { fragment in
+                    let reference: ResolvedTopicReference?
+                    if let preciseIdentifier = fragment.preciseIdentifier,
+                       let resolved = renderNodeTranslator.context.localOrExternalReference(symbolID: preciseIdentifier)
+                    {
+                        reference = resolved
+                        renderNodeTranslator.collectedTopicReferences.append(resolved)
+                    } else {
+                        reference = nil
+                    }
+
+                    // Add the declaration token
+                    return DeclarationRenderSection.Token(fragment: fragment, identifier: reference?.absoluteString)
+                }
+            }
+            
+            return AttributesRenderSection(
+                title: "Attributes",
+                attributes: attributes.compactMap { kind, attribute in
+                    
+                    switch (kind, attribute) {
+                    case (.minimum, let value as SymbolGraph.AnyNumber):
+                        return RenderAttribute.minimum(String(value))
+                    case (.maximum, let value as SymbolGraph.AnyNumber):
+                        return RenderAttribute.maximum(String(value))
+                    case (.minimumExclusive, let value as SymbolGraph.AnyNumber):
+                        return RenderAttribute.minimumExclusive(String(value))
+                    case (.maximumExclusive, let value as SymbolGraph.AnyNumber):
+                        return RenderAttribute.maximumExclusive(String(value))
+                    case (.minimumLength, let value as Int):
+                        return RenderAttribute.minimumLength(String(value))
+                    case (.maximumLength, let value as Int):
+                        return RenderAttribute.maximumLength(String(value))
+                    case (.default, let value as SymbolGraph.AnyScalar):
+                        return RenderAttribute.default(String(value))
+                    case (.allowedTypes, let types as [SymbolGraph.Symbol.TypeDetail]):
+                        let tokens = types.compactMap { $0.fragments.map(translateFragments) }
+                        return RenderAttribute.allowedTypes(tokens)
+                    case (.allowedValues, let values as [SymbolGraph.AnyScalar]):
+                        let stringValues = values.map { String($0) }
+                        return RenderAttribute.allowedValues(stringValues)
+                    default:
+                        return nil
+                    }
+                    
+                }.sorted { $0.title < $1.title }
+            )
+        }
+    }
+    
+    
+}

Sources/SwiftDocC/Semantics/Symbol/Symbol.swift

@@ -36,6 +36,7 @@ import SymbolKit
 /// - ``accessLevelVariants``
 /// - ``deprecatedSummaryVariants``
 /// - ``declarationVariants``
+/// - ``attributesVariants``
 /// - ``locationVariants``
 /// - ``constraintsVariants``
 /// - ``originVariants``
@@ -145,9 +146,12 @@ public final class Symbol: Semantic, Abstracted, Redirected, AutomaticTaskGroups
         defaultVariantValue: [:]
     )
 
-    /// The symbols alternate declarations in each language variant the symbol is available in.
+    /// The symbol's alternate declarations in each language variant the symbol is available in.
     public var alternateDeclarationVariants = DocumentationDataVariants<[[PlatformName?]: [SymbolGraph.Symbol.DeclarationFragments]]>()
 
+    /// The symbol's possible values in each language variant the symbol is available in.
+    public var attributesVariants = DocumentationDataVariants<[RenderAttribute.Kind: Any]>()
+    
     public var locationVariants = DocumentationDataVariants<SymbolGraph.Symbol.Location>()
 
     /// The symbol's availability or conformance constraints, in each language variant the symbol is available in.
@@ -304,6 +308,7 @@ public final class Symbol: Semantic, Abstracted, Redirected, AutomaticTaskGroups
         self.mixinsVariants = mixinsVariants
 
         for (trait, variant) in mixinsVariants.allValues {
+            var attributes: [RenderAttribute.Kind: Any] = [:]
             for item in variant.values {
                 switch item {
                 case let declaration as SymbolGraph.Symbol.DeclarationFragments:
@@ -317,9 +322,33 @@ public final class Symbol: Semantic, Abstracted, Redirected, AutomaticTaskGroups
                     self.isSPIVariants[trait] = spi.isSPI
                 case let alternateDeclarations as SymbolGraph.Symbol.AlternateDeclarations:
                     self.alternateDeclarationVariants[trait] = [[platformNameVariants[trait]]: alternateDeclarations.declarations]
+                
+                case let attribute as SymbolGraph.Symbol.Minimum:
+                    attributes[.minimum] = attribute.value
+                case let attribute as SymbolGraph.Symbol.Maximum:
+                    attributes[.maximum] = attribute.value
+                case let attribute as SymbolGraph.Symbol.MinimumExclusive:
+                    attributes[.minimumExclusive] = attribute.value
+                case let attribute as SymbolGraph.Symbol.MaximumExclusive:
+                    attributes[.maximumExclusive] = attribute.value
+                case let attribute as SymbolGraph.Symbol.MinimumLength:
+                    attributes[.minimumLength] = attribute.value
+                case let attribute as SymbolGraph.Symbol.MaximumLength:
+                    attributes[.maximumLength] = attribute.value
+                case let attribute as SymbolGraph.Symbol.DefaultValue:
+                    attributes[.default] = attribute.value
+                
+                case let attribute as SymbolGraph.Symbol.TypeDetails:
+                    attributes[.allowedTypes] = attribute.value
+                case let attribute as SymbolGraph.Symbol.AllowedValues:
+                    attributes[.allowedValues] = attribute.value
                 default: break;
                 }
             }
+            if !attributes.isEmpty {
+                self.attributesVariants[trait] = attributes
+            }
+
         }
 
         if !relationshipsVariants.isEmpty {

Tests/SwiftDocCTests/Model/SemaToRenderNodeDictionaryDataTests.swift

@@ -224,14 +224,17 @@ class SemaToRenderNodeDictionaryDataTests: XCTestCase {
         let outputConsumer = try renderNodeConsumer(for: "DictionaryData")
         let genreRenderNode = try outputConsumer.renderNode(withIdentifier: "data:test:Genre")
 
-        print(genreRenderNode)
+        let type1 = DeclarationRenderSection.Token(fragment: SymbolGraph.Symbol.DeclarationFragments.Fragment(kind: .text, spelling: "string", preciseIdentifier: nil), identifier: nil)
+        let type2 = DeclarationRenderSection.Token(fragment: SymbolGraph.Symbol.DeclarationFragments.Fragment(kind: .text, spelling: "GENCODE", preciseIdentifier: nil), identifier: nil)
+        
         assertExpectedContent(
             genreRenderNode,
             sourceLanguage: "data",
             symbolKind: "typealias",
             title: "Genre",
             navigatorTitle: nil,
             abstract: nil,
+            attributes: [.maximumLength("40"), .allowedTypes([[type1], [type2]]), .allowedValues(["Classic Rock", "Folk", "null"])],
             declarationTokens: [
                 "string ",
                 "Genre"

Tests/SwiftDocCTests/Test Bundles/DictionaryData.docc/dictionary.symbols.json

@@ -239,6 +239,12 @@
     },
     {
       "accessLevel": "public",
+      "allowedValues": [
+        "Classic Rock",
+        "Folk",
+        null
+      ],
+      "maximumLength": 40,
       "declarationFragments": [
         {
           "kind": "text",
@@ -276,6 +282,21 @@
       "typeDetails": [
         {
           "baseType": "string",
+          "fragments": [
+            {
+              "kind": "text",
+              "spelling": "string"
+            }
+          ]
+        },
+        {
+          "baseType": "string",
+          "fragments": [
+            {
+              "kind": "text",
+              "spelling": "GENCODE"
+            }
+          ]
         }
       ]
     },

Tests/SwiftDocCTests/XCTestCase+AssertingTestData.swift

@@ -23,6 +23,7 @@ extension XCTestCase {
         title expectedTitle: String,
         navigatorTitle expectedNavigatorTitle: String?,
         abstract expectedAbstract: String?,
+        attributes expectedAttributes: [RenderAttribute]? = nil,
         declarationTokens expectedDeclarationTokens: [String]?,
         endpointTokens expectedEndpointTokens: [String]? = nil,
         httpParameters expectedHTTPParameters: [String]? = nil,
@@ -62,6 +63,15 @@ extension XCTestCase {
             line: line
         )
 
+        let attributesSection = renderNode.primaryContentSections.compactMap { $0 as? AttributesRenderSection }.first
+        XCTAssertEqual(
+            attributesSection?.attributes,
+            expectedAttributes,
+            failureMessageForField("attributes"),
+            file: file,
+            line: line
+        )
+        
         XCTAssertEqual(
             (renderNode.primaryContentSections.first as? DeclarationsRenderSection)?
                 .declarations