Merge pull request #13 from rhkiswani/feature/fix-tests

tests added and better coverage, readme updated

Author: OyaAIProd

README.md

@@ -6,16 +6,31 @@ JavaFF: Java Facade/Factories
 
 We all know the Golden Object Oriented rule **Don't talk to strangers**
 
-We all know that the API/frameworks defects or magic or limitations is not showing at the begging of the development.
+We all know that you will never find the API/frameworks defects or magic or limitations the begging of the development.
 
-So imagine that you using an API in all your projects and after spending months or years that API you got a production issue becuase of it , 
+So imagine you are using an API in all your projects and after spending months or years that API you got a production issue because of it even if it so famous and mature, 
 changing the that API would be soo hard and costy !!!
- 
+
+Examples for famous bugs in very famous frameworks 
+--------------------------------------------------- 
+Memory Leak
+- [(POI) OOM caused by Memory Leak in FileBackedDataSource ](https://bz.apache.org/bugzilla/show_bug.cgi?id=60140)
+- [(MySql JDBC connector) Memory leak in ResultSet](https://bugs.mysql.com/bug.php?id=5022)
+- [(Gson) Memory Leak in web application](https://github.com/google/gson/issues/402) 
+
+Performance 
+- [(LOG4J) log4j performance tuning in production config](https://bugzilla.redhat.com/show_bug.cgi?id=778690)
+- [(Guava) performance problem in LinkedHashMultimap](https://github.com/google/guava/issues/1013)
+
+Deadlocks
+- [(Oracle JDK) deadlock in SSLSocketImpl between between write and close](http://bugs.java.com/view_bug.do?bug_id=8013809)
+
+So, we should always protect our project and noy use a framwork or API directly and this is the main idea here  
 
 Main Features
 -------------- 
 - This project offers a standard/clear API for the most used API's in the Java Applications like : Exceptions, Locale, Beans, Formatter's, Json Handlers, Loggers, ReflectionHelpers ...etc 
-- **you can control the implementation's through the class path without changing line of code**
+- **You can control the implementation's through the class path without changing line of code**
 - Smart Exception handling mechanism
 - Default Implementations
 - Many Utilises 

src/main/java/io/github/rhkiswani/javaff/format/DateFormatter.java

@@ -15,7 +15,9 @@
  */
 package io.github.rhkiswani.javaff.format;
 
+import io.github.rhkiswani.javaff.exceptions.SmartException;
 import io.github.rhkiswani.javaff.format.exception.FormatException;
+import io.github.rhkiswani.javaff.lang.utils.StringUtils;
 import io.github.rhkiswani.javaff.log.Log;
 import io.github.rhkiswani.javaff.log.LogFactory;
 
@@ -38,14 +40,21 @@ class DateFormatter extends DefaultFormatter<Date, String> {
     protected String formatVal(Date date, Object... params) {
         if (params.length > 0 && params[0] != null){
             try {
+                if (StringUtils.isEmpty(params[0] + "")){
+                    throw new FormatException(SmartException.TYPE_ERROR, "Date format", date);
+                }
                 SimpleDateFormat format = new SimpleDateFormat(params[0].toString());
                 return format.format(date);
             }catch (Throwable t){
                 LOGGER.error("Failed to format {0} due to {1} ", date, t.getMessage());
-                throw new FormatException(t);
+                throw new FormatException(SmartException.TYPE_ERROR, "Date format", date);
             }
         } else {
             return MessageFormat.format("{0}", date);
         }
     }
+
+    public String format(Date date, String pattern){
+        return format(date , new Object[]{pattern});
+    }
 }

src/main/java/io/github/rhkiswani/javaff/format/DefaultFormatter.java

@@ -23,12 +23,12 @@
  * @since 0.0.1
  * @see io.github.rhkiswani.javaff.format.Formatter
  */
-public abstract class DefaultFormatter<IN, OUT> implements Formatter<IN, OUT> {
+public abstract class DefaultFormatter<IN, OUT> extends Formatter<IN, OUT> {
 
     protected abstract OUT formatVal(IN in, Object[] params);
 
     @Override
-    public OUT format(IN in, Object[] params) throws FormatException {
+    protected OUT format(IN in, Object[] params) throws FormatException {
         if (in == null){
             return null;
         }
@@ -37,11 +37,14 @@ public OUT format(IN in, Object[] params) throws FormatException {
                 ArraysUtils.replace(params, null, "");
                 return formatVal(in, params);
             } catch (Throwable t ){
+                if (t instanceof FormatException) {
+                    throw t;
+                }
                 throw new FormatException(t);
             }
 
         }
-        return formatVal(in, null);
+        return formatVal(in, new Object[]{});
     }
 
 }

src/main/java/io/github/rhkiswani/javaff/format/FormatUtil.java

@@ -15,9 +15,6 @@
  */
 package io.github.rhkiswani.javaff.format;
 
-import io.github.rhkiswani.javaff.exceptions.SmartException;
-import io.github.rhkiswani.javaff.lang.exceptions.IllegalParamException;
-
 /**
  * @author Mohamed Kiswani
  * @since 0.0.1
@@ -35,7 +32,7 @@ public static String formatString(String str, Object... params){
 
     public static <T>T format(Object obj, Object... params){
         if (obj == null){
-            throw new IllegalParamException(SmartException.NULL_VAL, "Object");
+            return null;
         }
         return (T) FormatFactory.getFormatter(obj.getClass()).format(String.valueOf(obj), params);
     }

src/main/java/io/github/rhkiswani/javaff/format/Formatter.java

@@ -22,8 +22,8 @@
  * @since 0.0.1
  *
  */
-public interface Formatter<IN, OUT> {
+public abstract class Formatter<IN, OUT> {
 
-    OUT format(IN in, Object[] params) throws FormatException;
+    protected abstract OUT format(IN in, Object[] params) throws FormatException;
 
 }

src/main/java/io/github/rhkiswani/javaff/format/NumberFormatter.java

@@ -30,4 +30,7 @@ protected String formatVal(Number number, Object... params) {
         return MessageFormat.format("{0}", number);
     }
 
+    public String format(Number num){
+        return format(num, new Object[]{});
+    }
 }

src/main/java/io/github/rhkiswani/javaff/json/GsonHandler.java

@@ -17,6 +17,7 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import io.github.rhkiswani.javaff.json.exceptions.JsonException;
 
 import java.lang.reflect.Modifier;
 
@@ -31,12 +32,20 @@ class GsonHandler implements JsonHandler {
 
     @Override
     public <T> T fromJson(String json, Class clazz) {
-        return (T) gson.fromJson(json, clazz);
+        try {
+            return (T) gson.fromJson(json, clazz);
+        } catch (Throwable t){
+            throw new JsonException(t);
+        }
     }
 
     @Override
     public String toJson(Object object) {
-        return gson.toJson(object);
+        try{
+            return gson.toJson(object);
+        } catch (Throwable t){
+            throw new JsonException(t);
+        }
     }
 
     @Override

src/main/java/io/github/rhkiswani/javaff/lang/HashCodeHelper.java

@@ -32,10 +32,16 @@ protected Integer doAction(Object obj) {
             return -1;
         }
         HashCodeBuilder hashCodeBuilder = new HashCodeBuilder();
+        boolean atLestOneValueInserted = false;
         for (Field field : getFieldsByAnnotation(obj, HashcodeField.class)) {
-            hashCodeBuilder.append(reflectionHelper.getFieldValue(obj, field.getName()));
+            Object val = reflectionHelper.getFieldValue(obj, field.getName());
+            if (val != null){
+                atLestOneValueInserted = true;
+                hashCodeBuilder.append(val);
+            }
+
         }
-        return hashCodeBuilder.toHashCode();
+        return atLestOneValueInserted ? hashCodeBuilder.toHashCode() : -1;
     }
 
     public int toHashCode(Object obj) {

src/main/java/io/github/rhkiswani/javaff/lang/utils/StringUtils.java

@@ -16,7 +16,7 @@
 package io.github.rhkiswani.javaff.lang.utils;
 
 import io.github.rhkiswani.javaff.lang.ToStringHelper;
-import io.github.rhkiswani.javaff.security.encode.EncodeFactory;
+import io.github.rhkiswani.javaff.security.escape.EscapeersFactory;
 
 /**
  * @author Mohamed Kiswani
@@ -29,8 +29,8 @@ public static String toString(Object obj) {
         return new ToStringHelper().toString(obj);
     }
 
-    public static String encode(String input) {
-        return (String) EncodeFactory.getEncoder(String.class).encode(input);
+    public static String escape(String input) {
+        return (String) EscapeersFactory.getEscapeer(String.class).escape(input);
     }
 
     public static boolean isEmpty(String input){

…ecurity/encode/DefaultEncodeHandler.java …ecurity/escape/DefaultEscapeHandler.javasrc/main/java/io/github/rhkiswani/javaff/security/encode/DefaultEncodeHandler.java renamed to src/main/java/io/github/rhkiswani/javaff/security/escape/DefaultEscapeHandler.java src/main/java/io/github/rhkiswani/javaff/security/encode/DefaultEncodeHandler.java renamed to src/main/java/io/github/rhkiswani/javaff/security/escape/DefaultEscapeHandler.java

@@ -13,22 +13,22 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.github.rhkiswani.javaff.security.encode;
+package io.github.rhkiswani.javaff.security.escape;
 
 import io.github.rhkiswani.javaff.lang.utils.ArraysUtils;
-import io.github.rhkiswani.javaff.security.encode.exception.EncodeException;
+import io.github.rhkiswani.javaff.security.escape.exception.EncodeException;
 
 /**
  * @author Mohamed Kiswani
  * @since 0.0.1
- * @see io.github.rhkiswani.javaff.security.encode.EncodeHandler
+ * @see EscapeHandler
  */
-public abstract class DefaultEncodeHandler<IN, OUT> implements EncodeHandler<IN, OUT> {
+public abstract class DefaultEscapeHandler<IN, OUT> implements EscapeHandler<IN, OUT> {
 
     protected abstract OUT encodeVal(IN in, Object... params);
 
     @Override
-    public OUT encode(IN in, Object... params) throws EncodeException {
+    public OUT escape(IN in, Object... params) throws EncodeException {
         if (in == null){
             return null;
         }