Merge pull request #106 from Comcast/release/2.2.2

jaybpierce · web-flow · commit 80c8073f6cf2 · 2021-08-20T09:25:40.000-06:00
Release/2.2.2
diff --git a/mamba.xcodeproj/project.pbxproj b/mamba.xcodeproj/project.pbxproj
diff --git a/mamba.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/mamba.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
@@ -2,8 +2,6 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-	<key>BuildSystemType</key>
-	<string>Original</string>
 	<key>PreviewsEnabled</key>
 	<false/>
 </dict>
diff --git a/mamba.xcodeproj/xcshareddata/xcschemes/mamba.xcscheme b/mamba.xcodeproj/xcshareddata/xcschemes/mamba.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1150"
+   LastUpgradeVersion = "1200"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/mamba.xcodeproj/xcshareddata/xcschemes/mambaMacOS.xcscheme b/mamba.xcodeproj/xcshareddata/xcschemes/mambaMacOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1150"
+   LastUpgradeVersion = "1200"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/mamba.xcodeproj/xcshareddata/xcschemes/mambaTVOS.xcscheme b/mamba.xcodeproj/xcshareddata/xcschemes/mambaTVOS.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1150"
+   LastUpgradeVersion = "1200"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
diff --git a/mambaSharedFramework/FrameworkInfo.swift b/mambaSharedFramework/FrameworkInfo.swift
@@ -1,5 +1,5 @@
 //
-//  Mamba.swift
+//  FrameworkInfo.swift
 //  mamba
 //
 //  Created by David Coufal on 8/2/16.
@@ -19,8 +19,8 @@
 
 import Foundation
 
-/// Base object representing the Mamba framework
-public enum Mamba {
+///  Provides information about the framework
+public enum FrameworkInfo {
     
     /// returns the version of the mamba framework
     public static var version: String {
diff --git a/mambaSharedFramework/Playlist Models/Playlist Structure/MasterPlaylistStructure.swift b/mambaSharedFramework/Playlist Models/Playlist Structure/MasterPlaylistStructure.swift
@@ -41,7 +41,7 @@ import Foundation
  variantTagGroups[2]   3.m3u8
  ```
  */
-public typealias MasterPlaylistStructure = PlaylistStructureCore<MasterPlaylistStructureData, MasterPlaylistStructureDelegate>
+public typealias MasterPlaylistStructure = PlaylistStructureCore<MasterPlaylistStructureDelegate>
 
 extension PlaylistStructureCore: MasterPlaylistTagGroupProvider where PSD == MasterPlaylistStructureDelegate {
     
@@ -68,7 +68,7 @@ public protocol MasterPlaylistTagGroupProvider {
     var variantTagGroups: [VariantTagGroup] { get }
 }
 
-public struct MasterPlaylistStructureData: EmptyInitializerImplementor {
+public struct MasterPlaylistStructureData: PlaylistStructure {
     public init() {
         self.variantTagGroups = [VariantTagGroup]()
     }
@@ -78,7 +78,7 @@ public struct MasterPlaylistStructureData: EmptyInitializerImplementor {
     var variantTagGroups: [VariantTagGroup]
 }
 
-public final class MasterPlaylistStructureDelegate: PlaylistStructureDelegate, EmptyInitializerImplementor {
+public final class MasterPlaylistStructureDelegate: PlaylistStructureDelegate {
 
     public typealias T = MasterPlaylistStructureData
     
diff --git a/mambaSharedFramework/Playlist Models/Playlist Structure/PlaylistStructureCore.swift b/mambaSharedFramework/Playlist Models/Playlist Structure/PlaylistStructureCore.swift
@@ -19,27 +19,27 @@
 
 import Foundation
 
-public final class PlaylistStructureCore<T: EmptyInitializerImplementor, PSD: PlaylistStructureDelegate & EmptyInitializerImplementor>: PlaylistStructureInterface where PSD.T == T {
+public final class PlaylistStructureCore<PSD: PlaylistStructureDelegate>: PlaylistStructureInterface {
     
     private var structureState: StructureState = .dirtyRequiresRebuild
     
     private var _tags: [PlaylistTag]
     private let delegate: PSD
     
-    var _structureData: T
+    var _structureData: PSD.StructureType
     
     private let queue = DispatchQueue(label: "com.comcast.mamba.playliststructurecore",
                                       qos: .userInitiated)
     
     public convenience init(withTags tags: [PlaylistTag]) {
         self.init(withTags: tags,
                   withDelegate: PSD(),
-                  withStructureData: T())
+                  withStructureData: PSD.StructureType())
     }
     
     init(withTags tags: [PlaylistTag],
          withDelegate delegate: PSD,
-         withStructureData structureData: T) {
+         withStructureData structureData: PSD.StructureType) {
         self._tags = tags
         self.delegate = delegate
         self._structureData = structureData
@@ -58,7 +58,7 @@ public final class PlaylistStructureCore<T: EmptyInitializerImplementor, PSD: Pl
         }
     }
 
-    public var structureData: T {
+    public var structureData: PSD.StructureType {
         return queue.sync {
             rebuildIfRequired()
             return _structureData
@@ -188,7 +188,9 @@ public final class PlaylistStructureCore<T: EmptyInitializerImplementor, PSD: Pl
  */
 public protocol PlaylistStructureDelegate: class {
     
-    associatedtype T
+    associatedtype StructureType: PlaylistStructure
+    
+    init()
     
     /**
      Return true if this tag is a marker for structure boundaries in your structure definition.
@@ -205,9 +207,9 @@ public protocol PlaylistStructureDelegate: class {
      
      - parameter usingTagArray: The list of tags that defines our playlist.
      
-     - returns: New structure of `T` type
+     - returns: New structure of `StructureType` type
      */
-    func rebuild(usingTagArray tags: [PlaylistTag]) -> T
+    func rebuild(usingTagArray tags: [PlaylistTag]) -> StructureType
     
     /**
      `PlaylistStructureCore` has noted a minor change to the tag array and requests that
@@ -223,14 +225,14 @@ public protocol PlaylistStructureDelegate: class {
     func changed(numberOfTags alterCount: Int,
                  atIndex index: Int,
                  inTagArray tags: [PlaylistTag],
-                 withInitialStructure structure: T) -> PlaylistStructureChangeResult<T>
+                 withInitialStructure structure: StructureType) -> PlaylistStructureChangeResult<StructureType>
 }
 
-public struct PlaylistStructureChangeResult<T> {
+public struct PlaylistStructureChangeResult<StructureType> {
     /// `false` if we were able to fix up ourselves, `true` if we has to rebuild structure from scratch
     let hadToRebuildFromScratch: Bool
     /// New structure after rebuild
-    let structure: T
+    let structure: StructureType
 }
 
 struct PlaylistStructureConstructor {
@@ -421,6 +423,6 @@ struct PlaylistStructureConstructor {
     }
 }
 
-public protocol EmptyInitializerImplementor {
+public protocol PlaylistStructure {
     init()
 }
diff --git a/mambaSharedFramework/Playlist Models/Playlist Structure/VariantPlaylistStructure.swift b/mambaSharedFramework/Playlist Models/Playlist Structure/VariantPlaylistStructure.swift
@@ -55,7 +55,7 @@ import Foundation
  mediaSpans[1] would cover just mediaSegmentGroup[2] (range 2...2). Each media span has its own #EXT-X-KEY tag.
  
  */
-public typealias VariantPlaylistStructure = PlaylistStructureCore<MediaPlaylistStructureData, VariantPlaylistStructureDelegate>
+public typealias VariantPlaylistStructure = PlaylistStructureCore<VariantPlaylistStructureDelegate>
 
 extension PlaylistStructureCore: PlaylistTagSource, PlaylistTypeDetermination, VariantPlaylistStructureInterface where PSD == VariantPlaylistStructureDelegate {
     
@@ -173,7 +173,7 @@ extension VariantPlaylistStructureInterface {
     }
 }
 
-public struct MediaPlaylistStructureData: EmptyInitializerImplementor, PlaylistTypeDetermination {
+public struct MediaPlaylistStructureData: PlaylistStructure, PlaylistTypeDetermination {
     public init() {
         self.header = nil
         self.mediaSegmentGroups = [MediaSegmentPlaylistTagGroup]()
@@ -207,7 +207,7 @@ public struct MediaPlaylistStructureData: EmptyInitializerImplementor, PlaylistT
     public var playlistType: PlaylistType
 }
 
-public final class VariantPlaylistStructureDelegate: PlaylistStructureDelegate, EmptyInitializerImplementor {
+public final class VariantPlaylistStructureDelegate: PlaylistStructureDelegate {
     
     public typealias T = MediaPlaylistStructureData
     
diff --git a/mambaSharedFramework/PlaylistWriter.swift b/mambaSharedFramework/PlaylistWriter.swift
@@ -49,7 +49,7 @@ public class PlaylistWriter {
             try write(string: identityString, toStream: stream)
         }
         if !suppressMambaIdentityString {
-            try write(string: " Generated by Mamba(\(Mamba.version)) Copyright (c) 2017 Comcast Corporation", toStream: stream)
+            try write(string: " Generated by Mamba(\(FrameworkInfo.version)) Copyright (c) 2017 Comcast Corporation", toStream: stream)
         }
         
         // write tags
diff --git a/mambaSharedFramework/mamba.h b/mambaSharedFramework/mamba.h
@@ -17,7 +17,7 @@
 //  limitations under the License.
 //
 
-#import "Availability.h"
+#import <Availability.h>
 
 #ifdef __MAC_OS_X_VERSION_MAX_ALLOWED
 #import <Cocoa/Cocoa.h>
diff --git a/mambaTests/Helpers/XCTestCase+mamba.swift b/mambaTests/Helpers/XCTestCase+mamba.swift
@@ -23,9 +23,9 @@ import XCTest
 
 extension XCTestCase {
     
-    public func parseMasterPlaylist(inData data: Data,
-                                    tagTypes: [PlaylistTagDescriptor.Type]? = nil,
-                                    url: URL = fakePlaylistURL()) -> MasterPlaylist {
+    fileprivate func _parseMasterPlaylist(inData data: Data,
+                                          tagTypes: [PlaylistTagDescriptor.Type]? = nil,
+                                          url: URL = fakePlaylistURL()) -> MasterPlaylist? {
         let result = _parsePlaylist(inData: data, tagTypes: tagTypes, url: url)
         switch result {
         case .parseError(let error):
@@ -38,9 +38,15 @@ extension XCTestCase {
             break
         }
         // we've already stopped the test at this point
-        return nil!
+        return nil
     }
     
+    public func parseMasterPlaylist(inData data: Data,
+                                    tagTypes: [PlaylistTagDescriptor.Type]? = nil,
+                                    url: URL = fakePlaylistURL()) -> MasterPlaylist {
+        return _parseMasterPlaylist(inData: data, tagTypes: tagTypes, url: url)!
+    }
+
     public func parseMasterPlaylist(inString playlistString: String,
                                     tagTypes: [PlaylistTagDescriptor.Type]? = nil,
                                     url: URL? = fakePlaylistURL()) -> MasterPlaylist {
@@ -59,9 +65,9 @@ extension XCTestCase {
         return parseMasterPlaylist(inData: data! as Data, tagTypes: tagTypes, url: url!)
     }
     
-    public func parseVariantPlaylist(inData data: Data,
-                                     tagTypes: [PlaylistTagDescriptor.Type]? = nil,
-                                     url: URL = fakePlaylistURL()) -> VariantPlaylist {
+    fileprivate func _parseVariantPlaylist(inData data: Data,
+                                           tagTypes: [PlaylistTagDescriptor.Type]? = nil,
+                                           url: URL = fakePlaylistURL()) -> VariantPlaylist? {
         let result = _parsePlaylist(inData: data, tagTypes: tagTypes, url: url)
         switch result {
         case .parseError(let error):
@@ -74,7 +80,13 @@ extension XCTestCase {
             break
         }
         // we've already stopped the test at this point
-        return nil!
+        return nil
+    }
+    
+    public func parseVariantPlaylist(inData data: Data,
+                                     tagTypes: [PlaylistTagDescriptor.Type]? = nil,
+                                     url: URL = fakePlaylistURL()) -> VariantPlaylist {
+        return _parseVariantPlaylist(inData: data, tagTypes: tagTypes, url: url)!
     }
     
     public func parseVariantPlaylist(inString playlistString: String,
diff --git a/mambaTests/MasterPlaylistStreamSummaryTests.swift b/mambaTests/MasterPlaylistStreamSummaryTests.swift
@@ -168,6 +168,8 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 default:
                     XCTFail("Unexpected streamInfIndex: \(streamInfIndex)")
                 }
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
         }
         
@@ -333,6 +335,8 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 default:
                     XCTFail("Unexpected streamInfIndex: \(streamInfIndex)")
                 }
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
         }
         
@@ -455,6 +459,8 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 default:
                     XCTFail("Unexpected streamInfIndex: \(streamInfIndex)")
                 }
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
         }
         
@@ -551,6 +557,8 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 default:
                     XCTFail("Unexpected streamInfIndex: \(streamInfIndex)")
                 }
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
         }
         
@@ -624,6 +632,8 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 default:
                     XCTFail("Unexpected streamInfIndex: \(streamInfIndex)")
                 }
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
         }
         
@@ -647,7 +657,10 @@ class MasterPlaylistStreamSummaryTests: XCTestCase {
                 XCTAssert(errorText.contains("Location") && errorText.contains("streamInf"), "Expecting this error to be about location tags")
             case .internalIndexError:
                 XCTFail("Not expecting this error")
+            @unknown default:
+                XCTFail("Unknown enum case")
             }
+            
             return
         }
     }
diff --git a/mambaTests/PlaylistWriterTests.swift b/mambaTests/PlaylistWriterTests.swift
@@ -150,5 +150,5 @@ class PlaylistWriterTests: XCTestCase {
         }
     }
     
-    let standardMambaString = "# Generated by Mamba(\(Mamba.version)) Copyright (c) 2017 Comcast Corporation\n"
+    let standardMambaString = "# Generated by Mamba(\(FrameworkInfo.version)) Copyright (c) 2017 Comcast Corporation\n"
 }
diff --git a/mambaTests/ReadMeUnitTests.swift b/mambaTests/ReadMeUnitTests.swift
@@ -62,6 +62,8 @@ class ReadMeUnitTests: XCTestCase {
                             // handle the PlaylistParserError
                             myErrorHandler(error: error)
                             break
+                        @unknown default:
+                            XCTFail("Unknown enum case")
                         }
         })
         
@@ -81,6 +83,8 @@ class ReadMeUnitTests: XCTestCase {
             // handle the PlaylistParserError
             myErrorHandler(error: error)
             break
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
         
         // Validating a HLS Playlist
diff --git a/mambaTests/VariantPlaylistTagMatchSegmentInfoTests.swift b/mambaTests/VariantPlaylistTagMatchSegmentInfoTests.swift
@@ -66,6 +66,8 @@ segment5.ts
         case .timeMatch(let timeRange):
             XCTAssertEqual(timeRange.start, CMTime.zero)
             XCTAssertEqual(timeRange.duration, CMTime(failableInitWithString: "3.0000")!)
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
         
         // testing if the "match in header means no match" feature works
@@ -91,6 +93,8 @@ segment5.ts
         case .timeMatch(let timeRange):
             XCTAssertEqual(timeRange.start, CMTime(failableInitWithString: "6.0000")!)
             XCTAssertEqual(timeRange.duration, CMTime(failableInitWithString: "3.0000")!)
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
         
         XCTAssertEqual(testSegmentTags[1].containsDiscontinuity, true)
@@ -105,6 +109,8 @@ segment5.ts
         case .timeMatch(let timeRange):
             XCTAssertEqual(timeRange.start, CMTime(failableInitWithString: "12.0000")!)
             XCTAssertEqual(timeRange.duration, CMTime(failableInitWithString: "3.0000")!)
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
         
         // quick test of testing more "normal" segment based tags with "match in header means no match"
@@ -158,6 +164,8 @@ segment5.ts
             break
         case .timeMatch(_):
             XCTFail("Not expecting this value")
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
         
         XCTAssertEqual(testSegmentTags[1].containsDiscontinuity, true)
@@ -172,6 +180,8 @@ segment5.ts
             break
         case .timeMatch(_):
             XCTFail("Not expecting this value")
+        @unknown default:
+            XCTFail("Unknown enum case")
         }
     }
     

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ import Foundation`
`41`	`41`	`variantTagGroups[2] 3.m3u8`
`42`	`42`	```
`43`	`43`	`*/`
`44`		`-public typealias MasterPlaylistStructure = PlaylistStructureCore<MasterPlaylistStructureData, MasterPlaylistStructureDelegate>`
	`44`	`+public typealias MasterPlaylistStructure = PlaylistStructureCore<MasterPlaylistStructureDelegate>`
`45`	`45`
`46`	`46`	`extension PlaylistStructureCore: MasterPlaylistTagGroupProvider where PSD == MasterPlaylistStructureDelegate {`
`47`	`47`
`@@ -68,7 +68,7 @@ public protocol MasterPlaylistTagGroupProvider {`
`68`	`68`	`var variantTagGroups: [VariantTagGroup] { get }`
`69`	`69`	`}`
`70`	`70`
`71`		`-public struct MasterPlaylistStructureData: EmptyInitializerImplementor {`
	`71`	`+public struct MasterPlaylistStructureData: PlaylistStructure {`
`72`	`72`	`public init() {`
`73`	`73`	`self.variantTagGroups = [VariantTagGroup]()`
`74`	`74`	`}`
`@@ -78,7 +78,7 @@ public struct MasterPlaylistStructureData: EmptyInitializerImplementor {`
`78`	`78`	`var variantTagGroups: [VariantTagGroup]`
`79`	`79`	`}`
`80`	`80`
`81`		`-public final class MasterPlaylistStructureDelegate: PlaylistStructureDelegate, EmptyInitializerImplementor {`
	`81`	`+public final class MasterPlaylistStructureDelegate: PlaylistStructureDelegate {`
`82`	`82`
`83`	`83`	`public typealias T = MasterPlaylistStructureData`
`84`	`84`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ import Foundation`
`55`	`55`	`mediaSpans[1] would cover just mediaSegmentGroup[2] (range 2...2). Each media span has its own #EXT-X-KEY tag.`
`56`	`56`
`57`	`57`	`*/`
`58`		`-public typealias VariantPlaylistStructure = PlaylistStructureCore<MediaPlaylistStructureData, VariantPlaylistStructureDelegate>`
	`58`	`+public typealias VariantPlaylistStructure = PlaylistStructureCore<VariantPlaylistStructureDelegate>`
`59`	`59`
`60`	`60`	`extension PlaylistStructureCore: PlaylistTagSource, PlaylistTypeDetermination, VariantPlaylistStructureInterface where PSD == VariantPlaylistStructureDelegate {`
`61`	`61`
`@@ -173,7 +173,7 @@ extension VariantPlaylistStructureInterface {`
`173`	`173`	`}`
`174`	`174`	`}`
`175`	`175`
`176`		`-public struct MediaPlaylistStructureData: EmptyInitializerImplementor, PlaylistTypeDetermination {`
	`176`	`+public struct MediaPlaylistStructureData: PlaylistStructure, PlaylistTypeDetermination {`
`177`	`177`	`public init() {`
`178`	`178`	`self.header = nil`
`179`	`179`	`self.mediaSegmentGroups = [MediaSegmentPlaylistTagGroup]()`
`@@ -207,7 +207,7 @@ public struct MediaPlaylistStructureData: EmptyInitializerImplementor, PlaylistT`
`207`	`207`	`public var playlistType: PlaylistType`
`208`	`208`	`}`
`209`	`209`
`210`		`-public final class VariantPlaylistStructureDelegate: PlaylistStructureDelegate, EmptyInitializerImplementor {`
	`210`	`+public final class VariantPlaylistStructureDelegate: PlaylistStructureDelegate {`
`211`	`211`
`212`	`212`	`public typealias T = MediaPlaylistStructureData`
`213`	`213`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public class PlaylistWriter {`
`49`	`49`	`try write(string: identityString, toStream: stream)`
`50`	`50`	`}`
`51`	`51`	`if !suppressMambaIdentityString {`
`52`		`- try write(string: " Generated by Mamba(\(Mamba.version)) Copyright (c) 2017 Comcast Corporation", toStream: stream)`
	`52`	`+ try write(string: " Generated by Mamba(\(FrameworkInfo.version)) Copyright (c) 2017 Comcast Corporation", toStream: stream)`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`// write tags`