Skip to content

Commit 8219531

Browse files
mickael-menumickael-menu
committed
3.1.0 (#552)
1 parent 464122d commit 8219531

17 files changed

+48
-38
lines changed

Diff for: ‎CHANGELOG.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ All notable changes to this project will be documented in this file. Take a look
44

55
**Warning:** Features marked as *alpha* may change or be removed in a future release without notice. Use with caution.
66

7-
## [Unreleased]
7+
<!-- ## [Unreleased] -->
8+
9+
## [3.1.0]
810

911
### Added
1012

1113
#### Shared
1214

1315
* 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.
14-
* A new `ReadiumAdapterMinizip` library ships the old `ArchiveOpener` using Minizip. Compared to the newer default `ZIPArchiveOpener`, it has the following differences:
15-
* It does not support HTTP streaming of ZIP packages.
16-
* It offers better performance for LCP-protected publications containing large resources that are `deflated` instead of `stored` in the archive, which is not recommended.
1716

1817
### Deprecated
1918

@@ -863,3 +862,4 @@ progression. Now if no reading progression is set, the `effectiveReadingProgress
863862
[3.0.0-alpha.3]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.2...3.0.0-alpha.3
864863
[3.0.0-beta.1]: https://github.com/readium/swift-toolkit/compare/3.0.0-alpha.3...3.0.0-beta.1
865864
[3.0.0-beta.2]: https://github.com/readium/swift-toolkit/compare/3.0.0-beta.1...3.0.0-beta.2
865+
[3.1.0]: https://github.com/readium/swift-toolkit/compare/3.0.0...3.1.0

Diff for: ‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ If you're stuck, find more information at [developer.apple.com](https://develope
4545
Add the following to your `Cartfile`:
4646

4747
```
48-
github "readium/swift-toolkit" ~> 3.0.0
48+
github "readium/swift-toolkit" ~> 3.1.0
4949
```
5050

5151
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
7575
source 'https://github.com/readium/podspecs'
7676
source 'https://cdn.cocoapods.org/'
7777
78-
pod 'ReadiumShared', '~> 3.0.0'
79-
pod 'ReadiumStreamer', '~> 3.0.0'
80-
pod 'ReadiumNavigator', '~> 3.0.0'
81-
pod 'ReadiumOPDS', '~> 3.0.0'
82-
pod 'ReadiumLCP', '~> 3.0.0'
78+
pod 'ReadiumShared', '~> 3.1.0'
79+
pod 'ReadiumStreamer', '~> 3.1.0'
80+
pod 'ReadiumNavigator', '~> 3.1.0'
81+
pod 'ReadiumOPDS', '~> 3.1.0'
82+
pod 'ReadiumLCP', '~> 3.1.0'
8383
```
8484

8585
Take a look at [CocoaPods's documentation](https://guides.cocoapods.org/using/using-cocoapods.html) for more information.

Diff for: ‎Support/Carthage/.xcodegen

+3-4
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,9 @@
230230
},
231231
"ReadiumShared" : {
232232
"dependencies" : [
233+
{
234+
"framework" : "..\/..\/Carthage\/Build\/Minizip.xcframework"
235+
},
233236
{
234237
"framework" : "..\/..\/Carthage\/Build\/ReadiumFuzi.xcframework"
235238
},
@@ -439,13 +442,9 @@
439442
../../Sources/Navigator/EPUB/Assets/Static/scripts
440443
../../Sources/Navigator/EPUB/Assets/Static/scripts/.gitignore
441444
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-one.js
442-
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-one.js.map
443445
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-two.js
444-
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed-wrapper-two.js.map
445446
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed.js
446-
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-fixed.js.map
447447
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-reflowable.js
448-
../../Sources/Navigator/EPUB/Assets/Static/scripts/readium-reflowable.js.map
449448
../../Sources/Navigator/EPUB/CSS
450449
../../Sources/Navigator/EPUB/CSS/CSSLayout.swift
451450
../../Sources/Navigator/EPUB/CSS/CSSProperties.swift

Diff for: ‎Support/Carthage/Readium.xcodeproj/project.pbxproj

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
/* Begin PBXBuildFile section */
1010
0025BE4D568B560277323B95 /* FileResource.swift in Sources */ = {isa = PBXBuildFile; fileRef = C05502AD8940D6616D6C386F /* FileResource.swift */; };
11+
01AC52ADE389D14F5274CEB2 /* Minizip.xcframework in Frameworks */ = {isa = PBXBuildFile; fileRef = CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */; };
1112
01AD628D6DE82E1C1C4C281D /* NavigationDocumentParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = 29AD63CD2A41586290547212 /* NavigationDocumentParser.swift */; };
1213
01E785BEA7F30AD1C8A5F3DE /* SearchService.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9B5B029CA09EE1F86A19612A /* SearchService.swift */; };
1314
01F29BAD25D4597903AF253F /* CompositeFormatSniffer.swift in Sources */ = {isa = PBXBuildFile; fileRef = 41E54A18E2983098A6A4DAE0 /* CompositeFormatSniffer.swift */; };
@@ -781,6 +782,7 @@
781782
CF31AEFB5FF0E7892C6D903E /* EPUBPreferences+Legacy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "EPUBPreferences+Legacy.swift"; sourceTree = "<group>"; };
782783
CFE1142A6C038A35C527CE84 /* URITemplate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = URITemplate.swift; sourceTree = "<group>"; };
783784
CFE34EA8AF2D815F7169CA45 /* Fuzi.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Fuzi.swift; sourceTree = "<group>"; };
785+
CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = Minizip.xcframework; path = ../../Carthage/Build/Minizip.xcframework; sourceTree = "<group>"; };
784786
D008F7BB187AE82CBB115D0F /* WebServerResourceResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WebServerResourceResponse.swift; sourceTree = "<group>"; };
785787
D0C2A38D366CE8560BCBAC8B /* PDFPositionsService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PDFPositionsService.swift; sourceTree = "<group>"; };
786788
D0E8D322A523DA324E3E2E59 /* MinizipContainer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MinizipContainer.swift; sourceTree = "<group>"; };
@@ -905,6 +907,7 @@
905907
isa = PBXFrameworksBuildPhase;
906908
buildActionMask = 2147483647;
907909
files = (
910+
01AC52ADE389D14F5274CEB2 /* Minizip.xcframework in Frameworks */,
908911
B02109488289D631DF959B8D /* ReadiumFuzi.xcframework in Frameworks */,
909912
CDE5EE79D3F0D00F9CAED8B8 /* ReadiumZIPFoundation.xcframework in Frameworks */,
910913
D9499DACC5329F3774CBEDAC /* SwiftSoup.xcframework in Frameworks */,
@@ -1777,6 +1780,7 @@
17771780
342D5C0FEE79A2ABEE24A43E /* CoreServices.framework */,
17781781
E37F94C388A86CB8A34812A5 /* CryptoSwift.xcframework */,
17791782
3F95F3F20D758BE0E7005EA3 /* DifferenceKit.xcframework */,
1783+
CFFEBDFE931745C07DACD4A3 /* Minizip.xcframework */,
17801784
2828D89EBB52CCA782ED1146 /* ReadiumFuzi.xcframework */,
17811785
6536C07F5A50F7F25FDBF69C /* ReadiumGCDWebServer.xcframework */,
17821786
69E17C4870C64264819EB227 /* ReadiumZIPFoundation.xcframework */,

Diff for: ‎Support/Carthage/project.yml

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ targets:
1313
sources:
1414
- path: ../../Sources/Shared
1515
dependencies:
16+
- framework: ../../Carthage/Build/Minizip.xcframework
1617
- framework: ../../Carthage/Build/ReadiumFuzi.xcframework
1718
- framework: ../../Carthage/Build/ReadiumZIPFoundation.xcframework
1819
- framework: ../../Carthage/Build/SwiftSoup.xcframework

Diff for: ‎Support/CocoaPods/ReadiumAdapterGCDWebServer.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumAdapterGCDWebServer"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Adapter to use GCDWebServer as an HTTP server in Readium"
77
s.homepage = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
1414
s.ios.deployment_target = "13.4"
1515
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
1616

17-
s.dependency 'ReadiumShared', '~> 3.0.0'
18-
s.dependency 'ReadiumInternal', '~> 3.0.0'
17+
s.dependency 'ReadiumShared', '~> 3.1.0'
18+
s.dependency 'ReadiumInternal', '~> 3.1.0'
1919
s.dependency 'ReadiumGCDWebServer', '~> 4.0.0'
2020

2121
end

Diff for: ‎Support/CocoaPods/ReadiumAdapterLCPSQLite.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumAdapterLCPSQLite"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Adapter to use SQLite.swift for the Readium LCP repositories"
77
s.homepage = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
1414
s.ios.deployment_target = "13.4"
1515
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
1616

17-
s.dependency 'ReadiumLCP', '~> 3.0.0'
18-
s.dependency 'ReadiumShared', '~> 3.0.0'
17+
s.dependency 'ReadiumLCP', '~> 3.1.0'
18+
s.dependency 'ReadiumShared', '~> 3.1.0'
1919
s.dependency 'SQLite.swift', '~> 0.15.0'
2020

2121
end

Diff for: ‎Support/CocoaPods/ReadiumInternal.podspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumInternal"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Private utilities used by the Readium modules"
77
s.homepage = "http://readium.github.io"

Diff for: ‎Support/CocoaPods/ReadiumLCP.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumLCP"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Readium LCP"
77
s.homepage = "http://readium.github.io"
@@ -20,8 +20,8 @@ Pod::Spec.new do |s|
2020
s.ios.deployment_target = "13.4"
2121
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2'}
2222

23-
s.dependency 'ReadiumShared' , '~> 3.0.0'
24-
s.dependency 'ReadiumInternal', '~> 3.0.0'
23+
s.dependency 'ReadiumShared' , '~> 3.1.0'
24+
s.dependency 'ReadiumInternal', '~> 3.1.0'
2525
s.dependency 'ReadiumZIPFoundation', '~> 2.0.0'
2626
s.dependency 'CryptoSwift', '~> 1.8.0'
2727
end

Diff for: ‎Support/CocoaPods/ReadiumNavigator.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumNavigator"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Readium Navigator"
77
s.homepage = "http://readium.github.io"
@@ -19,8 +19,8 @@ Pod::Spec.new do |s|
1919
s.platform = :ios
2020
s.ios.deployment_target = "13.4"
2121

22-
s.dependency 'ReadiumShared', '~> 3.0.0'
23-
s.dependency 'ReadiumInternal', '~> 3.0.0'
22+
s.dependency 'ReadiumShared', '~> 3.1.0'
23+
s.dependency 'ReadiumInternal', '~> 3.1.0'
2424
s.dependency 'DifferenceKit', '~> 1.0'
2525
s.dependency 'SwiftSoup', '~> 2.7.0'
2626

Diff for: ‎Support/CocoaPods/ReadiumOPDS.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumOPDS"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Readium OPDS"
77
s.homepage = "http://readium.github.io"
@@ -14,8 +14,8 @@ Pod::Spec.new do |s|
1414
s.ios.deployment_target = "13.4"
1515
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
1616

17-
s.dependency 'ReadiumShared', '~> 3.0.0'
18-
s.dependency 'ReadiumInternal', '~> 3.0.0'
17+
s.dependency 'ReadiumShared', '~> 3.1.0'
18+
s.dependency 'ReadiumInternal', '~> 3.1.0'
1919
s.dependency 'ReadiumFuzi', '~> 4.0.0'
2020

2121
end

Diff for: ‎Support/CocoaPods/ReadiumShared.podspec

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumShared"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Readium Shared"
77
s.homepage = "http://readium.github.io"
@@ -20,6 +20,6 @@ Pod::Spec.new do |s|
2020
s.dependency 'SwiftSoup', '~> 2.7.0'
2121
s.dependency 'ReadiumFuzi', '~> 4.0.0'
2222
s.dependency 'ReadiumZIPFoundation', '~> 2.0.0'
23-
s.dependency 'ReadiumInternal', '~> 3.0.0'
23+
s.dependency 'ReadiumInternal', '~> 3.1.0'
2424

2525
end

Diff for: ‎Support/CocoaPods/ReadiumStreamer.podspec

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Pod::Spec.new do |s|
22

33
s.name = "ReadiumStreamer"
4-
s.version = "3.0.0"
4+
s.version = "3.1.0"
55
s.license = "BSD 3-Clause License"
66
s.summary = "Readium Streamer"
77
s.homepage = "http://readium.github.io"
@@ -22,8 +22,8 @@ Pod::Spec.new do |s|
2222
s.xcconfig = { 'HEADER_SEARCH_PATHS' => '$(SDKROOT)/usr/include/libxml2' }
2323

2424
s.dependency 'ReadiumFuzi', '~> 4.0.0'
25-
s.dependency 'ReadiumShared', '~> 3.0.0'
26-
s.dependency 'ReadiumInternal', '~> 3.0.0'
25+
s.dependency 'ReadiumShared', '~> 3.1.0'
26+
s.dependency 'ReadiumInternal', '~> 3.1.0'
2727
s.dependency 'CryptoSwift', '~> 1.8.0'
2828

2929
end

Diff for: ‎TestApp/Integrations/Carthage/project+lcp.yml

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ targets:
2525
dependencies:
2626
- framework: Carthage/Build/CryptoSwift.xcframework
2727
- framework: Carthage/Build/DifferenceKit.xcframework
28+
- framework: Carthage/Build/Minizip.xcframework
2829
- framework: Carthage/Build/R2LCPClient.xcframework
2930
- framework: Carthage/Build/ReadiumAdapterGCDWebServer.xcframework
3031
- framework: Carthage/Build/ReadiumAdapterLCPSQLite.xcframework

Diff for: ‎TestApp/Integrations/Carthage/project.yml

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ targets:
2525
dependencies:
2626
- framework: Carthage/Build/CryptoSwift.xcframework
2727
- framework: Carthage/Build/DifferenceKit.xcframework
28+
- framework: Carthage/Build/Minizip.xcframework
2829
- framework: Carthage/Build/ReadiumAdapterGCDWebServer.xcframework
2930
- framework: Carthage/Build/ReadiumFuzi.xcframework
3031
- framework: Carthage/Build/ReadiumGCDWebServer.xcframework

Diff for: ‎TestApp/Sources/Info.plist

+2-2
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,9 @@
252252
<key>CFBundlePackageType</key>
253253
<string>APPL</string>
254254
<key>CFBundleShortVersionString</key>
255-
<string>3.0.0</string>
255+
<string>3.1.0</string>
256256
<key>CFBundleVersion</key>
257-
<string>3.0.0</string>
257+
<string>3.1.0</string>
258258
<key>LSRequiresIPhoneOS</key>
259259
<true/>
260260
<key>LSSupportsOpeningDocumentsInPlace</key>

Diff for: ‎docs/Migration Guide.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
All migration steps necessary in reading apps to upgrade to major versions of the Swift Readium toolkit will be documented in this file.
44

5-
## Unreleased
5+
<!-- ## Unreleased -->
6+
7+
## 3.1.0
68

79
### Bringing back Minizip
810

@@ -65,6 +67,8 @@ The default `ZIPArchiveOpener` is now using ZIPFoundation instead of Minizip, wi
6567

6668
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.
6769

70+
:warning: When upgrading to 3.1.0 instead of 3.0.0, keep `Minizip.xcframework in your Carthage dependencies.
71+
6872
### Migration of HREFs and Locators (bookmarks, annotations, etc.)
6973

7074
:warning: This requires a database migration in your application, if you were persisting `Locator` objects.

0 commit comments

Comments
 (0)