lottie-ios 4.2.0 → 4.3.0

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/MakeViewProviding.swift

@@ -0,0 +1,60 @@
+// Created by eric_horacek on 12/1/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - MakeViewProviding
+
+/// The capability of constructing a `UIView`.
+protocol MakeViewProviding {
+  /// The view constructed when the `MakeView` closure is called.
+  associatedtype View: ViewType
+
+  /// A closure that's called to construct an instance of `View`.
+  typealias MakeView = () -> View
+
+  /// A closure that's called to construct an instance of `View`.
+  var makeView: MakeView { get }
+}
+
+// MARK: - ViewEpoxyModeled
+
+extension ViewEpoxyModeled where Self: MakeViewProviding {
+
+  // MARK: Internal
+
+  /// A closure that's called to construct an instance of `View` represented by this model.
+  var makeView: MakeView {
+    get { self[makeViewProperty] }
+    set { self[makeViewProperty] = newValue }
+  }
+
+  /// Replaces the default closure to construct the view with the given closure.
+  func makeView(_ value: @escaping MakeView) -> Self {
+    copy(updating: makeViewProperty, to: value)
+  }
+
+  // MARK: Private
+
+  private var makeViewProperty: EpoxyModelProperty<MakeView> {
+    // If you're getting a `EXC_BAD_INSTRUCTION` crash with this property in your stack trace, you
+    // probably either:
+    // - Conformed a view to `EpoxyableView` / `StyledView` with a custom initializer that
+    // takes parameters, or:
+    // - Used the `EpoxyModeled.init(dataID:)` initializer on a view has required initializer
+    //   parameters.
+    // If you have parameters to view initialization, they should either be passed to `init(style:)`
+    // or you should provide a `makeView` closure when constructing your view's corresponding model,
+    // e.g:
+    // ```
+    // MyView.itemModel(…)
+    //   .makeView { MyView(customParameter: …) }
+    //   .styleID(…)
+    // ```
+    // Note that with the above approach that you must supply an `styleID` with the same identity as
+    // your view parameters to ensure that views with different parameters are not reused in place
+    // of one another.
+    .init(
+      keyPath: \Self.makeView,
+      defaultValue: View.init,
+      updateStrategy: .replace)
+  }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/SetBehaviorsProviding.swift

@@ -0,0 +1,38 @@
+// Created by eric_horacek on 12/2/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - SetBehaviorsProviding
+
+/// A sentinel protocol for enabling an `CallbackContextEpoxyModeled` to provide a `setBehaviors`
+/// closure property.
+protocol SetBehaviorsProviding { }
+
+// MARK: - CallbackContextEpoxyModeled
+
+extension CallbackContextEpoxyModeled where Self: SetBehaviorsProviding {
+
+  // MARK: Internal
+
+  /// A closure that's called to set the content on this model's view with behaviors (e.g. tap handler
+  /// closures) whenever this model is updated.
+  typealias SetBehaviors = (CallbackContext) -> Void
+
+  /// A closure that's called to set the content on this model's view with behaviors (e.g. tap handler
+  /// closures) whenever this model is updated.
+  var setBehaviors: SetBehaviors? {
+    get { self[setBehaviorsProperty] }
+    set { self[setBehaviorsProperty] = newValue }
+  }
+
+  /// Returns a copy of this model with the set behaviors closure called after the current set
+  /// behaviors closure of this model, if there is one.
+  func setBehaviors(_ value: SetBehaviors?) -> Self {
+    copy(updating: setBehaviorsProperty, to: value)
+  }
+
+  // MARK: Private
+
+  private var setBehaviorsProperty: EpoxyModelProperty<SetBehaviors?> {
+    .init(keyPath: \Self.setBehaviors, defaultValue: nil, updateStrategy: .chain())
+  }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/SetContentProviding.swift

@@ -0,0 +1,38 @@
+// Created by eric_horacek on 12/1/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - SetContentProviding
+
+/// A sentinel protocol for enabling an `CallbackContextEpoxyModeled` to provide a `setContent`
+/// closure property.
+protocol SetContentProviding { }
+
+// MARK: - CallbackContextEpoxyModeled
+
+extension CallbackContextEpoxyModeled where Self: SetContentProviding {
+
+  // MARK: Internal
+
+  /// A closure that's called to set the content on this model's view when it is first created and
+  /// subsequently when the content changes.
+  typealias SetContent = (CallbackContext) -> Void
+
+  /// A closure that's called to set the content on this model's view when it is first created and
+  /// subsequently when the content changes.
+  var setContent: SetContent? {
+    get { self[setContentProperty] }
+    set { self[setContentProperty] = newValue }
+  }
+
+  /// Returns a copy of this model with the given setContent view closure called after the current
+  /// setContent view closure of this model, if there is one.
+  func setContent(_ value: SetContent?) -> Self {
+    copy(updating: setContentProperty, to: value)
+  }
+
+  // MARK: Private
+
+  private var setContentProperty: EpoxyModelProperty<SetContent?> {
+    .init(keyPath: \Self.setContent, defaultValue: nil, updateStrategy: .chain())
+  }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/StyleIDProviding.swift

@@ -0,0 +1,37 @@
+// Created by eric_horacek on 12/1/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - StyleIDProviding
+
+protocol StyleIDProviding {
+  /// An optional ID for a style type to use for reuse of a view.
+  ///
+  /// Use this to differentiate between different styling configurations.
+  var styleID: AnyHashable? { get }
+}
+
+// MARK: - EpoxyModeled
+
+extension EpoxyModeled where Self: StyleIDProviding {
+
+  // MARK: Internal
+
+  var styleID: AnyHashable? {
+    get { self[styleIDProperty] }
+    set { self[styleIDProperty] = newValue }
+  }
+
+  /// Returns a copy of this model with the `styleID` replaced with the provided `value`.
+  func styleID(_ value: AnyHashable?) -> Self {
+    copy(updating: styleIDProperty, to: value)
+  }
+
+  // MARK: Private
+
+  private var styleIDProperty: EpoxyModelProperty<AnyHashable?> {
+    .init(
+      keyPath: \StyleIDProviding.styleID,
+      defaultValue: nil,
+      updateStrategy: .replace)
+  }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/TraitCollectionProviding.swift

@@ -0,0 +1,14 @@
+// Created by eric_horacek on 12/16/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+#if !os(macOS)
+import UIKit
+
+/// The capability of providing a `UITraitCollection` instance.
+///
+/// Typically conformed to by the `CallbackContext` of a `CallbackContextEpoxyModeled`.
+protocol TraitCollectionProviding {
+  /// The `UITraitCollection` instance provided by this type.
+  var traitCollection: UITraitCollection { get }
+}
+#endif

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/ViewDifferentiatorProviding.swift

@@ -0,0 +1,34 @@
+// Created by Bryan Keller on 12/17/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - ViewDifferentiatorProviding
+
+/// The capability of providing a view differentiator that facilitates generating collection view
+/// cell reuse identifiers.
+protocol ViewDifferentiatorProviding {
+  /// The view differentiator for the item model.
+  var viewDifferentiator: ViewDifferentiator { get }
+}
+
+// MARK: - ViewDifferentiator
+
+/// Facilitates differentiating between two models' views, based on their view type, optional style
+/// identifier, and optional element kind for supplementary view models. If two models have the same
+/// view differentiator, then they're compatible with one another for element reuse. If two models
+/// have different view differentiators, then they're incompatible with one another for element
+/// reuse.
+struct ViewDifferentiator: Hashable {
+
+  // MARK: Lifecycle
+
+  init(viewType: AnyClass, styleID: AnyHashable?) {
+    viewTypeDescription = "\(type(of: viewType.self))"
+    self.styleID = styleID
+  }
+
+  // MARK: Public
+
+  var viewTypeDescription: String
+  var styleID: AnyHashable?
+
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/ViewProviding.swift

@@ -0,0 +1,13 @@
+// Created by eric_horacek on 12/16/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+/// The capability of providing an `View` instance
+///
+/// Typically conformed to by the `CallbackContext` of a `CallbackContextEpoxyModeled`.
+protocol ViewProviding {
+  /// The `UIView` view of this type.
+  associatedtype View: ViewType
+
+  /// The `UIView` view instance provided by this type.
+  var view: View { get }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/Providers/WillDisplayProviding.swift

@@ -0,0 +1,41 @@
+// Created by eric_horacek on 12/15/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+// MARK: - WillDisplayProviding
+
+/// A sentinel protocol for enabling an `CallbackContextEpoxyModeled` to provide a `willDisplay`
+/// closure property.
+///
+/// - SeeAlso: `DidDisplayProviding`
+/// - SeeAlso: `DidEndDisplayingProviding`
+protocol WillDisplayProviding { }
+
+// MARK: - CallbackContextEpoxyModeled
+
+extension CallbackContextEpoxyModeled where Self: WillDisplayProviding {
+
+  // MARK: Internal
+
+  /// A closure that's called when a view is about to be displayed, before it has been added to the
+  /// view hierarcy.
+  typealias WillDisplay = (_ context: CallbackContext) -> Void
+
+  /// A closure that's called when the view is about to be displayed, before it has been added to
+  /// the view hierarcy.
+  var willDisplay: WillDisplay? {
+    get { self[willDisplayProperty] }
+    set { self[willDisplayProperty] = newValue }
+  }
+
+  /// Returns a copy of this model with the given will display closure called after the current will
+  /// display closure of this model, if there is one.
+  func willDisplay(_ value: WillDisplay?) -> Self {
+    copy(updating: willDisplayProperty, to: value)
+  }
+
+  // MARK: Private
+
+  private var willDisplayProperty: EpoxyModelProperty<WillDisplay?> {
+    .init(keyPath: \Self.willDisplay, defaultValue: nil, updateStrategy: .chain())
+  }
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/Model/ViewEpoxyModeled.swift

@@ -0,0 +1,10 @@
+// Created by eric_horacek on 12/4/20.
+// Copyright © 2020 Airbnb Inc. All rights reserved.
+
+/// An Epoxy model with an associated `UIView` type.
+protocol ViewEpoxyModeled: EpoxyModeled {
+  /// The view type associated with this model.
+  ///
+  /// An instance of this view is typically configured by this model.
+  associatedtype View: ViewType
+}

package/Sources/Private/EmbeddedLibraries/EpoxyCore/README.md

@@ -0,0 +1,31 @@
+## EpoxyCore
+
+This directory includes the source code of the EpoxyCore library, from the following release:
+https://github.com/airbnb/epoxy-ios/releases/tag/0.10.0
+
+Lottie is distributed via multiple package managers (SPM, Cocoapods, Carthage, and NPM),
+each with different packaging and compilation requirements. 
+
+Due to limitations of these package managers, we can't depend on / import 
+a separate EpoxyCore module / library. Instead, we include the source
+directly within the Lottie library and compile everything as a single unit.
+
+### Update instructions
+
+From time to time we may need to update to a more recent version of EpoxyCore.
+When doing this, follow these steps:
+
+ 1. Download the latest release from https://github.com/epoxy-ios/EpoxyCore
+    and replace the source code in this directory with the updated code.
+    
+ 2. Update the URL at the top of this file to indicate what release is being used.
+ 
+ 3. Change all of the `public` symbols defined in this module to instead be `internal`
+    to prevent Lottie from exposing any EpoxyCore APIs.
+    
+ 4. Add `@available` annotations as necessary so the library compiles
+    (Lottie has a lower minimum iOS version than EpoxyCore). 
+    
+ 5. Namespace any types that conflict with other existing types.
+    For example, the EpoxyCore `Entry` type conflicts with the ZipFoundation `Entry` type,
+    so the EpoxyCore type has been renamed to `EpoxyEntry`.

package/Sources/Private/EmbeddedLibraries/EpoxyCore/SwiftUI/EpoxySwiftUIHostingController.swift

@@ -0,0 +1,46 @@
+// Created by eric_horacek on 10/8/21.
+// Copyright © 2021 Airbnb Inc. All rights reserved.
+
+import SwiftUI
+
+#if !os(macOS)
+// MARK: - EpoxySwiftUIUIHostingController
+
+/// A `UIHostingController` that hosts SwiftUI views within an Epoxy container, e.g. an Epoxy
+/// `CollectionView`.
+///
+/// Exposed internally to allow consumers to reason about these view controllers, e.g. to opt
+/// collection view cells out of automated view controller impression tracking.
+///
+/// - SeeAlso: `EpoxySwiftUIHostingView`
+@available(iOS 13.0, tvOS 13.0, *)
+open class EpoxySwiftUIHostingController<Content: View>: UIHostingController<Content> {
+
+  // MARK: Lifecycle
+
+  /// Creates a `UIHostingController` that optionally ignores the `safeAreaInsets` when laying out
+  /// its contained `RootView`.
+  convenience init(rootView: Content, ignoreSafeArea: Bool) {
+    self.init(rootView: rootView)
+
+    // We unfortunately need to call a private API to disable the safe area. We can also accomplish
+    // this by dynamically subclassing this view controller's view at runtime and overriding its
+    // `safeAreaInsets` property and returning `.zero`. An implementation of that logic is
+    // available in this file in the `2d28b3181cca50b89618b54836f7a9b6e36ea78e` commit if this API
+    // no longer functions in future SwiftUI versions.
+    _disableSafeArea = ignoreSafeArea
+  }
+
+  // MARK: Open
+
+  open override func viewDidLoad() {
+    super.viewDidLoad()
+
+    // A `UIHostingController` has a system background color by default as it's typically used in
+    // full-screen use cases. Since we're using this view controller to place SwiftUI views within
+    // other view controllers we default the background color to clear so we can see the views
+    // below, e.g. to draw highlight states in a `CollectionView`.
+    view.backgroundColor = .clear
+  }
+}
+#endif