v5.1.0

Author: Alex-GF

.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# 4 space indentation
+[*.java]
+indent_style = space
+indent_size = 4

.github/workflows/auto-asign-author-to-pr.yml

@@ -0,0 +1,14 @@
+name: Auto Assign Author
+
+on:
+  pull_request_target:
+    types: [opened, reopened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  assign-author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: toshimaru/auto-author-assign@v1.6.2

.github/workflows/deploy-release.yml

@@ -0,0 +1,33 @@
+name: Publish package to the Maven Central Repository
+on:
+    release:
+      types: [created]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Maven Central Repository
+        uses: actions/setup-java@v4
+        with:
+          java-version: "17"
+          distribution: "temurin"
+          server-id: ossrh
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+      - name: Install gpg secret key
+        run: |
+          # Install gpg secret key
+          echo "${{ secrets.OSSRH_GPG_SECRET_KEY }}" | base64 --decode | gpg --batch --import
+          # Verify that the key ID is shown in the logs
+          gpg --list-secret-keys --keyid-format LONG | grep "${{ secrets.OSSRH_GPG_SECRET_KEY_ID }}"
+      - name: Publish to Central Repository
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}
+        run: |
+          mvn \
+            --no-transfer-progress \
+            --batch-mode \
+            -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} \
+            clean deploy

.github/workflows/run-tests.yml

@@ -0,0 +1,22 @@
+name: Unit Tests Run
+on: 
+  pull_request:
+    branches:
+      - '**'
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Set up Java 17
+              uses: actions/setup-java@v4
+              with:
+                java-version: '17'
+                distribution: 'temurin'
+            
+            - name: Build with Maven
+              run: mvn test
+
+            

.gitignore

@@ -1,3 +1,8 @@
+# Temp test files
+
+src/main/resources/yaml-testing/
+
+
 # Compiled class file
 *.class
 
@@ -25,4 +30,13 @@ replay_pid*
 
 target/
 
-*.gpg
+*.gpg
+
+# IDEs
+
+.vscode
+
+.idea
+
+# MacOS
+.DS_Store

.vscode/settings.json

@@ -7,11 +7,11 @@
 
 	<groupId>io.github.isa-group</groupId>
 	<artifactId>Pricing4Java</artifactId>
-	<version>4.0.1</version>
+	<version>5.1.0</version>
 
 	<name>${project.groupId}:${project.artifactId}</name>
 	<description>A pricing driven feature toggling library for java</description>
-	<url>https://github.com/Alex-GF/pricingplans-4j</url>
+	<url>https://github.com/isa-group/Pricing4Java</url>
 	<packaging>jar</packaging>
 
 	<licenses>
@@ -53,9 +53,10 @@
 		<aspectj.version>1.9.7</aspectj.version>
 		<spring.version>6.1.5</spring.version>
 		<spring.boot.version>3.2.0</spring.boot.version>
-		<maven.compiler.source>11</maven.compiler.source>
-		<maven.compiler.target>11</maven.compiler.target>
-	</properties>
+		<maven.compiler.source>17</maven.compiler.source>
+		<maven.compiler.target>17</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
 
 
 	<dependencies>
@@ -140,6 +141,12 @@
 			<version>5.10.2</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.junit.jupiter</groupId>
+			<artifactId>junit-jupiter-params</artifactId>
+			<version>5.10.2</version>
+			<scope>test</scope>
+		</dependency>
 
 		<!-- JSON WEB TOKEN -->
 		<dependency>
@@ -157,7 +164,7 @@
 		<dependency>
 			<groupId>org.yaml</groupId>
 			<artifactId>snakeyaml</artifactId>
-			<version>1.33</version>
+			<version>2.3</version>
 		</dependency>
 
 		<!-- API, java.xml.bind module -->
@@ -183,13 +190,20 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-gpg-plugin</artifactId>
+				<version>3.2.7</version>
 				<executions>
 					<execution>
 						<id>sign-artifacts</id>
 						<phase>verify</phase>
 						<goals>
 							<goal>sign</goal>
 						</goals>
+						<configuration>
+						<gpgArguments>
+							<arg>--pinentry-mode</arg>
+							<arg>loopback</arg>
+						</gpgArguments>
+					</configuration>
 					</execution>
 				</executions>
 			</plugin>
@@ -212,9 +226,32 @@
 				</dependencies>
 			</plugin>
 			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.2.5</version>
+				<version>3.5.2</version>
+				<dependencies>
+					<dependency>
+						<groupId>me.fabriciorby</groupId>
+						<artifactId>maven-surefire-junit5-tree-reporter</artifactId>
+						<version>1.4.0</version>
+					</dependency>
+				</dependencies>
+				<configuration>
+					<reportFormat>plain</reportFormat>
+					<consoleOutputReporter>
+						<disable>true</disable>
+					</consoleOutputReporter>
+					<statelessTestsetInfoReporter
+							implementation="org.apache.maven.plugin.surefire.extensions.junit5.JUnit5StatelessTestsetInfoTreeReporter">
+						<printStacktraceOnError>true</printStacktraceOnError>
+						<printStacktraceOnFailure>true</printStacktraceOnFailure>
+						<printStdoutOnError>true</printStdoutOnError>
+						<printStdoutOnFailure>true</printStdoutOnFailure>
+						<printStdoutOnSuccess>false</printStdoutOnSuccess>
+						<printStderrOnError>true</printStderrOnError>
+						<printStderrOnFailure>true</printStderrOnFailure>
+						<printStderrOnSuccess>false</printStderrOnSuccess>
+					</statelessTestsetInfoReporter>
+				</configuration>
 			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
@@ -245,7 +282,7 @@
 			<plugin>
 				<groupId>org.jacoco</groupId>
 				<artifactId>jacoco-maven-plugin</artifactId>
-				<version>0.8.11</version>
+				<version>0.8.12</version>
 				<executions>
 					<execution>
 						<goals>
@@ -263,4 +300,4 @@
 			</plugin>
 		</plugins>
 	</build>
-</project>
+</project>

pom.xml

@@ -0,0 +1,52 @@
+# Yaml4SaaS Specification Changelog
+
+:warning: If no `version` is specified version 1.0 is set by default
+
+## Version 1.0
+
+## Version 1.1
+
+### :white_check_mark: New
+
+- new field `createdAt` to replace `day` `month` and `year`, see this [section](#deleted)
+- now addOns can depend on addOns putting the name of the addOn in the `avaliableFor` field
+
+### :x: Deleted
+
+- `day` `month` and `year` were used to indicate the day when the pricing was modeled.
+  These fields has been deleted as in yaml it is possible to specify a date.
+  Use new field `createdAt` instead.
+
+### :up: Improvements
+
+- Now you can skip duplicating the same `expression` in the `serverExpression` in a feature.
+  `serverExpression` has the same evaluation in `expression` by default. You can still
+  overwrite `serverExpression` if you want to be different.
+
+## Version 2.0
+
+### :white_check_mark: New
+
+- new field in plan called `price` that supports setting the price with a number or
+  compute mathematical expression to determine the price of the plan. Expression can
+  be greatly reduced with `variables` feature
+- new root field called `variables` to use in conjunction when computing expressions
+  plans prices. Assume that your plan price is calculated according to the number of
+  conections `c` you want and uses the following formula `2*c + 3 / (c+1)` to compute
+  the price. You can define in `variables` map parameter `c`.
+- dependencies between addons using the attribute `dependsOn`
+
+### :x: Deleted
+
+- plan fields `monthlyPrice` and `annualPrice` removed, use `price` instead
+
+## Future Work (not yet implemented)
+
+- new field in plan called `private` to indicate denote that you should contact sales
+  to hire their services
+
+- new root field called `billing` holds the discount ratio of different billing
+  present in the pricing. Assumming that discount ratios are applied to the monthly price
+  of plans and addOns
+
+- feature groups using tags