Merge pull request #45 from OnixByte/develop

v1.7.0

Author: Zihlu Wang

LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2023 CodeCrafters (CN)
+   Copyright 2023-2024 OnixByte (HK)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

devkit-core/src/main/java/com/onixbyte/devkit/core/exceptions/NotImplementedException.java

@@ -18,14 +18,12 @@
 package com.onixbyte.devkit.core.exceptions;
 
 /**
- * The {@code NotImplementedException} class is a custom runtime exception
- * that represents a situation where a particular method or functionality is
- * not implemented or is currently unavailable in the codebase.
+ * The {@code NotImplementedException} class is a custom runtime exception that represents a situation where a
+ * particular method or functionality is not implemented or is currently unavailable in the codebase.
  * <p>
- * This exception is typically thrown when developers need to indicate that a
- * specific part of the code is incomplete or requires further implementation.
- * It serves as a placeholder to highlight unfinished sections of the
- * application during development and testing phases.
+ * This exception is typically thrown when developers need to indicate that a specific part of the code is incomplete
+ * or requires further implementation. It serves as a placeholder to highlight unfinished sections of the application
+ * during development and testing phases.
  * <p>
  * Usage Example:
  * <pre>
@@ -54,15 +52,13 @@
 public class NotImplementedException extends RuntimeException {
 
     /**
-     * Creates a new {@code NotImplementedException} with no specific error
-     * message.
+     * Creates a new {@code NotImplementedException} with no specific error message.
      */
     public NotImplementedException() {
     }
 
     /**
-     * Creates a new {@code NotImplementedException} with the provided error
-     * message.
+     * Creates a new {@code NotImplementedException} with the provided error message.
      *
      * @param message the error message associated with this exception
      */
@@ -71,8 +67,7 @@ public NotImplementedException(String message) {
     }
 
     /**
-     * Creates a new {@code NotImplementedException} with the specified error
-     * message and a cause for this exception.
+     * Creates a new {@code NotImplementedException} with the specified error message and a cause for this exception.
      *
      * @param message the error message associated with this exception
      * @param cause   the cause of this exception
@@ -91,8 +86,8 @@ public NotImplementedException(Throwable cause) {
     }
 
     /**
-     * Creates a new {@code NotImplementedException} with the specified error
-     * message, cause, suppression flag, and stack trace writable flag.
+     * Creates a new {@code NotImplementedException} with the specified error message, cause, suppression flag, and
+     * stack trace writable flag.
      *
      * @param message            the error message associated with this
      *                           exception

devkit-core/src/main/resources/logback.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright (C) 2023 CodeCraftersCN.
+  ~ Copyright (C) 2023-2024 OnixByte.
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.

devkit-core/src/test/java/com/onixbyte/devkit/core/exceptions/NotImplementationExceptionTest.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2024-2024 OnixByte.
+ *
+ * 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 com.onixbyte.devkit.core.exceptions;
+
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.Test;
+
+@Slf4j
+public class NotImplementationExceptionTest {
+
+    @Test
+    public void testExceptionWithEmptyConstructor() {
+        try {
+            throw new NotImplementedException();
+        } catch (NotImplementedException e) {
+            log.error("NotImplementedException: ", e);
+        }
+    }
+
+    @Test
+    public void testExceptionWithStringConstructor() {
+        try {
+            throw new NotImplementedException("This function is not implemented yet, please contact developer for further information.");
+        } catch (NotImplementedException e) {
+            log.error("NotImplementedException: ", e);
+        }
+    }
+
+}

devkit-utils/src/main/java/com/onixbyte/devkit/utils/AesUtil.java

@@ -119,7 +119,7 @@ public static String decrypt(String data, String secret) {
     }
 
     /**
-     * Generates 16 characters-long random secret.
+     * Generates 16-character random secret.
      *
      * @return the generated secure secret
      */

devkit-utils/src/main/java/com/onixbyte/devkit/utils/MapUtil.java

@@ -31,7 +31,7 @@
  * Please see documentation for more information.
  *
  * @author zihluwang
- * @version 1.4.2
+ * @version 1.7.0
  * @since 1.0.0
  */
 @Slf4j
@@ -40,81 +40,31 @@ public final class MapUtil {
     /**
      * Converts an object to a map by mapping the field names to their corresponding values.
      *
-     * @param <T>      the type of the object
-     * @param entity   the object to be converted to a map
-     * @param adapters adapts the entity for mapping to a map
+     * @param <T>     the type of the object
+     * @param entity  the object to be converted to a map
+     * @param adapter adapts the entity for mapping to a map
      * @return a map representing the fields and their values of the object
      */
-    public static <T> Map<String, Object> objectToMap(T entity,
-                                                      Map<String, ObjectMapAdapter<T, ?>> adapters) {
-        var resultMap = new HashMap<String, Object>();
-        adapters.forEach((fieldName, adapter) -> resultMap.put(fieldName, adapter.fetch(entity)));
-        return resultMap;
+    public static <T> Map<String, Object> objectToMap(T entity, ObjectMapAdapter<T> adapter) {
+        return adapter.toMap(entity);
     }
 
     /**
      * Converts a map to an object of the specified type by setting the field values using the
      * map entries.
      *
      * @param objectMap the map representing the fields and their values
-     * @param entity    an empty entity of the target class
-     * @param adapters  the adapters to execute the setter for the entity
+     * @param adapter   the adapter to execute the setter for the entity
      * @param <T>       the type of the object to be created
      * @return an object of the specified type with the field values set from the map
      */
-    public static <T> T mapToObject(Map<String, Object> objectMap,
-                                    T entity,
-                                    Map<String, ObjectMapAdapter<T, ?>> adapters) {
-        adapters.forEach((fieldName, adapter) -> Optional.ofNullable(objectMap)
-                .map((data) -> data.get(fieldName))
-                .ifPresent((fieldValue) -> adapter.setValue(entity, fieldValue)));
-        return entity;
+    public static <T> T mapToObject(Map<String, Object> objectMap, ObjectMapAdapter<T> adapter) {
+        return adapter.toObject(objectMap);
     }
 
     /**
-     * Retrieves the value of a field from an object using reflection.
-     *
-     * @param <E>     the type of the entity
-     * @param <T>     the type of the field value
-     * @param entity  the object from which to retrieve the field value
-     * @param adapter the adapter to execute the getter
-     * @return the value of the field in the object, or null if the field does not exist or cannot
-     * be accessed
+     * Private constructor prevent class being instantiated.
      */
-    public static <E, T> T getFieldValue(E entity, ObjectMapAdapter<E, T> adapter) {
-        return adapter.fetch(entity);
-    }
-
-    /**
-     * Sets the value of a field in an object using reflection.
-     *
-     * @param <E>        the type of the entity
-     * @param <T>        the type of the field value
-     * @param entity     the object in which to set the field value
-     * @param adapter    the adapter to execute the setter
-     * @param fieldValue the value to be set
-     */
-    public static <E, T> void setFieldValue(E entity,
-                                            ObjectMapAdapter<E, T> adapter,
-                                            Object fieldValue) {
-        adapter.setValue(entity, fieldValue);
-    }
-
-    /**
-     * Casts the specified value to the required type with Optional.
-     *
-     * @param value        the value to be cast
-     * @param requiredType the type to which the value should be cast
-     * @param <T>          the type to which the value should be cast
-     * @return the cast value, or {@code null} if the value is not an instance of the requiredType
-     */
-    public static <T> T cast(Object value, Class<T> requiredType) {
-        return Optional.ofNullable(requiredType)
-                .filter((clazz) -> clazz.isInstance(value))
-                .map((clazz) -> clazz.cast(value))
-                .orElse(null);
-    }
-
     private MapUtil() {
     }
 }

devkit-utils/src/main/java/com/onixbyte/devkit/utils/ObjectMapAdapter.java

@@ -17,53 +17,32 @@
 
 package com.onixbyte.devkit.utils;
 
-import java.util.function.BiConsumer;
-import java.util.function.Function;
+import java.util.Map;
 
 /**
  * Adapts an Object to a Map, making conversion between Map and Object much more safe.
  *
- * @param <E> entity type
  * @param <T> field type
  * @author zihluwang
- * @version 1.4.2
+ * @version 1.7.0
  * @since 1.4.2
  */
-public class ObjectMapAdapter<E, T> {
-
-    private final Function<E, T> getter;
-
-    private final BiConsumer<E, Object> setter;
-
-    /**
-     * Create an adapter.
-     *
-     * @param getter the getter of the field
-     * @param setter the setter of the field
-     */
-    public ObjectMapAdapter(Function<E, T> getter, BiConsumer<E, Object> setter) {
-        this.getter = getter;
-        this.setter = setter;
-    }
+public interface ObjectMapAdapter<T> {
 
     /**
-     * Get data from the entity.
+     * Convert an object to a map.
      *
-     * @param entity the source of the data
-     * @return the data
+     * @param element the element that will be converted to Map
+     * @return a Map that is converted from the element
      */
-    public T fetch(E entity) {
-        return getter.apply(entity);
-    }
+    Map<String, Object> toMap(T element);
 
     /**
-     * Set value to the entity.
+     * Convert a Map to an object.
      *
-     * @param entity the target of the data
-     * @param value  the value
+     * @param map the map that will be converted to Object
+     * @return the object that is converted from the Map
      */
-    public void setValue(E entity, Object value) {
-        setter.accept(entity, value);
-    }
+    T toObject(Map<String, Object> map);
 
 }

devkit-utils/src/main/resources/logback.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~ Copyright (C) 2023 CodeCraftersCN.
+  ~ Copyright (C) 2023-2024 OnixByte.
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.

devkit-utils/src/test/java/com/onixbyte/devkit/utils/TestAesUtil.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2024-2024 OnixByte.
+ *
+ * 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 com.onixbyte.devkit.utils;
+
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+@Slf4j
+public class TestAesUtil {
+
+    @Test
+    public void testGenerateRandomSecret() {
+        log.info("Secret is {}", AesUtil.generateRandomSecret());
+    }
+
+    @Test
+    public void testEncrypt() {
+        var secret = "43f72073956d4c81";
+
+        Assertions.assertEquals("IbbYZu8GtMruBURfMBVy/w==", AesUtil.encrypt("Hello World", secret));
+        Assertions.assertEquals("1eVA7oQpTIhI7jc+6cdkmg==", AesUtil.encrypt("OnixByte", secret));
+        Assertions.assertEquals("fk6oNRJK8a+Pz7zVwtlD0UQocq5c3GkRuem0Z6jdAN8=", AesUtil.encrypt("Welcome to use JDevKit!", secret));
+        Assertions.assertEquals("dqzGjawNcQdBpXJWk/08UQ==", AesUtil.encrypt("127.0.0.1", secret));
+        Assertions.assertEquals("uwQQI60yAGL91q9jCDgoeA==", AesUtil.encrypt("root", secret));
+    }
+
+    @Test
+    public void testDecrypt() {
+        var secret = "43f72073956d4c81";
+
+        Assertions.assertEquals("Hello World", AesUtil.decrypt("IbbYZu8GtMruBURfMBVy/w==", secret));
+        Assertions.assertEquals("OnixByte", AesUtil.decrypt("1eVA7oQpTIhI7jc+6cdkmg==", secret));
+        Assertions.assertEquals("Welcome to use JDevKit!", AesUtil.decrypt("fk6oNRJK8a+Pz7zVwtlD0UQocq5c3GkRuem0Z6jdAN8=", secret));
+        Assertions.assertEquals("127.0.0.1", AesUtil.decrypt("dqzGjawNcQdBpXJWk/08UQ==", secret));
+        Assertions.assertEquals("root", AesUtil.decrypt("uwQQI60yAGL91q9jCDgoeA==", secret));
+    }
+
+}