Merge pull request #12 from xdev-software/develop

Release v1.0.0

Author: JohannesRabauer

.github/workflows/release.yml

@@ -6,7 +6,6 @@ on:
 
 env:
   PRIMARY_MAVEN_MODULE: ${{ github.event.repository.name }}
-  DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
 
 permissions:
   contents: write
@@ -58,17 +57,16 @@ jobs:
       run: |
         git config --global user.email "[email protected]"
         git config --global user.name "GitHub Actions"
-      
-    - name: Un-SNAP root
-      run: mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false
-    
-    - name: Un-SNAP demo
-      run: mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false
-      working-directory: ${{ env.DEMO_MAVEN_MODULE }}
   
     - name: Un-SNAP 
-      run: mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false
-      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
+      run: |
+        modules=("") # root
+        modules+=($(grep -ozP '(?<=module>)[^<]+' 'pom.xml' | tr -d '\0'))
+        for i in "${modules[@]}"
+        do
+            echo "Processing $i/pom.xml"
+            (cd "$i" && mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false)
+        done
   
     - name: Get version
       id: version
@@ -204,17 +202,16 @@ jobs:
         git config --global user.email "[email protected]"
         git config --global user.name "GitHub Actions"
         git pull
-        
-    - name: Inc Version and SNAP root
-      run: mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true
-    
-    - name: Inc Version and SNAP demo
-      run: mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true
-      working-directory: ${{ env.DEMO_MAVEN_MODULE }}
-  
+
     - name: Inc Version and SNAP 
-      run: mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true
-      working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
+      run: |
+        modules=("") # root
+        modules+=($(grep -ozP '(?<=module>)[^<]+' 'pom.xml' | tr -d '\0'))
+        for i in "${modules[@]}"
+        do
+            echo "Processing $i/pom.xml"
+            (cd "$i" && mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true)
+        done
 
     - name: Git Commit and Push
       run: |

.github/workflows/sonar.yml

@@ -53,7 +53,12 @@ jobs:
           restore-keys: ${{ runner.os }}-m2
 
       - name: Build with Maven
-        run: mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=${{ env.SONARCLOUD_ORG }}_${{ github.event.repository.name }} -Dsonar.organization=${{ env.SONARCLOUD_ORG }} -Dsonar.host.url=${{ env.SONARCLOUD_HOST }}
+        run: |
+          mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
+            -DskipTests \
+            -Dsonar.projectKey=${{ env.SONARCLOUD_ORG }}_${{ github.event.repository.name }} \
+            -Dsonar.organization=${{ env.SONARCLOUD_ORG }} \
+            -Dsonar.host.url=${{ env.SONARCLOUD_HOST }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -66,6 +66,9 @@ target/
 .flattened-pom.xml
 .tern-project
 
+# EclipseStore
+storage
+
 # == IntelliJ ==
 *.iml
 *.ipr

.idea/codeStyles/Project.xml

@@ -0,0 +1,16 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Benchmark" type="Application" factoryName="Application">
+    <option name="MAIN_CLASS_NAME" value="software.xdev.spring.data.eclipse.store.benchmark.BenchmarkRunner" />
+    <module name="spring-data-eclipse-store-benchmark" />
+    <option name="VM_PARAMETERS" value="--add-opens java.base/java.util=ALL-UNNAMED" />
+    <extension name="coverage">
+      <pattern>
+        <option name="PATTERN" value="software.xdev.spring.data.eclipse.store.benchmark.benchmarks.simple.user.*" />
+        <option name="ENABLED" value="true" />
+      </pattern>
+    </extension>
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>

.run/Run Benchmark.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run Complex Demo" type="Application" factoryName="Application">
+    <option name="MAIN_CLASS_NAME" value="software.xdev.spring.data.eclipse.store.demo.complex.ComplexDemoApplication" />
+    <module name="spring-data-eclipse-store-demo" />
+    <option name="VM_PARAMETERS" value="--add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.time=ALL-UNNAMED" />
+    <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
+    <extension name="coverage">
+      <pattern>
+        <option name="PATTERN" value="software.xdev.*" />
+        <option name="ENABLED" value="true" />
+      </pattern>
+    </extension>
+    <method v="2">
+      <option name="Make" enabled="true" />
+    </method>
+  </configuration>
+</component>

.run/Run Complex Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
-    <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
-    <module name="standard-maven-template-demo" />
+  <configuration default="false" name="Run Simple Demo" type="Application" factoryName="Application">
+    <option name="MAIN_CLASS_NAME" value="software.xdev.spring.data.eclipse.store.demo.simple.SimpleDemoApplication" />
+    <module name="spring-data-eclipse-store-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

.run/Run Demo.run.xml renamed to .run/Run Simple Demo.run.xml

@@ -0,0 +1,2 @@
+# 1.0.0
+* Initial release

CHANGELOG.md

@@ -33,10 +33,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/release.yml?branch=master)](https://github.com/xdev-software/standard-maven-template/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/spring-data-eclipse-store/release.yml?branch=master)](https://github.com/xdev-software/spring-data-eclipse-store/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/standard-maven-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/spring-data-eclipse-store/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

CONTRIBUTING.md

@@ -1,19 +1,95 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/standard-maven-template?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/standard-maven-template)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/standard-maven-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_standard-maven-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_standard-maven-template)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/spring-data-eclipse-store?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/spring-data-eclipse-store)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/spring-data-eclipse-store/checkBuild.yml?branch=develop)](https://github.com/xdev-software/spring-data-eclipse-store/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_spring-data-eclipse-store&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_spring-data-eclipse-store)
 
-# standard-maven-template
+<div align="center">
+    <img src="assets/Logo.png" height="200" alt="XDEV Spring-Data Eclipse-Store Logo">
+</div>
 
+# spring-data-eclipse-store
+
+A library to simplify using [EclipseStore](https://eclipsestore.io/) in the [Spring environment](https://spring.io/projects/spring-data/).
+
+What makes this library special is, that it creates a working copy of the data.
+This way EclipseStore behaves almost exactly like relational database from a coding perspective.
+
+## Features
+
+The library provides following features:
+
+* Enforces the
+  **[Spring data repository concept](https://docs.spring.io/spring-data/jpa/reference/repositories/core-concepts.html)**
+  for EclipseStore by using [working copies](#working-copies)
+* **[Drop in compatible](#usage)** for your existing Spring application
+* Utilizes **ultra-fast EclipseStore serializing and storing**
+* Enables your application to **select
+  any [EclipseStore target](https://docs.eclipsestore.io/manual/storage/storage-targets/index.html)** (e.g.
+  [PostgreSQL](https://docs.eclipsestore.io/manual/storage/storage-targets/sql-databases/postgresql.html),
+  [AWS S3](https://docs.eclipsestore.io/manual/storage/storage-targets/blob-stores/aws-s3.html) or
+  [IBM COS](https://github.com/xdev-software/eclipse-store-afs-ibm-cos))
+* Can save up to **99%[^1] of monthly costs** in the IBM Cloud and up to 82%[^2] in the AWS Cloud
+
+[^1]:If the COS Connector is used in the IBM Cloud instead of a PostgreSQL and approx. 10,000 entries with a total size
+of 1
+GB of data are stored. ([IBM Cloud Pricing](https://cloud.ibm.com/estimator/estimates), as of 08.01.2024)
+
+[^2]: If the S3 connector is used instead of DynamoDB under the same conditions at
+AWS. ([AWS Pricing Calculator](https://calculator.aws/#/estimate?id=ab85cddf77f0d1aa0457111ed82785dfb836b1d8), as of
+08.01.2024)
+
+### Working copies
+
+If you use EclipseStore without our library, EclipseStore loads the data from the datastore directly into memory. You make your changes on these loaded Java objects and by calling ``store`` EclipseStore writes it directly from memory to the datastore.
+
+![Native behavior of EclipseStore](assets/WorkingCopy_1.svg)
+
+If you e.g. change the address of a person, the changed address is already in your data model, **even before storing** this person.
+This is very different from the behavior a Spring user expects.
+
+With *Spring-Data-Eclipse-Store* every time an object is loaded from the datastore, a working copy of that object (or rather the object tree) is created and returned to the user. Therefore, the user can make the changes on the working copy without any changes to the actual data model. The changes are only persisted after calling ``save`` on a repository.
+
+![Behavior of EclipseStore with Spring-Data-Eclipse-Store](assets/WorkingCopy_2.svg)
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/standard-maven-template/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/spring-data-eclipse-store/releases/latest#Installation)
+
+### Prerequisites
+
+|              | Minimal Version |
+|--------------|-----------------|
+| Java         | ``17``          |
+| Spring Data  | ``3.2.2``       |
+| EclipseStore | ``1.1.0``       |
+
+### Usage
+
+After adding the library in your dependencies, using it is as easy as adding the ``@EnableEclipseStoreRepositories`` annotation to your ``@SpringBootApplication`` annotation.
+
+## Demo
+
+To see how easy it is to implement EclipseStore in your Spring project, take a look at the two
+[demos](./spring-data-eclipse-store-demo):<br/>
+A [simple](./spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/simple)
+and a
+more [complex demo](./spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/complex).
+
+> [!NOTE]  
+> Since the library is using reflection to copy data, the following JVM-Arguments may have to be set:
+> ```
+> --add-opens=java.base/java.util=ALL-UNNAMED
+> --add-exports java.base/jdk.internal.misc=ALL-UNNAMED
+> --add-opens=java.base/java.lang=ALL-UNNAMED
+> --add-opens=java.base/java.time=ALL-UNNAMED 
+> ```
 
 
 ## Support
-If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
+
+If you need support as soon as possible, and you can't wait for any pull request, feel free to
+use [our support](https://xdev.software/en/services/support).
 
 ## Contributing
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/standard-maven-template/dependencies/)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/spring-data-eclipse-store/dependencies/)

README.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/standard-maven-template/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/spring-data-eclipse-store/security/advisories/new).