From 1d73e4ed9ccb3dfb7709cb89957ed5bbcefad870 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Tue, 2 Feb 2021 09:05:21 +0100
Subject: [PATCH] Added the donation classes

ref #1
---
 src/models/DistanceDonation.ts | 40 ++++++++++++++++++++++++++++++++++
 src/models/Donation.ts         | 32 +++++++++++++++++++++++++++
 src/models/FixedDonation.ts    | 16 ++++++++++++++
 3 files changed, 88 insertions(+)
 create mode 100644 src/models/DistanceDonation.ts
 create mode 100644 src/models/Donation.ts
 create mode 100644 src/models/FixedDonation.ts

diff --git a/src/models/DistanceDonation.ts b/src/models/DistanceDonation.ts
new file mode 100644
index 0000000..a4e35e1
--- /dev/null
+++ b/src/models/DistanceDonation.ts
@@ -0,0 +1,40 @@
+import { IsInt, IsNotEmpty, IsObject, IsPositive } from "class-validator";
+import { Donation } from "./Donation";
+import { Runner } from "./Runner";
+
+/**
+ * Defines the DistanceDonation class.
+ * For distanceDonations a donor pledges to donate a certain amount for each kilometer ran by a runner.
+*/
+export class DistanceDonation extends Donation {
+  /**
+   * The donation's associated runner.
+   * Used as the source of the donation's distance.
+   */
+  @IsObject()
+  @IsNotEmpty()
+  runner: Runner;
+
+  /**
+   * The donation's amount donated per distance.
+   * The amount the donor set to be donated per kilometer that the runner ran.
+   */
+  @IsInt()
+  @IsPositive()
+  amountPerDistance: number;
+
+  /**
+   * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   * Get's calculated from the runner's distance ran and the amount donated per kilometer.
+   */
+  public get amount(): number {
+    let calculatedAmount = 0;
+    try {
+      calculatedAmount = this.amountPerDistance * (this.runner.distance / 1000);
+    } catch (error) {
+      throw error;
+    }
+    return calculatedAmount;
+  }
+
+}
diff --git a/src/models/Donation.ts b/src/models/Donation.ts
new file mode 100644
index 0000000..1beaf0c
--- /dev/null
+++ b/src/models/Donation.ts
@@ -0,0 +1,32 @@
+import {
+  IsInt,
+  IsNotEmpty,
+  IsObject
+} from "class-validator";
+import { Donor } from './Donor';
+
+/**
+ * Defines the Donation base calss.
+ * A donation just associates a donor with a donation amount.
+ * The specifics of the amoun's determination has to be implemented in child classes.
+*/
+export abstract class Donation {
+  /**
+   * Autogenerated unique id (primary key).
+   */
+  @IsInt()
+  id: number;
+
+  /**
+   * The donations's donor.
+   */
+  @IsNotEmpty()
+  @IsObject()
+  donor: Donor;
+
+  /**
+   * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   * The exact implementation may differ for each type of donation.
+   */
+  public abstract get amount(): number;
+}
\ No newline at end of file
diff --git a/src/models/FixedDonation.ts b/src/models/FixedDonation.ts
new file mode 100644
index 0000000..18c8a23
--- /dev/null
+++ b/src/models/FixedDonation.ts
@@ -0,0 +1,16 @@
+import { IsInt, IsPositive } from "class-validator";
+import { Donation } from "./Donation";
+
+/**
+ * Defines the FixedDonation entity.
+ * In the past there was no easy way to track fixed donations (eg. for creating donation receipts).
+*/
+export class FixedDonation extends Donation {
+
+  /**
+   * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   */
+  @IsInt()
+  @IsPositive()
+  amount: number;
+}
\ No newline at end of file