Coverage for src / rendercv / renderer / templater / connections.py: 100%

1from dataclasses import dataclass (empty)

2from typing import Literal (empty)

3 

4import phonenumbers (empty)

5 

6from rendercv.exception import RenderCVInternalError (empty)

7from rendercv.schema.models.rendercv_model import RenderCVModel (empty)

8 

9from .markdown_parser import markdown_to_typst (empty)

10from .string_processor import clean_url (empty)

11 

12fontawesome_icons = { (empty)

13 "LinkedIn": "linkedin", 

14 "GitHub": "github", 

15 "GitLab": "gitlab", 

16 "IMDB": "imdb", 

17 "Instagram": "instagram", 

18 "Mastodon": "mastodon", 

19 "ORCID": "orcid", 

20 "StackOverflow": "stack-overflow", 

21 "ResearchGate": "researchgate", 

22 "YouTube": "youtube", 

23 "Google Scholar": "graduation-cap", 

24 "Telegram": "telegram", 

25 "WhatsApp": "whatsapp", 

26 "Leetcode": "code", 

27 "X": "x-twitter", 

28 "Bluesky": "bluesky", 

29 "location": "location-dot", 

30 "email": "envelope", 

31 "phone": "phone", 

32 "website": "link", 

33 "Reddit": "reddit", 

34} 

35 

36 

37def compute_connections( (empty)

38 rendercv_model: RenderCVModel, file_type: Literal["typst", "markdown"] 

39) -> list[str]: 

40 """Route to format-specific connection generator. 

41 

42 Args: 

43 rendercv_model: CV model with contact information. 

44 file_type: Target format for connections. 

45 

46 Returns: 

47 List of formatted connection strings. 

48 """ 

49 return { (empty)

50 "typst": compute_connections_for_typst, 

51 "markdown": compute_connections_for_markdown, 

52 }[file_type](rendercv_model) 

53 

54 

55@dataclass (empty)

56class Connection: (empty)

57 fontawesome_icon: str (empty)

58 url: str | None (empty)

59 body: str (empty)

60 

61 

62def parse_connections(rendercv_model: RenderCVModel) -> list[Connection]: (empty)

63 """Extract contact information from CV model into normalized connection format. 

64 

65 Why: 

66 CV header displays various contact methods in user-defined order. This 

67 extracts emails, phones, websites, location, and social networks from 

68 the model, preserving the order specified in the input file. 

69 

70 Args: 

71 rendercv_model: CV model with contact information. 

72 

73 Returns: 

74 List of connections with icon specifiers, URLs, and display text. 

75 """ 

76 connections: list[Connection] = [] (empty)

77 for key in rendercv_model.cv._key_order: (empty)

78 match key: (empty)

79 case "email": (empty)

80 emails = rendercv_model.cv.email (empty)

81 if not isinstance(emails, list): (empty)

82 emails = [emails] (empty)

83 

84 for email in emails: (empty)

85 url = f"mailto:{email}" (empty)

86 body = str(email) (empty)

87 connections.append( (empty)

88 Connection( 

89 fontawesome_icon=fontawesome_icons[key], url=url, body=body 

90 ) 

91 ) 

92 

93 case "phone": (empty)

94 phones = rendercv_model.cv.phone (empty)

95 if phones is None: (empty)

96 raise RenderCVInternalError("phone key present but value is None") (empty)

97 if not isinstance(phones, list): (empty)

98 phones = [phones] (empty)

99 

100 for phone in phones: (empty)

101 url = str(phone) (empty)

102 body = phonenumbers.format_number( (empty)

103 phonenumbers.parse(phone, None), 

104 getattr( 

105 phonenumbers.PhoneNumberFormat, 

106 rendercv_model.design.header.connections.phone_number_format.upper(), 

107 ), 

108 ) 

109 connections.append( (empty)

110 Connection( 

111 fontawesome_icon=fontawesome_icons[key], url=url, body=body 

112 ) 

113 ) 

114 

115 case "website": (empty)

116 websites = rendercv_model.cv.website (empty)

117 if not websites: (empty)

118 raise RenderCVInternalError("website key present but value is None") (empty)

119 if not isinstance(websites, list): (empty)

120 websites = [websites] (empty)

121 

122 for website in websites: (empty)

123 url = str(website) (empty)

124 body = clean_url(url) (empty)

125 connections.append( (empty)

126 Connection( 

127 fontawesome_icon=fontawesome_icons[key], url=url, body=body 

128 ) 

129 ) 

130 

131 case "location": (empty)

132 url = None (empty)

133 body = str(rendercv_model.cv.location) (empty)

134 connections.append( (empty)

135 Connection( 

136 fontawesome_icon=fontawesome_icons[key], url=None, body=body 

137 ) 

138 ) 

139 

140 case "social_networks": (empty)

141 if rendercv_model.cv.social_networks is None: (empty)

142 raise RenderCVInternalError( (empty)

143 "social_networks key present but value is None" 

144 ) 

145 for social_network in rendercv_model.cv.social_networks: (empty)

146 url = social_network.url (empty)

147 if rendercv_model.design.header.connections.display_urls_instead_of_usernames: (empty)

148 body = clean_url(url) (empty)

149 else: 

150 match social_network.network: (empty)

151 case "Google Scholar": (empty)

152 body = "Google Scholar" (empty)

153 case _: (empty)

154 body = social_network.username (empty)

155 connections.append( (empty)

156 Connection( 

157 fontawesome_icon=fontawesome_icons[social_network.network], 

158 url=url, 

159 body=body, 

160 ) 

161 ) 

162 

163 case "custom_connections": (empty)

164 if rendercv_model.cv.custom_connections is None: (empty)

165 raise RenderCVInternalError( (empty)

166 "custom_connections key present but value is None" 

167 ) 

168 for custom_connection in rendercv_model.cv.custom_connections: (empty)

169 url = ( (empty)

170 str(custom_connection.url) 

171 if custom_connection.url is not None 

172 else None 

173 ) 

174 body = custom_connection.placeholder (empty)

175 connections.append( (empty)

176 Connection( 

177 fontawesome_icon=custom_connection.fontawesome_icon, 

178 url=url, 

179 body=body, 

180 ) 

181 ) 

182 

183 return connections (empty)

184 

185 

186def compute_connections_for_typst(rendercv_model: RenderCVModel) -> list[str]: (empty)

187 """Format connections with Typst markup, Font Awesome icons, and conditional hyperlinks. 

188 

189 Why: 

190 Typst templates need connection strings with icon syntax and link markup. 

191 Icon visibility and hyperlink behavior are user-configurable through 

192 design settings, requiring conditional formatting at render time. 

193 

194 Args: 

195 rendercv_model: CV model with contact information and design settings. 

196 

197 Returns: 

198 List of Typst-formatted connection strings ready for template insertion. 

199 """ 

200 connections = parse_connections(rendercv_model) (empty)

201 

202 show_icon = rendercv_model.design.header.connections.show_icons (empty)

203 hyperlink = rendercv_model.design.header.connections.hyperlink (empty)

204 

205 placeholders = [ (empty)

206 ( 

207 f'#connection-with-icon("{connection.fontawesome_icon}")' 

208 f"[{markdown_to_typst(connection.body)}]" 

209 if show_icon 

210 else markdown_to_typst(connection.body) 

211 ) 

212 for connection in connections 

213 ] 

214 

215 return [ (empty)

216 ( 

217 f'#link("{connection.url}", icon: false, if-underline: false, if-color:' 

218 f" false)[{placeholder}]" 

219 if connection.url and hyperlink 

220 else placeholder 

221 ) 

222 for connection, placeholder in zip(connections, placeholders, strict=True) 

223 ] 

224 

225 

226def compute_connections_for_markdown(rendercv_model: RenderCVModel) -> list[str]: (empty)

227 """Format connections as Markdown links without icons. 

228 

229 Args: 

230 rendercv_model: CV model with contact information. 

231 

232 Returns: 

233 List of Markdown-formatted connection strings. 

234 """ 

235 connections = parse_connections(rendercv_model) (empty)

236 

237 return [ (empty)

238 ( 

239 f"[{connection.body}]({connection.url})" 

240 if connection.url 

241 else connection.body 

242 ) 

243 for connection in connections 

244 ]