Merge pull request #921 from ie3-institute/rel/sp/#920-release-4.1

Release version 4.1

Author: sebastian-peter

CHANGELOG.md

@@ -6,6 +6,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased/Snapshot]
 
+### Added
+
+### Fixed
+
+### Changed
+
+## [4.1.0] - 2023-11-02
+
+### Fixed
+- Making constructor of `CsvDataSource` public [#894](https://github.com/ie3-institute/PowerSystemDataModel/issues/894)
+- Fixing spotless groovy [#918](https://github.com/ie3-institute/PowerSystemDataModel/issues/918)
+
+### Changed
+- `SqlIdCoordinateSource.createCooridinateValue` now throws an exception when the coordinate can not be built [#911](https://github.com/ie3-institute/PowerSystemDataModel/issues/911)
+- CleanUp `BufferedCsvWriterTest` only after all tests are completed [#809](https://github.com/ie3-institute/PowerSystemDataModel/issues/809)
+- Update gradle to version 8.4 [#891](https://github.com/ie3-institute/PowerSystemDataModel/issues/891)
+
 ## [4.0.0] - 2023-08-01
 
 ### Added
@@ -26,7 +43,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Data source will throw an exceptions instead of returning an empty optionals [#707](https://github.com/ie3-institute/PowerSystemDataModel/issues/707)
 - Improving `ValidationUtils` [#758](https://github.com/ie3-institute/PowerSystemDataModel/issues/758)
 
-
 ## [3.0.0] - 2023-02-16
 
 ### Added
@@ -116,6 +132,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Deleted parameter decimalPlaces and changed naming of serialization method [#710](https://github.com/ie3-institute/PowerSystemDataModel/issues/710)
 - Changed switch result documentation according to the implementation [#757](https://github.com/ie3-institute/PowerSystemDataModel/issues/757)
 - Added documentation for EmResult and FlexOptionResult [#656](https://github.com/ie3-institute/PowerSystemDataModel/issues/656)
+- Added method that checks if the transformer nodes are located on the correct voltage side [#803](https://github.com/ie3-institute/PowerSystemDataModel/issues/803)
 
 ## [2.0.1] - 2021-07-08
 
@@ -219,7 +236,8 @@ coordinates or multiple exactly equal coordinates possible
 -   CsvDataSource now stops trying to get an operator for empty operator uuid field in entities
 -   CsvDataSource now parsing multiple geoJson strings correctly
 
-[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.0.0...HEAD
+[Unreleased/Snapshot]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/3.0.0...4.0.0
 [3.0.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.1.0...3.0.0
 [2.1.0]: https://github.com/ie3-institute/powersystemdatamodel/compare/2.0.1...2.1.0

build.gradle

@@ -4,29 +4,32 @@ plugins {
   id 'maven-publish'
   id 'signing'
   id 'pmd' // code check, working on source code
-  id 'com.diffplug.spotless' version '6.20.0'//code format
-  id 'com.github.spotbugs' version '5.1.0' // code check, working on byte code
-  id 'de.undercouch.download' version '5.4.0'
+  id 'com.diffplug.spotless' version '6.22.0' //code format
+  id 'com.github.spotbugs' version '5.2.1' // code check, working on byte code
+  id 'de.undercouch.download' version '5.5.0'
   id 'kr.motd.sphinx' version '2.10.1' // documentation generation
   id 'jacoco' // java code coverage plugin
-  id "org.sonarqube" version "4.3.0.3225" // sonarqube
+  id "org.sonarqube" version "4.4.1.3373" // sonarqube
   id 'net.thauvin.erik.gradle.semver' version '1.0.4' // semantic versioning
 }
 
 ext {
   //version (changing these should be considered thoroughly!)
   javaVersion = JavaVersion.VERSION_17
   groovyVersion = "4.0"
-  groovyBinaryVersion = "4.0.13"
-  testcontainersVersion = '1.18.3'
+  groovyBinaryVersion = "4.0.15"
+  testcontainersVersion = '1.19.1'
 
   scriptsLocation = 'gradle' + File.separator + 'scripts' + File.separator //location of script plugins
 }
 
 group = 'com.github.ie3-institute'
 description = 'PowerSystemDataModel'
-sourceCompatibility = javaVersion
-targetCompatibility = javaVersion
+
+java {
+  sourceCompatibility = javaVersion
+  targetCompatibility = javaVersion
+}
 
 apply from: scriptsLocation + 'tests.gradle'
 apply from: scriptsLocation + 'pmd.gradle'
@@ -70,7 +73,7 @@ dependencies {
   testImplementation 'org.junit.jupiter:junit-jupiter:5.10.0'
   testImplementation "org.spockframework:spock-core:2.3-groovy-$groovyVersion"
   testImplementation 'org.objenesis:objenesis:3.3' // Mock creation with constructor parameters
-  testImplementation 'net.bytebuddy:byte-buddy:1.14.5' // Mocks of classes
+  testImplementation 'net.bytebuddy:byte-buddy:1.14.9' // Mocks of classes
 
   // testcontainers (docker framework for testing)
   testImplementation "org.testcontainers:testcontainers:$testcontainersVersion"
@@ -80,18 +83,18 @@ dependencies {
   testImplementation "org.testcontainers:couchbase:$testcontainersVersion"
 
   // logging
-  implementation platform('org.apache.logging.log4j:log4j-bom:2.20.0')
+  implementation platform('org.apache.logging.log4j:log4j-bom:2.21.1')
   implementation 'org.apache.logging.log4j:log4j-api' // log4j
   implementation 'org.apache.logging.log4j:log4j-core' // log4j
   implementation 'org.apache.logging.log4j:log4j-slf4j-impl' // log4j -> slf4j
 
   // Databases
   implementation 'org.influxdb:influxdb-java:2.23'
-  implementation 'com.couchbase.client:java-client:3.4.8'
+  implementation 'com.couchbase.client:java-client:3.4.11'
   runtimeOnly 'org.postgresql:postgresql:42.6.0' // postgresql jdbc driver required during runtime
 
-  implementation 'commons-io:commons-io:2.13.0' // I/O functionalities
-  implementation 'org.apache.commons:commons-compress:1.23.0' // I/O functionalities
+  implementation 'commons-io:commons-io:2.15.0' // I/O functionalities
+  implementation 'org.apache.commons:commons-compress:1.24.0' // I/O functionalities
   implementation 'org.apache.commons:commons-lang3:3.13.0'
 }
 

docs/readthedocs/requirements.txt

@@ -1,6 +1,6 @@
 commonmark==0.9.1
 recommonmark==0.7.1
-Sphinx==6.2.1
-sphinx-rtd-theme==1.2.2
+Sphinx==7.2.6
+sphinx-rtd-theme==1.3.0
 myst-parser==2.0.0
 markdown-it-py==3.0.0

gradle/scripts/documentation.gradle

@@ -1,5 +1,3 @@
-def docBaseDirPath = project.projectDir.toString() + File.separator + project.docsDirName.toString() + File.separator
-
 /*
  * Additional tasks, that are defined by default:
  *   - sphinx -> Generate HTML output of *.rst files in <projectDir>/docs/readthedocs
@@ -12,8 +10,8 @@ sphinx {
   description 'Generate high level HTML documentation output.'
   group 'Documentation'
 
-  sourceDirectory = "${docBaseDirPath}/readthedocs"
-  outputDirectory = "${project.buildDir}/docs/readthedocs"
+  sourceDirectory = "${project.projectDir}/docs/readthedocs"
+  outputDirectory = "${project.rootDir}/build/docs/readthedocs"
 }
 
 /**
@@ -54,8 +52,8 @@ task puml2png() {
         "build/plantuml.jar",
         "-psvg",
         "-o",
-        "${docBaseDirPath}readthedocs/_static/figures/uml/",
-        "${docBaseDirPath}uml/**/*.puml"
+        "${project.projectDir}/docs/readthedocs/_static/figures/uml/",
+        "${project.projectDir}/docs/uml/**/*.puml"
       ]
     }
   }

gradle/scripts/jacoco.gradle

@@ -3,16 +3,16 @@
 
 // general configuration
 jacoco {
-  toolVersion = "0.8.7"
-  reportsDir = file("$buildDir/reports/jacoco")
+  toolVersion = "0.8.10"
+  reportsDirectory = layout.projectDirectory.dir("$rootDir/build/reports/jacoco")
 }
 
 jacocoTestReport {
   reports {
-    xml.enabled true
-    csv.enabled false
-    html.enabled true
-    html.destination file("${buildDir}/reports/jacoco")
+    xml.required = true
+    csv.required = false
+    html.required = true
+    html.outputLocation = file("${rootDir}/build/reports/jacoco")
   }
 
   // what to exclude from coverage report (files that should not be analyzed!)
@@ -28,7 +28,7 @@ jacocoTestReport {
   ]
 
   getClassDirectories().setFrom(fileTree(
-      dir: "$buildDir/classes/",
+      dir: "$rootDir/build/classes/",
       excludes: excludes
       ))
 

gradle/scripts/mavenCentralPublish.gradle

@@ -1,11 +1,11 @@
 /* Maven publish - start */
 task sourcesJar(type: Jar) {
-  classifier "sources"
+  archiveClassifier.set("sources")
   from sourceSets.main.allJava
 }
 
 task javadocJar(type: Jar, dependsOn: javadoc) {
-  classifier "javadoc"
+  archiveClassifier.set("javadoc")
   from javadoc.destinationDir
 }
 
@@ -91,7 +91,7 @@ if (project.hasProperty('user') && project.hasProperty('password') && project.ha
 
   model {
     tasks.generatePomFileForMavenJavaPublication {
-      destination = file("$buildDir/generated-pom.xml")
+      destination = file("$rootDir/generated-pom.xml")
     }
   }
 }

gradle/scripts/spotless.gradle

@@ -20,14 +20,16 @@ spotless {
     licenseHeader ie3LicHead
     // the Groovy Eclipse formatter extends the Java Eclipse formatter,
     // so it formats Java files by default (unless `excludeJava` is used).
-    greclipse().configFile('greclipse.properties')
+    // FIXME rolled back greclipse version https://github.com/diffplug/spotless/issues/1860
+    greclipse('4.27').configFile('greclipse.properties')
     indentWithSpaces 2
   }
 
   groovyGradle {
     // same as groovy, but for .gradle (defaults to '*.gradle')
     target '*.gradle', 'gradle/scripts/*.gradle'
-    greclipse()
+    // FIXME rolled back greclipse version https://github.com/diffplug/spotless/issues/1860
+    greclipse('4.27')
     indentWithSpaces 2
   }
 

gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
-#Mon Dec 02 10:39:11 CET 2019
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists