CenterForDigitalHumanities / CenterForDigitalHumanities/rerum_server_nodejs
Helper functions for slug processing
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 3
- Forks
- 6
- Merge medio
- 2 d 47 min
- PR fusionados (30 d)
- 4
Descripción
In support of #151, the following transforming library for slugs should be added:
getSlugFromMetadata(__rerum:Object)->validSlug:String- extract
"this-slug"from DB record property{__rerum: { slug : "this-slug" } } - throw invalid argument if not
__rerummetadata - return empty
""ifslugproperty empty or missing
- extract
assignSlug(slug:String, document:Object)->document:Object- insert or overwrite
"this-slug"to__rerumproperty for traditional save - empty/remove slug with empty
""
- insert or overwrite
findBySlug(slug:String)async ->document:Object- RERUM lookup for slug match
- 404 on a miss, 400 on a bad slug
transferSlug(toDocument:Object, fromDocument?:Object)async ->200 <location>- RERUM upsert toDocument with
"this-slug"and RERUM patch fromDocument with{ __rerum.slug: "" } - A single transaction, revert on a failure
- RERUM upsert toDocument with
slugExists(slug:String)async ->Boolean- *findBySlug(slug) is not 40x
slugIsValid(slug:String)->Boolean- slug and normalizeSlug(slug) match
normalizeSlug(userSlug:String)->validSlug:String- "This, That & the Other! Various Outré Considerations" -> "this-that-the-other-various-outre-considerations"
buildSluggedId(validSlug:String)->atIdUrl:Url- "this-slug" -> "https://store.rerum.io/v1/id/this-slug"
Only "normalizeSlug" takes user input.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza leyendo el issue relacionado #151 para entender el contexto de procesamiento de slugs solicitado. Después, define los contratos de los helpers indicados y sus comportamientos de validación, búsqueda, normalización y transferencia según este issue. El trabajo estará terminado cuando todos los helpers especificados admitan los casos documentados de éxito y error, incluido el rollback de la transferencia de slugs.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript
- Área
- api, backend
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100