v5.2.0

**Pricing2Yaml 2.1** Refer to the [docs](https://pricing4saas-docs.vercel.app) for more information

Author: Alex-GF

pom.xml

@@ -7,7 +7,7 @@
 
 	<groupId>io.github.isa-group</groupId>
 	<artifactId>Pricing4Java</artifactId>
-	<version>5.1.1</version>
+	<version>5.2.0</version>
 
 	<name>${project.groupId}:${project.artifactId}</name>
 	<description>A pricing driven feature toggling library for java</description>

src/main/java/io/github/isagroup/models/PricingManager.java

@@ -17,10 +17,11 @@
 @EqualsAndHashCode
 public class PricingManager {
 
-    private Version version;
+    private Version syntaxVersion;
     private String saasName;
     private String url;
     private LocalDate createdAt;
+    private String version;
     private String currency;
     private List<String> tags;
     private Map<String, Double> billing;

src/main/java/io/github/isagroup/services/parsing/PricingManagerParser.java

@@ -2,6 +2,7 @@
 
 import java.time.LocalDate;
 import java.time.ZoneId;
+import java.time.format.DateTimeFormatter;
 import java.time.format.DateTimeParseException;
 import java.util.Date;
 import java.util.HashMap;
@@ -59,29 +60,29 @@ protected static Double evaluateFormula(String price, PricingManager pricingMana
 
     private static void setBasicAttributes(Map<String, Object> yamlConfigMap, PricingManager pricingManager) {
 
-        // -------------- version --------------
+        // -------------- syntaxVersion --------------
 
-        Version version = null;
+        Version syntaxVersion = null;
 
         try {
-            if (yamlConfigMap.get("version") == null) {
+            if (yamlConfigMap.get("syntaxVersion") == null) {
                 throw new PricingParsingException(
-                        "The version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted");
-            } else if (yamlConfigMap.get("version") instanceof Double
-                    || yamlConfigMap.get("version") instanceof String) {
+                        "The syntaxVersion field of the pricing must not be null or undefined. Please ensure that the syntaxVersion field is present and correctly formatted");
+            } else if (yamlConfigMap.get("syntaxVersion") instanceof Double
+                    || yamlConfigMap.get("syntaxVersion") instanceof String) {
 
-                version = Version.version(yamlConfigMap.get("version"));
+                        syntaxVersion = Version.version(yamlConfigMap.get("syntaxVersion"));
 
             } else {
                 throw new PricingParsingException(
-                        String.format("'version' detected type is %s but 'version' type must be Double or String",
-                                yamlConfigMap.get("version").getClass().getSimpleName()));
+                        String.format("'syntaxVersion' detected type is %s but 'syntaxVersion' type must be Double or String",
+                                yamlConfigMap.get("syntaxVersion").getClass().getSimpleName()));
             }
         } catch (VersionException e) {
             throw new PricingParsingException(e.getMessage());
         }
 
-        pricingManager.setVersion(version);
+        pricingManager.setSyntaxVersion(syntaxVersion);
 
         // -------------- saasName --------------
 
@@ -141,6 +142,17 @@ private static void setBasicAttributes(Map<String, Object> yamlConfigMap, Pricin
                             yamlConfigMap.get("createdAt").getClass().getSimpleName()));
         }
 
+        // -------------- version --------------
+
+        if (yamlConfigMap.get("version") == null) {
+            pricingManager.setVersion(pricingManager.getCreatedAt().format(DateTimeFormatter.ofPattern("yyyy-MM-dd")));
+        }else{
+            if (!(yamlConfigMap.get("version") instanceof String)) {
+                throw new PricingParsingException("'version' has to be a string");
+            }
+            pricingManager.setVersion((String) yamlConfigMap.get("version"));
+        }
+
         // -------------- currency --------------
 
         if (yamlConfigMap.get("currency") == null) {

src/main/java/io/github/isagroup/services/serializer/PricingManagerSerializer.java

@@ -22,9 +22,10 @@ public PricingManagerSerializer() {
 
     public Map<String, Object> serialize(PricingManager pricingManager) throws SerializerException {
 
-        serializedPricingManager.put("version", Version.LATEST.toString());
+        serializedPricingManager.put("syntaxVersion", Version.LATEST.toString());
         serializedPricingManager.put("saasName", pricingManager.getSaasName());
         serializedPricingManager.put("createdAt", pricingManager.getCreatedAt().toString());
+        serializedPricingManager.put("version", pricingManager.getVersion());
         serializedPricingManager.put("url", pricingManager.getUrl());
         serializedPricingManager.put("tags", pricingManager.getTags());
         serializedPricingManager.put("billing", pricingManager.getBilling());

src/main/java/io/github/isagroup/services/updaters/V20ToV21Updater.java

@@ -0,0 +1,39 @@
+package io.github.isagroup.services.updaters;
+
+import java.util.Map;
+
+import io.github.isagroup.exceptions.UpdateException;
+import io.github.isagroup.exceptions.VersionException;
+
+public class V20ToV21Updater extends VersionUpdater {
+
+    public V20ToV21Updater(Updater updater) {
+        super(Version.V2_0, updater);
+    }
+
+    @Override
+    public void update(Map<String, Object> configFile) throws UpdateException {
+
+        try {
+            if (Version.version(configFile.get("version")).compare(this.getSource()) < 0) {
+                super.update(configFile);
+
+            }
+        } catch (VersionException e) {
+            throw new UpdateException(e.getMessage(), configFile);
+        }
+
+        refactorPricingVersion(configFile);
+    }
+
+    private void refactorPricingVersion(Map<String,Object> configFile) {
+        configFile.put("syntaxVersion", "2.1");
+        
+        try{
+            configFile.put("version", configFile.get("createdAt").toString());
+        }catch(Exception e){
+            configFile.put("version", "latest");
+        }
+    }
+
+}

src/main/java/io/github/isagroup/services/updaters/Version.java

@@ -6,16 +6,16 @@
 import java.util.regex.Pattern;
 
 public enum Version {
-    V1_0(1, 0), V1_1(1, 1), V2_0(2, 0);
+    V1_0(1, 0), V1_1(1, 1), V2_0(2, 0), V2_1(2, 1);
 
     private final int major;
     private final int minor;
 
-    public static final Version LATEST = V2_0;
+    public static final Version LATEST = V2_1;
 
     Version(int major, int minor) {
         if (!isValid(major, minor)) {
-            throw new IllegalStateException(String.format("Version of yaml %d.%d is unsupported", major, minor));
+            throw new IllegalStateException(String.format("Version of Pricing2Yaml %d.%d is unsupported", major, minor));
         }
 
         this.major = major;
@@ -32,7 +32,7 @@ public static Version version(Object version) {
         } else if (version instanceof String) {
             return Version.version((String) version);
         } else {
-            throw new VersionException("Cannot parse " + version + " to a version");
+            throw new VersionException("Cannot parse " + version + " to a syntax version");
         }
 
     }
@@ -45,7 +45,7 @@ private static Version version(Double version) {
     private static Version version(String version) {
 
         if (version.isEmpty() || version.isBlank()) {
-            throw new VersionException("Version is blank");
+            throw new VersionException("SyntaxVersion is blank");
         }
 
         String regex = "(\\d+)\\.(\\d+)";
@@ -54,7 +54,7 @@ private static Version version(String version) {
         Matcher matcher = pattern.matcher(version);
 
         if (!matcher.matches()) {
-            throw new VersionException("Invalid version \"" + version + "\", use <major>.<minor> version format");
+            throw new VersionException("Invalid syntax version \"" + version + "\", use <major>.<minor> version format");
         }
 
         int major;
@@ -77,7 +77,7 @@ private static Version version(String version) {
         Version versionObj = Version.version(major, minor);
 
         if (versionObj == null) {
-            throw new VersionException("Unsupported version " + major + "." + minor);
+            throw new VersionException("Unsupported syntax version " + major + "." + minor);
         }
 
         return versionObj;
@@ -97,6 +97,9 @@ public static Version version(int major, int minor) {
             if (minor == 0) {
                 return V2_0;
             }
+            if (minor == 1) {
+                return V2_1;
+            }
         }
 
         return null;
@@ -112,7 +115,7 @@ public int getMinor() {
 
     public static boolean isValid(int major, int minor) {
         boolean oneDotVersions = major == 1 && (minor == 0 || minor == 1);
-        boolean twoDotVersions = major == 2 && minor == 0;
+        boolean twoDotVersions = major == 2 && (minor == 0 || minor == 1);
         return oneDotVersions || twoDotVersions;
     }
 

src/main/java/io/github/isagroup/services/updaters/YamlUpdater.java

@@ -3,6 +3,7 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+import io.github.isagroup.exceptions.PricingParsingException;
 import io.github.isagroup.exceptions.UpdateException;
 import io.github.isagroup.exceptions.VersionException;
 
@@ -13,19 +14,35 @@ public class YamlUpdater {
     static {
         updaters.put(Version.V1_0, new V10ToV11Updater(null));
         updaters.put(Version.V1_1, new V11ToV20Updater(updaters.get(Version.V1_0)));
+        updaters.put(Version.V2_0, new V20ToV21Updater(updaters.get(Version.V1_1)));
     }
 
     public static void update(Map<String, Object> configFile) throws UpdateException {
 
-        if (configFile.get("version") == null) {
-            throw new VersionException("The version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted");
+        if (configFile.get("syntaxVersion") == null && configFile.get("version") == null) {
+            throw new VersionException("The syntax version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted");
         }
 
-        Version version = Version.version(configFile.get("version"));
-        if (updaters.get(version) == null) {
-            return;
+
+        Object versionField = configFile.get("syntaxVersion");
+
+        if (versionField == null) {
+            versionField = configFile.get("version");
+        }
+
+        if (versionField instanceof String string && (string.isBlank() || string.isEmpty())){
+            throw new PricingParsingException("The syntax version field of the pricing must not be empty. Please ensure that the syntax version field is present and correctly formatted");
         }
 
-        updaters.get(Version.V1_1).update(configFile);
+        if (versionField instanceof Double || versionField instanceof String) {
+            Version version = Version.version(versionField);
+            if (updaters.get(version) == null) {
+                return;
+            }
+
+            updaters.get(Version.V2_0).update(configFile);
+        }else{
+            throw new PricingParsingException("The syntax version field of the pricing must be a string or a double. Please ensure that the version field is present and correctly formatted");
+        }
     }
 }

src/test/java/io/github/isagroup/parsing/positive/PricingManagerParserTest.java

@@ -169,6 +169,6 @@ void givenVersionShouldParse(String input) {
 
         String path = String.format(TEST_CASES + "version/%s.yml", input);
         PricingManager pricingManager = YamlUtils.retrieveManagerFromYaml(path);
-        assertInstanceOf(Version.class, pricingManager.getVersion());
+        assertInstanceOf(Version.class, pricingManager.getSyntaxVersion());
     }
 }

src/test/java/io/github/isagroup/updaters/UpdatersTest.java

@@ -45,7 +45,7 @@ void givenInvalidVersionFormatShouldThrow() {
         try {
             Version.version("alpha");
         } catch (VersionException e) {
-            assertEquals("Invalid version \"alpha\", use <major>.<minor> version format", e.getMessage());
+            assertEquals("Invalid syntax version \"alpha\", use <major>.<minor> version format", e.getMessage());
         }
     }
 

src/test/resources/negative-parsing-tests.csv

@@ -72,10 +72,10 @@ Throw an error if 'url' is a plain string;parsing/negative/url/invalid-string-ur
 Throw an error if 'url' is not a string;parsing/negative/url/number-url.yml;If 'url' field is used, it has to be a string
 # variables
 Throw an error if 'variables' is not a map;parsing/negative/variables/variables-is-boolean.yml;variables must be a map but found Boolean instead
-# version
-Throw an error if 'version' is bad formated;parsing/negative/version/pricing-invalid-format-version.yml;Invalid version "1.0.0", use <major>.<minor> version format
-Throw an error if 'version' is not a string like <major>.<minor>;parsing/negative/version/pricing-invalid-type-version.yml;Cannot parse 100 to a version
-Throw an error if 'version' is missing;parsing/negative/version/pricing-no-version.yml;The version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted
-Throw an error if 'version' is null;parsing/negative/version/pricing-null-version.yml;The version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted
+# syntaxVersion
+Throw an error if 'syntaxVersion' is bad formated;parsing/negative/syntaxVersion/pricing-invalid-format-version.yml;Invalid syntax version "1.0.0", use <major>.<minor> version format
+Throw an error if 'syntaxVersion' is not a string like <major>.<minor>;parsing/negative/syntaxVersion/pricing-invalid-type-version.yml;The syntax version field of the pricing must be a string or a double. Please ensure that the version field is present and correctly formatted
+Throw an error if 'syntaxVersion' is missing;parsing/negative/syntaxVersion/pricing-no-version.yml;The syntax version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted
+Throw an error if 'syntaxVersion' is null;parsing/negative/syntaxVersion/pricing-null-version.yml;The syntax version field of the pricing must not be null or undefined. Please ensure that the version field is present and correctly formatted
 # other checks
 Throw an error if 'plans' and 'addOns' are null at the same time;parsing/negative/null-plans-and-addons.yml;The pricing manager does not have any plans or add ons