🇬🇧 Read it in English, “GenCreate, GenUpdate, GenDetail and GenDelete“

En el último artículo describíamos Codenerix GenList para comenzar a usar los listados de CODENERIX. Ha llegado el momento de ver como crear, ver, actualizar y borrar la información de esos listados.

En este artículo hablaré sobre GenCreate, GenDetail, GenUpdate y GenDelete.

En primer lugar cabe decir que cada uno hereda de su equivalente en Django de tal modo que GenCreate hereda de CreateView, GenUpdate de UpdateView, GenDetail de DetailView y GenDelete de DeleteView.

Vamos a ver primero como serían el modelo de ejemplo que vamos a usar “Contact“:

class Contact(CodenerixModel):
    first_name = models.CharField(verbose_name=_(u'Nombre(s)'), max_length=128)
    last_name = models.CharField(verbose_name=_(u'Apellidos'), max_length=128, blank=True, null=True)
    alias = models.CharField(verbose_name=_(u'Alias'), max_length=32, blank=True, null=True)
    organization = models.CharField(verbose_name=_(u'Organización'), max_length=64, blank=True, null=True)
    borndate = models.DateField(verbose_name=_(u'Cumpleaños'), blank=True, null=True)
    address = models.TextField(verbose_name=_(u'Dirección'), blank=True, null=True)
    created_by = models.ForeignKey(User, verbose_name=_(u'Creado por'), on_delete=models.CASCADE, related_name='contacts')

    def __fields__(self, info):
        return (
            ('first_name', _(u'Nombre(s)')),
            ('last_name', _(u'Apellidos')),
            ('alias', _(u'Alias')),
            ('organization', _(u'Organization')),
        )

y su formulario “ContactForm” que heredará de GenModelForm:

from codenerix.forms import GenModelForm


class ContactForm(GenModelForm):

    class Meta:
        model = Contact
        exclude = ['created_by']

    def __groups__(self):
        return [
            (
                _(u'Principal'), 6,
                ['first_name', 6],
                ['last_name', 6],
                ['alias', 6],
            ),
            (
                _(u'Principal'), 6,
                ['organization', 6],
                ['borndate', 6],
                ['address', 6],
            )
        ]

    @staticmethod
    def __groups_details__():
        return [
            (
                _(u'Contact'), 12,
                ['alias', 12],
                ['organization', 12],
                ['borndate', 12],
                ['address', 12],
            )
        ]

Dado que GenModelForm es nuevo sólo voy a destacar que hereda de BaseModelForm de Django y que lo único que tiene nuevo frente a un ModelForm de Django son los grupos. Los grupos son la definición de cómo deseamos que se vea un formulario en la pantalla y se construye con una lista de tuplas que contienen:

1. Título del bloque de campos
2. Ancho en columnas de Bootstrap
3. N-tuplas que se refieren a los campos del formulario donde cada tupla tendrá como primer elemento el nombre del campo que irá en esa posición y su ancho en columnas de Bootstrap. Existen más elementos en estas tuplas que explicaré en próximas publicaciones.

De este modo el formulario indicado arriba quedaría como sigue:

Donde los campos están autovalidados en el lado del navegador del usuario y por lo tanto reduce mucho en llamadas al servidor. Dicho formulario explicado con su grupo quedaría como sigue:

Descubramos los detalles de cada una de estas 4 vistas que de base funcionan como sus homólogos en Python con los mismos atributos y métodos que estos, pero ofrecen mucha más funcionalidad.

GenModify

Para poder hablar con GenCreate y GenUpdate, primero tenemos que hablar de GenModify que es el encargado de gestionar el funcionamiento cuando se crea y se actualiza un registro. No es una vista que usaremos directamente, sin embargo esta clase formará parte de forma indirecta de GenCreate y GenUpdate respectivamente. Dado que la creación y actualización de registro varía en cuestiones mínimas: el formulario coincide y las validaciones son las mismas, la clase GenModify se encarga de gestionar como actuan GenCreate y GenUpdate en cada caso precargando el formulario con el registro que se está editando en un GenUpdate y en ambos casos almacenando los cambios (nuevos o actualizados) en la base de datos.

Estos atributos están disponibles tanto en las vistas de creación como en las de edicción.

GenCreate y GenCreateModal

from codenerix.views import GenCreate, GenCreateModal

class ContactCreate(GenCreate):
    model = Contact
    form_class = ConctactForm

class ContactCreateModal(GenCreateModal, ContactCreate):
    pass

GenCreate es una vista que hereda de CreateView de Django y de GenModify. En sus mínimos necesita los mismos campos que CreateView, estos son “model” y “form_class“. Dado que GenCreate hereda de GenModify, también estarán disponibles las funcionalidades de este.

A las vistas a las que les incluyamos un GenCreateModal, conseguiremos que el render se ocupe de preparar el resultado para ser mostrado en una ventana modal. En el fondo lo que realmente ocurre es que añade la marquesita de las ventanas modales de Bootstrap y termina el renderizado en ese punto.

GenUpdate y GenUpdateModal

from codenerix.views import GenUpdate, GenUpdateModal

class ContactUpdate(GenUpdate):
    model = Contact
    form_class = ContactForm

class ContactUpdateModal(GenUpdateModal, ContactUpdate):
    pass

GenUpdate es una vista que hereda de UpdateView de Django y de GenModify. En sus mínimos necesita los mismos campos que UpdateView, estos son “model” y “form_class“. Dado que GenUpdate hereda de GenModify, también estarán disponibles las funcionalidades de este.

A las vistas a las que les incluyamos un GenUpdateModal, conseguiremos que el render se ocupe de preparar el resultado para ser mostrado en una ventana modal. En el fondo lo que realmente ocurre es que añade la marquesita de las ventanas modales de Bootstrap y termina el renderizado en ese punto.

GenDetail y GenDetailModal

from codenerix.views import GenDetail, GenDetailModal

class ContactDetail(GenDetail):
    model = Contact
    groups = ContactForm.__groups_details__()

class ContactDetailModal(GenDetailModal, ContactDetail):
    pass

GenDetail es una vista que hereda de DetailView de Django y de GenModify, usada para visualizar datos de un objeto. En sus mínimos necesita los mismos campos que DetailView, estos son “model” y “form_class“.

A las vistas a las que les incluyamos un GenDetailModal, conseguiremos que el render se ocupe de preparar el resultado para ser mostrado en una ventana modal. En el fondo lo que realmente ocurre es que añade la marquesita de las ventanas modales de Bootstrap y termina el renderizado en ese punto.

GenDelete

from codenerix.views import GenDelete

class ContactDelete(GenDelete):
    model = Contact

Es la vista encargada de borrar los registros. La razón para heredar de GenDelete se debe a que el sistema hace ciertas comprobaciones de seguridad para el borrado del registro incluyendo permisos e integridad que el propio Django no hace. Además responde adecuadamente a los controladores que atienden a la gestión de los formularios.

Hasta aquí hemos explicado todo lo necesario para operar con las vistas Genéricas de CODENERIX.