coop-shares-transaction-reverse-entry (#40)

Co-authored-by: Marc O. Sandlus <marc.o.sandlus@hostsharing.net>
Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/40
Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>

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

@@ -27,6 +27,31 @@ components:
                     type: string
                 comment:
                     type: string
+                adjustedShareTx:
+                    $ref: '#/components/schemas/HsOfficeReferencedCoopSharesTransaction'
+                adjustmentShareTx:
+                    $ref: '#/components/schemas/HsOfficeReferencedCoopSharesTransaction'
+
+        HsOfficeReferencedCoopSharesTransaction:
+            description:
+                Similar to `HsOfficeCoopSharesTransaction` but without the self-referencing properties
+                (`adjustedShareTx` and `adjustmentShareTx`), to avoid recursive JSON.
+            type: object
+            properties:
+                uuid:
+                    type: string
+                    format: uuid
+                transactionType:
+                    $ref: '#/components/schemas/HsOfficeCoopSharesTransactionType'
+                shareCount:
+                    type: integer
+                valueDate:
+                    type: string
+                    format: date
+                reference:
+                    type: string
+                comment:
+                    type: string
 
         HsOfficeCoopSharesTransactionInsert:
             type: object
@@ -48,6 +73,9 @@ components:
                     maxLength: 48
                 comment:
                     type: string
+                adjustedShareTxUuid:
+                    type: string
+                    format: uuid
             required:
                 - membershipUuid
                 - transactionType

src/main/resources/db/changelog/5-hs-office/511-coopshares/5110-hs-office-coopshares.sql

@@ -15,12 +15,23 @@ create table if not exists hs_office_coopsharestransaction
     membershipUuid  uuid not null references hs_office_membership(uuid),
     transactionType HsOfficeCoopSharesTransactionType not null,
     valueDate       date not null,
-    shareCount      integer,
-    reference       varchar(48),
+    shareCount      integer not null,
+    reference       varchar(48) not null,
+    adjustedShareTxUuid uuid unique REFERENCES hs_office_coopsharestransaction(uuid) DEFERRABLE INITIALLY DEFERRED,
     comment         varchar(512)
 );
 --//
 
+-- ============================================================================
+--changeset hs-office-coopshares-BUSINESS-RULES:1 endDelimiter:--//
+-- ----------------------------------------------------------------------------
+
+alter table hs_office_coopsharestransaction
+    add constraint hs_office_coopsharestransaction_reverse_entry_missing
+        check ( transactionType = 'ADJUSTMENT' and adjustedShareTxUuid is not null
+             or transactionType <> 'ADJUSTMENT' and adjustedShareTxUuid is null);
+--//
+
 -- ============================================================================
 --changeset hs-office-coopshares-SHARE-COUNT-CONSTRAINT:1 endDelimiter:--//
 -- ----------------------------------------------------------------------------

src/main/resources/db/changelog/5-hs-office/511-coopshares/5118-hs-office-coopshares-test-data.sql

@@ -14,11 +14,13 @@ create or replace procedure createHsOfficeCoopSharesTransactionTestData(
 )
     language plpgsql as $$
 declare
-    currentTask     varchar;
-    membership      hs_office_membership;
+    currentTask             varchar;
+    membership              hs_office_membership;
+    subscriptionEntryUuid   uuid;
 begin
     currentTask = 'creating coopSharesTransaction test-data ' || givenPartnerNumber::text || givenMemberNumberSuffix;
     execute format('set local hsadminng.currentTask to %L', currentTask);
+    SET CONSTRAINTS ALL DEFERRED;
 
     call defineContext(currentTask);
     select m.uuid
@@ -29,12 +31,14 @@ begin
         into membership;
 
     raise notice 'creating test coopSharesTransaction: %', givenPartnerNumber::text || givenMemberNumberSuffix;
+    subscriptionEntryUuid := uuid_generate_v4();
     insert
-        into hs_office_coopsharestransaction(uuid, membershipuuid, transactiontype, valuedate, sharecount, reference, comment)
+        into hs_office_coopsharestransaction(uuid, membershipuuid, transactiontype, valuedate, sharecount, reference, comment, adjustedShareTxUuid)
         values
-            (uuid_generate_v4(), membership.uuid, 'SUBSCRIPTION', '2010-03-15', 4, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-1', 'initial subscription'),
-            (uuid_generate_v4(), membership.uuid, 'CANCELLATION', '2021-09-01', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-2', 'cancelling some'),
-            (uuid_generate_v4(), membership.uuid, 'ADJUSTMENT', '2022-10-20', 2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-3', 'some adjustment');
+            (uuid_generate_v4(), membership.uuid, 'SUBSCRIPTION', '2010-03-15', 4, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-1', 'initial subscription', null),
+            (uuid_generate_v4(), membership.uuid, 'CANCELLATION', '2021-09-01', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-2', 'cancelling some', null),
+            (subscriptionEntryUuid,       membership.uuid, 'SUBSCRIPTION',    '2022-10-20',  2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-3', 'some subscription', null),
+            (uuid_generate_v4(), membership.uuid, 'ADJUSTMENT', '2022-10-21', -2, 'ref '||givenPartnerNumber::text || givenMemberNumberSuffix||'-4', 'some adjustment', subscriptionEntryUuid);
 end; $$;
 --//