buildtimetrend.Collection

Complexity

Total Complexity

14

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

8 Methods

Rating	Name	Duplication	Size	Complexity
A	Collection.get_item()	0	11	2
A	Collection.get_key_sorted_items()	0	3	1
A	Collection.get_items()	0	4	1
A	Collection.__init__()	0	3	1
A	Collection.add_item()	0	13	4
A	Collection.get_items_with_summary()	0	15	2
A	Collection.get_size()	0	3	1
A	Collection.add_items()	0	10	2

# vim: set expandtab sw=4 ts=4:
"""
Dictionary based collection class.

Copyright (C) 2014-2016 Dieter Adriaenssens <ruleant@users.sourceforge.net>

This file is part of buildtimetrend/python-lib
<https://github.com/buildtimetrend/python-lib/>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""

import copy
from collections import OrderedDict
from buildtimetrend.tools import check_dict
from buildtimetrend import logger


class Collection(object):

    """Dictionary based collection object."""

    def __init__(self):
        """Initialize instance."""
        self.items = {}

    def add_item(self, name, value):
        """
        Add an item to the collection.

        Parameters :
        - name : Item name
        - value : Item value
        """
        if check_dict(value) and name in self.items and \
                check_dict(self.items[name]):
            self.items[name].update(value)
        else:
            self.items[name] = value

    def get_item(self, name):
        """
        Get an item from a collection.

        Parameters :
        - name : Item name
        """
        if name in self.items:
            return self.items[name]
        else:
            return None

    def get_size(self):
        """Get collection size."""
        return len(self.items)

    def add_items(self, items_dict):
        """
        Add items as a dictionary to the collection.

        Parameters:
        - items_dict : dictionary with items
        """
        if check_dict(items_dict, "items_dict"):
            # append dictionary with items to the existing collection
            self.items.update(items_dict)

    def get_items(self):
        """Return items collection as dictionary."""
        # copy values of items collection
        return copy.deepcopy(self.items)

    def get_items_with_summary(self):
        """Return items collection as dictionary with an summary property."""
        items = self.get_items()

        # concatenate all properties in a summary field
        matrix_params = self.get_key_sorted_items().values()
        try:
            items["summary"] = " ".join(matrix_params)
        except TypeError as msg:
            logger.error(
                "Error parsing build matrix properties : %s, message : %s",
                matrix_params, str(msg)
            )

        return items

    def get_key_sorted_items(self):
        """Return items as an ordered dictionary, sorted on key."""
        return OrderedDict(sorted(self.items.items()))