lottie-ios 3.2.0 → 3.4.0

package/{lottie-swift/src → Sources}/Public/iOS/BundleImageProvider.swift

@@ -5,51 +5,48 @@
 //  Created by Brandon Withrow on 1/25/19.
 //
 
-import Foundation
 import CoreGraphics
-#if os(iOS) || os(tvOS) || os(watchOS)
+import Foundation
+#if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 import UIKit
 
-/**
- An `AnimationImageProvider` that provides images by name from a specific bundle.
- The BundleImageProvider is initialized with a bundle and an optional searchPath.
- */
+/// An `AnimationImageProvider` that provides images by name from a specific bundle.
+/// The BundleImageProvider is initialized with a bundle and an optional searchPath.
 public class BundleImageProvider: AnimationImageProvider {
-  
-  let bundle: Bundle
-  let searchPath: String?
-  
-  /**
-   Initializes an image provider with a bundle and an optional subpath.
-   
-   Provides images for an animation from a bundle. Additionally the provider can
-   search a specific subpath for the images.
-   
-   - Parameter bundle: The bundle containing images for the provider.
-   - Parameter searchPath: The subpath is a path within the bundle to search for image assets.
-   
-   */
+
+  // MARK: Lifecycle
+
+  /// Initializes an image provider with a bundle and an optional subpath.
+  ///
+  /// Provides images for an animation from a bundle. Additionally the provider can
+  /// search a specific subpath for the images.
+  ///
+  /// - Parameter bundle: The bundle containing images for the provider.
+  /// - Parameter searchPath: The subpath is a path within the bundle to search for image assets.
+  ///
   public init(bundle: Bundle, searchPath: String?) {
     self.bundle = bundle
     self.searchPath = searchPath
   }
-  
+
+  // MARK: Public
+
   public func imageForAsset(asset: ImageAsset) -> CGImage? {
-    
-    if asset.name.hasPrefix("data:"),
-      let url = URL(string: asset.name),
-      let data = try? Data(contentsOf: url),
-      let image = UIImage(data: data) {
+
+    if
+      let data = Data(imageAsset: asset),
+      let image = UIImage(data: data)
+    {
       return image.cgImage
     }
-    
+
     let imagePath: String?
     /// Try to find the image in the bundle.
     if let searchPath = searchPath {
       /// Search in the provided search path for the image
       var directoryPath = URL(fileURLWithPath: searchPath)
       directoryPath.appendPathComponent(asset.directory)
-      
+
       if let path = bundle.path(forResource: asset.name, ofType: nil, inDirectory: directoryPath.path) {
         /// First search for the image in the asset provided sub directory.
         imagePath = path
@@ -68,20 +65,26 @@ public class BundleImageProvider: AnimationImageProvider {
         imagePath = bundle.path(forResource: asset.name, ofType: nil)
       }
     }
-    
+
     if imagePath == nil {
-        guard let image = UIImage(named: asset.name, in: bundle, compatibleWith: nil) else {
-            return nil
-        }
-        return image.cgImage
+      guard let image = UIImage(named: asset.name, in: bundle, compatibleWith: nil) else {
+        LottieLogger.shared.assertionFailure("Could not find image \"\(asset.name)\" in bundle")
+        return nil
+      }
+      return image.cgImage
     }
-    
+
     guard let foundPath = imagePath, let image = UIImage(contentsOfFile: foundPath) else {
       /// No image found.
+      LottieLogger.shared.assertionFailure("Could not find image \"\(asset.name)\" in bundle")
       return nil
     }
     return image.cgImage
   }
-  
+
+  // MARK: Internal
+
+  let bundle: Bundle
+  let searchPath: String?
 }
 #endif

package/{lottie-swift/src → Sources}/Public/iOS/Compatibility/CompatibleAnimationKeypath.swift

@@ -6,12 +6,14 @@
 //
 
 import Foundation
-#if os(iOS) || os(tvOS) || os(watchOS)
+#if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 
 /// An Objective-C compatible wrapper around Lottie's AnimationKeypath
 @objc
 public final class CompatibleAnimationKeypath: NSObject {
 
+  // MARK: Lifecycle
+
   /// Creates a keypath from a dot separated string. The string is separated by "."
   @objc
   public init(keypath: String) {
@@ -24,6 +26,8 @@ public final class CompatibleAnimationKeypath: NSObject {
     animationKeypath = AnimationKeypath(keys: keys)
   }
 
+  // MARK: Public
+
   public let animationKeypath: AnimationKeypath
 }
 #endif

package/{lottie-swift/src → Sources}/Public/iOS/Compatibility/CompatibleAnimationView.swift

@@ -6,7 +6,7 @@
 //
 
 import Foundation
-#if os(iOS) || os(tvOS) || os(watchOS)
+#if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 import UIKit
 
 /// An Objective-C compatible wrapper around Lottie's Animation class.
@@ -14,10 +14,7 @@ import UIKit
 @objc
 public final class CompatibleAnimation: NSObject {
 
-  @objc
-  static func named(_ name: String) -> CompatibleAnimation {
-    return CompatibleAnimation(name: name)
-  }
+  // MARK: Lifecycle
 
   @objc
   public init(name: String, bundle: Bundle = Bundle.main) {
@@ -26,8 +23,15 @@ public final class CompatibleAnimation: NSObject {
     super.init()
   }
 
+  // MARK: Internal
+
   internal var animation: Animation? {
-    return Animation.named(name, bundle: bundle)
+    Animation.named(name, bundle: bundle)
+  }
+
+  @objc
+  static func named(_ name: String) -> CompatibleAnimation {
+    CompatibleAnimation(name: name)
   }
 
   // MARK: Private
@@ -40,8 +44,10 @@ public final class CompatibleAnimation: NSObject {
 @objc
 public final class CompatibleAnimationView: UIView {
 
+  // MARK: Lifecycle
+
   @objc
-  init(compatibleAnimation: CompatibleAnimation) {
+  public init(compatibleAnimation: CompatibleAnimation) {
     animationView = AnimationView(animation: compatibleAnimation.animation)
     self.compatibleAnimation = compatibleAnimation
     super.init(frame: .zero)
@@ -55,7 +61,7 @@ public final class CompatibleAnimationView: UIView {
     commonInit()
   }
 
-  required init?(coder aDecoder: NSCoder) {
+  required init?(coder _: NSCoder) {
     fatalError("init(coder:) has not been implemented")
   }
 
@@ -78,58 +84,58 @@ public final class CompatibleAnimationView: UIView {
   @objc
   public override var contentMode: UIView.ContentMode {
     set { animationView.contentMode = newValue }
-    get { return animationView.contentMode }
+    get { animationView.contentMode }
   }
 
   @objc
   public var shouldRasterizeWhenIdle: Bool {
     set { animationView.shouldRasterizeWhenIdle = newValue }
-    get { return animationView.shouldRasterizeWhenIdle }
+    get { animationView.shouldRasterizeWhenIdle }
   }
 
   @objc
   public var currentProgress: CGFloat {
     set { animationView.currentProgress = newValue }
-    get { return animationView.currentProgress }
+    get { animationView.currentProgress }
   }
 
   @objc
   public var currentTime: TimeInterval {
     set { animationView.currentTime = newValue }
-    get { return animationView.currentTime }
+    get { animationView.currentTime }
   }
 
   @objc
   public var currentFrame: CGFloat {
     set { animationView.currentFrame = newValue }
-    get { return animationView.currentFrame }
+    get { animationView.currentFrame }
   }
 
   @objc
   public var realtimeAnimationFrame: CGFloat {
-    return animationView.realtimeAnimationFrame
+    animationView.realtimeAnimationFrame
   }
 
   @objc
   public var realtimeAnimationProgress: CGFloat {
-    return animationView.realtimeAnimationProgress
+    animationView.realtimeAnimationProgress
   }
 
   @objc
   public var animationSpeed: CGFloat {
     set { animationView.animationSpeed = newValue }
-    get { return animationView.animationSpeed }
+    get { animationView.animationSpeed }
   }
 
   @objc
   public var respectAnimationFrameRate: Bool {
     set { animationView.respectAnimationFrameRate = newValue }
-    get { return animationView.respectAnimationFrameRate }
+    get { animationView.respectAnimationFrameRate }
   }
 
   @objc
   public var isAnimationPlaying: Bool {
-    return animationView.isAnimationPlaying
+    animationView.isAnimationPlaying
   }
 
   @objc
@@ -203,9 +209,10 @@ public final class CompatibleAnimationView: UIView {
   @objc
   public func getValue(
     for keypath: CompatibleAnimationKeypath,
-    atFrame: CGFloat) -> Any?
+    atFrame: CGFloat)
+    -> Any?
   {
-    return animationView.getValue(
+    animationView.getValue(
       for: keypath.animationKeypath,
       atFrame: atFrame)
   }
@@ -216,8 +223,7 @@ public final class CompatibleAnimationView: UIView {
   }
 
   @objc
-  public func setColorValue(_ color: UIColor, forKeypath keypath: CompatibleAnimationKeypath)
-  {
+  public func setColorValue(_ color: UIColor, forKeypath keypath: CompatibleAnimationKeypath) {
     var red: CGFloat = 0
     var green: CGFloat = 0
     var blue: CGFloat = 0
@@ -241,14 +247,17 @@ public final class CompatibleAnimationView: UIView {
   }
 
   @objc
-  public func getColorValue(for keypath: CompatibleAnimationKeypath, atFrame: CGFloat) -> UIColor?
-  {
+  public func getColorValue(for keypath: CompatibleAnimationKeypath, atFrame: CGFloat) -> UIColor? {
     let value = animationView.getValue(for: keypath.animationKeypath, atFrame: atFrame)
     guard let colorValue = value as? Color else {
-        return nil;
+      return nil;
     }
 
-    return UIColor(red: CGFloat(colorValue.r), green: CGFloat(colorValue.g), blue: CGFloat(colorValue.b), alpha: CGFloat(colorValue.a))
+    return UIColor(
+      red: CGFloat(colorValue.r),
+      green: CGFloat(colorValue.g),
+      blue: CGFloat(colorValue.b),
+      alpha: CGFloat(colorValue.a))
   }
 
   @objc
@@ -267,7 +276,7 @@ public final class CompatibleAnimationView: UIView {
     toLayerAt keypath: CompatibleAnimationKeypath?)
     -> CGRect
   {
-    return animationView.convert(
+    animationView.convert(
       rect,
       toLayerAt: keypath?.animationKeypath) ?? .zero
   }
@@ -278,19 +287,19 @@ public final class CompatibleAnimationView: UIView {
     toLayerAt keypath: CompatibleAnimationKeypath?)
     -> CGPoint
   {
-    return animationView.convert(
+    animationView.convert(
       point,
       toLayerAt: keypath?.animationKeypath) ?? .zero
   }
 
   @objc
   public func progressTime(forMarker named: String) -> CGFloat {
-    return animationView.progressTime(forMarker: named) ?? 0
+    animationView.progressTime(forMarker: named) ?? 0
   }
 
   @objc
   public func frameTime(forMarker named: String) -> CGFloat {
-    return animationView.frameTime(forMarker: named) ?? 0
+    animationView.frameTime(forMarker: named) ?? 0
   }
 
   // MARK: Private

package/{lottie-swift/src → Sources}/Public/iOS/FilepathImageProvider.swift

@@ -6,51 +6,55 @@
 //
 
 import Foundation
-#if os(iOS) || os(tvOS) || os(watchOS)
+#if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 import UIKit
 
-/**
- Provides an image for a lottie animation from a provided Bundle.
- */
+/// Provides an image for a lottie animation from a provided Bundle.
 public class FilepathImageProvider: AnimationImageProvider {
-  
-  let filepath: URL
-  
-  /**
-   Initializes an image provider with a specific filepath.
-   
-   - Parameter filepath: The absolute filepath containing the images.
-   
-   */
+
+  // MARK: Lifecycle
+
+  /// Initializes an image provider with a specific filepath.
+  ///
+  /// - Parameter filepath: The absolute filepath containing the images.
+  ///
   public init(filepath: String) {
     self.filepath = URL(fileURLWithPath: filepath)
   }
-  
+
   public init(filepath: URL) {
     self.filepath = filepath
   }
-  
+
+  // MARK: Public
+
   public func imageForAsset(asset: ImageAsset) -> CGImage? {
 
-    if asset.name.hasPrefix("data:"),
+    if
+      asset.name.hasPrefix("data:"),
       let url = URL(string: asset.name),
       let data = try? Data(contentsOf: url),
-      let image = UIImage(data: data) {
+      let image = UIImage(data: data)
+    {
       return image.cgImage
     }
-    
+
     let directPath = filepath.appendingPathComponent(asset.name).path
     if FileManager.default.fileExists(atPath: directPath) {
       return UIImage(contentsOfFile: directPath)?.cgImage
     }
-    
+
     let pathWithDirectory = filepath.appendingPathComponent(asset.directory).appendingPathComponent(asset.name).path
     if FileManager.default.fileExists(atPath: pathWithDirectory) {
       return UIImage(contentsOfFile: pathWithDirectory)?.cgImage
     }
-    
+
+    LottieLogger.shared.assertionFailure("Could not find image \"\(asset.name)\" in bundle")
     return nil
   }
-  
+
+  // MARK: Internal
+
+  let filepath: URL
 }
 #endif

package/{lottie-swift/src → Sources}/Public/iOS/UIColorExtension.swift

@@ -6,16 +6,16 @@
 //
 
 import Foundation
-#if os(iOS) || os(tvOS) || os(watchOS)
+#if os(iOS) || os(tvOS) || os(watchOS) || targetEnvironment(macCatalyst)
 import UIKit
 
-public extension UIColor {
-  
-  var lottieColorValue: Color {
+extension UIColor {
+
+  public var lottieColorValue: Color {
     var r: CGFloat = 0, g: CGFloat = 0, b: CGFloat = 0, a: CGFloat = 0
     getRed(&r, green: &g, blue: &b, alpha: &a)
     return Color(r: Double(r), g: Double(g), b: Double(b), a: Double(a))
   }
-  
+
 }
 #endif

package/{lottie-swift/src/Public/MacOS/AnimationSubview.swift → Sources/Public/macOS/AnimationSubview.macOS.swift}

@@ -5,16 +5,15 @@
 //  Created by Brandon Withrow on 2/5/19.
 //
 
-import Foundation
-#if os(OSX)
+#if os(macOS)
 import AppKit
 
 /// A view that can be added to a keypath of an AnimationView
 public final class AnimationSubview: NSView {
-  
+
   var viewLayer: CALayer? {
-    return layer
+    layer
   }
-  
+
 }
 #endif

package/{lottie-swift/src/Public/MacOS/LottieView.swift → Sources/Public/macOS/AnimationViewBase.macOS.swift}

@@ -1,12 +1,11 @@
 //
-//  LottieView.swift
+//  AnimationViewBase.swift
 //  lottie-swift-iOS
 //
 //  Created by Brandon Withrow on 2/6/19.
 //
 
-import Foundation
-#if os(OSX)
+#if os(macOS)
 import AppKit
 
 public enum LottieContentMode: Int {
@@ -25,70 +24,79 @@ public enum LottieContentMode: Int {
   case bottomRight
 }
 
-/// A wrapper around NSView for cross platform compatibility.
+/// The base view for `AnimationView` on macOs.
+///
+/// Enables the `AnimationView` implementation to be shared across platforms.
+public class AnimationViewBase: NSView {
+
+  // MARK: Public
 
-public class LottieView: NSView {
-  
-  var screenScale: CGFloat {
-    return NSApp.mainWindow?.backingScaleFactor ?? 1
-  }
-  
-  var viewLayer: CALayer? {
-    return layer
-  }
-  
-  func layoutAnimation() {
-    
-  }
-  
-  func animationMovedToWindow() {
-    
-  }
-  
-  public override func viewDidMoveToWindow() {
-    super.viewDidMoveToWindow()
-    animationMovedToWindow()
-  }
-  
-  func commonInit() {
-    self.wantsLayer = true
-  }
-  
-  func setNeedsLayout() {
-    self.needsLayout = true
-  }
-  
-  func layoutIfNeeded() {
-    
-  }
-  
   public override var wantsUpdateLayer: Bool {
-    return true
+    true
   }
-  
+
   public override var isFlipped: Bool {
-    return true
+    true
   }
-  
+
   public var contentMode: LottieContentMode = .scaleAspectFit {
     didSet {
       setNeedsLayout()
     }
   }
-  
+
+  public override func viewDidMoveToWindow() {
+    super.viewDidMoveToWindow()
+    animationMovedToWindow()
+  }
+
   public override func layout() {
     super.layout()
     CATransaction.begin()
     CATransaction.setDisableActions(true)
-    self.layoutAnimation()
+    layoutAnimation()
     CATransaction.commit()
   }
-  
-  @objc func animationWillMoveToBackground() {
+
+  // MARK: Internal
+
+  var screenScale: CGFloat {
+    NSApp.mainWindow?.backingScaleFactor ?? 1
+  }
+
+  var viewLayer: CALayer? {
+    layer
+  }
+
+  func layoutAnimation() {
+    // Implemented by subclasses.
+  }
+
+  func animationMovedToWindow() {
+    // Implemented by subclasses.
+  }
+
+  func commonInit() {
+    wantsLayer = true
   }
-  
-  @objc func animationWillEnterForeground() {
+
+  func setNeedsLayout() {
+    needsLayout = true
   }
-  
+
+  func layoutIfNeeded() {
+    // Implemented by subclasses.
+  }
+
+  @objc
+  func animationWillMoveToBackground() {
+    // Implemented by subclasses.
+  }
+
+  @objc
+  func animationWillEnterForeground() {
+    // Implemented by subclasses.
+  }
+
 }
 #endif