Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/helpermethod/zip-forge
A tiny, formatter-friendly Java DSL for creating ZIP files.
https://github.com/helpermethod/zip-forge
dsl groovy java java-8 kotlin zipfile
Last synced: 2 months ago
JSON representation
A tiny, formatter-friendly Java DSL for creating ZIP files.
- Host: GitHub
- URL: https://github.com/helpermethod/zip-forge
- Owner: helpermethod
- License: apache-2.0
- Created: 2023-04-03T08:06:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T09:06:44.000Z (9 months ago)
- Last Synced: 2024-04-13T23:52:20.840Z (9 months ago)
- Topics: dsl, groovy, java, java-8, kotlin, zipfile
- Language: Java
- Homepage:
- Size: 117 KB
- Stars: 34
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌋 ZIP Forge
[](https://github.com/helpermethod/zip-forge/actions/workflows/ci.yml)
[](https://sonarcloud.io/summary/new_code?id=io.github.helpermethod%3Azip-forge)
[](https://sonarcloud.io/summary/new_code?id=io.github.helpermethod%3Azip-forge)
[](https://sonarcloud.io/summary/new_code?id=io.github.helpermethod%3Azip-forge)
[](https://sonarcloud.io/summary/new_code?id=io.github.helpermethod%3Azip-forge)
A tiny, formatter-friendly Java DSL for creating ZIP files.
# :sparkles: Features
## :pinching_hand: Tiny
The ZIP Forge API consists of only 3 methods.
## :clipboard: Formatter-friendly
Applying a code formatter like [palantir-java-format](https://github.com/palantir/palantir-java-format) won't mess up ZIP Forge's indentation.
## :package: No external dependencies
ZIP Forge is based on Java's [ZIP File System Provider](https://docs.oracle.com/javase/8/docs/technotes/guides/io/fsp/zipfilesystemprovider.html) and requires no external dependencies.
## :jigsaw: Modular
ZIP Forge is published as a Java 9 module but compatible with Java 8.
# :hammer_and_wrench: Installation
## Maven
```xml
io.github.helpermethod
zip-forge
1.0.1
```
## Gradle
```groovy
implementation 'io.github.helpermethod:zip-forge:1.0.1'
```
## Gradle (Kotlin)
```kotlin
implementation("io.github.helpermethod:zip-forge:1.0.1")
```
# :mag: Usage
## Java
The following code snippet calls `createZipFile` to create the ZIP file at the given location.
It uses the `file` and `directory` methods to create files and directories within the context of the ZIP file.
> [!WARNING]
> `file` and `directory` should never be used outside of `createZipFile`'s or `directory`'s context.
```java
import java.nio.charset.StandardCharsets;
import static io.github.helpermethod.zipforge.ZipForge.createZipFile;
import static io.github.helpermethod.zipforge.ZipForge.file;
import static io.github.helpermethod.zipforge.ZipForge.directory;
import static java.nio.charset.StandardCharsets.UTF_8;
class ZipForgeDemo {
public static void main(String[] args) throws IOException {
// creates a ZIP file named demo.zip in the /home/helpermethod directory
createZipFile(Paths.get("/home/helpermethod/demo.zip"), () -> {
// the file content can be specified as a String...
file("a.txt", "a");
directory("d", () -> {
// ... or a byte[]...
file("b.txt", "b".getBytes(UTF_8));
// ... or a Path
file("c.bin", Paths.get("c.bin"));
// directories can be nested
directory("e", () -> {
file("f.txt", "f");
});
});
});
}
}
```
The above code results in a ZIP file with the following structure.
```
Archive: demo.zip
Length Date Time Name
--------- ---------- ----- ----
0 07-11-2023 15:39 d/
0 07-11-2023 15:39 d/e/
1 07-11-2023 15:39 a.txt
1 07-11-2023 15:39 d/b.txt
1 07-11-2023 15:39 d/c.bin
1 07-11-2023 15:39 d/e/f.txt
--------- -------
4 6 files
```
## Kotlin
The same example written in Kotlin. It uses the same API as the Java version.
```kotlin
import io.github.helpermethod.zipforge.ZipForge.createZipFile
import io.github.helpermethod.zipforge.ZipForge.directory
import io.github.helpermethod.zipforge.ZipForge.file
import kotlin.io.path.Path
fun main() {
createZipFile(Path("/home/helpermethod/demo.zip")) {
file("a.txt", "a")
directory("d") {
file("b.txt", "b".toByteArray())
file("c.bin", Path("c.bin"))
directory("e") {
file("f.txt", "f")
}
}
}
}
```