CenterForDigitalHumanities / CenterForDigitalHumanities/rerum_server_nodejs

Helper functions for slug processing

Aperta
#152 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
JavaScript
Stelle
3
Fork
6
Merge medio
2g 47m
PR unite (30g)
4

Descrizione

In support of #151, the following transforming library for slugs should be added:

1. `getSlugFromMetadata(__rerum:Object)` -> `validSlug:String`
- extract `"this-slug"` from DB record property `{__rerum: { slug : "this-slug" } }`
- throw invalid argument if not `__rerum` metadata
- return empty `""` if `slug` property empty or missing
3. `assignSlug(slug:String, document:Object)` -> `document:Object`
- insert or overwrite `"this-slug"` to `__rerum` property for traditional save
- empty/remove slug with empty `""`
4. `findBySlug(slug:String)` async -> `document:Object`
- RERUM lookup for slug match
- 404 on a miss, 400 on a bad slug
6. `transferSlug(toDocument:Object, fromDocument?:Object)` async -> `200 `
- RERUM upsert toDocument with `"this-slug"` and RERUM patch fromDocument with `{ __rerum.slug: "" }`
- A single transaction, revert on a failure
7. `slugExists(slug:String)` async -> `Boolean`
- *findBySlug(slug) is not 40x
9. `slugIsValid(slug:String)` -> `Boolean`
- slug and normalizeSlug(slug) match
10. `normalizeSlug(userSlug:String)` -> `validSlug:String`
- "This, That & the Other! Various Outré Considerations" -> "this-that-the-other-various-outre-considerations"
11. `buildSluggedId(validSlug:String)` -> `atIdUrl:Url`
- "this-slug" -> "https://store.rerum.io/v1/id/this-slug"

Only "normalizeSlug" takes user input.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo l’issue correlata #151 per comprendere il contesto di elaborazione degli slug richiesto. Poi definisci i contratti degli helper elencati e i relativi comportamenti di validazione, ricerca, normalizzazione e trasferimento descritti in questa issue. Il lavoro è completato quando tutti gli helper specificati supportano i casi documentati di successo ed errore, incluso il rollback del trasferimento degli slug.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.