FZSwiftUtils

Swift Foundation extensions and useful classes & utilities.

For a full documentation take a look at the included documentation located at /Documentation. Opening the file launches Xcode's documentation browser.

Notable Extensions & Classes

DataSize

A data size abstraction.

var dataSize = DataSize(gigabytes: 1.5)
dataSize.megabyte // 1500 megabytes
dataSize.terabyte += 1
dataSize.string(includesUnit: true) // "1tb, 1gb, 500mb"
dataSize.string(for: .terabyte, includesUnit: false) // "1,15"

TimeDuration

A duration/time interval abstraction.

var duration = TimeDuration(seconds: 1)
duration.minutes += 2
duration.string(style: .full) // "2 minutes, 1 seconds"
duration.string(for: .seconds) =  "121 seconds"

// Duration between two dates.
let dateDuration = TimeDuration(from: date1, to: date2)

NSObject property observation

• Observe KVO properties of a NSObject using observeChanges(for:).

It returns KeyValueObservation that you need to save as long as you want to observe the property.

let textField = NSTextField()

let stringObservation = textField.observeChanges(for \.stringValue) { oldStringValue, stringValue in
    /// stringValue changed
}

• Observe multiple properties using KeyValueObserver:

let textFieldObserver = KeyValueObserver(textField)
textFieldObserver.add(\.stringValue) { oldStringValue, stringValue in
    /// stringValue changed
}
textFieldObserver.add(\.font) { oldFont, font in
    /// font changed
}
textFieldObserver.add(\.textColor) { oldTextColor, textColor in
    /// textColor changed
}

NSObject Associated Values

Associated Values allows you to add additional properties to a NSObject:

// Set
view.associatedValue["backgroundColor"] = NSColor.black

// get
if let backgroundColor: NSColor = view.associatedValue["backgroundColor"] {

}

// Or easily extend objects:
extension NSView {
    var backgroundColor: NSColor? {
        get { associatedValue["backgroundColor"] }
        set { 
            associatedValue["backgroundColor"] = newValue
            …
        }
    }
}

Iterate directories & files

Addition URL methods for iterating the content of file system directories.

• Iterate sub folders:

for folderURL in downloadsDirectory.iterateFolders() {
    
}

• Iterate files:

for fileURL in downloadsDirectory.iterateFiles() {
    
}

• Iterate files recursively (including the files of sub folders) and include hidden files:

for fileURL in downloadsDirectory.iterateFiles().recursive.includingHidden {
   
}

• Iterate files by file extensions, file types or by predicate:

// Iterate multimedia files
for multimediaFileURL in downloadsDirectory.iterateFiles(types: [.video, .image, .gif]) {

}

 // Iterates files with .txt extension
for txtFileURL in downloadsDirectory.iterateFiles(extensions: ["txt"]) {

}

// Iterates video files with file names that contain "vid_"
for fileURL in downloadsDirectory.iterate(predicate: { file in
    return file.fileType == .video && file.lastPathComponent.contains("vid_")
}).recursive.includingHidden {
    
}

File System URL Resources

Get properties of a file system resource (like creation date, file size or finder tags) using URL.resources:

let creationDate = fileURL.resources.creationDate
let fileSize = fileURL.resources.fileSize
let finderTags = fileURL.resources.finderTags

MeasureTime

Meassures the time executing a block.

MeasureTime.printTimeElapsed() {
/// The block to measure
}

NSObject Class Reflection

Reflects all properties, methods and ivars of a NSObject class including hidden ones.

/// All properties, methods and ivars of `NSView`:
Swift.print(NSView.classReflection())

/// All class properties of `UIView`:
Swift.print(UIView.classReflection().classProperties)

OSHash

An implementation of the OpenSuptitle hash.

let hash = try? OSHash.hash(url: fileURL)
hash?.hashValue /// The hash value

Progress extensions

• autoUpdateEstimatedTimeRemaining: Updates the estimted time remaining and throughput.
• addFileProgress(url: URL): Shows the file progress in Finder.

progress.addFileProgress(url: fileURL, kind: .downloading)

• MutableProgress: A progress that allows to add and remove children progresses.

Notification Observation Using Blocks

Observe NotificationCenter notifications using a block.

Use NotificationCenters observe(name:object:block:). It returns NotificationToken` that you need to save as long as you want to observe the notification.

let viewFrameNotificationToken = NotificationCenter.default.observe(NSView.frameDidChangeNotification, object: view) { _ in 
}

More…

• AsyncOperation: An asynchronous, pausable operation.
• PausableOperationQueue: A pausable operation queue.
• SynchronizedArray/SynchronizedDictionary: A synchronized array/dictionary.
• Equatable.isEqual(_ other: any Equatable) -> Bool: Returns a Boolean value indicating whether the value is equatable to another value.
• Comparable.isLessThan(_ other: any Comparable) -> Bool: Returns a Boolean value indicating whether the value is less than another value.