Skip to content

Commit f4aa094

Browse files
mikosikmikosik
committed
Rename zip/unzip -> compressZip/compressUnzip 
1 parent 2b4a2bc commit f4aa094

File tree

6 files changed

+39
-40
lines changed

6 files changed

+39
-40
lines changed

‎doc/api.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
#### Smooth standard library
22

3-
| function | definition |
4-
|-----------------------------------|---------------------------------------------------------------------|
5-
| [and](api/and.md) | Returns `true` if both arguments are `true`. |
6-
| [concat](api/concat.md) | Concatenates an array of arrays. |
7-
| [elem](api/elem.md) | Returns array element. |
8-
| [error](api/error.md) | Fails build with error. |
9-
| [equal](api/equal.md) | Returns `true` when arguments are equal. |
10-
| [file](api/file.md) | Reads single file from project filesystem. |
11-
| [files](api/files.md) | Reads files from project filesystem. |
12-
| [File](api/File.md) | Creates File from path and content. |
13-
| [filter](api/filter.md) | Filters array using predicate. |
14-
| [filterFiles](api/filterFiles.md) | Filters files according to glob pattern. |
15-
| [fold](api/fold.md) | Applies a function to each element of an array with an accumulator. |
16-
| [id](api/id.md) | Identity function - it returns its only argument. |
17-
| [if](api/if.md) | Returns one of two values depending on bool condition. |
18-
| [jar](api/jar.md) | Jars (compresses) files. |
19-
| [jarFile](api/jarFile.md) | Creates jar file with (compressed) files. |
20-
| [javac](api/javac.md) | Compiles java files. |
21-
| [junit](api/junit.md) | Runs junit tests. |
22-
| [map](api/map.md) | Applies given function to each element of an array. |
23-
| [not](api/not.md) | Returns negation of its argument. |
24-
| [or](api/or.md) | Returns `true` if any argument is `true`. |
25-
| [size](api/size.md) | Returns size of an array. |
26-
| [toBlob](api/toBlob.md) | Converts String to Blob using UTF-8 encoding. |
27-
| [toString](api/toString.md) | Converts Blob to String using UTF-8 encoding. |
28-
| [unjar](api/unjar.md) | Unjars (uncompresses) files from given jar file. |
29-
| [unzip](api/unzip.md) | Unzips files from zip file. |
30-
| [zip](api/zip.md) | Zips (compresses) files. |
3+
| function | definition |
4+
|---------------------------------------|---------------------------------------------------------------------|
5+
| [and](api/and.md) | Returns `true` if both arguments are `true`. |
6+
| [compressUnzip](api/compressUnzip.md) | Unzips files from zip file. |
7+
| [compressZip](api/compressZip.md) | Zips (compresses) files. |
8+
| [concat](api/concat.md) | Concatenates an array of arrays. |
9+
| [elem](api/elem.md) | Returns array element. |
10+
| [error](api/error.md) | Fails build with error. |
11+
| [equal](api/equal.md) | Returns `true` when arguments are equal. |
12+
| [file](api/file.md) | Reads single file from project filesystem. |
13+
| [files](api/files.md) | Reads files from project filesystem. |
14+
| [File](api/File.md) | Creates File from path and content. |
15+
| [filter](api/filter.md) | Filters array using predicate. |
16+
| [filterFiles](api/filterFiles.md) | Filters files according to glob pattern. |
17+
| [fold](api/fold.md) | Applies a function to each element of an array with an accumulator. |
18+
| [id](api/id.md) | Identity function - it returns its only argument. |
19+
| [if](api/if.md) | Returns one of two values depending on bool condition. |
20+
| [jar](api/jar.md) | Jars (compresses) files. |
21+
| [jarFile](api/jarFile.md) | Creates jar file with (compressed) files. |
22+
| [javac](api/javac.md) | Compiles java files. |
23+
| [junit](api/junit.md) | Runs junit tests. |
24+
| [map](api/map.md) | Applies given function to each element of an array. |
25+
| [not](api/not.md) | Returns negation of its argument. |
26+
| [or](api/or.md) | Returns `true` if any argument is `true`. |
27+
| [size](api/size.md) | Returns size of an array. |
28+
| [toBlob](api/toBlob.md) | Converts String to Blob using UTF-8 encoding. |
29+
| [toString](api/toString.md) | Converts Blob to String using UTF-8 encoding. |
30+
| [unjar](api/unjar.md) | Unjars (uncompresses) files from given jar file. |
3131

3232
| value | definition |
3333
|-------|----------------------------|

doc/api/unzip.md renamed to doc/api/compressUnzip.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## [File] unzip<>(Blob blob)
1+
## [File] compressUnzip<>(Blob blob)
22

33
Unzips files from given zip file.
44

@@ -12,6 +12,5 @@ Returns __[File]__ - arrays of File uncompressed from given zip.
1212
Uncompresses all files from "zips/myZip.zip" file.
1313

1414
```
15-
[File] files = file("zips/myZip.zip").content > unzip();
15+
[File] files = file("zips/myZip.zip").content > compressUnzip();
1616
```
17-

doc/api/zip.md renamed to doc/api/compressZip.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Blob zip<>([File] files)
1+
## Blob compressZip<>([File] files)
22

33
Zips an array of files.
44

@@ -12,5 +12,5 @@ Returns __Blob__ containing compressed files.
1212

1313
Zips all files from "src" directory.
1414
```
15-
Blob zippedFiles = files("src") > zip();
15+
Blob zippedFiles = files("src") > compressZip();
1616
```

‎doc/tutorial.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ It is used by many functions from the standard library, the most popular are:
189189
- [files](api/files.md) - reads all files from given directory inside project
190190
- [filterFiles](api/filterFiles.md) - filters array of files according to glob pattern
191191
- [jar](api/jar.md) - jars array of files
192-
- [zip](api/zip.md) - zips array of files
192+
- [compressZip](api/zip.md) - zips array of files
193193

194194

195195
#### Functions

‎src/standard-library/src/main/smooth/std_lib.smooth‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ Blob jar([File] files, Blob manifest = 0x);
5959
[File] javac_([File] srcs, [[File]] libs = [], [String] options = []);
6060

6161
String junit(File tests, [File] deps = [], String include = "**Test.class") =
62-
junit_(unzip(tests.content), jarsToFiles(deps), include);
62+
junit_(compressUnzip(tests.content), jarsToFiles(deps), include);
6363

6464
@Native("org.smoothbuild.stdlib.java.junit.JunitFunc")
6565
String junit_([File] tests, [[File]] deps, String include);
6666

6767
[[File]] jarsToFiles([File] libs) =
68-
map(libs, (File lib) -> filterFiles(unzip(lib.content), "**.class"));
68+
map(libs, (File lib) -> filterFiles(compressUnzip(lib.content), "**.class"));
6969

7070
@Native("org.smoothbuild.stdlib.string.ToBlobFunc")
7171
Blob toBlob(String string);
@@ -77,10 +77,10 @@ String toString(Blob blob);
7777
[File] unjar(Blob jar);
7878

7979
@Native("org.smoothbuild.stdlib.compress.UnzipFunc")
80-
[File] unzip(Blob blob);
80+
[File] compressUnzip(Blob blob);
8181

8282
@Native("org.smoothbuild.stdlib.compress.ZipFunc")
83-
Blob zip([File] files);
83+
Blob compressZip([File] files);
8484

8585
A id<A>(A a) = a;
8686

‎src/standard-library/src/test/java/org/smoothbuild/stdlib/compress/ZipTest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ public class ZipTest extends StandardLibraryTestContext {
1212
void zip_unzip() throws Exception {
1313
var userModule =
1414
"""
15-
result = [file("dir/file1.txt"), file("file2.txt")] > zip() > unzip();
15+
result = [file("dir/file1.txt"), file("file2.txt")] > compressZip() > compressUnzip();
1616
""";
1717
createUserModule(userModule);
1818
createProjectFile("dir/file1.txt", "abc");
@@ -29,7 +29,7 @@ void corrupted_archive_causes_error() throws IOException {
2929
var userModule =
3030
"""
3131
randomJunk = 0x123456;
32-
result = unzip(randomJunk);
32+
result = compressUnzip(randomJunk);
3333
""";
3434
createUserModule(userModule);
3535

0 commit comments

Comments
 (0)