rosedu/wouso

View on GitHub
wouso/games/specialquest/models.py

Summary

Maintainability
B
6 hrs
Test Coverage
from datetime import date

from django.db import models

from wouso.core.user.models import Player, PlayerGroup
from wouso.core.game.models import Game


class Invitation(models.Model):
    group = models.ForeignKey('SpecialQuestGroup')
    to = models.ForeignKey('SpecialQuestUser')

    def __unicode__(self):
        return u"Invitation from %s to %s" % (self.group.head, self.to)


class GroupCompletion(models.Model):
    team = models.ForeignKey('SpecialQuestGroup')
    task = models.ForeignKey('SpecialQuestTask')

    date = models.DateTimeField(auto_now_add=True)


class SpecialQuestGroup(PlayerGroup):
    head = models.ForeignKey('SpecialQuestUser', related_name='owned_groups')
    active = models.BooleanField(default=False, blank=True)
    created = models.DateTimeField(auto_now_add=True)

    done_tasks = models.ManyToManyField('SpecialQuestTask', blank=True, default=None, null=True,
                                        through=GroupCompletion,
                                        related_name="%(app_label)s_%(class)s_done")

    @property
    def members(self):
        return [p.get_extension(SpecialQuestUser) for p in self.players.all()]

    @property
    def members_except_first(self):
        return [p.get_extension(SpecialQuestUser) for p in self.players.all()[1:]]

    @property
    def completed_tasks(self):
        return GroupCompletion.objects.filter(team=self).order_by('-date')

    def is_empty(self):
        return self.players.count() < 2

    def set_task_done(self, task):
        if task not in self.done_tasks.all():
            GroupCompletion.objects.create(team=self, task=task)

    @classmethod
    def create(cls, head, name):
        game = SpecialQuestGame.get_instance()
        new_group = cls.objects.create(owner=game, name=name, head=head)
        new_group.players.add(head)
        head.group = new_group
        head.save()
        return new_group

    def remove(self, user):
        """Removing the head user would delete the group. However, this is
        handled separately somewhere else, so no need to worry about it.
        """
        if user != self.head:
            user.group = None
            user.save()
            self.players.remove(user)

    def __unicode__(self):
        return u"%s [%d]" % (self.name, self.players.count())


class SpecialQuestTask(models.Model):
    name = models.CharField(max_length=200)
    text = models.TextField()
    start_date = models.DateField()
    end_date = models.DateField()
    value = models.IntegerField()

    def is_active(self, today=None):
        if today is None:
            today = date.today()
        return self.start_date <= today

    def is_archived(self, today=None):
        if today is None:
            today = date.today()
        return self.end_date < today

    @classmethod
    def active(cls):
        today = date.today()
        return cls.objects.filter(end_date__lte=today)

    @property
    def completed_teams(self):
        return GroupCompletion.objects.filter(task=self).order_by('-date')

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


class SpecialQuestUser(Player):
    group = models.ForeignKey('SpecialQuestGroup', blank=True, default=None, null=True)
    done_tasks = models.ManyToManyField(SpecialQuestTask, blank=True, default=None, null=True,
                                        related_name="%(app_label)s_%(class)s_done")

    _active_tasks = None

    @property
    def active(self):
        return self.group.active if self.group else False

    @property
    def self_group(self):
        gs = list(self.owned_groups.all())
        if not gs:
            return None
        return gs[0]

    @property
    def active_tasks(self):
        if self._active_tasks is not None:
            return self._active_tasks
        tasks = SpecialQuestTask.active()
        today = date.today()
        self._active_tasks = [t for t in tasks if t not in self.done_tasks.all() and t.start_date <= today <= t.end_date]
        return self._active_tasks

    def invitations(self):
        return self.invitation_set.all()

    def add_to_group(self, group):
        self.group = group
        self.save()
        group.players.add(self.user.get_profile())


class SpecialQuestGame(Game):
    """ Each game must extend Game """
    class Meta:
        # A Game extending core.game.models.Game should be set as proxy
        proxy = True

    user_model = SpecialQuestUser

    def __init__(self, *args, **kwargs):
        # Set parent's fields
        self._meta.get_field('verbose_name').default = "Special Quest"
        self._meta.get_field('short_name').default = ""
        # the url field takes as value only a named url from module's urls.py
        self._meta.get_field('url').default = "specialquest_index_view"
        super(SpecialQuestGame, self).__init__(*args, **kwargs)

    @classmethod
    def tasks_for_user(kls, user):
        """ Return a pair of tasks_done, tasks_not_done for requested user
        """
        tasks = SpecialQuestTask.objects.all()
        tasks_done = [t for t in tasks if t in user.done_tasks.all()]
        tasks_not_done = [t for t in tasks if t not in user.done_tasks.all()]
        tasks_not_done = [t for t in tasks_not_done if t.is_active()]
        return tasks_done, tasks_not_done

    @classmethod
    def get_staff_and_permissions(cls):
        return [{'name': 'Specialquest Staff', 'permissions': ['change_specialquestuser']}]

    @classmethod
    def get_formulas(kls):
        fs = []
        quest_game = kls.get_instance()
        fs.append(dict(name='specialquest-passed', expression='gold={value}',
                  owner=quest_game.game,
                  description='Points earned when finishing a task. Arguments: value.'))

        return fs

    @classmethod
    def get_specialquest_user_button(kls, request, player):
        specialquest_button = dict(MATE=False, OTHER=False,
                                   ALREADY_INVITED=False, INIVTE=False)
        if request.user.get_profile().id != player.id:
            squser = request.user.get_profile().get_extension(SpecialQuestUser)
            targetuser = player.get_extension(SpecialQuestUser)
            if (not squser.self_group and not targetuser.group) or (squser.active or targetuser.active):
                return specialquest_button

            if ((squser.self_group is not None) and (targetuser in squser.self_group.members)) or ((targetuser.group is not None) and (squser in targetuser.group.members)):
                specialquest_button['MATE'] = True
                return specialquest_button

            if targetuser.group is not None:
                specialquest_button['OTHER'] = True
                return specialquest_button

            if Invitation.objects.filter(to=targetuser, group=squser.group).count() > 0:
                specialquest_button['ALREADY_INVITED'] = True
                return specialquest_button

            specialquest_button['INVITE'] = True
            return specialquest_button

        return specialquest_button