Skip to content

Commit d9fd27a

Browse files
ysangkokysangkok
committed
Rename user-facing strings to 'endorsements', add threshold template param
1 parent ada92d0 commit d9fd27a

File tree

4 files changed

+27
-26
lines changed

4 files changed

+27
-26
lines changed

‎datafiles/templates/Html/vouch.html.st

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,24 @@
22
<html>
33
<head>
44
$hackageCssTheme()$
5-
<title>Vouch for user | Hackage</title>
5+
<title>Endorse user | Hackage</title>
66
</head>
77

88
<body>
99
$hackagePageHeader()$
1010

1111
<div id="content">
12-
<h2>Vouch for user</h2>
12+
<h2>Endorse user</h2>
1313

1414
<p>$msg$</p>
1515

1616
<form action="" method=POST>
17-
<input type=submit value="Vouch for this user">
17+
<input type=submit value="Endorse this user">
1818
</form>
1919

20-
<p>Vouching cannot be undone! When the user has three vouches, the user
20+
<p>Endorsing cannot be undone! When the user has $requiredNumber$ endorsements, the user
2121
can upload packages. Note that users are, to a certain degree, held accountable
22-
for the actions of the users they vouch for. Only vouch for people you know.</p>
22+
for the actions of the users they endorse. Only endorse people you know.</p>
2323

2424
<ul>
2525
$vouches$

‎src/Distribution/Server/Features/UserNotify.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1100,7 +1100,7 @@ getNotificationEmails
11001100

11011101
renderNotifyVouchingCompleted =
11021102
EmailContentParagraph
1103-
"You have received all necessary vouches. \
1103+
"You have received all necessary endorsements. \
11041104
\You have been added the the 'uploaders' group. \
11051105
\You can now upload packages to Hackage. \
11061106
\Note that packages cannot be deleted, so be careful."

‎src/Distribution/Server/Features/Vouch.hs

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ renderToLBS lookupUserInfo vouches = do
152152
pure $
153153
templateUnescaped "vouches" $
154154
if null rendered
155-
then LBS.pack "Nobody has vouched yet."
155+
then LBS.pack "Nobody has endorsed yet."
156156
else LBS.intercalate mempty rendered
157157

158158
renderVouchers :: (UserId -> ServerPartE UserInfo) -> (UserId, UTCTime) -> ServerPartE LBS.ByteString
@@ -181,6 +181,7 @@ initVouchFeature ServerEnv{serverStateDir, serverTemplatesDir, serverTemplatesMo
181181
param <- renderToLBS lookupUserInfo vouches
182182
pure . toResponse $ vouchTemplate
183183
[ "msg" $= ""
184+
, "requiredNumber" $= show requiredCountOfVouches
184185
, param
185186
]
186187
handlePostVouch :: DynamicPath -> ServerPartE Response
@@ -193,15 +194,15 @@ initVouchFeature ServerEnv{serverStateDir, serverTemplatesDir, serverTemplatesMo
193194
existingVouchers <- queryState vouchState $ GetVouchesFor vouchee
194195
case judgeVouch ugroup now vouchee vouchersForVoucher existingVouchers voucher of
195196
Left NotAnUploader ->
196-
errBadRequest "Not an uploader" [MText "You must be an uploader yourself to vouch for other users."]
197+
errBadRequest "Not an uploader" [MText "You must be an uploader yourself to endorse other users."]
197198
Left You'reTooNew ->
198-
errBadRequest "You're too new" [MText "The latest of the vouches for your user must be at least 30 days old."]
199+
errBadRequest "You're too new" [MText "The latest of the endorsements for your user must be at least 30 days old."]
199200
Left VoucheeAlreadyUploader ->
200-
errBadRequest "Vouchee already uploader" [MText "You can't vouch for this user, since they are already an uploader."]
201+
errBadRequest "Endorsee already uploader" [MText "You can't endorse this user, since they are already an uploader."]
201202
Left AlreadySufficientlyVouched ->
202-
errBadRequest "Already sufficiently vouched" [MText "There are already a sufficient number of vouches for this user."]
203+
errBadRequest "Already sufficiently endorsed" [MText "There are already a sufficient number of endorsements for this user."]
203204
Left YouAlreadyVouched ->
204-
errBadRequest "Already vouched" [MText "You have already vouched for this user."]
205+
errBadRequest "Already endorsed" [MText "You have already endorsed this user."]
205206
Right result -> do
206207
updateState vouchState $ PutVouch vouchee (voucher, now)
207208
param <- renderToLBS lookupUserInfo $ existingVouchers ++ [(voucher, now)]
@@ -216,26 +217,26 @@ initVouchFeature ServerEnv{serverStateDir, serverTemplatesDir, serverTemplatesMo
216217

217218
liftIO $ Group.addUserToGroup uploadersGroup vouchee
218219
pure . toResponse $ vouchTemplate
219-
[ "msg" $= "Added vouch. User is now an uploader!"
220+
[ "msg" $= "Added endorsement. User is now an uploader!"
220221
, param
221222
]
222223
AddVouchIncomplete stillRequired ->
223224
pure . toResponse $ vouchTemplate
224225
[ "msg" $=
225-
"Added vouch. User still needs "
226+
"Added endorsement. User still needs "
226227
<> show stillRequired
227-
<> if stillRequired == 1 then " vouch" else " vouches"
228+
<> if stillRequired == 1 then " endorsement" else " endorsements"
228229
<> " to become uploader."
229230
, param
230231
]
231232
return $ VouchFeature {
232233
vouchFeatureInterface =
233-
(emptyHackageFeature "vouch")
234-
{ featureDesc = "Vouching for users getting upload permission."
234+
(emptyHackageFeature "endorse")
235+
{ featureDesc = "Endorsing users such that they get upload permission."
235236
, featureResources =
236-
[(resourceAt "/user/:username/vouch")
237-
{ resourceDesc = [(GET, "list people vouching")
238-
,(POST, "vouch for user")
237+
[(resourceAt "/user/:username/endorse")
238+
{ resourceDesc = [(GET, "list people endorsing")
239+
,(POST, "endorse for user")
239240
]
240241
, resourceGet = [("html", handleGetVouches)]
241242
, resourcePost = [("html", handlePostVouch)]

‎tests/golden/ReverseDependenciesTest/getNotificationEmails-NotifyVouchingCompleted.golden

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Content-Type: multipart/alternative; boundary="YIYrWcf3to"
88
Content-Type: text/plain; charset=utf-8
99
Content-Transfer-Encoding: quoted-printable
1010

11-
You have received all necessary vouches=2E You have been added the the 'upl=
12-
oaders' group=2E You can now upload packages to Hackage=2E Note that packag=
13-
es cannot be deleted, so be careful=2E
11+
You have received all necessary endorsements=2E You have been added the the=
12+
'uploaders' group=2E You can now upload packages to Hackage=2E Note that p=
13+
ackages cannot be deleted, so be careful=2E
1414

1515
You can adjust your notification preferences at
1616
https://hackage=2Ehaskell=2Eorg/user/user-watcher/notify (https://hackage=
@@ -23,9 +23,9 @@ Content-Transfer-Encoding: quoted-printable
2323

2424

2525
<p>
26-
You have received all necessary vouches=2E You have been added the the 'upl=
27-
oaders' group=2E You can now upload packages to Hackage=2E Note that packag=
28-
es cannot be deleted, so be careful=2E
26+
You have received all necessary endorsements=2E You have been added the the=
27+
'uploaders' group=2E You can now upload packages to Hackage=2E Note that p=
28+
ackages cannot be deleted, so be careful=2E
2929
</p>
3030
<p>
3131
You can adjust your notification preferences at

0 commit comments

Comments
 (0)