orchetect / otoperations

Useful Swift NSOperation and NSOperationQueue subclasses

OTOperations

Useful NSOperation (Operation) and NSOperationQueue (OperationQueue) subclasses for Swift.

Scalable, thread-safe, and automatically fully progress-reporting for nested child operations.

• Foundational
  • BasicOperation and BasicAsyncOperation
• Closure-based
  • ClosureOperation and AsyncClosureOperation
  • InteractiveClosureOperation and InteractiveAsyncClosureOperation
• Thread-safe atomic mutability
  • AtomicBlockOperation

Installation: Swift Package Manager (SPM)

Dependency within an Application

1. Add the package to your Xcode project using Swift Package Manager
   • Select File → Swift Packages → Add Package Dependency
   • Add package using https://github.com/orchetect/OTOperations as the URL.
2. Import the module in your *.swift files where needed.

   import OTOperations

Dependency within a Swift Package

1. In your Package.swift file:

   dependencies: [
       .package(url: "https://github.com/orchetect/OTOperations", from: "1.0.0")
   ],

2. @_implementationOnly prevents the methods and properties in OTOperations from being exported to the consumer of your SPM package.

   @_implementationOnly import OTOperations

Documentation

Most methods are implemented as category methods so they are generally discoverable.

All methods have inline help explaining their purpose and basic usage examples.

Author

Coded by a bunch of 🐹 hamsters in a trenchcoat that calls itself @orchetect.

License

Licensed under the MIT license. See LICENSE for details.

Contributions

Bug fixes and improvements are welcome. Please open an issue to discuss prior to submitting PRs.

otoperations's Issues

Add additional tests for progress labels calling `statusHandler`

Currently progress labels will recursively update through the entire progress child tree under these conditions:

• when a child progress is added to a parent progress
  • ie: when an operation is added to BasicOperationQueue or one of its subclasses
• when a progress label changes (setting labelProgress.label) anywhere in the progress tree
• when a child progress object deinits

BasicOperationQueue.statusHandler is called when .status changes, which is generally under these conditions (this list may not be exhaustive):

• when any of these KVO observers fire:
  • isSuspended
  • operationCount
  • progress.fractionCompleted
  • progress.isFinished

Additional unit tests need to be added to test various scenarios and states of BasicOperationQueue with nested child operations to ensure that statusHandler is being called sufficiently to provide updates to changes in the aggregate progress label. Especially with concurrent child operations complete, and as they complete in a staggered fashion.

Memory Leaks with LabelProgress

Putting this here till I have time to look or if you want to.