Source code for feretui.session

# This file is a part of the FeretUI project
#
#    Copyright (C) 2024 Jean-Sebastien SUZANNE <js.suzanne@gmail.com>
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file,You can
# obtain one at http://mozilla.org/MPL/2.0/.
"""Module feretui.session.

This is a internal session, it represent the session of the web-server but
with only the entry need by the client

The session can be overwritting by the developper::

    from feretui import Session


    session = Session()
"""

from wtforms import PasswordField, RadioField, StringField
from wtforms.validators import EqualTo, InputRequired

from feretui.form import FeretUIForm, Password




class LoginForm(FeretUIForm):
    """WTform for the login."""

    login = StringField(validators=[InputRequired()])
    password = PasswordField(validators=[InputRequired()])





class SignUpForm(FeretUIForm):
    """WTform for sign up."""

    login = StringField(validators=[InputRequired()])
    lang = RadioField(
        label="Language",
        choices=[("en", "English")],
        validators=[InputRequired()],
    )
    password = PasswordField(validators=[Password()])
    password_confirm = PasswordField(
        validators=[InputRequired(), EqualTo("password")],
    )





class Session:
    """Description of the session.

    The session can be overwritting by the developper::

        from feretui import Session


        class MySession(Session):
            pass

    You should overwrite the methods to link the session with your
    user model.

    * :meth:`.Session.login`
    * :meth:`.Session.signup`
    * :meth:`.Session.logout`

    Attributes
    ----------
    * [user: str = None] : User name of the session
    * [lang: str = 'en'] : The language use by the user session
    * [theme: str = 'default'] : The ui theme use by the user session

    """

    LoginForm: FeretUIForm = LoginForm
    SignUpForm: FeretUIForm = SignUpForm

    def __init__(
        self: "Session",
        user: str = None,
        lang: str = "en",
        theme: str = "default",
        **kwargs: dict,
    ) -> "Session":
        """FeretUI session."""
        self.user: str = user
        self.lang: str = lang
        self.theme: str = theme
        self.kwargs: dict = kwargs



    def to_dict(self: "Session") -> dict:
        """Return the value of the session as a dict."""
        dict_ = self.__dict__.copy()
        dict_.pop("kwargs")
        return dict_




    def login(
        self: "Session",
        form: FeretUIForm,
    ) -> None:
        """Login.

        :param form: the WTForm object
        :type login: :class:`feretui.form.FeretUIForm`
        """
        self.user = form.login.data




    def logout(self: "Session") -> None:
        """Logout."""
        self.user = None




    def signup(self: "Session", form: FeretUIForm) -> bool:
        """Signup.

        :param form: the WTForm object
        :type login: :class:`feretui.form.FeretUIForm`
        """
        self.user = form.login.data
        self.lang = form.lang.data
        return True