Net-ng/kansha

View on GitHub
kansha/card_addons/label/comp.py

Summary

Maintainability
A
2 hrs
Test Coverage
# -*- coding:utf-8 -*-
#--
# Copyright (c) 2012-2014 Net-ng.
# All rights reserved.
#
# This software is licensed under the BSD License, as described in
# the file LICENSE.txt, which you should have received as part of
# this distribution.
#--

import random

from nagare import component, var, i18n

from kansha.toolbox import overlay
from kansha.board import excel_export
from kansha.services.search import schema
from kansha.cardextension import CardExtension

from .models import DataLabel


class Label(object):

    """Label component

    6 labels by board
    A label contains tuple (color, title)
    """

    def __init__(self, data):
        """Initialization

        In:
          - ``data`` -- the label's database object
        """
        self.id = data.id
        self._data = data

    @property
    def data(self):
        """Return the label from the database

        Return:
         - the DataLabel instance
        """
        if self._data is None:
            self._data = DataLabel.get(self.id)
        return self._data

    def __getstate__(self):
        self._data = None
        return self.__dict__

    @property
    def index(self):
        return self.data.index

    def get_color(self):
        return self.data.color

    def set_color(self, v):
        """Change the color of the label

        In:
          - ``v`` -- the color of the label as hex string (ex. '#CECECE')
        """
        self.data.color = v

    def get_title(self):
        return self.data.title

    def set_title(self, title):
        """Set title

        In:
            - ``title`` -- new title
        """
        self.data.title = title

    def add(self, card):
        self.data.add(card.data)

    def remove(self, card):
        self.data.remove(card.data)

    def __eq__(self, other):
        return self.id == other.id


class CardLabels(CardExtension):

    """Card labels component

    This component represents all labels associated with a card
    """

    LOAD_PRIORITY = 10

    def __init__(self, card, action_log, configurator):
        """Initialization

        In:
          - ``card`` -- the card object (Card instance)
        """
        super(CardLabels, self).__init__(card, action_log, configurator)
        self.comp_id = str(random.randint(10000, 100000))
        self.labels = [Label(label) for label in self.data]

    @staticmethod
    def get_schema_def():
        return schema.Text('labels')

    def update_document(self, document):
        document.labels = u' '.join(label.get_title() for label in self.labels)

    @property
    def data(self):
        return DataLabel.get_by_card(self.card.data)

    def update(self, other):

        active_labels = set(label.get_title() for label in other.labels)
        for label in self.get_available_labels():
            if label.get_title() in active_labels:
                self.activate(label)

    @property
    def colors(self):
        """Returns the colors of the labels associated with the card
        """
        return (l.get_color() for l in self.labels)

    def get_available_labels(self):
        """Returns the labels available in the card's board
        """
        return self.configurator.labels if self.configurator else []

    def activate(self, label):
        """Adds/removes a label to the current card.

        If the label is already associated with the card,
        remove it. Else add it.

        """
        if label in self.labels:
            label.remove(self.card)
            self.labels.remove(label)
        else:
            label.add(self.card)
            self.labels.append(label)
            self.labels.sort(key=lambda l: l.index)

    def delete(self):
        for label in self.labels:
            label.remove(self.card)
        self.labels = []


@excel_export.get_extension_title_for(CardLabels)
def get_extension_title_CardDescription(card_extension):
    return i18n._(u'Labels')


@excel_export.write_extension_data_for(CardLabels)
def write_extension_data_CardDescription(self, sheet, row, col, style):
    text = u', '.join(label.get_title() for label in self.labels)
    sheet.write(row, col, text, style)