From eebf7baae64ff281e172cc2da53728497dbf8541 Mon Sep 17 00:00:00 2001
From: Jonah Lawrence <jonah@freshidea.com>
Date: Tue, 10 Dec 2024 11:41:24 +0200
Subject: [PATCH 1/4] Add the option to use short form for the Total
 Contributions count

Add the option to display the Total Contributions count in short form.

* Add a new parameter `short_total_contributions` to the `generateCard` function in `src/card.php` with a default value of `false`.
* Implement a `shortNumber` function in `src/card.php` to convert large numbers into short form.
* Update the `generateCard` function in `src/card.php` to use the `shortNumber` function if `short_total_contributions` is `true`.
* Use the `shortNumber` function for current streak and longest streak if `short_total_contributions` is `true`.
* Add a new input field for `short_total_contributions` in the form in `src/demo/index.php`.
* Add a test case for the new `short_total_contributions` parameter in `tests/RenderTest.php`.
---
 src/card.php         | 27 ++++++++++++++++++++++++---
 src/demo/index.php   |  8 +++++++-
 tests/RenderTest.php |  5 +++++
 3 files changed, 36 insertions(+), 4 deletions(-)

diff --git a/src/card.php b/src/card.php
index 3e4cf61d..b0922631 100644
--- a/src/card.php
+++ b/src/card.php
@@ -335,6 +335,21 @@ function getCardHeight(array $params): int
     return max($minimumHeight, intval($params["card_height"] ?? $defaultHeight));
 }
 
+/**
+ * Convert large numbers into short form
+ *
+ * @param float $num The number to convert
+ * @return string The number in short form
+ */
+function shortNumber(float $num): string
+{
+    $units = ['', 'K', 'M', 'B', 'T'];
+    for ($i = 0; $num >= 1000; $i++) {
+        $num /= 1000;
+    }
+    return round($num, 1) . $units[$i];
+}
+
 /**
  * Generate SVG output for a stats array
  *
@@ -418,12 +433,16 @@ function generateCard(array $stats, array $params = null): string
     ];
 
     // total contributions
-    $totalContributions = $numFormatter->format($stats["totalContributions"]);
+    $totalContributions = $params["short_total_contributions"] === "true"
+        ? shortNumber($stats["totalContributions"])
+        : $numFormatter->format($stats["totalContributions"]);
     $firstContribution = formatDate($stats["firstContribution"], $dateFormat, $localeCode);
     $totalContributionsRange = $firstContribution . " - " . $localeTranslations["Present"];
 
     // current streak
-    $currentStreak = $numFormatter->format($stats["currentStreak"]["length"]);
+    $currentStreak = $params["short_total_contributions"] === "true"
+        ? shortNumber($stats["currentStreak"]["length"])
+        : $numFormatter->format($stats["currentStreak"]["length"]);
     $currentStreakStart = formatDate($stats["currentStreak"]["start"], $dateFormat, $localeCode);
     $currentStreakEnd = formatDate($stats["currentStreak"]["end"], $dateFormat, $localeCode);
     $currentStreakRange = $currentStreakStart;
@@ -432,7 +451,9 @@ function generateCard(array $stats, array $params = null): string
     }
 
     // longest streak
-    $longestStreak = $numFormatter->format($stats["longestStreak"]["length"]);
+    $longestStreak = $params["short_total_contributions"] === "true"
+        ? shortNumber($stats["longestStreak"]["length"])
+        : $numFormatter->format($stats["longestStreak"]["length"]);
     $longestStreakStart = formatDate($stats["longestStreak"]["start"], $dateFormat, $localeCode);
     $longestStreakEnd = formatDate($stats["longestStreak"]["end"], $dateFormat, $localeCode);
     $longestStreakRange = $longestStreakStart;
diff --git a/src/demo/index.php b/src/demo/index.php
index 4a0df44f..ed68ee2f 100644
--- a/src/demo/index.php
+++ b/src/demo/index.php
@@ -173,6 +173,12 @@ function gtag() {
                 <label for="card-width">Card Height</label>
                 <input class="param" type="number" id="card-width" name="card_height" placeholder="195" value="195" step="1" min="170" />
 
+                <label for="short-total-contributions">Short Total Contributions</label>
+                <select class="param" id="short-total-contributions" name="short_total_contributions">
+                    <option>false</option>
+                    <option>true</option>
+                </select>
+
                 <label for="type">Output Type</label>
                 <select class="param" id="type" name="type">
                     <option value="svg">SVG</option>
@@ -279,4 +285,4 @@ function gtag() {
     </a>
 </body>
 
-</html>
\ No newline at end of file
+</html>
diff --git a/tests/RenderTest.php b/tests/RenderTest.php
index 0649213c..c74a8c94 100644
--- a/tests/RenderTest.php
+++ b/tests/RenderTest.php
@@ -49,6 +49,11 @@ public function testCardRender(): void
         $render = generateCard($this->testStats, $this->testParams);
         $expected = file_get_contents("tests/expected/test_card.svg");
         $this->assertEquals($expected, $render);
+
+        // Test short_total_contributions parameter
+        $this->testParams["short_total_contributions"] = "true";
+        $render = generateCard($this->testStats, $this->testParams);
+        $this->assertStringContainsString("2K", $render);
     }
 
     /**

From a25fb360aa84e21aeba20e1c43bcf5dee309b3b1 Mon Sep 17 00:00:00 2001
From: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Date: Tue, 10 Dec 2024 09:41:46 +0000
Subject: [PATCH 2/4] style: Formatted code with Prettier

---
 src/card.php | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/src/card.php b/src/card.php
index b0922631..8aee11b8 100644
--- a/src/card.php
+++ b/src/card.php
@@ -343,7 +343,7 @@ function getCardHeight(array $params): int
  */
 function shortNumber(float $num): string
 {
-    $units = ['', 'K', 'M', 'B', 'T'];
+    $units = ["", "K", "M", "B", "T"];
     for ($i = 0; $num >= 1000; $i++) {
         $num /= 1000;
     }
@@ -433,16 +433,18 @@ function generateCard(array $stats, array $params = null): string
     ];
 
     // total contributions
-    $totalContributions = $params["short_total_contributions"] === "true"
-        ? shortNumber($stats["totalContributions"])
-        : $numFormatter->format($stats["totalContributions"]);
+    $totalContributions =
+        $params["short_total_contributions"] === "true"
+            ? shortNumber($stats["totalContributions"])
+            : $numFormatter->format($stats["totalContributions"]);
     $firstContribution = formatDate($stats["firstContribution"], $dateFormat, $localeCode);
     $totalContributionsRange = $firstContribution . " - " . $localeTranslations["Present"];
 
     // current streak
-    $currentStreak = $params["short_total_contributions"] === "true"
-        ? shortNumber($stats["currentStreak"]["length"])
-        : $numFormatter->format($stats["currentStreak"]["length"]);
+    $currentStreak =
+        $params["short_total_contributions"] === "true"
+            ? shortNumber($stats["currentStreak"]["length"])
+            : $numFormatter->format($stats["currentStreak"]["length"]);
     $currentStreakStart = formatDate($stats["currentStreak"]["start"], $dateFormat, $localeCode);
     $currentStreakEnd = formatDate($stats["currentStreak"]["end"], $dateFormat, $localeCode);
     $currentStreakRange = $currentStreakStart;
@@ -451,9 +453,10 @@ function generateCard(array $stats, array $params = null): string
     }
 
     // longest streak
-    $longestStreak = $params["short_total_contributions"] === "true"
-        ? shortNumber($stats["longestStreak"]["length"])
-        : $numFormatter->format($stats["longestStreak"]["length"]);
+    $longestStreak =
+        $params["short_total_contributions"] === "true"
+            ? shortNumber($stats["longestStreak"]["length"])
+            : $numFormatter->format($stats["longestStreak"]["length"]);
     $longestStreakStart = formatDate($stats["longestStreak"]["start"], $dateFormat, $localeCode);
     $longestStreakEnd = formatDate($stats["longestStreak"]["end"], $dateFormat, $localeCode);
     $longestStreakRange = $longestStreakStart;

From 5cd233baf95fc64717097030ca8511f7391a0e87 Mon Sep 17 00:00:00 2001
From: Jonah Lawrence <jonah@freshidea.com>
Date: Tue, 10 Dec 2024 12:03:40 +0200
Subject: [PATCH 3/4] short number format

---
 src/card.php          | 32 ++++++++++++++++++--------------
 src/demo/index.php    | 12 ++++++------
 src/demo/js/script.js |  1 +
 tests/RenderTest.php  |  4 ++--
 4 files changed, 27 insertions(+), 22 deletions(-)

diff --git a/src/card.php b/src/card.php
index 8aee11b8..4d455c4a 100644
--- a/src/card.php
+++ b/src/card.php
@@ -339,15 +339,20 @@ function getCardHeight(array $params): int
  * Convert large numbers into short form
  *
  * @param float $num The number to convert
+ * @param NumberFormatter $numFormatter Number formatter
  * @return string The number in short form
  */
-function shortNumber(float $num): string
+function shortNumber(float $num, NumberFormatter $numFormatter = null): string
 {
     $units = ["", "K", "M", "B", "T"];
     for ($i = 0; $num >= 1000; $i++) {
         $num /= 1000;
     }
-    return round($num, 1) . $units[$i];
+    $numeric = round($num, 1);
+    if ($numFormatter) {
+        $numeric = $numFormatter->format($numeric);
+    }
+    return $numeric . $units[$i];
 }
 
 /**
@@ -432,19 +437,19 @@ function generateCard(array $stats, array $params = null): string
         19.5 + $heightOffset,
     ];
 
+    $useShortNumbers = ($params["short_numbers"] ?? "") === "true";
+
     // total contributions
-    $totalContributions =
-        $params["short_total_contributions"] === "true"
-            ? shortNumber($stats["totalContributions"])
-            : $numFormatter->format($stats["totalContributions"]);
+    $totalContributions = $useShortNumbers
+        ? shortNumber($stats["totalContributions"], $numFormatter)
+        : $numFormatter->format($stats["totalContributions"]);
     $firstContribution = formatDate($stats["firstContribution"], $dateFormat, $localeCode);
     $totalContributionsRange = $firstContribution . " - " . $localeTranslations["Present"];
 
     // current streak
-    $currentStreak =
-        $params["short_total_contributions"] === "true"
-            ? shortNumber($stats["currentStreak"]["length"])
-            : $numFormatter->format($stats["currentStreak"]["length"]);
+    $currentStreak = $useShortNumbers
+        ? shortNumber($stats["currentStreak"]["length"], $numFormatter)
+        : $numFormatter->format($stats["currentStreak"]["length"]);
     $currentStreakStart = formatDate($stats["currentStreak"]["start"], $dateFormat, $localeCode);
     $currentStreakEnd = formatDate($stats["currentStreak"]["end"], $dateFormat, $localeCode);
     $currentStreakRange = $currentStreakStart;
@@ -453,10 +458,9 @@ function generateCard(array $stats, array $params = null): string
     }
 
     // longest streak
-    $longestStreak =
-        $params["short_total_contributions"] === "true"
-            ? shortNumber($stats["longestStreak"]["length"])
-            : $numFormatter->format($stats["longestStreak"]["length"]);
+    $longestStreak = $useShortNumbers
+        ? shortNumber($stats["longestStreak"]["length"], $numFormatter)
+        : $numFormatter->format($stats["longestStreak"]["length"]);
     $longestStreakStart = formatDate($stats["longestStreak"]["start"], $dateFormat, $localeCode);
     $longestStreakEnd = formatDate($stats["longestStreak"]["end"], $dateFormat, $localeCode);
     $longestStreakRange = $longestStreakStart;
diff --git a/src/demo/index.php b/src/demo/index.php
index ed68ee2f..62f02c4e 100644
--- a/src/demo/index.php
+++ b/src/demo/index.php
@@ -120,6 +120,12 @@ function gtag() {
                     <?php endforeach; ?>
                 </select>
 
+                <label for="short-numbers">Short Numbers</label>
+                <select class="param" id="short-numbers" name="short_numbers">
+                    <option>false</option>
+                    <option>true</option>
+                </select>
+
                 <label for="date-format">Date Format</label>
                 <select class="param" id="date-format" name="date_format">
                     <option value="">default</option>
@@ -173,12 +179,6 @@ function gtag() {
                 <label for="card-width">Card Height</label>
                 <input class="param" type="number" id="card-width" name="card_height" placeholder="195" value="195" step="1" min="170" />
 
-                <label for="short-total-contributions">Short Total Contributions</label>
-                <select class="param" id="short-total-contributions" name="short_total_contributions">
-                    <option>false</option>
-                    <option>true</option>
-                </select>
-
                 <label for="type">Output Type</label>
                 <select class="param" id="type" name="type">
                     <option value="svg">SVG</option>
diff --git a/src/demo/js/script.js b/src/demo/js/script.js
index 7ca85e53..8239318a 100644
--- a/src/demo/js/script.js
+++ b/src/demo/js/script.js
@@ -19,6 +19,7 @@ const preview = {
     hide_total_contributions: "false",
     hide_current_streak: "false",
     hide_longest_streak: "false",
+    short_numbers: "false",
   },
 
   /**
diff --git a/tests/RenderTest.php b/tests/RenderTest.php
index c74a8c94..a551736a 100644
--- a/tests/RenderTest.php
+++ b/tests/RenderTest.php
@@ -50,8 +50,8 @@ public function testCardRender(): void
         $expected = file_get_contents("tests/expected/test_card.svg");
         $this->assertEquals($expected, $render);
 
-        // Test short_total_contributions parameter
-        $this->testParams["short_total_contributions"] = "true";
+        // Test short_numbers parameter
+        $this->testParams["short_numbers"] = "true";
         $render = generateCard($this->testStats, $this->testParams);
         $this->assertStringContainsString("2K", $render);
     }

From d63393995f02bdf2f5276900a96f7bd6211b1b65 Mon Sep 17 00:00:00 2001
From: Jonah Lawrence <jonah@freshidea.com>
Date: Tue, 10 Dec 2024 12:16:50 +0200
Subject: [PATCH 4/4] refactor format number

---
 src/card.php | 44 +++++++++++++++++++-------------------------
 1 file changed, 19 insertions(+), 25 deletions(-)

diff --git a/src/card.php b/src/card.php
index 4d455c4a..256cb844 100644
--- a/src/card.php
+++ b/src/card.php
@@ -336,23 +336,26 @@ function getCardHeight(array $params): int
 }
 
 /**
- * Convert large numbers into short form
+ * Format number using locale and short number if requested
  *
- * @param float $num The number to convert
- * @param NumberFormatter $numFormatter Number formatter
- * @return string The number in short form
+ * @param float $num The number to format
+ * @param string $localeCode Locale code
+ * @param bool $useShortNumbers Whether to use short numbers
+ * @return string The formatted number
  */
-function shortNumber(float $num, NumberFormatter $numFormatter = null): string
+function formatNumber(float $num, string $localeCode, bool $useShortNumbers): string
 {
-    $units = ["", "K", "M", "B", "T"];
-    for ($i = 0; $num >= 1000; $i++) {
-        $num /= 1000;
-    }
-    $numeric = round($num, 1);
-    if ($numFormatter) {
-        $numeric = $numFormatter->format($numeric);
+    $numFormatter = new NumberFormatter($localeCode, NumberFormatter::DECIMAL);
+    $suffix = "";
+    if ($useShortNumbers) {
+        $units = ["", "K", "M", "B", "T"];
+        for ($i = 0; $num >= 1000; $i++) {
+            $num /= 1000;
+        }
+        $suffix = $units[$i];
+        $num = round($num, 1);
     }
-    return $numeric . $units[$i];
+    return $numFormatter->format($num) . $suffix;
 }
 
 /**
@@ -382,9 +385,6 @@ function generateCard(array $stats, array $params = null): string
     // locale date formatter (used only if date_format is not specified)
     $dateFormat = $params["date_format"] ?? ($localeTranslations["date_format"] ?? null);
 
-    // number formatter
-    $numFormatter = new NumberFormatter($localeCode, NumberFormatter::DECIMAL);
-
     // read border_radius parameter, default to 4.5 if not set
     $borderRadius = $params["border_radius"] ?? 4.5;
 
@@ -440,16 +440,12 @@ function generateCard(array $stats, array $params = null): string
     $useShortNumbers = ($params["short_numbers"] ?? "") === "true";
 
     // total contributions
-    $totalContributions = $useShortNumbers
-        ? shortNumber($stats["totalContributions"], $numFormatter)
-        : $numFormatter->format($stats["totalContributions"]);
+    $totalContributions = formatNumber($stats["totalContributions"], $localeCode, $useShortNumbers);
     $firstContribution = formatDate($stats["firstContribution"], $dateFormat, $localeCode);
     $totalContributionsRange = $firstContribution . " - " . $localeTranslations["Present"];
 
     // current streak
-    $currentStreak = $useShortNumbers
-        ? shortNumber($stats["currentStreak"]["length"], $numFormatter)
-        : $numFormatter->format($stats["currentStreak"]["length"]);
+    $currentStreak = formatNumber($stats["currentStreak"]["length"], $localeCode, $useShortNumbers);
     $currentStreakStart = formatDate($stats["currentStreak"]["start"], $dateFormat, $localeCode);
     $currentStreakEnd = formatDate($stats["currentStreak"]["end"], $dateFormat, $localeCode);
     $currentStreakRange = $currentStreakStart;
@@ -458,9 +454,7 @@ function generateCard(array $stats, array $params = null): string
     }
 
     // longest streak
-    $longestStreak = $useShortNumbers
-        ? shortNumber($stats["longestStreak"]["length"], $numFormatter)
-        : $numFormatter->format($stats["longestStreak"]["length"]);
+    $longestStreak = formatNumber($stats["longestStreak"]["length"], $localeCode, $useShortNumbers);
     $longestStreakStart = formatDate($stats["longestStreak"]["start"], $dateFormat, $localeCode);
     $longestStreakEnd = formatDate($stats["longestStreak"]["end"], $dateFormat, $localeCode);
     $longestStreakRange = $longestStreakStart;