Integrated Analytics into the Infrastructure package (#40)

This PR contains the work done to define the `Analytics` type into the _Infrastructure_ package and also, to integrate this type into its `Page` protocol.

Reviewed-on: rock-n-code/loud-amsterdam#40
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>

Packages/Infrastructure/Tests/Cases/Public/Protocols/PageTests.swift

@@ -122,6 +122,40 @@ struct PageTests {
         ))
     }
 
+    @Test
+    func `omits the analytics tracker by default`() {
+        let html = StubPage().render()
+
+        #expect(!html.contains("data-website-id"))
+    }
+
+    @Test
+    func `renders the analytics tracker when provided`() {
+        let html = StubPage(analytics: .init(
+            scriptURL: "https://analytics.example.com/script",
+            websiteID: "0000-website-id",
+            domains: "example.com"
+        )).render()
+
+        #expect(html.contains(#"<script defer src="https://analytics.example.com/script" data-website-id="0000-website-id" data-domains="example.com" data-exclude-hash="true" data-do-not-track="true" data-performance="true"></script>"#))
+    }
+
+    @Test
+    func `omits the analytics behavior flags that are disabled`() {
+        let html = StubPage(analytics: .init(
+            scriptURL: "https://analytics.example.com/script",
+            websiteID: "0000-website-id",
+            domains: "example.com",
+            excludeHash: true,
+            doNotTrack: false,
+            performance: false
+        )).render()
+
+        #expect(html.contains(#"<script defer src="https://analytics.example.com/script" data-website-id="0000-website-id" data-domains="example.com" data-exclude-hash="true"></script>"#))
+        #expect(!html.contains("data-do-not-track"))
+        #expect(!html.contains("data-performance"))
+    }
+
     @Test
     func `appends the version token to the asset URLs`() {
         let html = StubPage(assetVersion: "0123456789abcdef").render()

Packages/Infrastructure/Tests/Cases/Public/Types/AnalyticsTests.swift

@@ -0,0 +1,55 @@
+import Testing
+
+@testable import Infrastructure
+
+@Suite(
+    "Analytics type",
+    .tags(.type)
+)
+struct AnalyticsTests {
+
+    // MARK: Functional tests
+
+    @Test
+    func `lists the website id and domains with every behavior flag on by default`() {
+        let analytics = Analytics(
+            scriptURL: "https://analytics.example.com/script",
+            websiteID: "id-123",
+            domains: "example.com"
+        )
+
+        #expect(analytics.attributes.map(\.name) == [
+            "data-website-id",
+            "data-domains",
+            "data-exclude-hash",
+            "data-do-not-track",
+            "data-performance",
+        ])
+        #expect(analytics.attributes.map(\.value) == [
+            "id-123",
+            "example.com",
+            "true",
+            "true",
+            "true",
+        ])
+    }
+
+    @Test
+    func `omits the disabled behavior flags`() {
+        let analytics = Analytics(
+            scriptURL: "https://analytics.example.com/script",
+            websiteID: "id-123",
+            domains: "example.com",
+            excludeHash: true,
+            doNotTrack: false,
+            performance: false
+        )
+
+        #expect(analytics.attributes.map(\.name) == [
+            "data-website-id",
+            "data-domains",
+            "data-exclude-hash",
+        ])
+    }
+
+}

Packages/Infrastructure/Tests/Utils/Pages/StubPage.swift

@@ -7,6 +7,9 @@ struct StubPage: Page {
 
     // MARK: Properties
 
+    /// The analytics tracker rendered as a deferred script in the document head, or `nil` to omit it.
+    let analytics: Analytics?
+
     /// The version token appended to the page's asset URLs, or `nil` to leave them unversioned.
     let assetVersion: String?
 
@@ -34,6 +37,8 @@ struct StubPage: Page {
     ///     default) to leave them unversioned.
     ///   - canonicalURL: the canonical URL rendered in the document head, or `nil` (the default)
     ///     to omit it.
+    ///   - analytics: the analytics tracker rendered as a deferred script in the document head,
+    ///     or `nil` (the default) to omit it.
     ///   - socialCard: the card rendered as link-preview tags in the document head, or `nil`
     ///     (the default) to omit them.
     ///   - structuredData: the structured data rendered as a JSON-LD script in the document
@@ -44,10 +49,12 @@ struct StubPage: Page {
         locale: Locale = .init(identifier: "en"),
         assetVersion: String? = nil,
         canonicalURL: String? = nil,
+        analytics: Analytics? = nil,
         socialCard: SocialCard? = nil,
         structuredData: StructuredData? = nil,
         summary: String? = nil
     ) {
+        self.analytics = analytics
         self.assetVersion = assetVersion
         self.canonicalURL = canonicalURL
         self.locale = locale