tracim.lib.core.userworkspace

Complexity

Total Complexity

17

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	RoleApi._get_all_for_user()	0	3	1
A	RoleApi.get_one()	0	2	1
A	RoleApi.create_one()	0	16	2
A	RoleApi._get_one_rsc()	0	9	1
A	RoleApi.delete_one()	0	4	2
A	RoleApi.role_can_read_member_role()	0	11	2
A	RoleApi.get_roles_for_select_field()	0	14	2
A	RoleApi.get_all_for_user_order_by_workspace()	0	6	1
A	RoleApi.get_all_for_workspace()	0	3	1
A	RoleApi.save()	0	2	1
A	RoleApi.__init__()	0	3	1
A	RoleApi.create_role()	0	5	1
A	RoleApi.get_all_for_user()	0	2	1

# -*- coding: utf-8 -*-

This module should have a docstring.

import typing

__author__ = 'damien'

from sqlalchemy.orm import Session
from tracim.models.auth import User
from tracim.models.data import Workspace
from tracim.models.data import UserRoleInWorkspace
from tracim.models.data import RoleType


class RoleApi(object):

This class should have a docstring.

The variable __class__ seems to be unused.

    ALL_ROLE_VALUES = UserRoleInWorkspace.get_all_role_values()
    # Dict containing readable members roles for given role
    members_read_rights = {
        UserRoleInWorkspace.NOT_APPLICABLE: [],
        UserRoleInWorkspace.READER: [
            UserRoleInWorkspace.WORKSPACE_MANAGER,
        ],
        UserRoleInWorkspace.CONTRIBUTOR: [
            UserRoleInWorkspace.WORKSPACE_MANAGER,
            UserRoleInWorkspace.CONTENT_MANAGER,
            UserRoleInWorkspace.CONTRIBUTOR,
        ],
        UserRoleInWorkspace.CONTENT_MANAGER: [
            UserRoleInWorkspace.WORKSPACE_MANAGER,
            UserRoleInWorkspace.CONTENT_MANAGER,
            UserRoleInWorkspace.CONTRIBUTOR,
            UserRoleInWorkspace.READER,
        ],
        UserRoleInWorkspace.WORKSPACE_MANAGER: [
            UserRoleInWorkspace.WORKSPACE_MANAGER,
            UserRoleInWorkspace.CONTENT_MANAGER,
            UserRoleInWorkspace.CONTRIBUTOR,
            UserRoleInWorkspace.READER,
        ],
    }

    @classmethod
    def role_can_read_member_role(cls, reader_role: int, tested_role: int) \
            -> bool:
        """
        :param reader_role: role as viewer
        :param tested_role: role as viwed
        :return: True if given role can view member role in workspace.
        """
        if reader_role in cls.members_read_rights:
            return tested_role in cls.members_read_rights[reader_role]
        return False

    @classmethod
    def create_role(cls) -> UserRoleInWorkspace:

This method should have a docstring.

        role = UserRoleInWorkspace()

        return role

    def __init__(self, session: Session, current_user: typing.Optional[User]):

The variable typing does not seem to be defined.

        self._session = session
        self._user = current_user

    def _get_one_rsc(self, user_id, workspace_id):
        """
        :param user_id:
        :param workspace_id:
        :return: a Query object, filtered query but without fetching the object.
        """
        return self._session.query(UserRoleInWorkspace).\
            filter(UserRoleInWorkspace.workspace_id == workspace_id).\
            filter(UserRoleInWorkspace.user_id == user_id)

    def get_one(self, user_id, workspace_id):

This method should have a docstring.

        return self._get_one_rsc(user_id, workspace_id).one()

    def create_one(

This method should have a docstring.

Too many arguments (6/5)

            self,
            user: User,
            workspace: Workspace,
            role_level: int,
            with_notif: bool,
            flush: bool=True

Exactly one space required around keyword argument assignment

    ) -> UserRoleInWorkspace:
        role = self.create_role()
        role.user_id = user.user_id
        role.workspace = workspace
        role.role = role_level
        role.do_notify = with_notif
        if flush:
            self._session.flush()
        return role

    def delete_one(self, user_id, workspace_id, flush=True):

This method should have a docstring.

        self._get_one_rsc(user_id, workspace_id).delete()
        if flush:
            self._session.flush()

    def _get_all_for_user(self, user_id):
        return self._session.query(UserRoleInWorkspace)\
            .filter(UserRoleInWorkspace.user_id == user_id)

    def get_all_for_user(self, user_id):

This method should have a docstring.

        return self._get_all_for_user(user_id).all()

    def get_all_for_user_order_by_workspace(

The name get_all_for_user_order_by_workspace does not conform to the method naming conventions ((([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$).

This method should have a docstring.

            self,
            user_id: int
    ) -> UserRoleInWorkspace:
        return self._get_all_for_user(user_id)\
            .join(UserRoleInWorkspace.workspace).order_by(Workspace.label).all()

    def get_all_for_workspace(self, workspace_id):

This method should have a docstring.

        return self._session.query(UserRoleInWorkspace)\
            .filter(UserRoleInWorkspace.workspace_id == workspace_id).all()

    def save(self, role: UserRoleInWorkspace):

This method should have a docstring.

The argument role seems to be unused.

        self._session.flush()

    @classmethod
    def get_roles_for_select_field(cls):
        """

        :return: list of DictLikeClass instances representing available Roles
        (to be used in select fields)
        """
        result = list()

        for role_id in UserRoleInWorkspace.get_all_role_values():
            role = RoleType(role_id)
            result.append(role)

        return result