Shorter label and variable names

Issue #224
64characters · Aug 24, 2016 · db151f8 · db151f8
1 parent 4efbef8
commit db151f8
Show file tree

Hide file tree

Showing 17 changed files with 103 additions and 124 deletions.
diff --git a/Telephone/CompositionRoot.swift b/Telephone/CompositionRoot.swift
@@ -25,7 +25,7 @@ final class CompositionRoot: NSObject {
     let preferencesController: PreferencesController
     let ringtonePlayback: RingtonePlaybackUseCase
     let storeWindowController: StoreWindowController
-    private let userDefaults: NSUserDefaults
+    private let defaults: NSUserDefaults
     private let queue: dispatch_queue_t
 
     private let storeEventSource: StoreEventSource
@@ -34,17 +34,14 @@ final class CompositionRoot: NSObject {
 
     init(preferencesControllerDelegate: PreferencesControllerDelegate, conditionalRingtonePlaybackUseCaseDelegate: ConditionalRingtonePlaybackUseCaseDelegate) {
         userAgent = AKSIPUserAgent.sharedUserAgent()
-        userDefaults = NSUserDefaults.standardUserDefaults()
+        defaults = NSUserDefaults.standardUserDefaults()
         queue = createQueue()
 
         let audioDevices = SystemAudioDevices()
-        let useCaseFactory = DefaultUseCaseFactory(repository: audioDevices, userDefaults: userDefaults)
+        let useCaseFactory = DefaultUseCaseFactory(repository: audioDevices, defaults: defaults)
 
         let userDefaultsSoundFactory = UserDefaultsSoundFactory(
-            load: UserDefaultsRingtoneSoundConfigurationLoadUseCase(
-                userDefaults: userDefaults,
-                repository: audioDevices
-            ),
+            load: UserDefaultsRingtoneSoundConfigurationLoadUseCase(defaults: defaults, repository: audioDevices),
             factory: NSSoundToSoundAdapterFactory()
         )
 
@@ -86,11 +83,7 @@ final class CompositionRoot: NSObject {
         )
 
         let userAgentSoundIOSelection = DelayingUserAgentSoundIOSelectionUseCase(
-            useCase: UserAgentSoundIOSelectionUseCase(
-                repository: audioDevices,
-                userAgent: userAgent,
-                userDefaults: userDefaults
-            ),
+            useCase: UserAgentSoundIOSelectionUseCase(repository: audioDevices, userAgent: userAgent, defaults: defaults),
             userAgent: userAgent
         )
 

diff --git a/Telephone/DefaultUseCaseFactory.swift b/Telephone/DefaultUseCaseFactory.swift
@@ -20,28 +20,24 @@ import UseCases
 
 final class DefaultUseCaseFactory {
     private let repository: SystemAudioDeviceRepository
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
 
-    init(repository: SystemAudioDeviceRepository, userDefaults: StringUserDefaults) {
+    init(repository: SystemAudioDeviceRepository, defaults: StringUserDefaults) {
         self.repository = repository
-        self.userDefaults = userDefaults
+        self.defaults = defaults
     }
 }
 
 extension DefaultUseCaseFactory: UseCaseFactory {
     func createUserDefaultsSoundIOLoadUseCase(output output: UserDefaultsSoundIOLoadUseCaseOutput) -> ThrowingUseCase {
-        return UserDefaultsSoundIOLoadUseCase(
-            repository: repository,
-            userDefaults: userDefaults,
-            output: output
-        )
+        return UserDefaultsSoundIOLoadUseCase(repository: repository, defaults: defaults, output: output)
     }
 
     func createUserDefaultsSoundIOSaveUseCase(soundIO soundIO: PresentationSoundIO) -> UseCase {
-        return UserDefaultsSoundIOSaveUseCase(soundIO: soundIO, userDefaults: userDefaults)
+        return UserDefaultsSoundIOSaveUseCase(soundIO: soundIO, defaults: defaults)
     }
 
     func createUserDefaultsRingtoneSoundNameSaveUseCase(name name: String) -> UseCase {
-        return UserDefaultsRingtoneSoundNameSaveUseCase(name: name, userDefaults: userDefaults)
+        return UserDefaultsRingtoneSoundNameSaveUseCase(name: name, defaults: defaults)
     }
 }
diff --git a/TelephoneTests/DefaultSoundPreferencesViewEventTargetTests.swift b/TelephoneTests/DefaultSoundPreferencesViewEventTargetTests.swift
@@ -43,7 +43,7 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
 
     func testExecutesUserDefaultsSoundIOLoadUseCaseOnViewDataReload() {
         let useCase = ThrowingUseCaseSpy()
-        factory.stubWithUserDefaultsSoundIOLoad(useCase)
+        factory.stub(withUserDefaultsSoundIOLoad: useCase)
 
         sut.viewShouldReloadData(SoundPreferencesViewSpy())
 
@@ -52,7 +52,7 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
 
     func testExecutesUserDefaultsSoundIOLoadUseCaseOnSoundIOReload() {
         let useCase = ThrowingUseCaseSpy()
-        factory.stubWithUserDefaultsSoundIOLoad(useCase)
+        factory.stub(withUserDefaultsSoundIOLoad: useCase)
 
         sut.viewShouldReloadSoundIO(SoundPreferencesViewSpy())
 
@@ -61,7 +61,7 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
 
     func testExecutesUserDefaultsSoundIOSaveUseCaseWithExpectedArgumentsOnSoundIOChange() {
         let useCase = UseCaseSpy()
-        factory.stubWithUserDefaultsSoundIOSave(useCase)
+        factory.stub(withUserDefaultsSoundIOSave: useCase)
         let soundIO = PresentationSoundIO(input: "input", output: "output1", ringtoneOutput: "output2")
 
         sut.viewDidChangeSoundIO(
@@ -73,15 +73,15 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
     }
 
     func testExecutesUserAgentSoundIOSelectionUseCaseOnSoundIOChange() {
-        factory.stubWithUserDefaultsSoundIOSave(UseCaseSpy())
+        factory.stub(withUserDefaultsSoundIOSave: UseCaseSpy())
 
         sut.viewDidChangeSoundIO(input: "any-input", output: "any-output", ringtoneOutput: "any-output")
 
         XCTAssertTrue(userAgentSoundIOSelection.didCallExecute)
     }
 
     func testExecutesRingtoneOutputUpdateUseCaseOnSoundIOChange() {
-        factory.stubWithUserDefaultsSoundIOSave(UseCaseSpy())
+        factory.stub(withUserDefaultsSoundIOSave: UseCaseSpy())
 
         sut.viewDidChangeSoundIO(input: "any-input", output: "any-output", ringtoneOutput: "any-output")
 
@@ -90,7 +90,7 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
 
     func testExecutesUserDefaultsRingtoneSoundNameSaveUseCaseWithExpectedArgumentsOnRingtoneNameChange() {
         let useCase = UseCaseSpy()
-        factory.stubWithUserDefaultsRingtoneSoundNameSave(useCase)
+        factory.stub(withUserDefaultsRingtoneSoundNameSave: useCase)
 
         sut.viewDidChangeRingtoneName("sound-name")
 
@@ -99,7 +99,7 @@ final class DefaultSoundPreferencesViewEventTargetTests: XCTestCase {
     }
 
     func testPlaysRingtoneSoundOnRingtoneNameChange() {
-        factory.stubWithUserDefaultsRingtoneSoundNameSave(UseCaseSpy())
+        factory.stub(withUserDefaultsRingtoneSoundNameSave: UseCaseSpy())
 
         sut.viewDidChangeRingtoneName("any-name")
 

diff --git a/UseCases/PreferredSoundIO.swift b/UseCases/PreferredSoundIO.swift
@@ -20,14 +20,14 @@ import Domain
 
 struct PreferredSoundIO {
     private let devices: SystemAudioDevices
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
     private let soundIO: SoundIO
 
-    init(devices: SystemAudioDevices, userDefaults: StringUserDefaults) {
+    init(devices: SystemAudioDevices, defaults: StringUserDefaults) {
         self.devices = devices
-        self.userDefaults = userDefaults
+        self.defaults = defaults
         soundIO = FallingBackSoundIO(
-            origin: UserDefaultsSoundIO(devices: devices, userDefaults: userDefaults),
+            origin: UserDefaultsSoundIO(devices: devices, defaults: defaults),
             fallback: Domain.PreferredSoundIO(devices: devices.all)
         )
     }

diff --git a/UseCases/UserAgentSoundIOSelectionUseCase.swift b/UseCases/UserAgentSoundIOSelectionUseCase.swift
@@ -21,15 +21,15 @@ import Domain
 public final class UserAgentSoundIOSelectionUseCase {
     private let repository: SystemAudioDeviceRepository
     private let userAgent: UserAgent
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
     private var devices: SystemAudioDevices!
     private var deviceMap: SystemToUserAgentAudioDeviceMap!
     private var soundIO: SoundIO!
 
-    public init(repository: SystemAudioDeviceRepository, userAgent: UserAgent, userDefaults: StringUserDefaults) {
+    public init(repository: SystemAudioDeviceRepository, userAgent: UserAgent, defaults: StringUserDefaults) {
         self.repository = repository
         self.userAgent = userAgent
-        self.userDefaults = userDefaults
+        self.defaults = defaults
     }
 }
 
@@ -53,7 +53,7 @@ extension UserAgentSoundIOSelectionUseCase: ThrowingUseCase {
     }
 
     private func updateSoundIO() {
-        soundIO = PreferredSoundIO(devices: devices, userDefaults: userDefaults)
+        soundIO = PreferredSoundIO(devices: devices, defaults: defaults)
     }
 
     private func selectUserAgentSoundIO() throws {

diff --git a/UseCases/UserDefaultsRingtoneSoundConfigurationLoadUseCase.swift b/UseCases/UserDefaultsRingtoneSoundConfigurationLoadUseCase.swift
@@ -19,11 +19,11 @@
 import Domain
 
 public final class UserDefaultsRingtoneSoundConfigurationLoadUseCase {
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
     private let repository: SystemAudioDeviceRepository
 
-    public init(userDefaults: StringUserDefaults, repository: SystemAudioDeviceRepository) {
-        self.userDefaults = userDefaults
+    public init(defaults: StringUserDefaults, repository: SystemAudioDeviceRepository) {
+        self.defaults = defaults
         self.repository = repository
     }
 }
@@ -34,7 +34,7 @@ extension UserDefaultsRingtoneSoundConfigurationLoadUseCase: SoundConfigurationL
     }
 
     private func ringtoneSoundName() throws -> String {
-        if let name = userDefaults[kRingingSound] {
+        if let name = defaults[kRingingSound] {
             return name
         } else {
             throw Error.RingtoneSoundNameNotFoundError
@@ -43,8 +43,7 @@ extension UserDefaultsRingtoneSoundConfigurationLoadUseCase: SoundConfigurationL
 
     private func ringtoneAudioDeviceUID() throws -> String {
         let soundIO = PreferredSoundIO(
-            devices: SystemAudioDevices(devices: try repository.allDevices()),
-            userDefaults: userDefaults
+            devices: SystemAudioDevices(devices: try repository.allDevices()), defaults: defaults
         )
         return soundIO.ringtoneOutput.uniqueIdentifier
     }

diff --git a/UseCases/UserDefaultsRingtoneSoundNameSaveUseCase.swift b/UseCases/UserDefaultsRingtoneSoundNameSaveUseCase.swift
@@ -18,18 +18,18 @@
 
 public final class UserDefaultsRingtoneSoundNameSaveUseCase {
     private let name: String
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
 
-    public init(name: String, userDefaults: StringUserDefaults) {
+    public init(name: String, defaults: StringUserDefaults) {
         self.name = name
-        self.userDefaults = userDefaults
+        self.defaults = defaults
     }
 }
 
 extension UserDefaultsRingtoneSoundNameSaveUseCase: UseCase {
     public func execute() {
         if !name.isEmpty {
-            userDefaults[kRingingSound] = name
+            defaults[kRingingSound] = name
         }
     }
 }
diff --git a/UseCases/UserDefaultsSoundIO.swift b/UseCases/UserDefaultsSoundIO.swift
@@ -20,14 +20,14 @@ import Domain
 
 struct UserDefaultsSoundIO {
     private let devices: SystemAudioDevices
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
     private var optionalInput: SystemAudioDevice!
     private var optionalOutput: SystemAudioDevice!
     private var optionalRingtoneOutput: SystemAudioDevice!
 
-    init(devices: SystemAudioDevices, userDefaults: StringUserDefaults) {
+    init(devices: SystemAudioDevices, defaults: StringUserDefaults) {
         self.devices = devices
-        self.userDefaults = userDefaults
+        self.defaults = defaults
         optionalInput = inputDeviceByNameWithUserDefaultsKey(kSoundInput)
         optionalOutput = outputDeviceByNameWithUserDefaultsKey(kSoundOutput)
         optionalRingtoneOutput = outputDeviceByNameWithUserDefaultsKey(kRingtoneOutput)
@@ -42,7 +42,7 @@ struct UserDefaultsSoundIO {
     }
 
     private func deviceByNameWithUserDefaultsKey(key: String, function: String -> SystemAudioDevice) -> SystemAudioDevice {
-        if let name = userDefaults.stringForKey(key) {
+        if let name = defaults.stringForKey(key) {
             return function(name)
         } else {
             return NullSystemAudioDevice()

diff --git a/UseCases/UserDefaultsSoundIOLoadUseCase.swift b/UseCases/UserDefaultsSoundIOLoadUseCase.swift
@@ -24,12 +24,12 @@ public protocol UserDefaultsSoundIOLoadUseCaseOutput: class {
 
 public final class UserDefaultsSoundIOLoadUseCase {
     private let repository: SystemAudioDeviceRepository
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
     private let output: UserDefaultsSoundIOLoadUseCaseOutput
 
-    public init(repository: SystemAudioDeviceRepository, userDefaults: StringUserDefaults, output: UserDefaultsSoundIOLoadUseCaseOutput) {
+    public init(repository: SystemAudioDeviceRepository, defaults: StringUserDefaults, output: UserDefaultsSoundIOLoadUseCaseOutput) {
         self.repository = repository
-        self.userDefaults = userDefaults
+        self.defaults = defaults
         self.output = output
     }
 }
@@ -39,9 +39,7 @@ extension UserDefaultsSoundIOLoadUseCase: ThrowingUseCase {
         let devices = SystemAudioDevices(devices: try repository.allDevices())
         output.update(
             devices: AudioDevices(devices: devices),
-            soundIO: PresentationSoundIO(
-                soundIO: PreferredSoundIO(devices: devices, userDefaults: userDefaults)
-            )
+            soundIO: PresentationSoundIO(soundIO: PreferredSoundIO(devices: devices, defaults: defaults))
         )
     }
 }
diff --git a/UseCases/UserDefaultsSoundIOSaveUseCase.swift b/UseCases/UserDefaultsSoundIOSaveUseCase.swift
@@ -18,11 +18,11 @@
 
 public final class UserDefaultsSoundIOSaveUseCase {
     private let soundIO: PresentationSoundIO
-    private let userDefaults: StringUserDefaults
+    private let defaults: StringUserDefaults
 
-    public init(soundIO: PresentationSoundIO, userDefaults: StringUserDefaults) {
+    public init(soundIO: PresentationSoundIO, defaults: StringUserDefaults) {
         self.soundIO = soundIO
-        self.userDefaults = userDefaults
+        self.defaults = defaults
     }
 }
 
@@ -35,19 +35,19 @@ extension UserDefaultsSoundIOSaveUseCase: UseCase {
 
     private func saveInputIfNeeded() {
         if !soundIO.input.isEmpty {
-            userDefaults[kSoundInput] = soundIO.input
+            defaults[kSoundInput] = soundIO.input
         }
     }
 
     private func saveOutputIfNeeded() {
         if !soundIO.output.isEmpty {
-            userDefaults[kSoundOutput] = soundIO.output
+            defaults[kSoundOutput] = soundIO.output
         }
     }
 
     private func saveRingtoneOutputIfNeeded() {
         if !soundIO.ringtoneOutput.isEmpty {
-            userDefaults[kRingtoneOutput] = soundIO.ringtoneOutput
+            defaults[kRingtoneOutput] = soundIO.ringtoneOutput
         }
     }
 }
diff --git a/UseCasesTestDoubles/UseCaseFactorySpy.swift b/UseCasesTestDoubles/UseCaseFactorySpy.swift
@@ -22,37 +22,37 @@ public final class UseCaseFactorySpy {
     public private(set) var invokedSoundIO = PresentationSoundIO(input: "", output: "", ringtoneOutput: "")
     public private(set) var invokedRingtoneSoundName = ""
 
-    private var userDefaultsSoundIOLoad: ThrowingUseCase!
-    private var userDefaultsSoundIOSave: UseCase!
-    private var userDefaultsRingtoneSoundNameSave: UseCase!
+    private var soundIOLoad: ThrowingUseCase!
+    private var soundIOSave: UseCase!
+    private var ringtoneSoundNameSave: UseCase!
 
     public init() {}
 
-    public func stubWithUserDefaultsSoundIOLoad(useCase: ThrowingUseCase) {
-        userDefaultsSoundIOLoad = useCase
+    public func stub(withUserDefaultsSoundIOLoad useCase: ThrowingUseCase) {
+        soundIOLoad = useCase
     }
 
-    public func stubWithUserDefaultsSoundIOSave(useCase: UseCase) {
-        userDefaultsSoundIOSave = useCase
+    public func stub(withUserDefaultsSoundIOSave useCase: UseCase) {
+        soundIOSave = useCase
     }
 
-    public func stubWithUserDefaultsRingtoneSoundNameSave(useCase: UseCase) {
-        userDefaultsRingtoneSoundNameSave = useCase
+    public func stub(withUserDefaultsRingtoneSoundNameSave useCase: UseCase) {
+        ringtoneSoundNameSave = useCase
     }
 }
 
 extension UseCaseFactorySpy: UseCaseFactory {
     public func createUserDefaultsSoundIOLoadUseCase(output output: UserDefaultsSoundIOLoadUseCaseOutput) -> ThrowingUseCase {
-        return userDefaultsSoundIOLoad
+        return soundIOLoad
     }
 
     public func createUserDefaultsSoundIOSaveUseCase(soundIO soundIO: PresentationSoundIO) -> UseCase {
         invokedSoundIO = soundIO
-        return userDefaultsSoundIOSave
+        return soundIOSave
     }
 
     public func createUserDefaultsRingtoneSoundNameSaveUseCase(name name: String) -> UseCase {
         invokedRingtoneSoundName = name
-        return userDefaultsRingtoneSoundNameSave
+        return ringtoneSoundNameSave
     }
 }