ore.models.project

Complexity

Total Complexity

3

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	Project.__unicode__()	0	2	1
A	Project.to_dict()	0	13	1
A	Project.is_authorized()	0	11	1

from django.contrib.auth.models import User
from django.db import models


class Project(models.Model):

    """
    Class: Project

    Fields:
     {str}            name     - the name of the project
     {User}           owner    - a link to the owner of the project
     {User}           users    - a link to the members of the project
     {const datetime} created  - timestamp of the moment of project creation (default: now)
     {bool}           deleted  - flag indicating whether this project was deleted or not. Simplifies restoration of the
                                 project if needed by toggling this member (default: False)
    """

    class Meta:
        app_label = 'ore'

    name = models.CharField(max_length=255)
    owner = models.ForeignKey(User, related_name='own_projects')
    users = models.ManyToManyField(User, related_name='projects')
    modified = models.DateTimeField(auto_now=True)
    created = models.DateTimeField(auto_now_add=True, editable=False)
    deleted = models.BooleanField(default=False)

    def __unicode__(self):
        return unicode(self.name)

The variable unicode does not seem to be defined.

    def to_dict(self):
        """
        Method: to_dict

        Encodes the project as dictionary

        Returns:
         {dict} the project as dictionary
        """
        return {
            'pk': self.pk,
            'name': self.name,
            'created': self.created
        }

    def is_authorized(self, user):
        """
        Method: is_authorized

        A user is athorized to browse a project if he is the owner or member of the project

        Returns:
          {bool}
        """
        return (self.owner == user) or (
            self.users.all().filter(id=user.id).exists())