mattpolzin / mattpolzin/JSONAPI
Redesign Attributes/Relationships around property wrappers
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Swift
- Estrellas
- 81
- Forks
- 21
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Exploration started here: https://github.com/mattpolzin/JSONAPI/tree/feature/transformed-property
This project is on hold until property wrapper chaining (or nesting) is supported (likely Swift 5.2).
The idea I am pursuing is to replace Attribute/TransformedAttribute with an @Attribute attribute and use an @Omittable attribute to represent when attributes can be omitted (i.e. the key is not required). I am a little less solid on relationships, but they would get similar treatment. Then, I additionally would like to flatten things so that attributes and relationships are defined in the same structure with their property attributes being the thing that differentiates them. Definitely have not worked out all of the details yet, but I hope that in addition to being a breaking change this will bring some concision and reduce the overall number of types needed a bit.
Something like
PersonProperties {
// takes the place of current `Attribute`
@Attribute
var name: String
// where age is stored as a `String` for some reason but we expect it to always be an `Int`
// takes the place of current `TransformedAttribute`
@Attribute(deserialize: StringToInt.self)
var age: Int
// takes the place of current `ToOneRelationship`
@Relationship(to: City?.self)
var hometown: Id?
// takes the place of current `ToManyRelationship`
@Relationship(to: [Person].self)
var friends: [Id]
}
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
Empieza revisando la exploración de la rama vinculada transformed-property y los tipos existentes Attribute, TransformedAttribute y relationship. Aclara el diseño del property-wrapper y de las relaciones, incluida la compatibilidad con el encadenamiento o el anidamiento, antes de definir los criterios de finalización del breaking change.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- swift
- Área
- api
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 15/100