Add support for links via #METASPACE_NAVIGATION

rafalkopiec · rafalkopiec · commit 7b8b3034ef43 · 2024-07-11T06:43:06.000+03:00
diff --git a/Sources/MTSPDecoder/Container.swift b/Sources/MTSPDecoder/Container.swift
@@ -23,4 +23,7 @@ public struct Container: Equatable, Sendable, Hashable, Codable {
 
     /// The URL to the metaspace scene, a `.usdz` 3D file.
     public let sceneURL: URL
+
+    /// The dictionary of entity names to `Container` URL destinations.
+    public let navigation: [String: URL]
 }
diff --git a/Sources/MTSPDecoder/DecoderError.swift b/Sources/MTSPDecoder/DecoderError.swift
@@ -21,4 +21,6 @@ public enum DecoderError: Error {
     case containerNotRecognised
     case containerNoPreviewURL
     case containerNoSceneURL
+    case containerNavigationPathNotRecognised
+    case containerNavigationKeyNotRecognised
 }
diff --git a/Sources/MTSPDecoder/Util/Parser.swift b/Sources/MTSPDecoder/Util/Parser.swift
@@ -20,6 +20,8 @@ internal enum Parser {
     private static let mtspName: String = "#METASPACE_NAME"
     private static let mtspPreviewPath: String = "#METASPACE_PREVIEW_PATH"
     private static let mtsp3DPath: String = "#METASPACE_3D_PATH"
+    private static let mtspNavigation: String = "#METASPACE_NAVIGATION"
+    private static let mtspNavigationSeparator: String = " -> "
 
     private static let mtspExpectedVersion: Int = 1
 
@@ -40,13 +42,18 @@ internal enum Parser {
         var name: String?
         var previewPath: String?
         var scenePath: String?
+        var navigationPaths: [String] = []
 
         for line in mtspLines {
             switch line.components(separatedBy: ":").first {
             case mtspVersion: version = getIntFrom(line)
             case mtspName: name = getStringFrom(line)
             case mtspPreviewPath: previewPath = getStringFrom(line)
             case mtsp3DPath: scenePath = getStringFrom(line)
+            case mtspNavigation: 
+                if let path = getStringFrom(line) {
+                    navigationPaths.append(path)
+                }
             default: break
             }
         }
@@ -63,10 +70,29 @@ internal enum Parser {
             throw DecoderError.containerNoSceneURL
         }
 
+        var navigation: [String: URL] = [:]
+
+        for navigationPath in navigationPaths {
+            if let navigationURL = URLMap.getNavigationURL(
+                from: navigationPath,
+                separator: mtspNavigationSeparator,
+                using: containerURL
+            ) {
+                if let dir = navigationPath.components(separatedBy: mtspNavigationSeparator).first {
+                    navigation[dir] = navigationURL
+                } else {
+                    throw DecoderError.containerNavigationKeyNotRecognised
+                }
+            } else {
+                throw DecoderError.containerNavigationPathNotRecognised
+            }
+        }
+
         return Container(
             name: name,
             previewImageURL: previewURL,
-            sceneURL: sceneURL
+            sceneURL: sceneURL,
+            navigation: navigation
         )
     }
 
diff --git a/Sources/MTSPDecoder/Util/URLMap.swift b/Sources/MTSPDecoder/Util/URLMap.swift
@@ -48,4 +48,29 @@ internal enum URLMap {
 
         return containerURL.deletingLastPathComponent().appending(component: path)
     }
+
+    static func getNavigationURL(from path: String, separator: String, using containerURL: URL) -> URL? {
+        guard path.contains(separator) else {
+            return nil
+        }
+
+        let components = path.components(separatedBy: separator)
+
+        guard components.count == 2 else {
+            return nil
+        }
+
+        var containerURL = containerURL.deletingLastPathComponent()
+        var upPathComponents = components[1].components(separatedBy: "../")
+        let count = upPathComponents.count - 1
+
+        if count > 0 {
+            for _ in 0..<count {
+                upPathComponents.removeFirst()
+                containerURL.deleteLastPathComponent()
+            }
+        }
+
+        return containerURL.appending(path: upPathComponents.joined())
+    }
 }
diff --git a/Tests/MTSPDecoderTests/ParserTests.swift b/Tests/MTSPDecoderTests/ParserTests.swift
@@ -42,7 +42,53 @@ final class ParserTests: XCTestCase {
         let expected = Container(
             name: "Untitled",
             previewImageURL: URL(string: "https://metaspace.rocks/mtsp/preview.jpg")!,
-            sceneURL: URL(string: "https://metaspace.rocks/mtsp/file.usdz")!
+            sceneURL: URL(string: "https://metaspace.rocks/mtsp/file.usdz")!,
+            navigation: [:]
+        )
+
+        let data = input.data(using: .utf8)!
+        let result = try Parser.parse(data, containerURL: containerURL)
+
+        XCTAssertEqual(expected, result)
+    }
+
+    func testParse_ValidWithNavigation_Succeed() throws {
+        let containerURL = URL(string: "https://metaspace.rocks/mtsp/index.html")!
+        let input: String = """
+        // Copyright 2024 Rafal Kopiec
+        //
+        // Licensed under the Apache License, Version 2.0 (the "License");
+        // you may not use this file except in compliance with the License.
+        // You may obtain a copy of the License at
+        // http://www.apache.org/licenses/LICENSE-2.0
+        //
+        // Unless required by applicable law or agreed to in writing, software
+        // distributed under the License is distributed on an "AS IS" BASIS,
+        // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        // See the License for the specific language governing permissions and
+        // limitations under the License.
+
+        #METASPACE_HOST
+        #METASPACE_VERSION:1
+        #METASPACE_NAME:"Untitled"
+        #METASPACE_PREVIEW_PATH:"preview.jpg"
+        #METASPACE_3D_PATH:"file.usdz"
+        #METASPACE_NAVIGATION:"red_box" -> "red_box/index.mtsp"
+        #METASPACE_NAVIGATION:"yellow_box" -> "yellow_box/index.mtsp"
+        #METASPACE_NAVIGATION:"green_box" -> "green_box/index.mtsp"
+        #METASPACE_NAVIGATION:"up_level_box" -> "../index.mtsp"
+        """
+
+        let expected = Container(
+            name: "Untitled",
+            previewImageURL: URL(string: "https://metaspace.rocks/mtsp/preview.jpg")!,
+            sceneURL: URL(string: "https://metaspace.rocks/mtsp/file.usdz")!,
+            navigation: [
+                "red_box": URL(string: "https://metaspace.rocks/mtsp/red_box/index.mtsp")!,
+                "yellow_box": URL(string: "https://metaspace.rocks/mtsp/yellow_box/index.mtsp")!,
+                "green_box": URL(string: "https://metaspace.rocks/mtsp/green_box/index.mtsp")!,
+                "up_level_box": URL(string: "https://metaspace.rocks/index.mtsp")!,
+            ]
         )
 
         let data = input.data(using: .utf8)!
@@ -77,7 +123,8 @@ final class ParserTests: XCTestCase {
         let expected = Container(
             name: "Untitled",
             previewImageURL: URL(string: "https://metaspace.rocks/mtsp/preview.jpg")!,
-            sceneURL: URL(string: "https://metaspace.rocks/mtsp/file.usdz")!
+            sceneURL: URL(string: "https://metaspace.rocks/mtsp/file.usdz")!,
+            navigation: [:]
         )
 
         let data = input.data(using: .utf8)!
diff --git a/Tests/MTSPDecoderTests/URLMapTests.swift b/Tests/MTSPDecoderTests/URLMapTests.swift
@@ -70,4 +70,36 @@ final class URLMapTests: XCTestCase {
         let result = URLMap.getFileURL(from: path, using: containerURL)
         XCTAssertNil(result)
     }
+
+    func testNavigationURL_ViablePath_Succeed() {
+        let path = "some_path -> result/index.mtsp"
+        let containerURL = URL(string: "https://metaspace.rocks/mtsp/index.mtsp")!
+        let expected = URL(string: "https://metaspace.rocks/mtsp/result/index.mtsp")
+        let result = URLMap.getNavigationURL(from: path, separator: " -> ", using: containerURL)
+        XCTAssertEqual(expected, result)
+    }
+
+    func testNavigationURL_ViablePathUpOneLevel_Succeed() {
+        let path = "some_path -> ../index.mtsp"
+        let containerURL = URL(string: "https://metaspace.rocks/mtsp/index.mtsp")!
+        let expected = URL(string: "https://metaspace.rocks/index.mtsp")
+        let result = URLMap.getNavigationURL(from: path, separator: " -> ", using: containerURL)
+        XCTAssertEqual(expected, result)
+    }
+
+    func testNavigationURL_ViablePathUpTwoLevels_Succeed() {
+        let path = "some_path -> ../../index.mtsp"
+        let containerURL = URL(string: "https://metaspace.rocks/mtsp/path/index.mtsp")!
+        let expected = URL(string: "https://metaspace.rocks/index.mtsp")
+        let result = URLMap.getNavigationURL(from: path, separator: " -> ", using: containerURL)
+        XCTAssertEqual(expected, result)
+    }
+
+    func testNavigationURL_NonViablePath_Fail() {
+        let path = "some_path - result/index.mtsp"
+        let containerURL = URL(string: "https://metaspace.rocks/mtsp/index.mtsp")!
+        let expected = URL(string: "https://metaspace.rocks/mtsp/result/index.mtsp")
+        let result = URLMap.getNavigationURL(from: path, separator: " -> ", using: containerURL)
+        XCTAssertNotEqual(expected, result)
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,4 +23,7 @@ public struct Container: Equatable, Sendable, Hashable, Codable {`
`23`	`23`
`24`	`24`	/// The URL to the metaspace scene, a `.usdz` 3D file.
`25`	`25`	`public let sceneURL: URL`
	`26`	`+`
	`27`	+ /// The dictionary of entity names to `Container` URL destinations.
	`28`	`+ public let navigation: [String: URL]`
`26`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,4 +21,6 @@ public enum DecoderError: Error {`
`21`	`21`	`case containerNotRecognised`
`22`	`22`	`case containerNoPreviewURL`
`23`	`23`	`case containerNoSceneURL`
	`24`	`+ case containerNavigationPathNotRecognised`
	`25`	`+ case containerNavigationKeyNotRecognised`
`24`	`26`	`}`