Merge pull request #3 from appulse-projects/develop

Add resource utils class

Author: xxlabaza

CHANGELOG.md

@@ -12,6 +12,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Add more tests.
 - Add `JavaDoc`.
 
+## [1.3.0](https://github.com/appulse-projects/utils-java/releases/tag/1.3.0) - 2018-02-01
+
+Add resource utils class and made small refactorign.
+
+### Added
+
+- `ResourceUtils` which contains resource related functions.
+
+### Changed
+
+- Renamed `BytesUtil` to `BytesUtils`.
+- Moved methods for reading `InputStream` to `BytesUtils`.
+
 ## [1.2.1](https://github.com/appulse-projects/utils-java/releases/tag/1.2.1) - 2018-02-01
 
 Add socket utils class, with help functions related to sockets work.

README.md

@@ -34,9 +34,9 @@ $> mvn clean compile
 [INFO] ------------------------------------------------------------------------
 [INFO] BUILD SUCCESS
 [INFO] ------------------------------------------------------------------------
-[INFO] Total time: 13.033 s
-[INFO] Finished at: 2018-01-30T00:29:40+03:00
-[INFO] Final Memory: 43M/467M
+[INFO] Total time: 12.712 s
+[INFO] Finished at: 2018-02-01T15:23:30+03:00
+[INFO] Final Memory: 44M/585M
 [INFO] ------------------------------------------------------------------------
 ```
 
@@ -54,7 +54,7 @@ $> mvn clean test
 [INFO]
 [INFO] Results:
 [INFO]
-[INFO] Tests run: 19, Failures: 0, Errors: 0, Skipped: 0
+[INFO] Tests run: 22, Failures: 0, Errors: 0, Skipped: 0
 [INFO]
 ...
 ```

pom.xml

@@ -24,7 +24,7 @@ limitations under the License.
 
   <groupId>io.appulse</groupId>
   <artifactId>utils-java</artifactId>
-  <version>1.2.1</version>
+  <version>1.3.0</version>
   <packaging>jar</packaging>
 
   <properties>
@@ -62,7 +62,7 @@ limitations under the License.
     <url>https://github.com/appulse-projects/utils-java</url>
     <connection>scm:git:https://github.com/appulse-projects/utils-java.git</connection>
     <developerConnection>scm:git:https://github.com/appulse-projects/utils-java.git</developerConnection>
-    <tag>1.2.1</tag>
+    <tag>1.3.0</tag>
   </scm>
 
   <distributionManagement>
@@ -259,7 +259,7 @@ limitations under the License.
           <dependency>
             <groupId>com.puppycrawl.tools</groupId>
             <artifactId>checkstyle</artifactId>
-            <version>8.7</version>
+            <version>8.8</version>
           </dependency>
         </dependencies>
         <executions>

src/main/java/io/appulse/utils/BytesDelegatePuts.java

@@ -16,8 +16,8 @@
 
 package io.appulse.utils;
 
-import static io.appulse.utils.BytesUtil.align;
-import static io.appulse.utils.BytesUtil.asBytes;
+import static io.appulse.utils.BytesUtils.align;
+import static io.appulse.utils.BytesUtils.asBytes;
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static lombok.AccessLevel.PRIVATE;
 

…ain/java/io/appulse/utils/BytesUtil.java …in/java/io/appulse/utils/BytesUtils.javasrc/main/java/io/appulse/utils/BytesUtil.java renamed to src/main/java/io/appulse/utils/BytesUtils.java src/main/java/io/appulse/utils/BytesUtil.java renamed to src/main/java/io/appulse/utils/BytesUtils.java

@@ -18,18 +18,22 @@
 
 import static java.lang.Math.min;
 
+import java.io.ByteArrayOutputStream;
+import java.io.EOFException;
+import java.io.InputStream;
 import java.nio.ByteBuffer;
 import java.util.stream.Stream;
 
 import lombok.NonNull;
+import lombok.SneakyThrows;
 import lombok.val;
 
 /**
  *
  * @author Artem Labazin
- * @since 1.0.0
+ * @since 1.3.0
  */
-public final class BytesUtil {
+public final class BytesUtils {
 
   public static byte[] asBytes (char value) {
     return new byte[] {
@@ -148,6 +152,90 @@ public static byte[] align (@NonNull byte[] bytes, int length) {
     return result;
   }
 
-  private BytesUtil () {
+  /**
+   * Reads all bytes from stream till the end of the stream.
+   *
+   * @param stream steam
+   *
+   * @return readed bytes array
+   *
+   * @since 1.3.0
+   */
+  @SneakyThrows
+  public static byte[] read (@NonNull InputStream stream) {
+    val outputStream = new ByteArrayOutputStream(32);
+    val buffer = new byte[32];
+
+    while (true) {
+      val length = stream.read(buffer);
+      if (length == -1) {
+        break;
+      }
+      outputStream.write(buffer, 0, length);
+    }
+
+    return outputStream.toByteArray();
+  }
+
+  /**
+   * Reads fixed length bytes from the stream.
+   *
+   * @param stream steam
+   * @param length how many bytes to read from stream
+   *
+   * @return readed bytes array
+   *
+   * @since 1.3.0
+   */
+  @SneakyThrows
+  public static byte[] read (@NonNull InputStream stream, int length) {
+    if (length < 0) {
+      throw new IndexOutOfBoundsException();
+    }
+
+    val result = new byte[length];
+    int readed = 0;
+
+    while (readed < length) {
+      val count = stream.read(result, readed, length - readed);
+      if (count < -1) {
+        throw new EOFException();
+      }
+      readed += count;
+    }
+
+    return result;
+  }
+
+  /**
+   * Reads all bytes from stream till the end of the stream.
+   *
+   * @param stream steam
+   *
+   * @return readed bytes array wrapped in {@link Bytes} instance
+   *
+   * @since 1.3.0
+   */
+  public static Bytes readBytes (@NonNull InputStream stream) {
+    val result = read(stream);
+    return Bytes.wrap(result);
+  }
+
+  /**
+   * Reads fixed length bytes from the stream.
+   *
+   * @param stream steam
+   * @param length how many bytes to read from stream
+   *
+   * @return readed bytes array wrapped in {@link Bytes} instance
+   *
+   * @since 1.3.0
+   */
+  public static Bytes readBytes (@NonNull InputStream stream, int length) {
+    val result = read(stream, length);
+    return Bytes.wrap(result);
+  }
+
+  private BytesUtils () {
   }
 }

src/main/java/io/appulse/utils/ResourceUtils.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils;
+
+import static java.nio.charset.StandardCharsets.UTF_8;
+import static java.util.Optional.empty;
+import static java.util.Optional.of;
+
+import java.io.InputStream;
+import java.nio.charset.Charset;
+import java.util.Optional;
+
+import lombok.NonNull;
+import lombok.val;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.3.0
+ */
+public final class ResourceUtils {
+
+  public static Optional<String> getResource (@NonNull String name) {
+    return getResource(name, UTF_8);
+  }
+
+  public static Optional<String> getResource (@NonNull String name, @NonNull Charset charset) {
+    val classLoader = Thread.currentThread().getContextClassLoader();
+    InputStream inputStream = classLoader.getResourceAsStream(name);
+    if (inputStream == null) {
+      inputStream = ResourceUtils.class.getResourceAsStream(name);
+      if (inputStream == null) {
+        return empty();
+      }
+    }
+
+    val bytes = BytesUtils.read(inputStream);
+    val string = new String(bytes, charset);
+    return of(string);
+  }
+
+  private ResourceUtils () {
+  }
+}

src/main/java/io/appulse/utils/SocketUtils.java

@@ -20,17 +20,13 @@
 import static java.util.Optional.of;
 import static java.util.concurrent.TimeUnit.SECONDS;
 
-import java.io.ByteArrayOutputStream;
-import java.io.EOFException;
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.InetSocketAddress;
 import java.net.Socket;
 import java.util.Optional;
 
 import lombok.NonNull;
 import lombok.SneakyThrows;
-import lombok.val;
 
 /**
  *
@@ -61,70 +57,24 @@ public static boolean isPortAvailable (int port) {
     }
   }
 
-  @SneakyThrows
-  public static byte[] read (@NonNull InputStream stream) {
-    val outputStream = new ByteArrayOutputStream(32);
-    val buffer = new byte[32];
-
-    while (true) {
-      val length = stream.read(buffer);
-      if (length == -1) {
-        break;
-      }
-      outputStream.write(buffer, 0, length);
-    }
-
-    return outputStream.toByteArray();
-  }
-
   @SneakyThrows
   public static byte[] read (@NonNull Socket socket) {
-    return read(socket.getInputStream());
-  }
-
-  @SneakyThrows
-  public static byte[] read (@NonNull InputStream stream, int length) {
-    if (length < 0) {
-      throw new IndexOutOfBoundsException();
-    }
-
-    val result = new byte[length];
-    int readed = 0;
-
-    while (readed < length) {
-      val count = stream.read(result, readed, length - readed);
-      if (count < -1) {
-        throw new EOFException();
-      }
-      readed += count;
-    }
-
-    return result;
+    return BytesUtils.read(socket.getInputStream());
   }
 
   @SneakyThrows
   public static byte[] read (@NonNull Socket socket, int length) {
-    return read(socket.getInputStream(), length);
-  }
-
-  public static Bytes readBytes (@NonNull InputStream stream) {
-    val result = read(stream);
-    return Bytes.wrap(result);
+    return BytesUtils.read(socket.getInputStream(), length);
   }
 
   @SneakyThrows
   public static Bytes readBytes (@NonNull Socket socket) {
-    return readBytes(socket.getInputStream());
-  }
-
-  public static Bytes readBytes (@NonNull InputStream stream, int length) {
-    val result = read(stream, length);
-    return Bytes.wrap(result);
+    return BytesUtils.readBytes(socket.getInputStream());
   }
 
   @SneakyThrows
   public static Bytes readBytes (@NonNull Socket socket, int fixedLength) {
-    return readBytes(socket.getInputStream(), fixedLength);
+    return BytesUtils.readBytes(socket.getInputStream(), fixedLength);
   }
 
   private SocketUtils () {