Adds Mastodon social network

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,7 +4,6 @@ about: Create a report to help us improve
 title: ''
 labels: bug
 assignees: sinaatalay
-
 ---
 
 **Describe the bug**

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,9 @@
+---
+name: Enhancement
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: sinaatalay
+---
+
+A clear and concise description of what you want to happen.

.github/workflows/ci.yaml

@@ -69,8 +69,9 @@ jobs:
           name: coverage
           path: .coverage.${{ matrix.python-version }}.${{ matrix.os }}
 
-  combine-coverages:
-    name: Upload coverage report
+  report-coverage:
+    if: github.event_name == 'push'
+    name: Generate a coverage report
     needs: [test]
     runs-on: ubuntu-latest
 
@@ -108,6 +109,7 @@ jobs:
           SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 50
           SMOKESHOW_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SMOKESHOW_GITHUB_PR_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
+
   publish:
     if: github.event_name == 'release'
     name: Publish to PyPI

.gitignore

@@ -186,4 +186,9 @@ output/
 
 # Personal CVs
 Sina_Atalay_CV.yaml
-run_sina_atalay_cv.py
+run_sina_atalay_cv.py
+
+# Jeffrey Goldbergs local stuff
+# We can remove these once work by him is finished
+Jeffrey_Paul_Goldberg_CV.yaml
+pyvenv.cfg

pyproject.toml

@@ -47,6 +47,9 @@ linting = ["black", "ruff"]
 requires = ['setuptools>=68.2.2', "setuptools-scm>=8.0.4"]
 build-backend = 'setuptools.build_meta'
 
+[tool.setuptools]
+packages = ["rendercv"]
+
 [tool.ruff]
 line-length = 88
 

rendercv/data_model.py

@@ -1022,10 +1022,10 @@ def doi_url(self) -> str:
 class SocialNetwork(BaseModel):
     """This class stores a social network information.
 
-    Currently, only LinkedIn, Github, and Instagram are supported.
+    Currently, only LinkedIn, Github, Mastodon, and Instagram are supported.
     """
 
-    network: Literal["LinkedIn", "GitHub", "Instagram", "Orcid"] = Field(
+    network: Literal["LinkedIn", "GitHub", "Instagram", "Orcid", "Mastodon"] = Field(
         title="Social Network",
         description="The social network name.",
     )
@@ -1048,13 +1048,99 @@ class Connection(BaseModel):
         "GitHub",
         "Instagram",
         "Orcid",
+        "Mastodon",
         "phone",
         "email",
         "website",
         "location",
     ]
     value: str
 
+    @staticmethod
+    def is_valid_hostname(hostname: str) -> bool:
+        """Is hostname a valid hostname by RFCs 952 and 1123"""
+
+        # slightly modified from
+        # https://stackoverflow.com/a/33214423/1304076
+        if hostname[-1] == ".":
+            # strip exactly one dot from the right, if present
+            hostname = hostname[:-1]
+        if len(hostname) > 253:
+            return False
+
+        labels = hostname.split(".")
+
+        # the last label must be not all-numeric
+        if re.match(r"[0-9]+$", labels[-1]):
+            return False
+
+        # labels cannot begin with a hyphen
+        # labels must have at least character
+        # labels may not have more than 63 characters
+        allowed = re.compile(r"(?!-)[a-z0-9-]{1,63}(?<!-)$", re.IGNORECASE)
+        return all(allowed.match(label) for label in labels)
+
+    @staticmethod
+    def MastodonUname2Url(address: str) -> Optional[HttpUrl]:
+        """returns profile url from a mastodon user address.
+
+        Args:
+            address (str): A Mastodon user address. E.g., "[email protected]"
+
+        Returns:
+            A pydantic HttpUrl object with the https URL for the user profile
+
+        Example:
+            ```
+            url = MastodonUname2Url("[email protected]")
+            assert(url == HttpUrl(http://social.example/@user))
+            ```
+
+        Exceptions:
+            ValueError if the address is malformed.
+            Note that well-formed addresses should never yield
+            syntactically invalid URLs.
+        """
+
+        # The closest thing to a formal spec of Mastodon usernames
+        # where these regular expressions from a (reference?)
+        # implementation
+        #
+        # https://github.com/mastodon/mastodon/blob/f1657e6d6275384c199956e8872115fdcec600b0/app/models/account.rb#L68
+        #
+        # USERNAME_RE   = /[a-z0-9_]+([a-z0-9_.-]+[a-z0-9_]+)?/i
+        # MENTION_RE    = %r{(?<![=/[:word:]])@((#{USERNAME_RE})(?:@[[:word:].-]+[[:word:]]+)?)}i
+        #
+        # `[[:word:]]` in Ruby includes lots of things that could never be in a # domain name. As my intent here is to construct an HTTPS URL,
+        # What we need are valid hostnames,
+        # and so need to satisfy the constraints of RFC 952 and and 1123.
+
+        pattern = re.compile(
+            r"""
+            ^\s*                    # ignore leading spaces
+            @?                      # Optional @ prefix
+            (?P<uname>[a-z0-9_]+([a-z0-9_.-]+[a-z0-9_]+)?)  # username part
+            @                       # separator
+            (?P<domain>[a-z0-9]+([a-z0-9.-]+)?) # domain part
+            \s*$                    # ignore trailing whitespace
+        """,
+            re.VERBOSE | re.IGNORECASE,
+        )
+
+        m = pattern.match(address)
+        if m is None:
+            raise ValueError("Invalid mastodon address")
+        uname = m.group("uname")
+        domain = m.group("domain")
+
+        # the domain part of pattern allows some things that are not
+        # valid names. So we run a stricter check
+        if not Connection.is_valid_hostname(domain):
+            raise ValueError("Invalid hostname in mastodon address")
+
+        url = HttpUrl(f"https://{domain}/@{uname}")
+        return url
+
     @computed_field
     @cached_property
     def url(self) -> Optional[HttpUrl | str]:
@@ -1066,6 +1152,8 @@ def url(self) -> Optional[HttpUrl | str]:
             url = f"https://www.instagram.com/{self.value}"
         elif self.name == "Orcid":
             url = f"https://orcid.org/{self.value}"
+        elif self.name == "Mastodon":
+            url = self.MastodonUname2Url(self.value)
         elif self.name == "email":
             url = f"mailto:{self.value}"
         elif self.name == "website":

rendercv/templates/classic/components/header_connections.tex.j2

@@ -15,6 +15,10 @@
 \mbox{\hrefWithoutArrow{<<url>>}{{\small\faOrcid}\hspace{0.13cm}<<username>>}}
 ((*- endmacro *))
 
+((* macro Mastodon(username, url) -*))
+\mbox{\hrefWithoutArrow{<<url>>}{{\small\faMastodon}\hspace{0.13cm}<<username>>}}
+((*- endmacro *))
+
 ((* macro phone(number, url) -*))
 \mbox{\hrefWithoutArrow{<<url|replace("-","")>>}{{\footnotesize\faPhone*}\hspace{0.13cm}<<number|replace("tel:", "")|replace("-"," ")>>}}
 ((*- endmacro *))

schema.json

@@ -1588,7 +1588,8 @@
             "LinkedIn",
             "GitHub",
             "Instagram",
-            "Orcid"
+            "Orcid",
+            "Mastodon"
           ],
           "title": "Social Network",
           "type": "string"