blob: 32782f94b4c84056291c8bc3a27ebbe817029e6e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# zip-crystal
Read and write zip archives natively from
[Crystal](http://crystal-lang.org/).
*Features*
* Read and write zip files
* Native Crystal, no dependencies other than zlib
* Stream writing (e.g. write zip to socket, pipe, or other arbitrary, non-seekable IO)
* ZIP64 support
* Store and DEFLATE compression
* UTF-8 filename and comment support (EFS)
*TODO*
* LZMA and BZip2 compression
* Encryption (Legacy and Strong Encryption)
* Split archives (e.g. multi-disk archives)
* Legacy Unicode support
## Installation
Add this to your application's `shard.yml`:
```yaml
dependencies:
zip-crystal:
github: pablotron/zip-crystal
```
## Usage
```crystal
require "zip-crystal/zip"
# write to "foo.zip"
Zip.write("foo.zip") do |zip|
# add "bar.txt" with contents "hello!"
zip.add("bar.txt", "hello!")
# add local file "/path/to/image.png" as "image.png"
zip.add_file("image.png", "/path/to/image.png")
end
# create memory io
mem_io = MemoryIO.new
# read from "foo.zip"
Zip.read("foo.zip") do |zip|
# extract "bar.txt" to mem_io
zip["bar.txt"].write(mem_io)
# extract "image.png" to "output-image.png"
zip["image.png"].write("output-image.png")
end
```
See the [API documentation](https://pablotron.github.com/zip-crystal/)
for additional information.
## Contributing
1. Fork it ( https://github.com/pablotron/zip-crystal/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [pablotron](https://github.com/pablotron) Paul Duncan - creator, maintainer
|
