loglan_db.model_db.addons.addon_word_linker

Complexity

Total Complexity

9

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	AddonWordLinker.add_child()	0	15	2
A	AddonWordLinker.add_author()	0	12	2
A	AddonWordLinker.add_authors()	0	11	2
A	AddonWordLinker.add_children()	0	14	2
A	AddonWordLinker._is_parented()	0	11	1

# -*- coding: utf-8 -*-
"""
This module contains an addon for basic Word Model,
which makes it possible to specify the authors and derivatives of words
"""
from typing import List

from flask_sqlalchemy import BaseQuery

from loglan_db.model_db.base_author import BaseAuthor
from loglan_db.model_db.base_connect_tables import t_connect_words
from loglan_db.model_db.base_word import BaseWord


class AddonWordLinker:
    """AddonWordLinker Model"""
    _derivatives: BaseQuery = None
    authors: BaseQuery = None

    def _is_parented(self, child: BaseWord) -> bool:
        """
        Check, if this word is already added as a parent for this 'child'

        Args:
            child: BaseWord: BaseWord object to check

        Returns: bool:

        """
        return bool(self._derivatives.filter(t_connect_words.c.child_id == child.id).count() > 0)

    def add_child(self, child: BaseWord) -> str:
        """Add derivative for the source word
        Get words from Used In and add relationship in database

        Args:
          child: BaseWord: Object to add

        Returns:
            String with the name of the added child (BaseWord.name)

        """
        # TODO add check if type of child is allowed to add to this word
        if not self._is_parented(child):
            self._derivatives.append(child)
        return child.name

    def add_children(self, children: List[BaseWord]):
        """Add derivatives for the source word
        Get words from Used In and add relationship in database

        Args:
          children: List[BaseWord]:

        Returns:
          None

        """
        # TODO add check if type of child is allowed to add to this word
        new_children = list(set(children) - set(self._derivatives))
        _ = self._derivatives.extend(new_children) if new_children else None

    def add_author(self, author: BaseAuthor) -> str:
        """Connect Author object with BaseWord object

        Args:
          author: BaseAuthor:

        Returns:

        """
        if not self.authors.filter(BaseAuthor.abbreviation == author.abbreviation).count() > 0:
            self.authors.append(author)
        return author.abbreviation

    def add_authors(self, authors: List[BaseAuthor]):
        """Connect Author objects with BaseWord object

        Args:
          authors: List[BaseAuthor]:

        Returns:

        """
        new_authors = list(set(authors) - set(self.authors))
        _ = self.authors.extend(new_authors) if new_authors else None