Initial commit with CocoaPods && SwiftPM support

Author: dreampiggy

.gitignore

@@ -23,9 +23,7 @@ DerivedData
 .bundle
 
 # Add this line if you want to avoid checking in source code from Carthage dependencies.
-# Carthage/Checkouts
-
-Carthage/Build
+Carthage
 
 # We recommend against adding the Pods directory to your .gitignore. However
 # you should judge for yourself, the pros and cons are mentioned at:
@@ -34,4 +32,5 @@ Carthage/Build
 # Note: if you ignore the Pods directory, make sure to uncomment
 # `pod install` in .travis.yml
 #
-# Pods/
+Pods/
+Podfile.lock

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

@@ -313,11 +313,15 @@
 );
 inputPaths = (
 "${PODS_ROOT}/Target Support Files/Pods-SDWebImageLottiePlugin_Example/Pods-SDWebImageLottiePlugin_Example-frameworks.sh",
+"${BUILT_PRODUCTS_DIR}/SDWebImage/SDWebImage.framework",
 "${BUILT_PRODUCTS_DIR}/SDWebImageLottiePlugin/SDWebImageLottiePlugin.framework",
+"${BUILT_PRODUCTS_DIR}/lottie-ios/Lottie.framework",
 );
 name = "[CP] Embed Pods Frameworks";
 outputPaths = (
+"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/SDWebImage.framework",
 "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/SDWebImageLottiePlugin.framework",
+"${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/Lottie.framework",
 );
 runOnlyForDeploymentPostprocessing = 0;
 shellPath = /bin/sh;

Example/SDWebImageLottiePlugin.xcodeproj/project.pbxproj

@@ -7,17 +7,33 @@
 //
 
 import UIKit
+import Lottie
+import SDWebImageLottiePlugin
 
 class ViewController: UIViewController {
+ 
+ let animationView = AnimationView()
 
  override func viewDidLoad() {
  super.viewDidLoad()
- // Do any additional setup after loading the view, typically from a nib.
- }
-
- override func didReceiveMemoryWarning() {
- super.didReceiveMemoryWarning()
- // Dispose of any resources that can be recreated.
+ animationView.contentMode = .scaleAspectFit
+ animationView.frame = self.view.bounds
+ animationView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
+ view.addSubview(animationView)
+ 
+ let lottieUrl = URL(string: "https://raw.githubusercontent.com/airbnb/lottie-web/master/demo/gatin/data.json")
+ animationView.sd_setImage(with: lottieUrl) { (image, error, cacheType, url) in
+ self.animationView.play(fromProgress: 0,
+ toProgress: 1,
+ loopMode: LottieLoopMode.playOnce,
+ completion: { (finished) in
+ if finished {
+ print("Animation Complete")
+ } else {
+ print("Animation cancelled")
+ }
+ })
+ }
  }
 
 }

Example/SDWebImageLottiePlugin.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,34 @@
+// swift-tools-version:5.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+ name: "SDWebImageLottiePlugin",
+ platforms: [
+ .macOS(.v10_10), .iOS(.v9), .tvOS(.v9)
+ ],
+ products: [
+ // Products define the executables and libraries produced by a package, and make them visible to other packages.
+ .library(
+ name: "SDWebImageLottiePlugin",
+ targets: ["SDWebImageLottiePlugin"]),
+ ],
+ dependencies: [
+ // Dependencies declare other packages that this package depends on.
+ // .package(url: /* package url */, from: "1.0.0"),
+ .package(url: "https://github.com/SDWebImage/SDWebImage.git", from: "5.1.0"),
+ .package(url: "https://github.com/airbnb/lottie-ios.git", from: "3.1.2")
+ ],
+ targets: [
+ // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+ // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+ .target(
+ name: "SDWebImageLottiePlugin",
+ dependencies: ["SDWebImage"],
+ path: ".",
+ sources: ["SDWebImageLottiePlugin/Classes"],
+ publicHeadersPath: "SDWebImageLottiePlugin/Classes"
+ )
+ ]
+)

Example/SDWebImageLottiePlugin/ViewController.swift

@@ -1,28 +1,95 @@
 # SDWebImageLottiePlugin
 
-[![CI Status](https://img.shields.io/travis/lizhuoli1126@126.com/SDWebImageLottiePlugin.svg?style=flat)](https://travis-ci.org/lizhuoli1126@126.com/SDWebImageLottiePlugin)
+[![CI Status](https://img.shields.io/travis/SDWebImage/SDWebImageLottiePlugin.svg?style=flat)](https://travis-ci.org/SDWebImage/SDWebImageLottiePlugin)
 [![Version](https://img.shields.io/cocoapods/v/SDWebImageLottiePlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageLottiePlugin)
 [![License](https://img.shields.io/cocoapods/l/SDWebImageLottiePlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageLottiePlugin)
 [![Platform](https://img.shields.io/cocoapods/p/SDWebImageLottiePlugin.svg?style=flat)](https://cocoapods.org/pods/SDWebImageLottiePlugin)
+[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-brightgreen.svg?style=flat)](https://github.com/SDWebImage/SDWebImageLottiePlugin)
+[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg?style=flat)](https://swift.org/package-manager/)
+[![codecov](https://codecov.io/gh/SDWebImage/SDWebImageLottiePlugin/branch/master/graph/badge.svg)](https://codecov.io/gh/SDWebImage/SDWebImageLottiePlugin)
 
-## Example
-
-To run the example project, clone the repo, and run `pod install` from the Example directory first.
+## What's for
+SDWebImageLottiePlugin is a plugin for [SDWebImage](https://github.com/rs/SDWebImage/) framework, which provide the [Lottie](https://github.com/airbnb/lottie-ios) aniamtion loading from JSON file.
 
 ## Requirements
 
++ iOS 9+
++ macOS 10.10+
++ tvOS 9+
++ Xcode 11+
+
 ## Installation
 
+#### CocoaPods
+
 SDWebImageLottiePlugin is available through [CocoaPods](https://cocoapods.org). To install
 it, simply add the following line to your Podfile:
 
 ```ruby
 pod 'SDWebImageLottiePlugin'
 ```
 
+#### Carthage
+
+SDWebImageLottiePlugin is available through [Carthage](https://github.com/Carthage/Carthage).
+
+```
+github "SDWebImage/SDWebImageLottiePlugin"
+```
+
+#### Swift Package Manager (Xcode 11+)
+
+SDWebImageLottiePlugin is available through [Swift Package Manager](https://swift.org/package-manager).
+
+```swift
+let package = Package(
+ dependencies: [
+ .package(url: "https://github.com/SDWebImage/SDWebImageLottiePlugin.git", from: "0.1")
+ ]
+)
+```
+
+## Usage
+
++ Swift
+
+```swift
+let animationView: AnimationView
+let lottieJSONURL: URL
+animationView.sd_setImage(with: lottieJSONURL)
+```
+
++ Objective-C
+
+Note: Lottie 3.0 was rewritten with Swift, but there are still one compatible view left for Objective-C. Learn more here: http://airbnb.io/lottie/#/ios-migration
+
+```objective-c
+CompatibleAnimationView *animationView;
+NSURL *lottieJSONURL;
+[animationView sd_setImageWithURL:lottieJSONURL];
+```
+
+## Demo
+
+If you have some issue about usage, SDWebImageLottiePlugin provide a demo for iOS && macOS platform. To run the demo, clone the repo and run the following command.
+
+```bash
+cd Example/
+pod install
+open SDWebImageLottiePlugin.xcworkspace
+```
+
+After the Xcode project was opened, click `Run` to build and run the demo.
+
+## Screenshot
+
+<img src="https://raw.githubusercontent.com/SDWebImage/SDWebImageLottiePlugin/master/Example/Screenshot/LottieDemo.gif" width="300" />
+
+The lottie json is from [lottie-web example](https://github.com/airbnb/lottie-web/tree/master/demo/gatin)
+
 ## Author
 
-lizhuoli1126@126.com, lizhuoli1126@126.com
+DreamPiggy
 
 ## License
 

Example/Screenshot/LottieDemo.gif

@@ -21,22 +21,17 @@ Pod::Spec.new do |s|
 TODO: Add long description of the pod here.
  DESC
 
- s.homepage = 'https://github.com/lizhuoli1126@126.com/SDWebImageLottiePlugin'
- # s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
+ s.homepage = 'https://github.com/SDWebImage/SDWebImageLottiePlugin'
  s.license = { :type => 'MIT', :file => 'LICENSE' }
- s.author = { 'lizhuoli1126@126.com' => 'lizhuoli1126@126.com' }
- s.source = { :git => 'https://github.com/lizhuoli1126@126.com/SDWebImageLottiePlugin.git', :tag => s.version.to_s }
- # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
-
- s.ios.deployment_target = '8.0'
+ s.author = { 'DreamPiggy' => 'lizhuoli1126@126.com' }
+ s.source = { :git => 'https://github.com/SDWebImage/SDWebImageLottiePlugin.git', :tag => s.version.to_s }
+ s.swift_version = '5.0'
+ s.ios.deployment_target = '9.0'
+ s.osx.deployment_target = '10.10'
+ s.tvos.deployment_target = '9.0'
 
  s.source_files = 'SDWebImageLottiePlugin/Classes/**/*'
- 
- # s.resource_bundles = {
- # 'SDWebImageLottiePlugin' => ['SDWebImageLottiePlugin/Assets/*.png']
- # }
 
- # s.public_header_files = 'Pod/Classes/**/*.h'
- # s.frameworks = 'UIKit', 'MapKit'
- # s.dependency 'AFNetworking', '~> 2.3'
+ s.dependency 'SDWebImage', '~> 5.1'
+ s.dependency 'lottie-ios', '~> 3.1'
 end

Package.swift

@@ -0,0 +1,42 @@
+//
+// AnimatedControl+WebCache.swift
+// SDWebImageLottiePlugin
+//
+// Created by 李卓立 on 2020/2/29.
+//
+
+import SDWebImage
+import Lottie
+
+extension AnimatedControl {
+ /**
+ * Set the imageView `image` with an `url`, placeholder, custom options and context.
+ *
+ * The download is asynchronous and cached.
+ *
+ * @param url The url for the image.
+ * @param placeholder The image to be set initially, until the image request finishes.
+ * @param options The options to use when downloading the image. @see SDWebImageOptions for the possible values.
+ * @param context A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
+ * @param progressBlock A block called while image is downloading
+ * @note the progress block is executed on a background queue
+ * @param completedBlock A block called when operation has been completed. This block has no return value
+ * and takes the requested UIImage as first parameter. In case of error the image parameter
+ * is nil and the second parameter may contain an NSError. The third parameter is a Boolean
+ * indicating if the image was retrieved from the local cache or from the network.
+ * The fourth parameter is the original image url.
+ */
+ public func sd_setImage(with url: URL?, placeholderImage placeholder: UIImage? = nil, options: SDWebImageOptions = [], context: [SDWebImageContextOption : Any]? = nil, progress progressBlock: SDImageLoaderProgressBlock? = nil, completed completedBlock: SDExternalCompletionBlock? = nil) {
+ var context = context ?? [:]
+ context[.animatedImageClass] = LottieImage.self
+ self.sd_internalSetImage(with: url, placeholderImage: placeholder, options: options, context: context, setImageBlock: { [weak self] (image, data, cacheType, url) in
+ if let lottieImage = image as? LottieImage {
+ self?.animation = lottieImage.animation
+ } else {
+ self?.animation = nil
+ }
+ }, progress: progressBlock) { (image, data, error, cacheType, finiseh, url) in
+ completedBlock?(image, error, cacheType, url)
+ }
+ }
+}