From bb00bf1b7335f37cd537736639a4fc9ad54e9fcc Mon Sep 17 00:00:00 2001 From: DreamPiggy Date: Sat, 26 Jan 2019 18:16:22 +0800 Subject: [PATCH] Update the CHANGELOG and API diff --- CHANGELOG.md | 33 +++++++++++++++++++++++++++++ Docs/API-Diff/5.0/apidiff.html | 38 ++++++++++++++++++++++++++-------- 2 files changed, 62 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 860c23e6..c923ac54 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,36 @@ +## [5.0.0-beta4 - Customizable SDWebImage, on Jan 26th, 2019](https://github.com/rs/SDWebImage/releases/tag/5.0.0-beta4) +See [all tickets marked for the 5.0.0 release](https://github.com/rs/SDWebImage/milestone/15) + +#### Features +- Expose the graphics helper method for coder plugin author and fix scale issue #2523 + +#### Performances +- Decrease animated decode times when cache enable #2468 +- Remove kCGImageSourceShouldCache option when creating image source #2472 +- Add autoreleasepool to release autorelease objects in advance when using GCD #2474 + +#### Fixes +- Add protect when custom animated image class image data is nil during progressive animation check #2466 +- Fix background download #2500 + +#### Project +- Merged targets + MapKit dedicated target for Carthage installs #2476. Carthage user now does not enable MapKit support by default. +- Upgrade Xcode 10 + using xcconfig for project settings #2494 + +#### Notable Changes (from beta3) + +Behavior: + +- Move webp component (and libwebp dependency) to SDWebImage/SDWebImageWebPCoder #2469. Any user who use WebP in 5.0.0 should add [SDWebImageWebPCoder](https://github.com/SDWebImage/SDWebImageWebPCoder) to your Podfile or Cartfile instead. +- Refactory cache path about namespace && final cache directory #2535. Now the default disk cache path was moved to suitable path with the namespace. +- Use the memory bytes size, instead of pixel size to calculate the memory cost function #2568. Now the memory cost function use bytes size instead of pixels count. + +Swift Only: + +- Fix the accident changes of Swift API naming for `sd_imageDataAsFormat:` #2517 + +You can always check [5.0 migration guide](https://github.com/SDWebImage/SDWebImage/wiki/5.0-Migration-guide) for the latest information for these changes. + ## [5.0.0-beta3 - Customizable SDWebImage, on Aug 30th, 2018](https://github.com/rs/SDWebImage/releases/tag/5.0.0-beta3) See [all tickets marked for the 5.0.0 release](https://github.com/rs/SDWebImage/milestone/15) diff --git a/Docs/API-Diff/5.0/apidiff.html b/Docs/API-Diff/5.0/apidiff.html index 13c7d66c..ce82699a 100644 --- a/Docs/API-Diff/5.0/apidiff.html +++ b/Docs/API-Diff/5.0/apidiff.html @@ -227,6 +227,8 @@
Removed SDImageCache.maxMemoryCountLimit
Removed -[SDImageCache makeDiskCachePath:]
Removed -[SDImageCache addReadOnlyCachePath:]
+
Removed -[SDImageCache getSize]
+
Removed -[SDImageCache getDiskCount]
Removed -[SDImageCache cachePathForKey:inPath:]
Removed -[SDImageCache defaultCachePathForKey:]
@@ -247,6 +249,8 @@
Added -[SDImageCache queryCacheOperationForKey:options:context:done:]
Added -[SDImageCache removeImageFromMemoryForKey:]
Added -[SDImageCache removeImageFromDiskForKey:]
+
Added -[SDImageCache totalDiskSize]
+
Added -[SDImageCache totalDiskCount]
@@ -272,6 +276,13 @@ To@property (class, nonatomic, readonly, nonnull) SDImageCache *sharedImageCache
+
Modified -[SDImageCache initWithNamespace:diskCacheDirectory:]
+ + + + +
Declaration
From- (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns diskCacheDirectory:(nonnull NSString *)directory
To- (nonnull instancetype)initWithNamespace:(nonnull NSString *)ns diskCacheDirectory:(nullable NSString *)directory
+
Modified -[SDImageCache diskImageExistsWithKey:completion:]
@@ -309,15 +320,18 @@
Removed SDImageCacheConfig.shouldDecompressImages
+
Removed SDImageCacheConfig.maxCacheAge
+
Removed SDImageCacheConfig.maxCacheSize
Added SDImageCacheConfig.defaultCacheConfig
Added SDImageCacheConfig.shouldRemoveExpiredDataWhenEnterBackground
+
Added SDImageCacheConfig.maxDiskAge
+
Added SDImageCacheConfig.maxDiskSize
Added SDImageCacheConfig.maxMemoryCost
Added SDImageCacheConfig.maxMemoryCount
-
Added SDImageCacheConfig.namespacePrefix
Added SDImageCacheConfig.fileManager
Added SDImageCacheConfig.memoryCacheClass
Added SDImageCacheConfig.diskCacheClass
@@ -332,13 +346,6 @@
Declaration
ToNSCopying

-
Modified SDImageCacheConfig.maxCacheAge
- - - - -
Declaration
From@property (nonatomic, assign) NSInteger maxCacheAge
To@property (nonatomic, assign) NSTimeInterval maxCacheAge
-
@@ -475,6 +482,19 @@ +
+
SDImageGraphics.h
+ +
+
Added SDGraphicsGetCurrentContext()
+
Added SDGraphicsBeginImageContext()
+
Added SDGraphicsBeginImageContextWithOptions()
+
Added SDGraphicsEndImageContext()
+
Added SDGraphicsGetImageFromCurrentImageContext()
+
+ +
+
SDImageIOCoder.h
@@ -563,7 +583,6 @@
SDMemoryCache.h
-
Added SDMemoryCacheCostForImage()
Added SDMemoryCache
Added -[SDMemoryCache initWithConfig:]
Added -[SDMemoryCache objectForKey:]
@@ -1283,6 +1302,7 @@
Removed SDWebImageInternalSetImageGroupKey
Removed SDWebImageExternalCustomManagerKey
+
Removed SDInternalSetImageBlock
Removed -[UIView sd_internalSetImageWithURL:placeholderImage:options:operationKey:setImageBlock:progress:completed:]
Removed -[UIView sd_internalSetImageWithURL:placeholderImage:options:operationKey:setImageBlock:progress:completed:context:]
Removed -[UIView sd_setShowActivityIndicatorView:]