Update behavior of recent-xp stats type ⬆

Minor refactoring making addition of stats types easier
More consistent formats for types
Closes #2

Author: aksh1618

README.md

@@ -34,25 +34,28 @@
 
 - **STATS_TYPE:** (Optional) Type of stats, supported values:
 
-  - `level-xp`: (Default) Show total and language XPs with level:
+  - `level-xp`: (Default) Shows total and language XPs with level, sorted by XP:
 
       ```none
-      Total XP :::::::::::::::::::::: lvl  25 [1,020,821 XP]
-      Java :::::::::::::::::::::::::: lvl  17 [  512,366 XP]
+      💻 My Code::Stats XP (Top Languages)
+      Total XP :::::::::::::::::::::: lvl  26 (1,104,152 XP)
+      Java :::::::::::::::::::::::::: lvl  19 (  580,523 XP)
       ```
 
-  - `recent-xp`: Shows the past week in total as well as language wise recent XP:
+  - `recent-xp`: Shows total and language XPs with level and recent xp, sorted by recent XP:
 
       ```none
-      Total XP :::::::::::::::: 998,967 + 21,854 (past week)
-      Java :::::::::::::::::::::::::: 511,969 + 397 (new xp)
+      💻 My Code::Stats XP (Recent Languages)
+      Total XP ::::::::::::: lvl  26 (1,104,152 XP) (+1,874)
+      Python ::::::::::::::: lvl   7 (   82,719 XP) (+1,789)
       ```
 
-  - `xp`: Skips the recent stats (the parts after the ` +`) and shows just the aggregate total and language XPs:
+  - `xp`: Shows total and language XPs, sorted by XP:
 
       ```none
-      Total XP ::::::::::::::::::::::::::::::::::: 1,020,821
-      Java ::::::::::::::::::::::::::::::::::::::::: 512,366
+      💻 My Code::Stats XP (Top Languages)
+      Total XP :::::::::::::::::::::::::::::::: 1,104,152 XP
+      Java ::::::::::::::::::::::::::::::::::::   580,523 XP
       ```
 
   (This can also be put directly in `.github/workflows/codestats.yml`)

codestats_box.py

@@ -1,23 +1,48 @@
-from collections import namedtuple
 import datetime
 import math
 import os
 import sys
-from typing import Any, Dict, List
-from github.InputFileContent import InputFileContent
+from collections import namedtuple
+from itertools import takewhile
+from typing import Any, Callable, Dict, List
 
 import requests
 from github import Github
+from github.InputFileContent import InputFileContent
+
+TitleAndValue = namedtuple("TitleAndValue", "title value")
+
+STATS_TYPE_LEVEL = "level-xp"
+STATS_TYPE_RECENT_XP = "recent-xp"
+STATS_TYPE_XP = "xp"
+ALLOWED_STATS_TYPES = [
+    STATS_TYPE_RECENT_XP,
+    STATS_TYPE_XP,
+    STATS_TYPE_LEVEL,
+]
+DEFAULT_STATS_TYPE = STATS_TYPE_LEVEL
 
 TOP_LANGUAGES_COUNT = 10
+MAX_LINE_LENGTH = 54
 WIDTH_JUSTIFICATION_SEPARATOR = ":"
 RECENT_STATS_SEPARATOR = " + "
 TOTAL_XP_TITLE = "Total XP"
-PAST_WEEK_SUFFIX_STRING = " (past week)"
-NEW_XP_SUFFIX_STRING = " (new xp)"
-LEVEL_STRING_FORMAT = "lvl {level:>3} [{xp:>9,} XP]"
-GIST_TITLE = "💻 My Code::Stats XP"
-MAX_LINE_LENGTH = 54
+VALUE_FORMAT = {
+    STATS_TYPE_LEVEL: "lvl {level:>3} ({xp:>9,} XP)",
+    STATS_TYPE_RECENT_XP: "lvl {level:>3} ({xp:>9,} XP) (+{recent_xp:>5,})",
+    STATS_TYPE_XP: "{xp:>9,} XP",
+}
+GIST_TITLE = {
+    STATS_TYPE_LEVEL: "💻 My Code::Stats XP (Top Languages)",
+    STATS_TYPE_RECENT_XP: "💻 My Code::Stats XP (Recent Languages)",
+    STATS_TYPE_XP: "💻 My Code::Stats XP (Top Languages)",
+}
+NO_RECENT_XP_LINES = [
+    TitleAndValue("Not been coding recently", "🙈"),
+    TitleAndValue("Probably busy with something else", "🗓"),
+    TitleAndValue("Or just taking a break", "🌴"),
+    TitleAndValue("But would be back to it soon!", "🤓"),
+]
 
 ENV_VAR_GIST_ID = "GIST_ID"
 ENV_VAR_GITHUB_TOKEN = "GH_TOKEN"
@@ -29,27 +54,16 @@
     ENV_VAR_CODE_STATS_USERNAME,
 ]
 
-STATS_TYPE_RECENT_XP = "recent-xp"
-STATS_TYPE_XP = "xp"
-STATS_TYPE_LEVEL = "level-xp"
-ALLOWED_STATS_TYPES = [
-    STATS_TYPE_RECENT_XP,
-    STATS_TYPE_XP,
-    STATS_TYPE_LEVEL,
-]
-DEFAULT_STATS_TYPE = STATS_TYPE_LEVEL
-
 CODE_STATS_URL_FORMAT = "https://codestats.net/api/users/{user}"
 CODE_STATS_DATE_KEY = "dates"
 CODE_STATS_TOTAL_XP_KEY = "total_xp"
+CODE_STATS_TOTAL_NEW_XP_KEY = "new_xp"
 CODE_STATS_LANGUAGES_KEY = "languages"
 CODE_STATS_LANGUAGES_XP_KEY = "xps"
 CODE_STATS_LANGUAGES_NEW_XP_KEY = "new_xps"
 
 XP_TO_LEVEL = lambda xp: math.floor(0.025 * math.sqrt(xp))
 
-TitleAndValue = namedtuple("TitleAndValue", "title value")
-
 
 def validate_and_init() -> bool:
     env_vars_absent = [
@@ -72,86 +86,89 @@ def validate_and_init() -> bool:
     return True
 
 
-def get_adjusted_line(title_and_value: TitleAndValue) -> str:
-    separation = MAX_LINE_LENGTH - (
-        len(title_and_value.title) + len(title_and_value.value) + 2
-    )
-    separator = f" {WIDTH_JUSTIFICATION_SEPARATOR * separation} "
-    return title_and_value.title + separator + title_and_value.value
-
-
 def get_code_stats_response(user: str) -> Dict[str, Any]:
     return requests.get(CODE_STATS_URL_FORMAT.format(user=user)).json()
 
 
+def __get_formatted_value(
+    xp: int, recent_xp_supplier: Callable[[], int], stats_type: str
+) -> str:
+    value_format = VALUE_FORMAT[stats_type]
+    if stats_type == STATS_TYPE_LEVEL:
+        return value_format.format(level=XP_TO_LEVEL(xp), xp=xp)
+    elif stats_type == STATS_TYPE_RECENT_XP:
+        recent_xp = recent_xp_supplier()
+        formatted_value = value_format.format(
+            level=XP_TO_LEVEL(xp), xp=xp, recent_xp=recent_xp
+        )
+        return formatted_value if recent_xp > 0 else formatted_value[:-9]
+    elif stats_type == STATS_TYPE_XP:
+        return value_format.format(xp=xp)
+    raise RuntimeError(f"Unknown stats type {stats_type}")
+
+
 def get_total_xp_line(
     code_stats_response: Dict[str, Any], stats_type: str
 ) -> TitleAndValue:
-    last_seven_days = [
-        str(datetime.date.today() - datetime.timedelta(days=i)) for i in range(7)
-    ]
-    last_seven_days_xp = sum(
-        [
-            code_stats_response[CODE_STATS_DATE_KEY][day]
-            for day in last_seven_days
-            if day in code_stats_response[CODE_STATS_DATE_KEY]
-        ]
-    )
     total_xp = code_stats_response[CODE_STATS_TOTAL_XP_KEY]
-    total_xp_value = ""
-    if stats_type == STATS_TYPE_RECENT_XP:
-        total_xp_value = f"{total_xp - last_seven_days_xp:,}" + (
-            f"{RECENT_STATS_SEPARATOR}{last_seven_days_xp:,}{PAST_WEEK_SUFFIX_STRING}"
-            if last_seven_days_xp > 0
-            else ""
-        )
-    elif stats_type == STATS_TYPE_XP:
-        total_xp_value = f"{total_xp:,}"
-    elif stats_type == STATS_TYPE_LEVEL:
-        total_xp_value = LEVEL_STRING_FORMAT.format(
-            level=XP_TO_LEVEL(total_xp), xp=total_xp
-        )
-    return TitleAndValue(TOTAL_XP_TITLE, total_xp_value)
+    recent_total_xp_supplier = lambda: code_stats_response[CODE_STATS_TOTAL_NEW_XP_KEY]
+    formatted_value = __get_formatted_value(
+        total_xp, recent_total_xp_supplier, stats_type
+    )
+    return TitleAndValue(TOTAL_XP_TITLE, formatted_value)
 
 
 def __get_language_xp_line(
     language: str, language_stats: Dict[str, int], stats_type: str
 ) -> TitleAndValue:
     xp = language_stats[CODE_STATS_LANGUAGES_XP_KEY]
-    recent_xp = language_stats[CODE_STATS_LANGUAGES_NEW_XP_KEY]
-    language_xp_value = ""
-    if stats_type == STATS_TYPE_RECENT_XP:
-        language_xp_value = f"{xp - recent_xp:,}" + (
-            f"{RECENT_STATS_SEPARATOR}{recent_xp:,}{NEW_XP_SUFFIX_STRING}"
-            if recent_xp > 0
-            else ""
-        )
-    elif stats_type == STATS_TYPE_XP:
-        language_xp_value = f"{xp:,}"
-    elif stats_type == STATS_TYPE_LEVEL:
-        language_xp_value = LEVEL_STRING_FORMAT.format(level=XP_TO_LEVEL(xp), xp=xp)
-    return TitleAndValue(language, language_xp_value)
+    recent_xp_supplier = lambda: language_stats[CODE_STATS_LANGUAGES_NEW_XP_KEY]
+    formatted_value = __get_formatted_value(xp, recent_xp_supplier, stats_type)
+    return TitleAndValue(language, formatted_value)
 
 
 def get_language_xp_lines(
     code_stats_response: Dict[str, Any], stats_type: str
 ) -> List[TitleAndValue]:
-    top_languages = sorted(
-        code_stats_response[CODE_STATS_LANGUAGES_KEY].items(),
-        key=lambda t: t[1][CODE_STATS_LANGUAGES_XP_KEY],
-        reverse=True,
-    )[:TOP_LANGUAGES_COUNT]
+    if stats_type == STATS_TYPE_RECENT_XP:
+        # Only considering languages with recent xp
+        top_languages = list(
+            takewhile(
+                lambda t: t[1][CODE_STATS_LANGUAGES_NEW_XP_KEY] > 0,
+                sorted(
+                    code_stats_response[CODE_STATS_LANGUAGES_KEY].items(),
+                    key=lambda t: t[1][CODE_STATS_LANGUAGES_NEW_XP_KEY],
+                    reverse=True,
+                )[:TOP_LANGUAGES_COUNT],
+            ),
+        )
+        if not top_languages:
+            return NO_RECENT_XP_LINES
+    else:
+        top_languages = sorted(
+            code_stats_response[CODE_STATS_LANGUAGES_KEY].items(),
+            key=lambda t: t[1][CODE_STATS_LANGUAGES_XP_KEY],
+            reverse=True,
+        )[:TOP_LANGUAGES_COUNT]
     return [
         __get_language_xp_line(language, stats, stats_type)
         for language, stats in top_languages
     ]
 
 
+def get_adjusted_line(title_and_value: TitleAndValue) -> str:
+    separation = MAX_LINE_LENGTH - (
+        len(title_and_value.title) + len(title_and_value.value) + 2
+    )
+    separator = f" {WIDTH_JUSTIFICATION_SEPARATOR * separation} "
+    return title_and_value.title + separator + title_and_value.value
+
+
 def update_gist(title: str, content: str) -> bool:
     access_token = os.environ[ENV_VAR_GITHUB_TOKEN]
     gist_id = os.environ[ENV_VAR_GIST_ID]
     gist = Github(access_token).get_gist(gist_id)
-    # Shouldn't necessarily work, keeping for case of single file made in hurry to get gist id.
+    # Works only for single file. Should we clear all files and create new file?
     old_title = list(gist.files.keys())[0]
     gist.edit(title, {old_title: InputFileContent(content, title)})
     print(f"{title}\n{content}")
@@ -179,8 +196,10 @@ def main():
             "Validations failed! See the messages above for more information"
         )
 
+    stats_type = os.environ[ENV_VAR_STATS_TYPE]
+    title = GIST_TITLE[stats_type]
     content = get_content()
-    update_gist(GIST_TITLE, content)
+    update_gist(title, content)
 
 
 if __name__ == "__main__":