ProgressManager

main

An easy way to manage a Progress object that relies on other sub-tasks via child Progress objects.
edonv/ProgressManager

ProgressManager

ProgressManager is a class to make dealing with Progress and its child tasks just a bit more straightforward and easy. Why use it? It allows for a complex but accessible way to use Progress for things like ProgressView and UIProgressView.

How to Use ProgressManager

  1. Just create any type that you'd like to use for referencing each child task (most easily an enumeration, but could be anything that conforms to Hashable).
enum ProgressSteps: Hashable {
    case importantStep, smallStep, aMultiUnitStep
}
  1. Then create an instance of ProgressManager using your key type. When initializing your ProgressManager, you tell it how many units each child task needs to be complete (could be 1, or it could be that a child task is doing something 3 times, so it would be 3 units). You also enter how you want each child task weighted, as maybe uploading uploading a file to a server should have a heavier weight than creating a local instance variable (so it has more significance).
let progress = ProgressManager(
    ProgressSteps.self,
    childTaskUnitCounts: [
        .importantStep: 1,
        .smallStep: 1,
        .aMultiUnitStep: 6
    ],
    childTaskUnitCountsInParent: [
        .importantStep: 5,
        .smallStep: 1,
        .aMultiUnitStep: 1
    ]
)
  1. As your code completes the tasks, you call any combination of the child task updating functions (setCompletedUnitCount(_:forChildTask:), addToCompletedUnitCount(_:forChildTask:), and updateCompletedUnitCount(forChildTask:updateClosure:)).
// Perform `.importantStep`.
progress.setCompletedUnitCount(1, forChildTask: .importantStep)

// Perform `.smallStemp`.
progress.setCompletedUnitCount(1, forChildTask: .smallStemp)

// Perform `.aMultiUnitStep`.
for i in 0..<6 {
    progress.addToCompletedUnitCount(i, forChildTask: .aMultiUnitStep)
}

And that's it! If you need more granular control, you can access the child tasks by either the childTasks property or just via the subscript (progress[.aMultiUnitStep]).

Description

  • Swift Tools 5.6.0
View More Packages from this Author

Dependencies

  • None
Last updated: Fri Oct 18 2024 04:12:32 GMT-0900 (Hawaii-Aleutian Daylight Time)