feature/split-up-postalAddress (#118)

Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/118
Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>

src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContact.java

@@ -54,8 +54,14 @@ public class HsOfficeContact implements Stringifyable, BaseEntity<HsOfficeContac
     @Column(name = "caption")
     private String caption;
 
+    @Builder.Default
+    @Setter(AccessLevel.NONE)
+    @Type(JsonType.class)
     @Column(name = "postaladdress")
-    private String postalAddress; // multiline free-format text
+    private Map<String, String> postalAddress = new HashMap<>();
+
+    @Transient
+    private PatchableMapWrapper<String> postalAddressWrapper;
 
     @Builder.Default
     @Setter(AccessLevel.NONE)
@@ -75,6 +81,17 @@ public class HsOfficeContact implements Stringifyable, BaseEntity<HsOfficeContac
     @Transient
     private PatchableMapWrapper<String> phoneNumbersWrapper;
 
+    public PatchableMapWrapper<String> getPostalAddress() {
+        return PatchableMapWrapper.of(
+                postalAddressWrapper,
+                (newWrapper) -> {postalAddressWrapper = newWrapper;},
+                postalAddress);
+    }
+
+    public void putPostalAddress(Map<String, String> newPostalAddress) {
+        getPostalAddress().assign(newPostalAddress);
+    }
+
     public PatchableMapWrapper<String> getEmailAddresses() {
         return PatchableMapWrapper.of(
                 emailAddressesWrapper,

src/main/java/net/hostsharing/hsadminng/hs/office/contact/HsOfficeContactEntityPatcher.java

@@ -18,7 +18,8 @@ class HsOfficeContactEntityPatcher implements EntityPatcher<HsOfficeContactPatch
     @Override
     public void apply(final HsOfficeContactPatchResource resource) {
         OptionalFromJson.of(resource.getCaption()).ifPresent(entity::setCaption);
-        OptionalFromJson.of(resource.getPostalAddress()).ifPresent(entity::setPostalAddress);
+        Optional.ofNullable(resource.getPostalAddress())
+                .ifPresent(r -> entity.getPostalAddress().patch(KeyValueMap.from(resource.getPostalAddress())));
         Optional.ofNullable(resource.getEmailAddresses())
                 .ifPresent(r -> entity.getEmailAddresses().patch(KeyValueMap.from(resource.getEmailAddresses())));
         Optional.ofNullable(resource.getPhoneNumbers())

src/main/java/net/hostsharing/hsadminng/hs/office/relation/HsOfficeRelationRbacRepository.java

@@ -47,7 +47,7 @@ public interface HsOfficeRelationRbacRepository extends Repository<HsOfficeRelat
                             OR lower(rel.anchor.givenName) LIKE :personData OR lower(rel.holder.givenName) LIKE :personData )
                     AND ( :contactData IS NULL
                             OR lower(rel.contact.caption) LIKE :contactData
-                            OR lower(rel.contact.postalAddress) LIKE :contactData
+                            OR lower(CAST(rel.contact.postalAddress AS String)) LIKE :contactData
                             OR lower(CAST(rel.contact.emailAddresses AS String)) LIKE :contactData
                             OR lower(CAST(rel.contact.phoneNumbers AS String)) LIKE :contactData )
             """)

src/main/resources/api-definition/hs-office/hs-office-contact-schemas.yaml

@@ -12,7 +12,7 @@ components:
                 caption:
                     type: string
                 postalAddress:
-                    type: string
+                    $ref: '#/components/schemas/HsOfficeContactPostalAddress'
                 emailAddresses:
                     $ref: '#/components/schemas/HsOfficeContactEmailAddresses'
                 phoneNumbers:
@@ -24,7 +24,7 @@ components:
                 caption:
                     type: string
                 postalAddress:
-                    type: string
+                    $ref: '#/components/schemas/HsOfficeContactPostalAddress'
                 emailAddresses:
                     $ref: '#/components/schemas/HsOfficeContactEmailAddresses'
                 phoneNumbers:
@@ -39,21 +39,48 @@ components:
                     type: string
                     nullable: true
                 postalAddress:
-                    type: string
-                    nullable: true
+                    $ref: '#/components/schemas/HsOfficeContactPostalAddress'
                 emailAddresses:
                     $ref: '#/components/schemas/HsOfficeContactEmailAddresses'
                 phoneNumbers:
                     $ref: '#/components/schemas/HsOfficeContactPhoneNumbers'
 
+        HsOfficeContactPostalAddress:
+            # forces generating a java.lang.Object containing a Map, instead of a class with fixed properties
+            anyOf:
+                - type: object
+                  properties:
+                      firm:
+                          type: string
+                          nullable: true
+                      name:
+                          type: string
+                          nullable: true
+                      co:
+                          type: string
+                          nullable: true
+                      street:
+                          type: string
+                          nullable: true
+                      zipcode:
+                          type: string
+                          nullable: true
+                      city:
+                          type: string
+                          nullable: true
+                      country:
+                          type: string
+                          nullable: true
+                  additionalProperties: true
+
         HsOfficeContactEmailAddresses:
-            # forces generating a java.lang.Object containing a Map, instead of class HsOfficeContactEmailAddresses
+            # forces generating a java.lang.Object containing a Map, instead of a class with fixed properties
             anyOf:
                 - type: object
                   additionalProperties: true
 
         HsOfficeContactPhoneNumbers:
-            # forces generating a java.lang.Object containing a Map, instead of class HsOfficeContactEmailAddresses
+            # forces generating a java.lang.Object containing a Map, instead of a class with fixed properties
             anyOf:
                 - type: object
                   properties:

src/main/resources/db/changelog/5-hs-office/501-contact/5010-hs-office-contact.sql

@@ -9,7 +9,7 @@ create table if not exists hs_office.contact
     uuid           uuid unique references rbac.object (uuid) initially deferred,
     version        int not null default 0,
     caption        varchar(128) not null,
-    postalAddress  text,
+    postalAddress  jsonb not null,
     emailAddresses jsonb not null,
     phoneNumbers   jsonb not null
 );

src/main/resources/db/changelog/5-hs-office/501-contact/5018-hs-office-contact-test-data.sql

@@ -11,7 +11,6 @@
 create or replace procedure hs_office.contact_create_test_data(contCaption varchar)
     language plpgsql as $$
 declare
-    postalAddr      varchar;
     emailAddr       varchar;
 begin
     emailAddr = 'contact-admin@' || base.cleanIdentifier(contCaption) || '.example.com';
@@ -19,14 +18,18 @@ begin
     perform rbac.create_subject(emailAddr);
     call base.defineContext('creating contact test-data', null, emailAddr);
 
-    postalAddr := E'Vorname Nachname\nStraße Hnr\nPLZ Stadt';
-
     raise notice 'creating test contact: %', contCaption;
     insert
         into hs_office.contact (caption, postaladdress, emailaddresses, phonenumbers)
         values (
             contCaption,
-            postalAddr,
+            ( '{ ' ||
+--                 '"name": "' || contCaption || '",' ||
+--                 '"street": "Somewhere 1",' ||
+--                 '"zipcode": "12345",' ||
+--                 '"city": "Where-Ever",' ||
+                '"country": "Germany"' ||
+              '}')::jsonb,
             ('{ "main": "' || emailAddr || '" }')::jsonb,
             ('{ "phone_office": "+49 123 1234567" }')::jsonb
         );