Merge branch 'develop'

Author: charphi

CHANGELOG.md

@@ -7,6 +7,22 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.0.24] - 2023-06-30
+
+### Added
+
+- Add lock factory to `File*` utilities
+- Add uncloseable stream utilities
+- Add resource utilities
+
+### Changed
+
+- Improve path to file conversion
+
+### Fixed
+
+- Fix unexpected closing of resources in FileFormatter and FileParser
+
 ## [0.0.23] - 2023-06-09
 
 ### Added
@@ -208,7 +224,8 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 - Initial release
 
-[Unreleased]: https://github.com/nbbrd/java-io-util/compare/v0.0.23...HEAD
+[Unreleased]: https://github.com/nbbrd/java-io-util/compare/v0.0.24...HEAD
+[0.0.24]: https://github.com/nbbrd/java-io-util/compare/v0.0.23...v0.0.24
 [0.0.23]: https://github.com/nbbrd/java-io-util/compare/v0.0.22...v0.0.23
 [0.0.22]: https://github.com/nbbrd/java-io-util/compare/v0.0.21...v0.0.22
 [0.0.21]: https://github.com/nbbrd/java-io-util/compare/v0.0.20...v0.0.21

java-io-base/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.nbbrd.java-io-util</groupId>
         <artifactId>java-io-parent</artifactId>
-        <version>0.0.23</version>
+        <version>0.0.24</version>
     </parent>
 
     <artifactId>java-io-base</artifactId>

java-io-base/src/main/java/internal/io/DecodingFileFormatter.java

@@ -10,6 +10,8 @@
 import java.io.InputStream;
 import java.nio.file.Path;
 
+import static nbbrd.io.Resource.uncloseableInputStream;
+
 @lombok.RequiredArgsConstructor
 public final class DecodingFileFormatter<T> implements FileParser<T> {
 
@@ -45,7 +47,7 @@ public final class DecodingFileFormatter<T> implements FileParser<T> {
 
     @Override
     public @NonNull T parseStream(@NonNull InputStream resource) throws IOException {
-        try (InputStream decoding = decoder.applyWithIO(resource)) {
+        try (InputStream decoding = decoder.applyWithIO(uncloseableInputStream(resource))) {
             return parser.parseStream(decoding);
         }
     }

java-io-base/src/main/java/internal/io/EncodingFileFormatter.java

@@ -10,6 +10,8 @@
 import java.io.OutputStream;
 import java.nio.file.Path;
 
+import static nbbrd.io.Resource.uncloseableOutputStream;
+
 @lombok.RequiredArgsConstructor
 public final class EncodingFileFormatter<T> implements FileFormatter<T> {
 
@@ -39,7 +41,7 @@ public void formatStream(@NonNull T value, @NonNull IOSupplier<? extends OutputS
 
     @Override
     public void formatStream(@NonNull T value, @NonNull OutputStream resource) throws IOException {
-        try (OutputStream encoding = encoder.applyWithIO(resource)) {
+        try (OutputStream encoding = encoder.applyWithIO(uncloseableOutputStream(resource))) {
             formatter.formatStream(value, encoding);
         }
     }

java-io-base/src/main/java/internal/io/FunctionalFileFormatter.java

@@ -7,14 +7,15 @@
 import java.io.IOException;
 import java.io.OutputStream;
 
+import static nbbrd.io.Resource.uncloseableOutputStream;
+
 @lombok.RequiredArgsConstructor
 public final class FunctionalFileFormatter<T> implements FileFormatter<T> {
 
-    @NonNull
-    private final IOBiConsumer<? super T, ? super OutputStream> function;
+    private final @NonNull IOBiConsumer<? super T, ? super OutputStream> function;
 
     @Override
     public void formatStream(@NonNull T value, @NonNull OutputStream resource) throws IOException {
-        function.acceptWithIO(value, resource);
+        function.acceptWithIO(value, uncloseableOutputStream(resource));
     }
 }

java-io-base/src/main/java/internal/io/FunctionalFileParser.java

@@ -8,14 +8,15 @@
 import java.io.InputStream;
 import java.util.Objects;
 
+import static nbbrd.io.Resource.uncloseableInputStream;
+
 @lombok.RequiredArgsConstructor
 public final class FunctionalFileParser<T> implements FileParser<T> {
 
-    @NonNull
-    private final IOFunction<? super InputStream, ? extends T> function;
+    private final @NonNull IOFunction<? super InputStream, ? extends T> function;
 
     @Override
     public @NonNull T parseStream(@NonNull InputStream resource) throws IOException {
-        return Objects.requireNonNull(function.applyWithIO(resource), "result");
+        return Objects.requireNonNull(function.applyWithIO(uncloseableInputStream(resource)), "result");
     }
 }

java-io-base/src/main/java/internal/io/LockingFileFormatter.java

@@ -0,0 +1,51 @@
+package internal.io;
+
+import lombok.NonNull;
+import nbbrd.io.FileFormatter;
+import nbbrd.io.function.IOSupplier;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.channels.Channels;
+import java.nio.channels.FileChannel;
+import java.nio.channels.FileLock;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+
+import static internal.io.text.FileSystemExceptions.checkTarget;
+
+@lombok.RequiredArgsConstructor
+public final class LockingFileFormatter<T> implements FileFormatter<T> {
+
+    private final @NonNull FileFormatter<T> delegate;
+
+    @Override
+    public void formatFile(@NonNull T value, @NonNull File target) throws IOException {
+        try (FileOutputStream stream = new FileOutputStream(checkTarget(target))) {
+            try (FileLock ignore = stream.getChannel().lock()) {
+                delegate.formatStream(value, stream);
+            }
+        }
+    }
+
+    @Override
+    public void formatPath(@NonNull T value, @NonNull Path target) throws IOException {
+        try (FileChannel channel = FileChannel.open(checkTarget(target), StandardOpenOption.WRITE, StandardOpenOption.CREATE)) {
+            try (FileLock ignore = channel.lock()) {
+                delegate.formatStream(value, Channels.newOutputStream(channel));
+            }
+        }
+    }
+
+    @Override
+    public void formatStream(@NonNull T value, @NonNull IOSupplier<? extends OutputStream> target) throws IOException {
+        delegate.formatStream(value, target);
+    }
+
+    @Override
+    public void formatStream(@NonNull T value, @NonNull OutputStream resource) throws IOException {
+        delegate.formatStream(value, resource);
+    }
+}

java-io-base/src/main/java/internal/io/LockingFileParser.java

@@ -0,0 +1,56 @@
+package internal.io;
+
+import lombok.NonNull;
+import nbbrd.io.FileParser;
+import nbbrd.io.function.IOSupplier;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.channels.Channels;
+import java.nio.channels.FileChannel;
+import java.nio.channels.FileLock;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+
+import static internal.io.text.FileSystemExceptions.checkSource;
+
+@lombok.RequiredArgsConstructor
+public final class LockingFileParser<T> implements FileParser<T> {
+
+    private final @NonNull FileParser<T> delegate;
+
+    @Override
+    public @NonNull T parseFile(@NonNull File source) throws IOException {
+        try (FileInputStream stream = new FileInputStream(checkSource(source))) {
+            try (FileLock ignore = stream.getChannel().lock(0, Long.MAX_VALUE, true)) {
+                return delegate.parseStream(stream);
+            }
+        }
+    }
+
+    @Override
+    public @NonNull T parsePath(@NonNull Path source) throws IOException {
+        try (FileChannel channel = FileChannel.open(checkSource(source), StandardOpenOption.READ)) {
+            try (FileLock ignore = channel.lock(0, Long.MAX_VALUE, true)) {
+                return delegate.parseStream(Channels.newInputStream(channel));
+            }
+        }
+    }
+
+    @Override
+    public @NonNull T parseResource(@NonNull Class<?> type, @NonNull String name) throws IOException {
+        return delegate.parseResource(type, name);
+    }
+
+    @Override
+    public @NonNull T parseStream(@NonNull IOSupplier<? extends InputStream> source) throws IOException {
+        return delegate.parseStream(source);
+    }
+
+    @Override
+    public @NonNull T parseStream(@NonNull InputStream resource) throws IOException {
+        return delegate.parseStream(resource);
+    }
+}

java-io-base/src/main/java/internal/io/UncloseableInputStream.java

@@ -0,0 +1,15 @@
+package internal.io;
+
+import lombok.NonNull;
+import nbbrd.design.MightBePromoted;
+
+import java.io.Closeable;
+import java.io.InputStream;
+
+@MightBePromoted
+@lombok.AllArgsConstructor
+public final class UncloseableInputStream extends InputStream {
+
+    @lombok.experimental.Delegate(excludes = Closeable.class)
+    private final @NonNull InputStream delegate;
+}

java-io-base/src/main/java/internal/io/UncloseableOutputStream.java

@@ -0,0 +1,22 @@
+package internal.io;
+
+import lombok.NonNull;
+import nbbrd.design.MightBePromoted;
+
+import java.io.Closeable;
+import java.io.IOException;
+import java.io.OutputStream;
+
+@MightBePromoted
+@lombok.AllArgsConstructor
+public final class UncloseableOutputStream extends OutputStream {
+
+    @lombok.experimental.Delegate(excludes = Closeable.class)
+    private final @NonNull OutputStream delegate;
+
+    @Override
+    public void close() throws IOException {
+        flush();
+        super.close();
+    }
+}