Merge pull request #9 from joutvhu/development

joutvhu · web-flow · commit 1bf4adc2c7eb · 2020-09-20T23:11:39.000+07:00
0.0.10-SNAPSHOT
diff --git a/build.gradle b/build.gradle
@@ -7,7 +7,7 @@ plugins {
 }
 
 group = 'com.github.joutvhu'
-version '0.0.8-SNAPSHOT'
+version '0.0.10-SNAPSHOT'
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/FixedParser.java b/src/main/java/com/joutvhu/fixedwidth/parser/FixedParser.java
@@ -3,8 +3,8 @@
 import com.joutvhu.fixedwidth.parser.module.DefaultModule;
 import com.joutvhu.fixedwidth.parser.module.FixedModule;
 import com.joutvhu.fixedwidth.parser.support.FixedParseStrategy;
-import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 import com.joutvhu.fixedwidth.parser.support.FixedStringAssembler;
+import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 import com.joutvhu.fixedwidth.parser.support.StringAssembler;
 
 /**
@@ -50,7 +50,7 @@ public FixedParser with(FixedModule module) {
      *
      * @param line fixed-width string
      * @param type class type of result
-     * @param <T> type of result
+     * @param <T>  type of result
      * @return object
      */
     public <T> T parse(String line, Class<T> type) {
@@ -63,7 +63,7 @@ public <T> T parse(String line, Class<T> type) {
      * Export object to fixed-width string
      *
      * @param object value
-     * @param <T> object type
+     * @param <T>    object type
      * @return fixed-width string
      */
     public <T> String export(T object) {
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/convert/reader/CollectionReader.java b/src/main/java/com/joutvhu/fixedwidth/parser/convert/reader/CollectionReader.java
@@ -5,7 +5,6 @@
 import com.joutvhu.fixedwidth.parser.support.FixedParseStrategy;
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 import com.joutvhu.fixedwidth.parser.support.StringAssembler;
-import com.joutvhu.fixedwidth.parser.util.ClassUtil;
 import com.joutvhu.fixedwidth.parser.util.FixedHelper;
 
 import java.util.Collection;
@@ -30,7 +29,7 @@ public CollectionReader(FixedTypeInfo info, FixedParseStrategy strategy) {
     @Override
     public Collection<?> read(StringAssembler assembler) {
         Class<?> type = info.getType();
-        Class<? extends Collection> selectedType = (Class<? extends Collection>) ClassUtil.selectSubTypeOf(type);
+        Class<? extends Collection> selectedType = (Class<? extends Collection>) FixedHelper.selectSubTypeOf(type);
         if (selectedType == null)
             throw new FixedException(String.format("Not found subclass for %s", info.getLabel()));
 
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/convert/reader/MapReader.java b/src/main/java/com/joutvhu/fixedwidth/parser/convert/reader/MapReader.java
@@ -5,7 +5,6 @@
 import com.joutvhu.fixedwidth.parser.support.FixedParseStrategy;
 import com.joutvhu.fixedwidth.parser.support.FixedTypeInfo;
 import com.joutvhu.fixedwidth.parser.support.StringAssembler;
-import com.joutvhu.fixedwidth.parser.util.ClassUtil;
 import com.joutvhu.fixedwidth.parser.util.FixedHelper;
 
 import java.util.Map;
@@ -35,7 +34,7 @@ public MapReader(FixedTypeInfo info, FixedParseStrategy strategy) {
     @Override
     public Map<?, ?> read(StringAssembler assembler) {
         Class<?> type = info.getType();
-        Class<? extends Map> selectedType = (Class<? extends Map>) ClassUtil.selectSubTypeOf(type);
+        Class<? extends Map> selectedType = (Class<? extends Map>) FixedHelper.selectSubTypeOf(type);
         if (selectedType == null)
             throw new FixedException(String.format("Not found subclass for %s", info.getLabel()));
 
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/BooleanValidator.java b/src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/BooleanValidator.java
@@ -36,7 +36,7 @@ public boolean validate(String value, ValidationType type) {
             String message = getMessage(fixedFormat.message(),
                     fixedFormat.nativeMessage(),
                     "{title} should be equal to one of the following value(s): {0}.",
-                    StringUtils.join(options, ", "));
+                    "\"" + StringUtils.join(options, "\", \"") + "\"");
             throw new InvalidException(message);
         }
         return true;
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/OptionValidator.java b/src/main/java/com/joutvhu/fixedwidth/parser/convert/validator/OptionValidator.java
@@ -32,7 +32,7 @@ public boolean validate(String value, ValidationType type) {
                 String message = getMessage(fixedOption.message(),
                         fixedOption.nativeMessage(),
                         "{label} at position {position} should be equal to one of the following value(s): {0}.",
-                        StringUtils.join(", ", options));
+                        "\"" + StringUtils.join(options, "\", \"") + "\"");
                 throw new InvalidException(message);
             }
         }
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/exception/FindTypeException.java b/src/main/java/com/joutvhu/fixedwidth/parser/exception/FindTypeException.java
@@ -0,0 +1,20 @@
+package com.joutvhu.fixedwidth.parser.exception;
+
+public class FindTypeException extends FixedException {
+    private Class<?> classType;
+
+    public FindTypeException(String message, Class<?> classType) {
+        super(message);
+        this.classType = classType;
+    }
+
+    public FindTypeException(String message, Throwable cause, Class<?> classType) {
+        super(message, cause);
+        this.classType = classType;
+    }
+
+    public FindTypeException(Throwable cause, Class<?> classType) {
+        super(cause);
+        this.classType = classType;
+    }
+}
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/support/FinalTypeFinder.java b/src/main/java/com/joutvhu/fixedwidth/parser/support/FinalTypeFinder.java
@@ -0,0 +1,145 @@
+package com.joutvhu.fixedwidth.parser.support;
+
+import com.google.re2j.Pattern;
+import com.joutvhu.fixedwidth.parser.annotation.FixedField;
+import com.joutvhu.fixedwidth.parser.annotation.FixedObject;
+import com.joutvhu.fixedwidth.parser.exception.FindTypeException;
+import com.joutvhu.fixedwidth.parser.util.CommonUtil;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Find final type
+ *
+ * @author Giao Ho
+ * @since 1.0.0
+ */
+public interface FinalTypeFinder {
+    /**
+     * Get all fixed fields of a object type
+     *
+     * @param type class
+     * @return all fixed width fields
+     */
+    default List<Field> getFixedFields(Class<?> type) {
+        List<Field> fields = new ArrayList<>();
+        Class<?> superType = type.getSuperclass();
+        if (superType != null) fields.addAll(getFixedFields(superType));
+        for (Field field : type.getDeclaredFields()) {
+            FixedField fixedField = field.getAnnotation(FixedField.class);
+            if (fixedField != null) fields.add(field);
+        }
+        return fields;
+    }
+
+    /**
+     * Get final type of a string by supper FixedObject
+     *
+     * @param assembler is {@link StringAssembler}
+     * @param type      of supper {@link FixedObject}
+     * @return final class
+     */
+    default Class<?> detectFinalType(StringAssembler assembler, Class<?> type) {
+        FixedObject fixedObject = type.getAnnotation(FixedObject.class);
+        if (fixedObject != null && CommonUtil.isNotBlank(fixedObject.subTypes())) {
+            for (FixedObject.Type subType : fixedObject.subTypes()) {
+                checkAssignableFrom(type, subType.value());
+                if (checkSelectionCondition(subType, valueOf(assembler, type, subType)))
+                    return detectFinalType(assembler, subType.value());
+            }
+            if (!void.class.equals(fixedObject.defaultSubType())) {
+                checkAssignableFrom(type, fixedObject.defaultSubType());
+                return detectFinalType(assembler, fixedObject.defaultSubType());
+            }
+        }
+        return type;
+    }
+
+    /**
+     * Check the subClass is extends from superClass
+     *
+     * @param superClass is super-class
+     * @param subClass   is sub-class
+     */
+    default void checkAssignableFrom(Class<?> superClass, Class<?> subClass) {
+        if (!superClass.isAssignableFrom(subClass)) {
+            String message = String.format("%s class is not a subclass of %s class.",
+                    subClass.getName(), superClass.getName());
+            throw new FindTypeException(message, superClass);
+        }
+    }
+
+    /**
+     * Check that the final class is neither the interface nor the abstract class
+     *
+     * @param type is final class
+     * @return final class
+     */
+    default Class<?> checkFinalClass(Class<?> type) {
+        int modifiers = type.getModifiers();
+        if (!Modifier.isInterface(modifiers) && !Modifier.isAbstract(modifiers))
+            return type;
+        else {
+            String message = String.format("Can't find the final class of %s.", type.getName());
+            if (Modifier.isInterface(modifiers))
+                message += String.format(" The %s is a interface.", type.getName());
+            if (Modifier.isAbstract(modifiers))
+                message += String.format(" The %s is a abstract class.", type.getName());
+            throw new FindTypeException(message, type);
+        }
+    }
+
+    /**
+     * Check selection condition of class
+     *
+     * @param subType {@link FixedObject.Type}
+     * @param value   for checking
+     * @return can use this class?
+     */
+    default boolean checkSelectionCondition(FixedObject.Type subType, String value) {
+        if (CommonUtil.isNotBlank(subType.oneOf()) && CommonUtil.listOf(subType.oneOf()).contains(value))
+            return true;
+        if (CommonUtil.isNotBlank(subType.matchWith()) && Pattern.matches(subType.matchWith(), value))
+            return true;
+        return false;
+    }
+
+    /**
+     * Get value of field by {@link FixedObject.Type} annotation
+     *
+     * @param assembler {@link StringAssembler}
+     * @param type      is class type
+     * @param subType   {@link FixedObject.Type}
+     * @return string value
+     */
+    default String valueOf(StringAssembler assembler, Class<?> type, FixedObject.Type subType) {
+        if (subType.length() > 0)
+            return assembler.get(subType.start(), subType.length());
+        else if (CommonUtil.isNotBlank(subType.prop()))
+            return valueOf(assembler, type, subType.prop());
+        else return null;
+    }
+
+    /**
+     * Get value of field by field name
+     *
+     * @param assembler {@link StringAssembler}
+     * @param type      is class type
+     * @param prop      is field name
+     * @return string value
+     */
+    default String valueOf(StringAssembler assembler, Class<?> type, String prop) {
+        for (Field field : getFixedFields(type)) {
+            if (field.getName().equals(prop)) {
+                FixedField fixedField = field.getAnnotation(FixedField.class);
+                if (fixedField != null)
+                    return assembler.get(fixedField.start(), fixedField.length());
+                else throw new UnsupportedOperationException(String.format("%s field is not a fixed field.", prop));
+            }
+        }
+        throw new NullPointerException(String.format("Can't found %s field.", prop));
+    }
+}
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/support/FixedParseStrategy.java b/src/main/java/com/joutvhu/fixedwidth/parser/support/FixedParseStrategy.java
@@ -34,7 +34,7 @@ public Object read(FixedTypeInfo info, StringAssembler assembler) {
         assembler.trim(info);
         if (assembler.isBlank(info)) {
             if (info.require)
-                throw new NullPointerException(info.buildMessage("{label} can\'t be blank."));
+                throw new NullPointerException(info.buildMessage("{title} can\'t be blank."));
             return null;
         }
         validate(info, assembler.getValue(), ValidationType.BEFORE_READ);
@@ -43,7 +43,7 @@ public Object read(FixedTypeInfo info, StringAssembler assembler) {
         if (reader != null) {
             Object result = reader.read(assembler);
             if (result == null && info.require)
-                throw new NullPointerException(info.buildMessage("{title} can\'t be null."));
+                throw new NullPointerException(info.buildMessage("{label} can\'t be null."));
             return result;
         }
         throw new FixedException("Reader not found.");
@@ -66,7 +66,7 @@ public String write(FixedTypeInfo info, Object value) {
 
             if (assembler.isBlank(info)) {
                 if (info.require)
-                    throw new NullPointerException(info.buildMessage("{label} can\'t be blank."));
+                    throw new NullPointerException(info.buildMessage("{title} can\'t be blank."));
             } else validate(info, assembler.getValue(), ValidationType.AFTER_WRITE);
             return assembler.getValue();
         }
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/support/FixedStringAssembler.java b/src/main/java/com/joutvhu/fixedwidth/parser/support/FixedStringAssembler.java
@@ -1,7 +1,6 @@
 package com.joutvhu.fixedwidth.parser.support;
 
 import com.joutvhu.fixedwidth.parser.domain.Alignment;
-import com.joutvhu.fixedwidth.parser.domain.Padding;
 import com.joutvhu.fixedwidth.parser.util.Assert;
 import com.joutvhu.fixedwidth.parser.util.CommonUtil;
 import org.apache.commons.lang3.StringUtils;
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/support/TypeDetector.java b/src/main/java/com/joutvhu/fixedwidth/parser/support/TypeDetector.java
@@ -4,7 +4,6 @@
 import com.joutvhu.fixedwidth.parser.annotation.FixedObject;
 import com.joutvhu.fixedwidth.parser.annotation.FixedParam;
 import com.joutvhu.fixedwidth.parser.util.Assert;
-import com.joutvhu.fixedwidth.parser.util.FixedHelper;
 import com.joutvhu.fixedwidth.parser.util.ReflectionUtil;
 import lombok.Getter;
 
@@ -21,7 +20,7 @@
  * @since 1.0.0
  */
 @Getter
-public abstract class TypeDetector {
+public abstract class TypeDetector implements FinalTypeFinder {
     protected Field field;
     protected Class<?> type;
     protected AnnotatedType annotatedType;
@@ -130,7 +129,8 @@ public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
     public final Class<?> detectTypeWith(StringAssembler assembler) {
         if (!finalType) {
             if (!type.isPrimitive() && fixedObject != null) {
-                Class<?> newType = FixedHelper.detectType(assembler, type);
+                Class<?> newType = detectFinalType(assembler, type);
+                checkFinalClass(newType);
                 if (!type.equals(newType)) {
                     this.detectedNewType(newType);
                     this.type = newType;
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/support/TypeInfoSetter.java b/src/main/java/com/joutvhu/fixedwidth/parser/support/TypeInfoSetter.java
@@ -5,7 +5,10 @@
 import com.joutvhu.fixedwidth.parser.domain.Alignment;
 import com.joutvhu.fixedwidth.parser.domain.KeepPadding;
 import com.joutvhu.fixedwidth.parser.domain.Padding;
-import com.joutvhu.fixedwidth.parser.util.*;
+import com.joutvhu.fixedwidth.parser.util.Assert;
+import com.joutvhu.fixedwidth.parser.util.CommonUtil;
+import com.joutvhu.fixedwidth.parser.util.ReflectionUtil;
+import com.joutvhu.fixedwidth.parser.util.TypeConstants;
 import lombok.Getter;
 
 import java.lang.reflect.AnnotatedParameterizedType;
@@ -141,8 +144,7 @@ public void afterTypeDetected() {
      */
     private void detectFields(Class<?> type) {
         this.elementTypeInfo = new ArrayList<>();
-        FixedHelper
-                .getFixedFields(type)
+        this.getFixedFields(type)
                 .stream()
                 .map(FixedTypeInfo::of)
                 .forEach(i -> this.elementTypeInfo.add(i));
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/util/ClassUtil.java b/src/main/java/com/joutvhu/fixedwidth/parser/util/ClassUtil.java
diff --git a/src/main/java/com/joutvhu/fixedwidth/parser/util/FixedHelper.java b/src/main/java/com/joutvhu/fixedwidth/parser/util/FixedHelper.java

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ plugins {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`group = 'com.github.joutvhu'`
`10`		`-version '0.0.8-SNAPSHOT'`
	`10`	`+version '0.0.10-SNAPSHOT'`
`11`	`11`	`sourceCompatibility = 1.8`
`12`	`12`	`targetCompatibility = 1.8`
`13`	`13`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public boolean validate(String value, ValidationType type) {`
`36`	`36`	`String message = getMessage(fixedFormat.message(),`
`37`	`37`	`fixedFormat.nativeMessage(),`
`38`	`38`	`"{title} should be equal to one of the following value(s): {0}.",`
`39`		`- StringUtils.join(options, ", "));`
	`39`	`+ "\"" + StringUtils.join(options, "\", \"") + "\"");`
`40`	`40`	`throw new InvalidException(message);`
`41`	`41`	`}`
`42`	`42`	`return true;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public boolean validate(String value, ValidationType type) {`
`32`	`32`	`String message = getMessage(fixedOption.message(),`
`33`	`33`	`fixedOption.nativeMessage(),`
`34`	`34`	`"{label} at position {position} should be equal to one of the following value(s): {0}.",`
`35`		`- StringUtils.join(", ", options));`
	`35`	`+ "\"" + StringUtils.join(options, "\", \"") + "\"");`
`36`	`36`	`throw new InvalidException(message);`
`37`	`37`	`}`
`38`	`38`	`}`