lottie-ios 3.2.2 → 3.4.1

package/Package.resolved

@@ -0,0 +1,88 @@
+{
+  "object": {
+    "pins": [
+      {
+        "package": "SourceKitten",
+        "repositoryURL": "https://github.com/jpsim/SourceKitten.git",
+        "state": {
+          "branch": null,
+          "revision": "817dfa6f2e09b0476f3a6c9dbc035991f02f0241",
+          "version": "0.32.0"
+        }
+      },
+      {
+        "package": "AirbnbSwift",
+        "repositoryURL": "https://github.com/airbnb/swift",
+        "state": {
+          "branch": "master",
+          "revision": "b844956fd69f05e550038469a5d498462176f87a",
+          "version": null
+        }
+      },
+      {
+        "package": "swift-argument-parser",
+        "repositoryURL": "https://github.com/apple/swift-argument-parser.git",
+        "state": {
+          "branch": null,
+          "revision": "e394bf350e38cb100b6bc4172834770ede1b7232",
+          "version": "1.0.3"
+        }
+      },
+      {
+        "package": "SwiftSyntax",
+        "repositoryURL": "https://github.com/apple/swift-syntax.git",
+        "state": {
+          "branch": null,
+          "revision": "0b6c22b97f8e9320bca62e82cdbee601cf37ad3f",
+          "version": "0.50600.1"
+        }
+      },
+      {
+        "package": "SwiftFormat",
+        "repositoryURL": "https://github.com/calda/SwiftFormat",
+        "state": {
+          "branch": null,
+          "revision": "2a9ed335450d3b3f66b2699d65124b9089195f5d",
+          "version": "0.49.11-beta-2"
+        }
+      },
+      {
+        "package": "SwiftLint",
+        "repositoryURL": "https://github.com/realm/SwiftLint",
+        "state": {
+          "branch": "e497f1f",
+          "revision": "e497f1f5b161af96ba439049d21970c6204d06c6",
+          "version": null
+        }
+      },
+      {
+        "package": "SwiftyTextTable",
+        "repositoryURL": "https://github.com/scottrhoyt/SwiftyTextTable.git",
+        "state": {
+          "branch": null,
+          "revision": "c6df6cf533d120716bff38f8ff9885e1ce2a4ac3",
+          "version": "0.9.0"
+        }
+      },
+      {
+        "package": "SWXMLHash",
+        "repositoryURL": "https://github.com/drmohundro/SWXMLHash.git",
+        "state": {
+          "branch": null,
+          "revision": "6469881a3f30417c5bb02404ea4b69207f297592",
+          "version": "6.0.0"
+        }
+      },
+      {
+        "package": "Yams",
+        "repositoryURL": "https://github.com/jpsim/Yams.git",
+        "state": {
+          "branch": null,
+          "revision": "9ff1cc9327586db4e0c8f46f064b6a82ec1566fa",
+          "version": "4.0.6"
+        }
+      }
+    ]
+  },
+  "version": 1
+}

package/Package.swift

@@ -1,18 +1,13 @@
-// swift-tools-version:5.0
+// swift-tools-version:5.3
 import PackageDescription
 
 let package = Package(
-    name: "Lottie",
-    platforms: [.iOS(.v9)],
-    // platforms: [.iOS("9.0"), .macOS("10.10"), tvOS("9.0"), .watchOS("2.0")],
-    products: [
-        .library(name: "Lottie", targets: ["Lottie"])
-    ],
-    targets: [
-        .target(
-            name: "Lottie",
-            path: "lottie-swift/src",
-            exclude: ["Public/MacOS"]
-        )
-    ]
-)
+  name: "Lottie",
+  platforms: [.iOS("11.0"), .macOS("10.10"), .tvOS("11.0")],
+  products: [.library(name: "Lottie", targets: ["Lottie"])],
+  targets: [.target(name: "Lottie", path: "Sources")])
+
+#if swift(>=5.6)
+// Add the Airbnb Swift formatting plugin if possible
+package.dependencies.append(.package(url: "https://github.com/airbnb/swift", .branch("master")))
+#endif

package/README.md

@@ -1,18 +1,17 @@
-# Lottie for iOS, macOS (and [Android](https://github.com/airbnb/lottie-android) and [React Native](https://github.com/airbnb/lottie-react-native))
-[![Version](https://img.shields.io/cocoapods/v/lottie-ios.svg?style=flat)](https://cocoapods.org/pods/lottie-ios)[![License](https://img.shields.io/cocoapods/l/lottie-ios.svg?style=flat)](https://cocoapods.org/pods/lottie-ios)[![Platform](https://img.shields.io/cocoapods/p/lottie-ios.svg?style=flat)](https://cocoapods.org/pods/lottie-ios)
+# Lottie for iOS
+ [![Version](https://img.shields.io/cocoapods/v/lottie-ios.svg?style=flat)](https://cocoapods.org/pods/lottie-ios) [![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![SwiftPM](https://img.shields.io/badge/SPM-supported-DE5C43.svg?style=flat)](https://swift.org/package-manager/) [![License](https://img.shields.io/cocoapods/l/lottie-ios.svg?style=flat)](https://cocoapods.org/pods/lottie-ios) [![Platform](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fairbnb%2Flottie-ios%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/airbnb/lottie-ios) [![Swift Versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fairbnb%2Flottie-ios%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/airbnb/lottie-ios)
 
-# View documentation, FAQ, help, examples, and more at [airbnb.io/lottie](http://airbnb.io/lottie/)
+**View documentation, FAQ, help, examples, and more at [airbnb.io/lottie](http://airbnb.io/lottie/)**
 
-Lottie is a mobile library for Android and iOS that natively renders vector based animations and art in realtime with minimal code.
+Lottie is a cross-platform library for iOS, macOS, tvOS, [Android](https://github.com/airbnb/lottie), and [Web](https://github.com/airbnb/lottie-web) that natively renders vector-based animations and art in realtime with minimal code.
 
-Lottie loads and renders animations and vectors exported in the bodymovin JSON format. Bodymovin JSON can be created and exported from After Effects with [bodymovin](https://github.com/bodymovin/bodymovin), Sketch with [Lottie Sketch Export](https://github.com/buba447/Lottie-Sketch-Export), and from [Haiku](https://www.haiku.ai). 
+Lottie loads and renders animations and vectors exported in the bodymovin JSON format. Bodymovin JSON can be created and exported from After Effects with [bodymovin](https://github.com/bodymovin/bodymovin), Sketch with [Lottie Sketch Export](https://github.com/buba447/Lottie-Sketch-Export), and from [Haiku](https://www.haiku.ai).
 
-For the first time, designers can create **and ship** beautiful animations without an engineer painstakingly recreating it by hand.
+Designers can create **and ship** beautiful animations without an engineer painstakingly recreating it by hand.
 Since the animation is backed by JSON they are extremely small in size but can be large in complexity!
 Animations can be played, resized, looped, sped up, slowed down, reversed, and even interactively scrubbed.
 Lottie can play or loop just a portion of the animation as well, the possibilities are endless!
-Animations can even be ***changed at runtime*** in various ways! Change the color, position or any keyframable value!
-Lottie also supports native UIViewController Transitions out of the box!
+Animations can even be ***changed at runtime*** in various ways! Change the color, position, or any keyframable value!
 
 Here is just a small sampling of the power of Lottie
 
@@ -26,10 +25,18 @@ Here is just a small sampling of the power of Lottie
 ![Abcs](_Gifs/Examples4.gif)
 
 ## Installing Lottie
-Lottie supports [CocoaPods](https://cocoapods.org/) and [Carthage](https://github.com/Carthage/Carthage) (Both dynamic and static). Lottie is written in ***Swift 4.2***.
+Lottie supports [Swift Package Manager](https://www.swift.org/package-manager/), [CocoaPods](https://cocoapods.org/), and [Carthage](https://github.com/Carthage/Carthage) (Both dynamic and static).
+
 ### Github Repo
 
-You can pull the [Lottie Github Repo](https://github.com/airbnb/lottie-ios/) and include the Lottie.xcodeproj to build a dynamic or static library.
+You can pull the [Lottie Github Repo](https://github.com/airbnb/lottie-ios/) and include the `Lottie.xcodeproj` to build a dynamic or static library.
+
+### Swift Package Manager
+
+To install Lottie using [Swift Package Manager](https://github.com/apple/swift-package-manager)  you can follow the [tutorial published by Apple](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app) using the URL for the Lottie repo with the current version:
+
+1. In Xcode, select “File” → “Swift Packages” → “Add Package Dependency”
+1. Enter https://github.com/airbnb/lottie-ios.git
 
 ### CocoaPods
 Add the pod to your Podfile:
@@ -41,7 +48,7 @@ And then run:
 ```ruby
 pod install
 ```
-After installing the cocoapod into your project import Lottie with 
+After installing the cocoapod into your project import Lottie with
 ```swift
 import Lottie
 ```
@@ -57,60 +64,33 @@ carthage update
 ```
 In your application targets “General” tab under the “Linked Frameworks and Libraries” section, drag and drop lottie-ios.framework from the Carthage/Build/iOS directory that `carthage update` produced.
 
-### Swift Package Manager
-``` swift
-// swift-tools-version:5.1
-
-import PackageDescription
-
-let package = Package(
-  name: "YourTestProject",
-  platforms: [
-       .iOS(.v12),
-  ],
-  dependencies: [
-    .package(url: "https://github.com/airbnb/lottie-ios.git", from: "3.1.2")
-  ],
-  targets: [
-    .target(name: "YourTestProject", dependencies: ["Lottie"])
-  ]
-)
-```
-And then import wherever needed: ```import Lottie```
-
-#### Adding it to an existent iOS Project via Swift Package Manager
-
-1. Using Xcode 11 go to File > Swift Packages > Add Package Dependency
-2. Paste the project URL: https://github.com/airbnb/lottie-ios
-3. Click on next and select the project target
-4. Don't forget to set `DEAD_CODE_STRIPPING = NO` in your `Build Settings` (https://bugs.swift.org/plugins/servlet/mobile#issue/SR-11564)
-  **NOTE: For MacOS you must set the `Branch` field to `lottie/macos-spm`
-  ![Example](_Gifs/spm-branch.png)
-
-If you have doubts, please, check the following links:
-
-[How to use](https://developer.apple.com/videos/play/wwdc2019/408/)
-
-[Creating Swift Packages](https://developer.apple.com/videos/play/wwdc2019/410/)
-
-After successfully retrieved the package and added it to your project, just import `Lottie` and you can get the full benefits of it.
-
------
-
-### Objective-C Support
+### Data collection
 
-As of 3.0 Lottie has been completely rewritten in Swift! 
+The Lottie SDK does not collect any data. We provide this notice to help you fill out [App Privacy Details](https://developer.apple.com/app-store/app-privacy-details/).
 
-For Objective-C support please use Lottie 2.5.3. Alternatively an Objective-C branch exists and is still active.
+## Contributing
 
-The official objective c branch can be found here:
+We always appreciate contributions from the community. To make changes to the project, you can clone the repo and open `Lottie.xcworkspace`. This workspace includes:
+ - the Lottie framework (for iOS, macOS, and tvOS)
+ - 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
 
-[Objective-C Branch](https://github.com/airbnb/lottie-ios/tree/lottie/objectiveC)
+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.
 
-Also check out the documentation regarding it here: 
+The project also includes several helpful commands defined in our [Rakefile](https://github.com/airbnb/lottie-ios/blob/master/Rakefile). To use these, you need to install [Bundler](https://bundler.io/):
 
-[iOS Migration](http://airbnb.io/lottie/#/ios-migration)
+```bash
+$ sudo gem install bundle
+$ bundle install
+```
 
-### Data collection
+For example, all Swift code should be formatted according to the [Airbnb Swift Style Guide](https://github.com/airbnb/swift). After making changes, you can reformat the code automatically using [SwiftFormat](https://github.com/nicklockwood/SwiftFormat) and [SwiftLint](https://github.com/realm/SwiftLint) by running `bundle exec rake format:swift`. Other helpful commands include:
 
-The Lottie SDK does not collect any data. We provide this notice to help you fill out [App Privacy Details](https://developer.apple.com/app-store/app-privacy-details/).
+```bash
+$ bundle exec rake build:all # builds all targets for all platforms
+$ bundle exec rake build:package:iOS # builds the Lottie package for iOS
+$ bundle exec rake test:package # tests the Lottie package
+$ bundle exec rake format:swift # reformat Swift code based on the Airbnb Swift Style Guide
+```

package/Rakefile

@@ -0,0 +1,121 @@
+namespace :build do
+  desc 'Builds all packages and executables'
+  task all: ['package:all', 'example:all']
+
+  desc 'Builds the Lottie package for supported platforms'
+  namespace :package do
+    desc 'Builds the Lottie package for all supported platforms'
+    task all: ['iOS', 'macOS', 'tvOS']
+
+    desc 'Builds the Lottie package for iOS'
+    task :iOS do
+      xcodebuild('build -scheme "Lottie (iOS)" -destination generic/platform=iOS -workspace Lottie.xcworkspace')
+    end
+
+    desc 'Builds the Lottie package for macOS'
+    task :macOS do
+      xcodebuild('build -scheme "Lottie (macOS)" -destination generic/platform=macOS -workspace Lottie.xcworkspace')
+    end
+
+    desc 'Builds the Lottie package for tvOS'
+    task :tvOS do
+      xcodebuild('build -scheme "Lottie (tvOS)" -destination generic/platform=tvOS -workspace Lottie.xcworkspace')
+    end
+  end
+
+  desc 'Builds the Lottie example app for supported platforms'
+  namespace :example do
+    desc 'Builds the Lottie example apps for all supported platforms'
+    task all: ['iOS', 'macOS', 'tvOS']
+
+    desc 'Builds the iOS Lottie Example app'
+    task :iOS do
+      xcodebuild('build -scheme "Example (iOS)" -destination "platform=iOS Simulator,name=iPhone 8" -workspace Lottie.xcworkspace')
+    end
+
+    desc 'Builds the macOS Lottie Example app'
+    task :macOS do
+      xcodebuild('build -scheme "Example (macOS)" -workspace Lottie.xcworkspace')
+    end
+
+    desc 'Builds the tvOS Lottie Example app'
+    task :tvOS do
+      xcodebuild('build -scheme "Example (tvOS)" -destination "platform=tvOS Simulator,name=Apple TV" -workspace Lottie.xcworkspace')
+    end
+  end
+end
+
+namespace :test do
+  desc 'Tests the Lottie package for iOS'
+  task :package do
+    sh 'rm -rf Tests/Artifacts'
+    xcodebuild('test -scheme "Lottie (iOS)" -destination "platform=iOS Simulator,name=iPhone 8" -resultBundlePath Tests/Artifacts/LottieTests.xcresult')
+  end
+
+  desc 'Processes .xcresult artifacts from the most recent test:package execution'
+  task :process do
+    sh 'mint run ChargePoint/xcparse@2.2.1 xcparse attachments Tests/Artifacts/LottieTests.xcresult Tests/Artifacts/TestAttachments'
+  end
+
+  desc 'Tests Carthage support'
+  task :carthage do
+    # Copy the repo to `Carthage/Checkouts/Lottie-ios`
+    sh 'rm -rf script/test-carthage/Carthage'
+    sh 'mkdir script/test-carthage/Carthage script/test-carthage/Carthage/Checkouts script/test-carthage/Carthage/Checkouts/lottie-ios'
+    sh 'cp -R [^script]* script/test-carthage/Carthage/Checkouts/lottie-ios'
+
+    Dir.chdir('script/test-carthage') do
+      # Build the LottieCarthage framework scheme
+      sh 'carthage build --use-xcframeworks'
+
+      # Delete Carthage's derived data to verify that the built .xcframework doesn't depend on any
+      # side effects from building on this specific machine.
+      # https://github.com/airbnb/lottie-ios/issues/1492
+      sh 'rm -rf ~/Library/Caches/org.carthage.CarthageKit/DerivedData'
+
+      # Build a test app that imports and uses the LottieCarthage framework
+      xcodebuild('build -scheme CarthageTest -destination "platform=iOS Simulator,name=iPhone 8"')
+      xcodebuild('build -scheme CarthageTest-macOS')
+    end
+  end
+
+  desc 'Tests Swift Package Manager support'
+  task :spm do
+    Dir.chdir('script/test-spm') do
+      # Build for iOS, macOS, and tvOS using the targets defined in Package.swift
+      xcodebuild('build -scheme "Lottie" -destination generic/platform=iOS')
+      xcodebuild('build -scheme "Lottie" -destination generic/platform=macOS')
+      xcodebuild('build -scheme "Lottie" -destination generic/platform=tvOS')
+    end
+  end
+end
+
+namespace :lint do
+  desc 'Lints swift files'
+  task :swift do
+    sh 'swift package --allow-writing-to-package-directory format --lint'
+  end
+
+  desc 'Lints the CocoaPods podspec'
+  task :podspec do
+    sh 'pod lib lint lottie-ios.podspec'
+  end
+end
+
+namespace :format do
+  desc 'Formats swift files'
+  task :swift do
+    sh 'swift package --allow-writing-to-package-directory format'
+  end
+end
+
+def xcodebuild(command)
+  # Check if the mint tool is installed -- if so, pipe the xcodebuild output through xcbeautify
+  `which mint`
+
+  if $?.success?
+    sh "set -o pipefail && xcodebuild #{command} | mint run thii/xcbeautify@0.10.2"
+  else
+    sh "xcodebuild #{command}"
+  end
+end

package/Sources/Private/CoreAnimation/Animations/CAAnimation+TimingConfiguration.swift

@@ -0,0 +1,81 @@
+// Created by Cal Stephens on 1/6/22.
+// Copyright © 2022 Airbnb Inc. All rights reserved.
+
+import QuartzCore
+
+extension CAAnimation {
+  /// Creates a `CAAnimation` that wraps this animation,
+  /// applying timing-related configuration from the given `LayerAnimationContext`.
+  ///  - This animation should start at the beginning of the animation and
+  ///    last the entire duration of the animation. It will be trimmed and retimed
+  ///    to match the current playback state / looping configuration of the animation view.
+  @nonobjc
+  func timed(with context: LayerAnimationContext, for layer: CALayer) -> CAAnimation {
+    // The base animation always has the duration of the full animation,
+    // since that's the time space where keyframing and interpolating happens.
+    // So we start with a simple animation timeline from 0% to 100%:
+    //
+    //  ┌──────────────────────────────────┐
+    //  │           baseAnimation          │
+    //  └──────────────────────────────────┘
+    //  0%                                100%
+    //
+    let baseAnimation = self
+    baseAnimation.duration = context.animation.duration
+    baseAnimation.speed = (context.endFrame < context.startFrame) ? -1 : 1
+
+    // To select the subrange of the `baseAnimation` that should be played,
+    // we create a parent animation with the duration of that subrange
+    // to clip the `baseAnimation`. This parent animation can then loop
+    // and/or autoreverse over the clipped subrange.
+    //
+    //        ┌────────────────────┬───────►
+    //        │   clippingParent   │  ...
+    //        └────────────────────┴───────►
+    //       25%                  75%
+    //  ┌──────────────────────────────────┐
+    //  │           baseAnimation          │
+    //  └──────────────────────────────────┘
+    //  0%                                100%
+    //
+    let clippingParent = CAAnimationGroup()
+    clippingParent.animations = [baseAnimation]
+
+    clippingParent.duration = Double(abs(context.endFrame - context.startFrame)) / context.animation.framerate
+    baseAnimation.timeOffset = context.animation.time(forFrame: context.startFrame)
+
+    clippingParent.autoreverses = context.timingConfiguration.autoreverses
+    clippingParent.repeatCount = context.timingConfiguration.repeatCount
+    clippingParent.timeOffset = context.timingConfiguration.timeOffset
+
+    // Once the animation ends, it should pause on the final frame
+    clippingParent.fillMode = .both
+    clippingParent.isRemovedOnCompletion = false
+
+    // We can pause the animation on a specific frame by setting the root layer's
+    // `speed` to 0, and then setting the `timeOffset` for the given frame.
+    //  - For that setup to work properly, we have to set the `beginTime`
+    //    of this animation to a time slightly before the current time.
+    //  - It's not really clear why this is necessary, but `timeOffset`
+    //    is not applied correctly without this configuration.
+    //  - We can't do this when playing the animation in real time,
+    //    because it can cause keyframe timings to be incorrect.
+    if context.timingConfiguration.speed == 0 {
+      let currentTime = layer.convertTime(CACurrentMediaTime(), from: nil)
+      clippingParent.beginTime = currentTime - .leastNonzeroMagnitude
+    }
+
+    return clippingParent
+  }
+}
+
+extension CALayer {
+  /// Adds the given animation to this layer, timed with the given timing configuration
+  ///  - The given animation should start at the beginning of the animation and
+  ///    last the entire duration of the animation. It will be trimmed and retimed
+  ///    to match the current playback state / looping configuration of the animation view.
+  @nonobjc
+  func add(_ animation: CAPropertyAnimation, timedWith context: LayerAnimationContext) {
+    add(animation.timed(with: context, for: self), forKey: animation.keyPath)
+  }
+}