validate ProjectSpace names (#249)

* validate ProjectSpace names

Co-authored-by: Sven F. <sven.fillinger@qbic.uni-tuebingen.de>

Author: wow-such-code

CHANGELOG.rst

@@ -13,8 +13,11 @@ This project adheres to `Semantic Versioning <https://semver.org/>`_.
 * New properties ``internalUnitPrice``, ``externalUnitPrice`` and ``serviceProvider`` for the ``life.qbic.datamodel.dtos.business.services.Product`` and its derivatives (`#245 <https://github.com/qbicsoftware/data-model-lib/pull/245>`_)
 * New properties ``totalPrice`` and ``totalDiscountPrice`` for the ``life.qbic.datamodel.dtos.business.ProductItem`` and ``totalDiscountPrice`` for the ``life.qbic.datamodel.dtos.business.Offer``
 * A ``life.qbic.datamodel.dtos.business.facilities.FacilityFactory`` to get the facility for a given string representation (`#247 <https://github.com/qbicsoftware/data-model-lib/pull/247>`_)
+
 **Fixed**
 
+* ProjectSpace names are now validated (`#249 <https://github.com/qbicsoftware/data-model-lib/pull/249>`_)
+
 **Dependencies**
 
 **Deprecated**

src/main/groovy/life/qbic/datamodel/dtos/projectmanagement/ProjectSpace.groovy

@@ -23,11 +23,24 @@ final class ProjectSpace {
      */
     final String name
 
+    /**
+     * Alphanumerical characters, underscores and '-' allowed, German umlauts will lead to a mismatch
+     */
+    private static final def SPACE_NAME_REGEX = ~'[-\\w]+'
+
     ProjectSpace(String name) {
         final def space = Objects.requireNonNull(name, "Space name must not be null.")
+        validateName(name)
         this.name = formatSpaceName(space)
     }
 
+    private void validateName(String name) {
+        // validation happens with the formatted name, but the input name must be returned so the user does not get confused
+        if(! SPACE_NAME_REGEX.matcher(formatSpaceName(name)).matches()) {
+            throw new IllegalArgumentException("${name} is not a valid project code.")
+        }
+    }
+
     private static String formatSpaceName(String name) {
         def capitalizedName = name.trim().toUpperCase()
         def refactoredName = capitalizedName.replaceAll("\\s+", "_")

src/test/groovy/life/qbic/datamodel/dtos/projectmanagement/ProjectSpaceSpec.groovy

@@ -20,6 +20,18 @@ class ProjectSpaceSpec extends Specification {
         space.name.equals("MY_NEW_SPACE")
     }
 
+    def "A String violating the space name format standard shall throw an IllegalArgumentException" () {
+        given:
+        String invalidCode = "Plausibilitätsüberprüfungs_Space"
+
+        when:
+        new ProjectSpace(invalidCode)
+
+        then:
+        thrown(IllegalArgumentException)
+
+    }
+
     def "Dashes are replaced by underscores"() {
         given:
         String projectSpaceName = "my-new-space"