lottie-ios 4.0.0 → 4.0.1

package/.github/workflows/main.yml

@@ -39,8 +39,6 @@ jobs:
     runs-on: macos-12
     steps:
       - uses: actions/checkout@v2
-        with:
-          lfs: 'true'
       - uses: ./.github/actions/setup
       - name: Test Package
         run: bundle exec rake test:package

package/README.md

@@ -75,13 +75,6 @@ We always appreciate contributions from the community. To make changes to the pr
  - unit tests and snapshot tests (for iOS, must be run on an iPhone 8 simulator)
  - an Example iOS app that lets you browse and test over 100 sample animations included in the repo
 
-To reduce the size of the repository, snapshot images are stored using [Git Large File Storage](https://git-lfs.github.com/). Before running the snapshot tests, you'll need to install Git LFS:
-
-```bash
-$ brew install git-lfs
-$ git lfs install
-```
-
 All pull requests with new features or bug fixes that affect how animations render should include snapshot test cases that validate the included changes. 
   - To add a new sample animation to the snapshot testing suite, you can add the `.json` file to `Tests/Samples`. Re-run the snapshot tests to generate the new snapshot image files.
   - To update existing snapshots after making changes, you can set `isRecording = true` in `SnapshotTests.swift` and then re-run the snapshot tests.

package/lottie-ios.podspec

@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'lottie-ios'
-  s.version          = '4.0.0'
+  s.version          = '4.0.1'
   s.summary          = 'A library to render native animations from bodymovin json'
 
   s.description = <<-DESC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lottie-ios",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Lottie is a mobile library for Android and iOS that parses Adobe After Effects animations exported as json with bodymovin and renders the vector animations natively on mobile and through React Native!",
   "main": "index.js",
   "scripts": {

package/.gitattributes

@@ -1 +0,0 @@
-Tests/__Snapshots__/SnapshotTests/** filter=lfs diff=lfs merge=lfs -text

package/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>

package/.swiftpm/xcode/xcuserdata/cal.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -1,67 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>SchemeUserState</key>
-	<dict>
-		<key>Lottie-Package.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>0</integer>
-		</dict>
-		<key>Lottie.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>0</integer>
-		</dict>
-		<key>_LottieCore.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>2</integer>
-		</dict>
-	</dict>
-	<key>SuppressBuildableAutocreation</key>
-	<dict>
-		<key>Lottie</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>Lottie Tests</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>LottieCarthage</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>LottieCore</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>LottieTests</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>Lottie_LottieTests</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>_LottieCore</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-		<key>_LottieDynamic</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-	</dict>
-</dict>
-</plist>

package/.swiftpm/xcode/xcuserdata/calstephens.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>SchemeUserState</key>
-	<dict>
-		<key>Lottie.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>6</integer>
-		</dict>
-	</dict>
-</dict>
-</plist>

package/Tests/AnimationCacheProviderTests.swift

@@ -1,40 +0,0 @@
-//
-//  AnimationCacheProviderTests.swift
-//  LottieTests
-//
-//  Created by Marcelo Fabri on 10/18/22.
-//
-
-import XCTest
-
-@testable import Lottie
-
-final class AnimationCacheProviderTests: XCTestCase {
-
-  func testCaches() throws {
-    let cache = DefaultAnimationCache()
-    let animation1 = try XCTUnwrap(Samples.animation(named: "Boat_Loader"))
-    let animation2 = try XCTUnwrap(Samples.animation(named: "TwitterHeart"))
-
-    XCTAssertNil(cache.animation(forKey: "animation1"))
-    cache.setAnimation(animation1, forKey: "animation1")
-    XCTAssertNoDiff(cache.animation(forKey: "animation1"), animation1)
-
-    XCTAssertNil(cache.animation(forKey: "animation2"))
-    cache.setAnimation(animation2, forKey: "animation2")
-    XCTAssertNoDiff(cache.animation(forKey: "animation2"), animation2)
-    XCTAssertNoDiff(cache.animation(forKey: "animation1"), animation1)
-  }
-
-  func testClearCache() throws {
-    let cache = DefaultAnimationCache()
-    let animation = try XCTUnwrap(Samples.animation(named: "Boat_Loader"))
-
-    XCTAssertNil(cache.animation(forKey: "animation"))
-    cache.setAnimation(animation, forKey: "animation")
-    XCTAssertNotNil(cache.animation(forKey: "animation"))
-
-    cache.clearCache()
-    XCTAssertNil(cache.animation(forKey: "animation"))
-  }
-}

package/Tests/AnimationKeypathTests.swift

@@ -1,110 +0,0 @@
-// Created by Cal Stephens on 1/24/22.
-// Copyright © 2022 Airbnb Inc. All rights reserved.
-
-import SnapshotTesting
-import XCTest
-
-@testable import Lottie
-
-@MainActor
-final class AnimationKeypathTests: XCTestCase {
-
-  // MARK: Internal
-
-  func testKeypathMatches() {
-    let keypath = AnimationKeypath(keypath: "Layer.Shape Group.Stroke 1.Color")
-
-    XCTAssertTrue(keypath.matches("Layer.Shape Group.Stroke 1.Color"))
-    XCTAssertTrue(keypath.matches("**.Color"))
-    XCTAssertTrue(keypath.matches("**.Stroke 1.Color"))
-    XCTAssertTrue(keypath.matches("**.Shape Group.Stroke 1.Color"))
-    XCTAssertTrue(keypath.matches("Layer.**.Color"))
-    XCTAssertTrue(keypath.matches("Layer.Shape Group.*.Color"))
-    XCTAssertTrue(keypath.matches("Layer.*.*.Color"))
-
-    XCTAssertFalse(keypath.matches("Layer.*.Color"))
-    XCTAssertFalse(keypath.matches("**.Layer.Shape Group.Stroke 1.Color"))
-    XCTAssertFalse(keypath.matches("*.Layer.Shape Group.Stroke 1.Color"))
-    XCTAssertFalse(keypath.matches("Layer.Shape Group.Stroke 1.Color.*"))
-    XCTAssertFalse(keypath.matches("Layer.Shape Group.Stroke 1.Color.**"))
-  }
-
-  func testLayerForKeypath() {
-    let animationView = LottieAnimationView(
-      animation: Samples.animation(named: "Boat_Loader"),
-      configuration: LottieConfiguration(renderingEngine: .mainThread))
-
-    XCTAssertNotNil(animationView.animationLayer?.layer(for: "Success.FishComplete.Fish1Tail 7"))
-    XCTAssertNotNil(animationView.animationLayer?.layer(for: "Success.FishComplete"))
-    XCTAssertNotNil(animationView.animationLayer?.layer(for: "Success"))
-    XCTAssertNotNil(animationView.animationLayer?.layer(for: "Success.*.Fish1Tail 7"))
-  }
-
-  func testMainThreadEngineKeypathLogging() async {
-    await snapshotHierarchyKeypaths(
-      animationName: "Switch",
-      configuration: LottieConfiguration(renderingEngine: .mainThread))
-  }
-
-  func testCoreAnimationEngineKeypathLogging() async {
-    await snapshotHierarchyKeypaths(
-      animationName: "Switch",
-      configuration: LottieConfiguration(renderingEngine: .coreAnimation))
-
-    await snapshotHierarchyKeypaths(
-      animationName: "Issues/issue_1664",
-      configuration: LottieConfiguration(renderingEngine: .coreAnimation))
-  }
-
-  /// The Core Animation engine supports a subset of the keypaths supported by the Main Thread engine.
-  /// All keypaths that are supported in the Core Animation engine should also be supported by the Main Thread engine.
-  func testCoreAnimationEngineKeypathCompatibility() async {
-    let mainThreadKeypaths =
-      Set(await hierarchyKeypaths(animationName: "Switch", configuration: .init(renderingEngine: .mainThread)))
-    let coreAnimationKeypaths = await hierarchyKeypaths(
-      animationName: "Switch",
-      configuration: .init(renderingEngine: .coreAnimation))
-
-    for coreAnimationKeypath in coreAnimationKeypaths {
-      XCTAssert(
-        mainThreadKeypaths.contains(coreAnimationKeypath),
-        """
-        \(coreAnimationKeypath) from Core Animation rendering engine \
-        is not supported in Main Thread rendering engine
-        """)
-    }
-  }
-
-  // MARK: Private
-
-  private func snapshotHierarchyKeypaths(
-    animationName: String,
-    configuration: LottieConfiguration,
-    function: String = #function,
-    line: UInt = #line) async
-  {
-    let hierarchyKeypaths = await hierarchyKeypaths(animationName: animationName, configuration: configuration)
-
-    assertSnapshot(
-      matching: hierarchyKeypaths.sorted().joined(separator: "\n"),
-      as: .description,
-      named: animationName,
-      testName: function,
-      line: line)
-  }
-
-  private func hierarchyKeypaths(animationName: String, configuration: LottieConfiguration) async -> [String] {
-    var printedMessages = [String]()
-    let logger = LottieLogger(info: { message in
-      printedMessages.append(message())
-    })
-
-    let animationView = await SnapshotConfiguration.makeAnimationView(
-      for: animationName,
-      configuration: configuration,
-      logger: logger)
-    animationView?.logHierarchyKeypaths()
-    return Array(printedMessages[1...])
-  }
-
-}

package/Tests/AnimationViewTests.swift

@@ -1,64 +0,0 @@
-// Created by Cal Stephens on 11/11/22.
-// Copyright © 2022 Airbnb Inc. All rights reserved.
-
-import Lottie
-import XCTest
-
-@MainActor
-final class AnimationViewTests: XCTestCase {
-
-  func testLoadJsonFile() {
-    let animationView = LottieAnimationView(
-      name: "LottieLogo1",
-      bundle: .module,
-      subdirectory: Samples.directoryName)
-
-    XCTAssertNotNil(animationView.animation)
-
-    let expectation = XCTestExpectation(description: "animationLoaded is called")
-    animationView.animationLoaded = { [weak animationView] view, animation in
-      XCTAssert(animation === view.animation)
-      XCTAssertEqual(view, animationView)
-      XCTAssert(Thread.isMainThread)
-      expectation.fulfill()
-    }
-
-    wait(for: [expectation], timeout: 0.25)
-  }
-
-  func testLoadDotLottieFileAsyncWithCompletionClosure() {
-    let expectation = XCTestExpectation(description: "completion closure is called")
-
-    _ = LottieAnimationView(
-      dotLottieName: "DotLottie/animation",
-      bundle: .module,
-      subdirectory: Samples.directoryName,
-      completion: { animationView, error in
-        XCTAssertNil(error)
-        XCTAssertNotNil(animationView.animation)
-        XCTAssert(Thread.isMainThread)
-        expectation.fulfill()
-      })
-
-    wait(for: [expectation], timeout: 1.0)
-  }
-
-  func testLoadDotLottieFileAsyncWithDidLoadClosure() {
-    let expectation = XCTestExpectation(description: "animationLoaded closure is called")
-
-    let animationView = LottieAnimationView(
-      dotLottieName: "DotLottie/animation",
-      bundle: .module,
-      subdirectory: Samples.directoryName)
-
-    animationView.animationLoaded = { [weak animationView] view, animation in
-      XCTAssert(view.animation === animation)
-      XCTAssertEqual(view, animationView)
-      XCTAssert(Thread.isMainThread)
-      expectation.fulfill()
-    }
-
-    wait(for: [expectation], timeout: 1.0)
-  }
-
-}

package/Tests/AutomaticEngineTests.swift

@@ -1,67 +0,0 @@
-// Created by Cal Stephens on 5/2/22.
-// Copyright © 2022 Airbnb Inc. All rights reserved.
-
-import SnapshotTesting
-import UIKit
-import XCTest
-
-@testable import Lottie
-
-@MainActor
-final class AutomaticEngineTests: XCTestCase {
-
-  /// Snapshot tests for whether or not each sample animation supports the Core Animation engine
-  func testAutomaticEngineDetection() async throws {
-    for sampleAnimationName in Samples.sampleAnimationNames {
-      var animation = Samples.animation(named: sampleAnimationName)
-      if animation == nil {
-        animation = await Samples.dotLottie(named: sampleAnimationName)?.animations.first?.animation
-      }
-
-      guard let animation = animation else {
-        XCTFail("Couldn't load animation named \(sampleAnimationName)")
-        continue
-      }
-
-      var compatibilityIssues = [CompatibilityIssue]()
-
-      let animationLayer = try XCTUnwrap(CoreAnimationLayer(
-        animation: animation,
-        imageProvider: BundleImageProvider(bundle: Bundle.main, searchPath: nil),
-        textProvider: DefaultTextProvider(),
-        fontProvider: DefaultFontProvider(),
-        compatibilityTrackerMode: .track,
-        logger: .shared))
-
-      animationLayer.didSetUpAnimation = { issues in
-        compatibilityIssues = issues
-      }
-
-      animationLayer.bounds = CGRect(origin: .zero, size: animation.size)
-      animationLayer.layoutIfNeeded()
-      animationLayer.display()
-
-      let compatibilityReport: String
-      if compatibilityIssues.isEmpty {
-        compatibilityReport = "Supports Core Animation engine"
-      } else {
-        compatibilityReport = "Does not support Core Animation engine. Encountered compatibility issues:\n"
-          + compatibilityIssues.map { $0.description }.joined(separator: "\n")
-      }
-
-      assertSnapshot(
-        matching: compatibilityReport,
-        as: .description,
-        named: sampleAnimationName)
-    }
-  }
-
-  override func setUp() {
-    LottieLogger.shared = .printToConsole
-  }
-
-  override func tearDown() {
-    LottieLogger.shared = LottieLogger()
-  }
-
-}

package/Tests/BundleTests.swift

@@ -1,25 +0,0 @@
-//
-//  BundleTests.swift
-//  LottieTests
-//
-//  Created by Marcelo Fabri on 5/5/22.
-//
-
-import XCTest
-
-@testable import Lottie
-
-final class BundleTests: XCTestCase {
-
-  var bundle: Bundle { .module }
-
-  func testGetAnimationDataWithSuffix() throws {
-    let data = try bundle.getAnimationData("HamburgerArrow.json", subdirectory: "Samples")
-    XCTAssertNotNil(data)
-  }
-
-  func testGetAnimationDataWithoutSuffix() throws {
-    let data = try bundle.getAnimationData("HamburgerArrow", subdirectory: "Samples")
-    XCTAssertNotNil(data)
-  }
-}

package/Tests/DataURLTests.swift

@@ -1,64 +0,0 @@
-// Created by Nicholas Mata on 2/23/22.
-// Copyright © 2022 Airbnb Inc. All rights reserved.
-
-import Foundation
-import XCTest
-
-@testable import Lottie
-
-// MARK: - DataURLTests
-
-// Tests are based on implementation found here
-// https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
-final class DataURLTests: XCTestCase {
-
-  let red5x5 =
-    "%89%50%4e%47%0d%0a%1a%0a%00%00%00%0d%49%48%44%52%00%00%00%05%00%00%00%05%08%06%00%00%00%8d%6f%26%e5%00%00%00%12%49%44%41%54%78%da%63%fc%cf%c0%00%44%a8%80%91%06%82%00%5c%65%09%fc%86%fe%00%b0%00%00%00%00%49%45%4e%44%ae%42%60%82"
-
-  let red5x5Base64 = "iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAEklEQVR42mP8z8AARKiAkQaCAFxlCfyG/gCwAAAAAElFTkSuQmCC"
-
-  func testValidDataURL() {
-    let dataString = "data:image/png;base64,\(red5x5Base64)"
-
-    let data = Data(dataString: dataString)
-    XCTAssertNotNil(data, "Data should not be nil if valid base64 string")
-    let image = UIImage(data: data!)
-    XCTAssertNotNil(image, "Should be valid image")
-
-    // Since legacy options will print nil host logs
-    let legacyData = Data(dataString: dataString, options: .legacy)
-    XCTAssertNotNil(legacyData, "Data should not be nil if valid base64 string")
-    let legacyImage = UIImage(data: legacyData!)
-    XCTAssertNotNil(legacyImage, "Should be valid image")
-
-    XCTAssertEqual(data, legacyData)
-  }
-
-  func testValidDataURLWithoutBase64() {
-    let dataString = "data:image/png,\(red5x5)"
-    // Since ;base64 is missing still prints nil host warnings.
-    // If we can figure out how to turn red5x5 into Data properly
-    // like Data(contentsOf:) does then we can avoid the warning.
-    let data = Data(dataString: dataString)
-    XCTAssertNotNil(data, "Data should not be nil since format is valid data URL")
-
-    let image = UIImage(data: data!)
-    XCTAssertNotNil(image, "Should be valid image. Since missing ';base64' the data is valid just not base64 encoded")
-  }
-
-  func testInvalidDataURLWithBadBase64() {
-    let dataString = "data:image/png;base64,INVALIDBASE64"
-
-    let data = Data(dataString: dataString)
-    let legacyData = Data(dataString: dataString, options: .legacy)
-    XCTAssertNil(data, "Data should be nil because 'INVALIDBASE64' is not valid base64 string.")
-    XCTAssertNil(legacyData, "Data should be nil because 'INVALIDBASE64' is not valid base64 string.")
-  }
-
-  func testInvalidDataURL() {
-    let dataString = "ImageAssetName"
-
-    let data = Data(dataString: dataString)
-    XCTAssertNil(data, "Data should be nil as valid Data URL starts with 'data:'")
-  }
-}

package/Tests/ParsingTests.swift

@@ -1,45 +0,0 @@
-//
-//  ParsingTests.swift
-//  Lottie
-//
-//  Created by Marcelo Fabri on 5/5/22.
-//
-
-import Difference
-import Foundation
-import Lottie
-import XCTest
-
-// MARK: - ParsingTests
-
-final class ParsingTests: XCTestCase {
-
-  func testParsingIsTheSameForBothImplementations() throws {
-    for url in Samples.sampleAnimationURLs {
-      guard url.pathExtension == "json" else { continue }
-
-      do {
-        let data = try Data(contentsOf: url)
-        let codableAnimation = try LottieAnimation.from(data: data, strategy: .legacyCodable)
-        let dictAnimation = try LottieAnimation.from(data: data, strategy: .dictionaryBased)
-
-        XCTAssertNoDiff(codableAnimation, dictAnimation)
-      } catch {
-        XCTFail("Error for \(url.lastPathComponent): \(error)")
-      }
-    }
-  }
-}
-
-func XCTAssertNoDiff<T>(
-  _ expected: @autoclosure () throws -> T,
-  _ received: @autoclosure () throws -> T,
-  file: StaticString = #filePath,
-  line: UInt = #line) rethrows
-{
-  let expected = try expected()
-  let received = try received()
-  let diff = diff(expected, received)
-  let isEqual = diff.isEmpty || diff.allSatisfy(\.isEmpty)
-  XCTAssertTrue(isEqual, "Found difference for \n" + diff.joined(separator: ", "), file: file, line: line)
-}