Add logging and some structure

Author: brianmichel

.swift-version

@@ -0,0 +1 @@
+5

.swiftlint.yml

@@ -0,0 +1,9 @@
+disabled_rules:
+ - line_length
+ - unused_closure_parameter
+ - trailing_comma
+ - type_body_length
+ - file_length
+opt_in_rules:
+ - switch_case_on_newline
+ - implicitly_unwrapped_optional

Operator.xcodeproj/project.pbxproj

@@ -3,11 +3,13 @@
 archiveVersion = 1;
 classes = {
 };
-objectVersion = 50;
+objectVersion = 51;
 objects = {
 
 /* Begin PBXBuildFile section */
 72352439246D006D00F58C61 /* String+Extensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = 72352438246D006D00F58C61 /* String+Extensions.swift */; };
+726A21F124701C4800DBAB87 /* Log.swift in Sources */ = {isa = PBXBuildFile; fileRef = 726A21F024701C4800DBAB87 /* Log.swift */; };
+726A21F324701C5D00DBAB87 /* LogFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 726A21F224701C5D00DBAB87 /* LogFormatter.swift */; };
 72704C6B2460EF10006F3E99 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 72704C6A2460EF10006F3E99 /* AppDelegate.swift */; };
 72704C6D2460EF10006F3E99 /* SceneDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 72704C6C2460EF10006F3E99 /* SceneDelegate.swift */; };
 72704C6F2460EF10006F3E99 /* ContentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 72704C6E2460EF10006F3E99 /* ContentView.swift */; };
@@ -37,6 +39,8 @@
 6761102642A44577E3E6499D /* Pods-Operator.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Operator.debug.xcconfig"; path = "Target Support Files/Pods-Operator/Pods-Operator.debug.xcconfig"; sourceTree = "<group>"; };
 722F0F2B246CE18800C857E9 /* sample-modified.aif */ = {isa = PBXFileReference; lastKnownFileType = file; path = "sample-modified.aif"; sourceTree = "<group>"; };
 72352438246D006D00F58C61 /* String+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "String+Extensions.swift"; sourceTree = "<group>"; };
+726A21F024701C4800DBAB87 /* Log.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Log.swift; sourceTree = "<group>"; };
+726A21F224701C5D00DBAB87 /* LogFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LogFormatter.swift; sourceTree = "<group>"; };
 72704C672460EF10006F3E99 /* Operator.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Operator.app; sourceTree = BUILT_PRODUCTS_DIR; };
 72704C6A2460EF10006F3E99 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
 72704C6C2460EF10006F3E99 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = "<group>"; };
@@ -90,6 +94,25 @@
 path = Extensions;
 sourceTree = "<group>";
 };
+726A21EF24701C2A00DBAB87 /* Logging */ = {
+isa = PBXGroup;
+children = (
+726A21F024701C4800DBAB87 /* Log.swift */,
+726A21F224701C5D00DBAB87 /* LogFormatter.swift */,
+);
+path = Logging;
+sourceTree = "<group>";
+};
+726A21F424701C9D00DBAB87 /* Sections */ = {
+isa = PBXGroup;
+children = (
+72704C6A2460EF10006F3E99 /* AppDelegate.swift */,
+72704C6C2460EF10006F3E99 /* SceneDelegate.swift */,
+72704C6E2460EF10006F3E99 /* ContentView.swift */,
+);
+path = Sections;
+sourceTree = "<group>";
+};
 72704C5E2460EF10006F3E99 = {
 isa = PBXGroup;
 children = (
@@ -113,13 +136,9 @@
 72704C692460EF10006F3E99 /* Operator */ = {
 isa = PBXGroup;
 children = (
+726A21F424701C9D00DBAB87 /* Sections */,
 72704C832460EF94006F3E99 /* Infrastructure */,
 72704C7F2460EF4A006F3E99 /* Resources */,
-72704C6A2460EF10006F3E99 /* AppDelegate.swift */,
-72704C6C2460EF10006F3E99 /* SceneDelegate.swift */,
-72704C6E2460EF10006F3E99 /* ContentView.swift */,
-72704C702460EF13006F3E99 /* Assets.xcassets */,
-72704C752460EF13006F3E99 /* LaunchScreen.storyboard */,
 72704C722460EF13006F3E99 /* Preview Content */,
 );
 path = Operator;
@@ -139,6 +158,8 @@
 72704C802460EF59006F3E99 /* Test Sound Files */,
 72704C782460EF13006F3E99 /* Info.plist */,
 72704C7E2460EF41006F3E99 /* Operator.entitlements */,
+72704C702460EF13006F3E99 /* Assets.xcassets */,
+72704C752460EF13006F3E99 /* LaunchScreen.storyboard */,
 );
 path = Resources;
 sourceTree = "<group>";
@@ -154,6 +175,7 @@
 72704C832460EF94006F3E99 /* Infrastructure */ = {
 isa = PBXGroup;
 children = (
+726A21EF24701C2A00DBAB87 /* Logging */,
 72352437246D006200F58C61 /* Extensions */,
 72704C842460EF9E006F3E99 /* Audio */,
 );
@@ -193,7 +215,6 @@
 6761102642A44577E3E6499D /* Pods-Operator.debug.xcconfig */,
 32F8E8113014F8384AD3C0D6 /* Pods-Operator.release.xcconfig */,
 );
-name = Pods;
 path = Pods;
 sourceTree = "<group>";
 };
@@ -209,6 +230,8 @@
 72704C642460EF10006F3E99 /* Frameworks */,
 72704C652460EF10006F3E99 /* Resources */,
 411B10740FB47AEB4D78E934 /* [CP] Embed Pods Frameworks */,
+726A21F5247023F900DBAB87 /* Run SwiftFormat */,
+726A21F62470242300DBAB87 /* Run SwiftLint */,
 );
 buildRules = (
 );
@@ -338,6 +361,42 @@
 shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n";
 showEnvVarsInLog = 0;
 };
+726A21F5247023F900DBAB87 /* Run SwiftFormat */ = {
+isa = PBXShellScriptBuildPhase;
+buildActionMask = 2147483647;
+files = (
+);
+inputFileListPaths = (
+);
+inputPaths = (
+);
+name = "Run SwiftFormat";
+outputFileListPaths = (
+);
+outputPaths = (
+);
+runOnlyForDeploymentPostprocessing = 0;
+shellPath = /bin/sh;
+shellScript = "git diff HEAD --name-only --diff-filter=ACMRTU -- \"Operator/*.swift\" | while read filename; do\n${SRCROOT}/Pods/SwiftFormat/CommandLineTool/swiftformat \"$filename\";\ndone\n";
+};
+726A21F62470242300DBAB87 /* Run SwiftLint */ = {
+isa = PBXShellScriptBuildPhase;
+buildActionMask = 2147483647;
+files = (
+);
+inputFileListPaths = (
+);
+inputPaths = (
+);
+name = "Run SwiftLint";
+outputFileListPaths = (
+);
+outputPaths = (
+);
+runOnlyForDeploymentPostprocessing = 0;
+shellPath = /bin/sh;
+shellScript = "git diff HEAD --name-only --diff-filter=ACMRTU -- \"Operator/*.swift\" | while read filename; do\n${PODS_ROOT}/SwiftLint/swiftlint lint --path \"$filename\";\ndone\n";
+};
 /* End PBXShellScriptBuildPhase section */
 
 /* Begin PBXSourcesBuildPhase section */
@@ -347,6 +406,8 @@
 files = (
 72352439246D006D00F58C61 /* String+Extensions.swift in Sources */,
 72704C862460EFB7006F3E99 /* AudioFile.swift in Sources */,
+726A21F124701C4800DBAB87 /* Log.swift in Sources */,
+726A21F324701C5D00DBAB87 /* LogFormatter.swift in Sources */,
 72704C6B2460EF10006F3E99 /* AppDelegate.swift in Sources */,
 72704C6D2460EF10006F3E99 /* SceneDelegate.swift in Sources */,
 72704C6F2460EF10006F3E99 /* ContentView.swift in Sources */,

Operator/Infrastructure/Audio/AudioFile.swift

@@ -21,14 +21,13 @@ extension FourCharCode {
  var code: FourCharCode = 0
  // Value has to consist of 4 printable ASCII characters, e.g. '420v'.
  // Note: This implementation does not enforce printable range (32-126)
- if value.count == 4 && value.utf8.count == 4 {
+ if value.count == 4, value.utf8.count == 4 {
  for byte in value.utf8 {
  code = code << 8 + FourCharCode(byte)
  }
- }
- else {
- print("FourCharCode: Can't initialize with '\(value)', only printable ASCII allowed. Setting to '????'.")
- code = 0x3F3F3F3F // = '????'
+ } else {
+ Log.warn("FourCharCode: Can't initialize with '\(value)', only printable ASCII allowed. Setting to '????'.")
+ code = 0x3F3F_3F3F // = '????'
  }
  self = code
  }
@@ -46,14 +45,14 @@ final class AudioFile {
 
  let status = AudioFileCountUserData(fileId, code, &itemCount)
 
- guard status == noErr else  {
+ guard status == noErr else {
  return 0
  }
 
  var size: UInt32 = 0
  AudioFileGetUserDataSize(fileId, code, 0, &size)
 
- guard let data: UnsafeMutablePointer<UInt8> = get(userDataPointer: code, index: 0, inputSize: size) else  {
+ guard let data: UnsafeMutablePointer<UInt8> = get(userDataPointer: code, index: 0, inputSize: size) else {
  return 0
  }
  defer {
@@ -64,13 +63,13 @@ final class AudioFile {
  let string: String? = String(cString: data)
  // Determine if we've reached the OP-1 JSON, and if so advance 4 bytes and strip control characters.
  if let almostJSON = string, almostJSON.starts(with: "op-1") {
- let strippedString = almostJSON[4..<almostJSON.count].trimmingCharacters(in: .controlCharacters)
+ let strippedString = almostJSON[4 ..< almostJSON.count].trimmingCharacters(in: .controlCharacters)
 
  do {
  let parsed = try JSONSerialization.jsonObject(with: strippedString.data(using: .utf8)!)
- print("Parsed: \(parsed)")
- } catch(let error) {
- print("Error Parsing String - \(error)")
+ Log.debug("Parsed: \(parsed)")
+ } catch {
+ Log.error("Error Parsing String - \(error)")
  }
  }
 
@@ -90,15 +89,15 @@ final class AudioFile {
 
  let status = AudioFileOpenURL(url as CFURL, .readPermission, kAudioFileAIFFType, &audioFile)
 
- print("status: \(status)")
+ Log.debug("status: \(status)")
 
  if let file = audioFile {
  fileId = file
  } else {
  return nil
  }
 
- print("Data count: \(self.userDataCount)")
+ Log.debug("Data count: \(userDataCount)")
  }
 
  func get<T>(userData code: FourCharCode, index: UInt32, inputSize: UInt32 = UInt32(MemoryLayout<T>.size)) -> T? {
@@ -115,7 +114,7 @@ final class AudioFile {
  &size,
  propertyData)
 
- if status == noErr && size > 0 {
+ if status == noErr, size > 0 {
  return propertyData[0]
  }
 
@@ -132,7 +131,7 @@ final class AudioFile {
  &size,
  propertyData)
 
- if status == noErr && size > 0 {
+ if status == noErr, size > 0 {
  return propertyData
  }
 
@@ -168,9 +167,9 @@ final class AudioFile {
  &size,
  propertyData)
 
- print("Got status \(status) when looking for property \(property)")
+ Log.debug("Got status \(status) when looking for property \(property)")
 
- if status == noErr && size > 0 {
+ if status == noErr, size > 0 {
  return propertyData.pointee
  }
 

Operator/Infrastructure/Logging/Log.swift

@@ -0,0 +1,92 @@
+//
+// Log.swift
+// Operator
+//
+// Created by Brian Michel on 5/16/20.
+// Copyright © 2020 Brian Michel. All rights reserved.
+//
+
+import CocoaLumberjack
+import Foundation
+
+private var logLevel: DDLogLevel = .all
+
+final class Log {
+ private static let logger: DDLog = {
+ DDLog.add(DDOSLogger.sharedInstance) // ASL = Apple System Logs
+
+ let logFormatter = LogFormatter()
+ DDOSLogger.sharedInstance.logFormatter = logFormatter
+
+ let fileLogger: DDFileLogger = DDFileLogger() // File Logger
+ fileLogger.rollingFrequency = TimeInterval(60 * 60 * 24) // 24 hours
+ fileLogger.logFileManager.maximumNumberOfLogFiles = 7
+ DDLog.add(fileLogger)
+
+ return DDLog.sharedInstance
+ }()
+
+ class func info(_ message: @autoclosure () -> String,
+ _ path: StaticString = #file,
+ _ function: StaticString = #function,
+ line: UInt = #line) {
+ _DDLogMessage(message(),
+ level: logLevel,
+ flag: .info,
+ context: 0,
+ file: path,
+ function: function,
+ line: line,
+ tag: nil,
+ asynchronous: true,
+ ddlog: logger)
+ }
+
+ class func debug(_ message: @autoclosure () -> String,
+ _ path: StaticString = #file,
+ _ function: StaticString = #function,
+ line: UInt = #line) {
+ _DDLogMessage(message(),
+ level: logLevel,
+ flag: .debug,
+ context: 0,
+ file: path,
+ function: function,
+ line: line,
+ tag: nil,
+ asynchronous: true,
+ ddlog: logger)
+ }
+
+ class func warn(_ message: @autoclosure () -> String,
+ _ path: StaticString = #file,
+ _ function: StaticString = #function,
+ line: UInt = #line) {
+ _DDLogMessage(message(),
+ level: logLevel,
+ flag: .warning,
+ context: 0,
+ file: path,
+ function: function,
+ line: line,
+ tag: nil,
+ asynchronous: true,
+ ddlog: logger)
+ }
+
+ class func error(_ message: @autoclosure () -> String,
+ _ path: StaticString = #file,
+ _ function: StaticString = #function,
+ line: UInt = #line) {
+ _DDLogMessage(message(),
+ level: logLevel,
+ flag: .error,
+ context: 0,
+ file: path,
+ function: function,
+ line: line,
+ tag: nil,
+ asynchronous: true,
+ ddlog: logger)
+ }
+}

Operator/Infrastructure/Logging/LogFormatter.swift

@@ -0,0 +1,30 @@
+//
+// LogFormatter.swift
+// Operator
+//
+// Created by Brian Michel on 5/16/20.
+// Copyright © 2020 Brian Michel. All rights reserved.
+//
+
+import CocoaLumberjack
+
+final class LogFormatter: NSObject, DDLogFormatter {
+ func format(message logMessage: DDLogMessage) -> String? {
+ return "\(logLevelName(from: logMessage)) \(Int(logMessage.timestamp.timeIntervalSince1970)) - \(logMessage.message)"
+ }
+
+ private func logLevelName(from message: DDLogMessage) -> String {
+ switch message.flag {
+ case .error:
+ return "❗️"
+ case .warning:
+ return "⚠️"
+ case .info:
+ return "ℹ️"
+ case .debug:
+ return "🛠"
+ default:
+ return "🤷‍♀️"
+ }
+ }
+}