# Godzippa

**Repository Path**: volcengine/Godzippa

## Basic Information

- **Project Name**: Godzippa
- **Description**: No description available
- **Primary Language**: Objective-C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-19
- **Last Updated**: 2022-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Godzippa!

[![Build Status][build status badge]][build status]
[![License][license badge]][license]
[![Swift Version][swift version badge]][swift version]
![Cocoapods platforms][cocoapods platforms badge]
[![Cocoapods compatible][cocoapods badge]][cocoapods]
[![Carthage compatible][carthage badge]][carthage]

**gzip Compression / Decompression Category for NSData & NSFileManager**

> This library is no longer being maintained.
> As of iOS 13+ and macOS 10.15+,
> Foundation provides equivalent functionality through APIs like
> [`compressed(using:)`](https://developer.apple.com/documentation/foundation/nsdata/3174960-compressed)
> and [`decompressed(using:)`](https://developer.apple.com/documentation/foundation/nsdata/3174961-decompressed).

### CocoaPods

You can install `Godzippa` via CocoaPods,
by adding the following line to your `Podfile`:

```ruby
pod 'Godzippa', '~> 2.1.1'
```

Run the `pod install` command to download the library
and integrate it into your Xcode project.

### Carthage

To use `Godzippa` in your Xcode project using Carthage,
specify it in `Cartfile`:

```
github "mattt/Godzippa" ~> 2.1.1
```

Then run the `carthage update` command to build the framework,
and drag the built Godzippa.framework into your Xcode project.

### Manual Installation

Copy the `.h` and `.m` files in the `Sources` directory to your project.
In the "Link Binary With Libraries" Build Phase of your Target,
add `libz.dylib`.

## Usage

### Objective-C

#### NSData

```objective-c
NSData *originalData = [@"Look out! It's..." dataUsingEncoding:NSUTF8StringEncoding];
NSData *compressedData = [originalData dataByGZipCompressingWithError:nil];
NSData *decompressedData = [compressedData dataByGZipDecompressingDataWithError:nil];
NSLog(@"%@ %@", [NSString stringWithUTF8String:[decompressedData bytes]], @"Godzippa!");
```

#### NSFileManager

```objective-c
NSFileManager *fileManager = [NSFileManager defaultManager];
NSURL *file = [NSURL fileURLWithPath:@"/path/to/file.txt"];
NSError *error = nil;

[fileManager GZipCompressFile:file
        writingContentsToFile:[file URLByAppendingPathExtension:@"gz"]
                        error:&error];
```

### Swift

#### NSData

```swift
let originalString = "Look out! It's Godzippa!"
let originalData = originalString.data(using: .utf8)! as NSData
let compressedData = try! originalData.gzipCompressed() as NSData
let decompressedData = try! compressedData.gzipDecompressed()
let decompressedString = String(data: decompressedData, encoding: .utf8)
```

#### FileManager

```swift
let fileManager = FileManager.default
let textFile = URL(fileURLWithPath: "/path/to/file.txt")
let gzipFile = textFile.appendingPathExtension("gz")
try fileManager.gzipCompressFile(at: textFile, to: gzipFile)
```

## Contact

Mattt ([@mattt](http://twitter.com/mattt))

## License

Godzippa! is available under the MIT license.
See the LICENSE file for more info.

[build status]: https://travis-ci.org/mattt/Godzippa
[build status badge]: https://api.travis-ci.org/mattt/Godzippa.svg?branch=master
[license]: https://opensource.org/licenses/MIT
[license badge]: https://img.shields.io/cocoapods/l/Godzippa.svg
[swift version]: https://swift.org/download/
[swift version badge]: https://img.shields.io/badge/swift%20version-4.0+-orange.svg
[cocoapods platforms badge]: https://img.shields.io/cocoapods/p/Godzippa.svg
[cocoapods]: https://cocoapods.org/pods/Godzippa
[cocoapods badge]: https://img.shields.io/cocoapods/v/Godzippa.svg
[carthage]: https://github.com/Carthage/Carthage
[carthage badge]: https://img.shields.io/badge/Carthage-compatible-4BC51D.svg