Refactored RolesExtractor to be consistent with manifest file role …

…name formatting (#69)

Sources/MarkersExtractor/Extractors/FCPXMLMarkerExtractor.swift

@@ -319,17 +319,8 @@ class FCPXMLMarkerExtractor: NSObject, ProgressReporting {
             }
         }
 
-        // collapse subroles that are redundant
-        markerRoles.collapseSubroles()
-
-        // remove any roles with empty strings
-        markerRoles.removeEmptyStrings()
-
-        // FCP often writes built-in roles as lowercase strings
-        // (ie: "dialogue" or "dialogue.dialogue-1")
-        // so we will explicitly title-case these if encountered, so as to match
-        // FCP's title-cased display of these roles (ie: "Dialogue")
-        markerRoles.titleCaseBuiltInRoles()
+        // process markers
+        markerRoles.process()
 
         return markerRoles
     }
@@ -338,3 +329,17 @@ class FCPXMLMarkerExtractor: NSObject, ProgressReporting {
         enableSubframes ? [.showSubFrames] : .default()
     }
 }
+
+extension FCPXMLMarkerExtractor {
+    static func processExtractedRole<Role: FCPXMLRole>(role: Role) -> Role {
+        role
+            // collapse subroles that are redundant
+            .collapsingSubRole()
+
+            // FCP often writes built-in roles as lowercase strings
+            // (ie: "dialogue" or "dialogue.dialogue-1")
+            // so we will explicitly title-case these if encountered, so as to match
+            // FCP's title-cased display of these roles (ie: "Dialogue")
+            .titleCasedDefaultRole(derivedOnly: true)
+    }
+}

Sources/MarkersExtractor/Import/Marker/MarkerRoles.swift

@@ -188,24 +188,27 @@ extension MarkerRoles {
         }
     }
 
-    /// FCP often writes built-in roles as lowercase strings
-    /// (ie: "dialogue" or "dialogue.dialogue-1").
-    /// This will title-cased these roles (ie: "Dialogue") to match FCP's display.
-    public mutating func titleCaseBuiltInRoles() {
+    /// Process markers, performing post-extraction formatting.
+    public mutating func process() {
+        removeEmptyStrings()
+        
         if var audioRoles = audio {
             for index in audioRoles.indices {
-                if audioRoles[index].isMainRoleBuiltIn == true {
-                    audioRoles[index] = audioRoles[index].titleCased(derivedOnly: true)
-                }
+                audioRoles[index] = FCPXMLMarkerExtractor
+                    .processExtractedRole(role: audioRoles[index])
             }
             audio = audioRoles
         }
 
-        if video?.isMainRoleBuiltIn == true {
-            video = video?.titleCased(derivedOnly: true)
+        if let videoRole = video {
+            video = FCPXMLMarkerExtractor
+                .processExtractedRole(role: videoRole)
         }
 
-        // don't title-case caption roles.
+        if let captionRole = caption {
+            caption = FCPXMLMarkerExtractor
+                .processExtractedRole(role: captionRole)
+        }
     }
 }
 

Sources/MarkersExtractor/RolesExtractor/RolesExtractor.swift

@@ -4,13 +4,16 @@
 //  Licensed under MIT License
 //
 
-import Foundation
 import DAWFileKit
+import Foundation
 import OTCore
 
 /// Returns all the roles used in a FCPXML document that are relevant to the main project
 /// timeline.
 ///
+/// Results will be formatted in the same manner as ``MarkersExtractor`` formats
+/// roles for output manifest files.
+///
 /// Results will be sorted by type (video, audio, caption), then by name.
 public final class RolesExtractor {
     public var fcpxml: FCPXMLFile
@@ -22,6 +25,9 @@ public final class RolesExtractor {
     /// Returns all the roles used in the FCPXML document that are relevant to the main project
     /// timeline.
     ///
+    /// Results will be formatted in the same manner as ``MarkersExtractor`` formats
+    /// roles for output manifest files.
+    ///
     /// Results will be sorted by type (video, audio, caption), then by name.
     ///
     /// - Returns: A flat array of roles.
@@ -38,6 +44,9 @@ public final class RolesExtractor {
 
         let sorted = projectsRoles
             .flatMap { $0 }
+            .map {
+                FCPXMLMarkerExtractor.processExtractedRole(role: $0)
+            }
 
         return sorted
     }