79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
|
|
|
|
[](https://travis-ci.org/marmelroy/Zip) [](http://cocoapods.org/?q=Zip) [](https://github.com/Carthage/Carthage) [](https://swift.org/package-manager)
|
|
|
|
|
|
# Zip
|
|
A Swift framework for zipping and unzipping files. Simple and quick to use. Built on top of [minizip](https://github.com/nmoinvaz/minizip).
|
|
|
|
## Usage
|
|
|
|
Import Zip at the top of the Swift file.
|
|
|
|
```swift
|
|
import Zip
|
|
```
|
|
|
|
## Quick functions
|
|
|
|
The easiest way to use Zip is through quick functions. Both take local file paths as NSURLs, throw if an error is encountered and return an NSURL to the destination if successful.
|
|
```swift
|
|
do {
|
|
let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
|
|
let unzipDirectory = try Zip.quickUnzipFile(filePath) // Unzip
|
|
let zipFilePath = try Zip.quickZipFiles([filePath], fileName: "archive") // Zip
|
|
}
|
|
catch {
|
|
print("Something went wrong")
|
|
}
|
|
```
|
|
|
|
## Advanced Zip
|
|
|
|
For more advanced usage, Zip has functions that let you set custom destination paths, work with password protected zips and use a progress handling closure. These functions throw if there is an error but don't return.
|
|
```swift
|
|
do {
|
|
let filePath = Bundle.main.url(forResource: "file", withExtension: "zip")!
|
|
let documentsDirectory = FileManager.default.urls(for:.documentDirectory, in: .userDomainMask)[0]
|
|
try Zip.unzipFile(filePath, destination: documentsDirectory, overwrite: true, password: "password", progress: { (progress) -> () in
|
|
print(progress)
|
|
}) // Unzip
|
|
|
|
let zipFilePath = documentsFolder.appendingPathComponent("archive.zip")
|
|
try Zip.zipFiles([filePath], zipFilePath: zipFilePath, password: "password", progress: { (progress) -> () in
|
|
print(progress)
|
|
}) //Zip
|
|
|
|
}
|
|
catch {
|
|
print("Something went wrong")
|
|
}
|
|
```
|
|
|
|
## Custom File Extensions
|
|
|
|
Zip supports '.zip' and '.cbz' files out of the box. To support additional zip-derivative file extensions:
|
|
```swift
|
|
Zip.addCustomFileExtension("file-extension-here")
|
|
```
|
|
|
|
### [Preferred] Setting up with [Swift Package Manager](https://swift.org/package-manager)
|
|
To use Zip with Swift Package Manager, add it to your package's dependencies:
|
|
```swift
|
|
.package(url: "https://github.com/marmelroy/Zip.git", .upToNextMinor(from: "2.1"))
|
|
```
|
|
|
|
### Setting up with [CocoaPods](http://cocoapods.org/?q=Zip)
|
|
```ruby
|
|
source 'https://github.com/CocoaPods/Specs.git'
|
|
pod 'Zip', '~> 2.1'
|
|
```
|
|
|
|
### Setting up with [Carthage](https://github.com/Carthage/Carthage)
|
|
To integrate Zip into your Xcode project using Carthage, specify it in your `Cartfile`:
|
|
|
|
```ogdl
|
|
github "marmelroy/Zip" ~> 2.1
|
|
```
|
|
|