3.1.0 (#552)

CHANGELOG.md

@@ -4,16 +4,15 @@ All notable changes to this project will be documented in this file. Take a look
 
 **Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
 
-## [Unreleased]
+<!-- ## [Unreleased] -->
+
+## [3.1.0]
 
 ### Added
 
 #### Shared
 
 * Support for streaming ZIP packages over HTTP. This lets you open a remote EPUB, audiobook, or any other ZIP-based publication without needing to download it first.
-* A new `ReadiumAdapterMinizip` library ships the old `ArchiveOpener` using Minizip. Compared to the newer default `ZIPArchiveOpener`, it has the following differences:  
-    * It does not support HTTP streaming of ZIP packages.  
-    * It offers better performance for LCP-protected publications containing large resources that are `deflated` instead of `stored` in the archive, which is not recommended.
 
 ### Deprecated
 
@@ -863,3 +862,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
 [3.0.0-alpha.3]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.2...3.0.0-alpha.3
 [3.0.0-beta.1]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.3...3.0.0-beta.1
 [3.0.0-beta.2]: https://github.com/readium/swift-toolkit/compare/3.0.0-beta.1...3.0.0-beta.2
+[3.1.0]: https://github.com/readium/swift-toolkit/compare/3.0.0...3.1.0

README.md

@@ -45,7 +45,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
 Add the following to your `Cartfile`:
 
 ```
-github "readium/swift-toolkit" ~> 3.0.0
+github "readium/swift-toolkit" ~> 3.1.0
 ```
 
 Then, [follow the usual Carthage steps](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to add the Readium libraries to your project.
@@ -75,11 +75,11 @@ Add the following `pod` statements to your `Podfile` for the Readium libraries y
 source 'https://github.com/readium/podspecs'
 source 'https://cdn.cocoapods.org/'
 
-pod 'ReadiumShared', '~> 3.0.0'
-pod 'ReadiumStreamer', '~> 3.0.0'
-pod 'ReadiumNavigator', '~> 3.0.0'
-pod 'ReadiumOPDS', '~> 3.0.0'
-pod 'ReadiumLCP', '~> 3.0.0'
+pod 'ReadiumShared', '~> 3.1.0'
+pod 'ReadiumStreamer', '~> 3.1.0'
+pod 'ReadiumNavigator', '~> 3.1.0'
+pod 'ReadiumOPDS', '~> 3.1.0'
+pod 'ReadiumLCP', '~> 3.1.0'
 ```
 
 Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.

Support/Carthage/.xcodegen

@@ -230,6 +230,9 @@
     },
     "ReadiumShared" : {
       "dependencies" : [
+        {
+          "framework" : "..\/..\/Carthage\/Build\/Minizip.xcframework"
+        },
         {
           "framework" : "..\/..\/Carthage\/Build\/ReadiumFuzi.xcframework"
         },
@@ -439,13 +442,9 @@
 ../../Sources/Navigator/EPUB/Assets/Static/scripts
 ../../Sources/Navigator/EPUB/Assets/Static/scripts/.gitignore
 ../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-one.js
-../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-one.js.map
 ../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-two.js
-../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-two.js.map
 ../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed.js
-../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed.js.map
 ../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-reflowable.js
-../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-reflowable.js.map
 ../../Sources/Navigator/EPUB/CSS
 ../../Sources/Navigator/EPUB/CSS/CSSLayout.swift
 ../../Sources/Navigator/EPUB/CSS/CSSProperties.swift

Support/Carthage/Readium.xcodeproj/project.pbxproj

@@ -8,6 +8,7 @@
 
 /* Begin PBXBuildFile section */
 		0025BE4D568B560277323B95 /* FileResource.swift in Sources */ = {isa = PBXBuildFile; fileRef = C05502AD8940D6616D6C386F /* FileResource.swift */; };
+		01AC52ADE389D14F5274CEB2 /* Minizip.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */; };
 		01AD628D6DE82E1C1C4C281D /* NavigationDocumentParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 29AD63CD2A41586290547212 /* NavigationDocumentParser.swift */; };
 		01E785BEA7F30AD1C8A5F3DE /* SearchService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9B5B029CA09EE1F86A19612A /* SearchService.swift */; };
 		01F29BAD25D4597903AF253F /* CompositeFormatSniffer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41E54A18E2983098A6A4DAE0 /* CompositeFormatSniffer.swift */; };
@@ -781,6 +782,7 @@
 		CF31AEFB5FF0E7892C6D903E /* EPUBPreferences+Legacy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "EPUBPreferences+Legacy.swift"; sourceTree = "<group>"; };
 		CFE1142A6C038A35C527CE84 /* URITemplate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URITemplate.swift; sourceTree = "<group>"; };
 		CFE34EA8AF2D815F7169CA45 /* Fuzi.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Fuzi.swift; sourceTree = "<group>"; };
+		CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = Minizip.xcframework; path = ../../Carthage/Build/Minizip.xcframework; sourceTree = "<group>"; };
 		D008F7BB187AE82CBB115D0F /* WebServerResourceResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebServerResourceResponse.swift; sourceTree = "<group>"; };
 		D0C2A38D366CE8560BCBAC8B /* PDFPositionsService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PDFPositionsService.swift; sourceTree = "<group>"; };
 		D0E8D322A523DA324E3E2E59 /* MinizipContainer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MinizipContainer.swift; sourceTree = "<group>"; };
@@ -905,6 +907,7 @@
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				01AC52ADE389D14F5274CEB2 /* Minizip.xcframework in Frameworks */,
 				B02109488289D631DF959B8D /* ReadiumFuzi.xcframework in Frameworks */,
 				CDE5EE79D3F0D00F9CAED8B8 /* ReadiumZIPFoundation.xcframework in Frameworks */,
 				D9499DACC5329F3774CBEDAC /* SwiftSoup.xcframework in Frameworks */,
@@ -1777,6 +1780,7 @@
 				342D5C0FEE79A2ABEE24A43E /* CoreServices.framework */,
 				E37F94C388A86CB8A34812A5 /* CryptoSwift.xcframework */,
 				3F95F3F20D758BE0E7005EA3 /* DifferenceKit.xcframework */,
+				CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */,
 				2828D89EBB52CCA782ED1146 /* ReadiumFuzi.xcframework */,
 				6536C07F5A50F7F25FDBF69C /* ReadiumGCDWebServer.xcframework */,
 				69E17C4870C64264819EB227 /* ReadiumZIPFoundation.xcframework */,

Support/Carthage/project.yml

@@ -13,6 +13,7 @@ targets:
     sources: 
       - path: ../../Sources/Shared
     dependencies:
+      - framework: ../../Carthage/Build/Minizip.xcframework
       - framework: ../../Carthage/Build/ReadiumFuzi.xcframework
       - framework: ../../Carthage/Build/ReadiumZIPFoundation.xcframework
       - framework: ../../Carthage/Build/SwiftSoup.xcframework

Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumAdapterGCDWebServer"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Adapter to use GCDWebServer as an HTTP server in Readium"
   s.homepage      = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = "13.4"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
 
-  s.dependency 'ReadiumShared', '~> 3.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumShared', '~> 3.1.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
   s.dependency 'ReadiumGCDWebServer', '~> 4.0.0'
 
 end

Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumAdapterLCPSQLite"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Adapter to use SQLite.swift for the Readium LCP repositories"
   s.homepage      = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = "13.4"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
 
-  s.dependency 'ReadiumLCP', '~> 3.0.0'
-  s.dependency 'ReadiumShared', '~> 3.0.0'
+  s.dependency 'ReadiumLCP', '~> 3.1.0'
+  s.dependency 'ReadiumShared', '~> 3.1.0'
   s.dependency 'SQLite.swift', '~> 0.15.0'
 
 end

Support/CocoaPods/ReadiumInternal.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumInternal"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Private utilities used by the Readium modules"
   s.homepage      = "http://readium.github.io"

Support/CocoaPods/ReadiumLCP.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumLCP"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium LCP"
   s.homepage      = "http://readium.github.io"
@@ -20,8 +20,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = "13.4"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2'}
 
-  s.dependency 'ReadiumShared' , '~> 3.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumShared' , '~> 3.1.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
   s.dependency 'ReadiumZIPFoundation', '~> 2.0.0'
   s.dependency 'CryptoSwift', '~> 1.8.0'
 end

Support/CocoaPods/ReadiumNavigator.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumNavigator"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium Navigator"
   s.homepage      = "http://readium.github.io"
@@ -19,8 +19,8 @@ Pod::Spec.new do |s|
   s.platform      = :ios
   s.ios.deployment_target = "13.4"
 
-  s.dependency 'ReadiumShared', '~> 3.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumShared', '~> 3.1.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
   s.dependency 'DifferenceKit', '~> 1.0'
   s.dependency 'SwiftSoup', '~> 2.7.0'
 

Support/CocoaPods/ReadiumOPDS.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumOPDS"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium OPDS"
   s.homepage      = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
   s.ios.deployment_target = "13.4"
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
 
-  s.dependency 'ReadiumShared', '~> 3.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumShared', '~> 3.1.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
 
 end

Support/CocoaPods/ReadiumShared.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "ReadiumShared"
-  s.version      = "3.0.0"
+  s.version      = "3.1.0"
   s.license      = "BSD 3-Clause License"
   s.summary      = "Readium Shared"
   s.homepage     = "http://readium.github.io"
@@ -20,6 +20,6 @@ Pod::Spec.new do |s|
   s.dependency 'SwiftSoup', '~> 2.7.0'
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
   s.dependency 'ReadiumZIPFoundation', '~> 2.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
 
 end

Support/CocoaPods/ReadiumStreamer.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name          = "ReadiumStreamer"
-  s.version       = "3.0.0"
+  s.version       = "3.1.0"
   s.license       = "BSD 3-Clause License"
   s.summary       = "Readium Streamer"
   s.homepage      = "http://readium.github.io"
@@ -22,8 +22,8 @@ Pod::Spec.new do |s|
   s.xcconfig      = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
 
   s.dependency 'ReadiumFuzi', '~> 4.0.0'
-  s.dependency 'ReadiumShared', '~> 3.0.0'
-  s.dependency 'ReadiumInternal', '~> 3.0.0'
+  s.dependency 'ReadiumShared', '~> 3.1.0'
+  s.dependency 'ReadiumInternal', '~> 3.1.0'
   s.dependency 'CryptoSwift', '~> 1.8.0'
 
 end

TestApp/Integrations/Carthage/project+lcp.yml

@@ -25,6 +25,7 @@ targets:
     dependencies:
       - framework: Carthage/Build/CryptoSwift.xcframework
       - framework: Carthage/Build/DifferenceKit.xcframework
+      - framework: Carthage/Build/Minizip.xcframework
       - framework: Carthage/Build/R2LCPClient.xcframework
       - framework: Carthage/Build/ReadiumAdapterGCDWebServer.xcframework
       - framework: Carthage/Build/ReadiumAdapterLCPSQLite.xcframework

TestApp/Integrations/Carthage/project.yml

@@ -25,6 +25,7 @@ targets:
     dependencies:
       - framework: Carthage/Build/CryptoSwift.xcframework
       - framework: Carthage/Build/DifferenceKit.xcframework
+      - framework: Carthage/Build/Minizip.xcframework
       - framework: Carthage/Build/ReadiumAdapterGCDWebServer.xcframework
       - framework: Carthage/Build/ReadiumFuzi.xcframework
       - framework: Carthage/Build/ReadiumGCDWebServer.xcframework

TestApp/Sources/Info.plist

@@ -252,9 +252,9 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.0.0</string>
+	<string>3.1.0</string>
 	<key>CFBundleVersion</key>
-	<string>3.0.0</string>
+	<string>3.1.0</string>
 	<key>LSRequiresIPhoneOS</key>
 	<true/>
 	<key>LSSupportsOpeningDocumentsInPlace</key>

docs/Migration Guide.md

@@ -2,7 +2,9 @@
 
 All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
 
-## Unreleased
+<!-- ## Unreleased -->
+
+## 3.1.0
 
 ### Bringing back Minizip
 
@@ -65,6 +67,8 @@ The default `ZIPArchiveOpener` is now using ZIPFoundation instead of Minizip, wi
 
 If you use Carthage, remove `Minizip.xcframework` from your dependencies and add `ReadiumZIPFoundation.xcframework` instead. No changes are needed when using Swift Package Manager or CocoaPods.
 
+:warning: When upgrading to 3.1.0 instead of 3.0.0, keep `Minizip.xcframework in your Carthage dependencies.
+
 ### Migration of HREFs and Locators (bookmarks, annotations, etc.)
 
  :warning: This requires a database migration in your application, if you were persisting `Locator` objects.