LOOP-1099: Promote AlertSoundPlayer to LoopKit (#74)

* LOOP-1179: Implement Alert Sounds

Introduces a new "AlertSoundVendor" abstraction, which DeviceManagers now can implement in order to vend sounds to play with alerts.
The sounds are simply named as part of the DeviceAlert to play.  Sound configuration is still up to the device's settings UI.

This adds the ability to:
1. Copy Alert Sounds to /Library/Sounds from each device manager (they need to be there for UserNotifications to find them, and for convenience we play them from that same location in-app)
2. Play those sounds either in the in-app modal or the UserNotification

* Promote AlertSoundPlayer to LoopKit

...that way, it can be used elsewhere for playing alert sounds.

* PR Feedback: Make DeviceAlert.SoundName a struct

* More PR feedback

* Build fix

* More PR feedback: Make SoundName a first-class enum (and name it just "Sound")

* PR Feedback

* Remove unused import

Author: rickpasetto

Loop.xcodeproj/project.pbxproj

@@ -332,6 +332,7 @@
 		892D7C5123B54A15008A9656 /* CarbEntryViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 892D7C5023B54A14008A9656 /* CarbEntryViewController.swift */; };
 		892FB4CD22040104005293EC /* OverridePresetRow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 892FB4CC22040104005293EC /* OverridePresetRow.swift */; };
 		892FB4CF220402C0005293EC /* OverrideSelectionController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 892FB4CE220402C0005293EC /* OverrideSelectionController.swift */; };
+		893C9F852446F54E00CD4185 /* Environment+Dismiss.swift in Sources */ = {isa = PBXBuildFile; fileRef = 893C9F842446F54E00CD4185 /* Environment+Dismiss.swift */; };
 		894F6DD3243BCBDB00CCE676 /* Environment+SizeClass.swift in Sources */ = {isa = PBXBuildFile; fileRef = 894F6DD2243BCBDB00CCE676 /* Environment+SizeClass.swift */; };
 		894F6DD7243C047300CCE676 /* View+Position.swift in Sources */ = {isa = PBXBuildFile; fileRef = 894F6DD6243C047300CCE676 /* View+Position.swift */; };
 		894F6DD9243C060600CCE676 /* ScalablePositionedText.swift in Sources */ = {isa = PBXBuildFile; fileRef = 894F6DD8243C060600CCE676 /* ScalablePositionedText.swift */; };
@@ -343,7 +344,6 @@
 		895788B1242E69A2002CB114 /* Color.swift in Sources */ = {isa = PBXBuildFile; fileRef = 895788A9242E69A1002CB114 /* Color.swift */; };
 		895788B2242E69A2002CB114 /* CircularAccessoryButtonStyle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 895788AA242E69A1002CB114 /* CircularAccessoryButtonStyle.swift */; };
 		895788B3242E69A2002CB114 /* ActionButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = 895788AB242E69A2002CB114 /* ActionButton.swift */; };
-		893C9F852446F54E00CD4185 /* Environment+Dismiss.swift in Sources */ = {isa = PBXBuildFile; fileRef = 893C9F842446F54E00CD4185 /* Environment+Dismiss.swift */; };
 		895FE0952201234000FCF18A /* OverrideSelectionViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = 895FE0942201234000FCF18A /* OverrideSelectionViewController.swift */; };
 		8968B1122408B3520074BB48 /* UIFont.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8968B1112408B3520074BB48 /* UIFont.swift */; };
 		8968B114240C55F10074BB48 /* LoopSettingsTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8968B113240C55F10074BB48 /* LoopSettingsTests.swift */; };
@@ -1019,6 +1019,7 @@
 		892D7C5023B54A14008A9656 /* CarbEntryViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CarbEntryViewController.swift; sourceTree = "<group>"; };
 		892FB4CC22040104005293EC /* OverridePresetRow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OverridePresetRow.swift; sourceTree = "<group>"; };
 		892FB4CE220402C0005293EC /* OverrideSelectionController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OverrideSelectionController.swift; sourceTree = "<group>"; };
+		893C9F842446F54E00CD4185 /* Environment+Dismiss.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Environment+Dismiss.swift"; sourceTree = "<group>"; };
 		894F6DD2243BCBDB00CCE676 /* Environment+SizeClass.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Environment+SizeClass.swift"; sourceTree = "<group>"; };
 		894F6DD6243C047300CCE676 /* View+Position.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; name = "View+Position.swift"; path = "WatchApp Extension/Views/View+Position.swift"; sourceTree = SOURCE_ROOT; };
 		894F6DD8243C060600CCE676 /* ScalablePositionedText.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ScalablePositionedText.swift; sourceTree = "<group>"; };
@@ -1030,7 +1031,6 @@
 		895788A9242E69A1002CB114 /* Color.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Color.swift; sourceTree = "<group>"; };
 		895788AA242E69A1002CB114 /* CircularAccessoryButtonStyle.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CircularAccessoryButtonStyle.swift; sourceTree = "<group>"; };
 		895788AB242E69A2002CB114 /* ActionButton.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ActionButton.swift; sourceTree = "<group>"; };
-		893C9F842446F54E00CD4185 /* Environment+Dismiss.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Environment+Dismiss.swift"; sourceTree = "<group>"; };
 		895FE0942201234000FCF18A /* OverrideSelectionViewController.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OverrideSelectionViewController.swift; sourceTree = "<group>"; };
 		8968B1112408B3520074BB48 /* UIFont.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UIFont.swift; sourceTree = "<group>"; };
 		8968B113240C55F10074BB48 /* LoopSettingsTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoopSettingsTests.swift; sourceTree = "<group>"; };

Loop/Managers/DeviceAlert/InAppModalDeviceAlertPresenter.swift

@@ -8,14 +8,6 @@
 
 import Foundation
 import LoopKit
-import AudioToolbox
-import AVFoundation
-
-
-public protocol AlertSoundPlayer {
-    func vibrate()
-    func play(url: URL)
-}
 
 public class InAppModalDeviceAlertPresenter: DeviceAlertPresenter {
 
@@ -31,11 +23,11 @@ public class InAppModalDeviceAlertPresenter: DeviceAlertPresenter {
     typealias TimerFactoryFunction = (TimeInterval, Bool, (() -> Void)?) -> Timer
     private let newTimerFunc: TimerFactoryFunction
 
-    private let soundPlayer: AlertSoundPlayer
+    private let soundPlayer: DeviceAlertSoundPlayer
 
     init(rootViewController: UIViewController,
          deviceAlertManagerResponder: DeviceAlertManagerResponder,
-         soundPlayer: AlertSoundPlayer = AVSoundPlayer(),
+         soundPlayer: DeviceAlertSoundPlayer = DeviceAVSoundPlayer(),
          newActionFunc: @escaping ActionFactoryFunction = UIAlertAction.init,
          newTimerFunc: TimerFactoryFunction? = nil) {
         self.rootViewController = rootViewController
@@ -185,28 +177,3 @@ extension InAppModalDeviceAlertPresenter {
         }
     }
 }
-
-private class AVSoundPlayer: AlertSoundPlayer {
-    private var soundEffect: AVAudioPlayer?
-    private let log = DiagnosticLog(category: "AVSoundPlayer")
-    
-    func vibrate() {
-        AudioServicesPlayAlertSound(SystemSoundID(kSystemSoundID_Vibrate))
-    }
-    
-    func play(url: URL) {
-        DispatchQueue.main.async {
-            do {
-                // The AVAudioPlayer has to remain around until the sound completes playing.  A cleaner way might be
-                // to wait until that completes, then delete it, but seems overkill.
-                let soundEffect = try AVAudioPlayer(contentsOf: url)
-                self.soundEffect = soundEffect
-                if !soundEffect.play() {
-                    self.log.default("couldn't play sound (app may be in the background): %@", url.absoluteString)
-                }
-            } catch {
-                self.log.error("couldn't play sound %@: %@", url.absoluteString, String(describing: error))
-            }
-        }
-    }
-}

LoopTests/Managers/DeviceAlert/InAppModalDeviceAlertPresenterTests.swift

@@ -57,7 +57,7 @@ class InAppModalDeviceAlertPresenterTests: XCTestCase {
         }
     }
 
-    class MockSoundPlayer: AlertSoundPlayer {
+    class MockSoundPlayer: DeviceAlertSoundPlayer {
         var vibrateCalled = false
         func vibrate() {
             vibrateCalled = true