CollageLabs/candyshop

# -*- coding: utf-8 -*-
#
# Please refer to AUTHORS.rst for a complete list of Copyright holders.
# Copyright (C) 2016-2022, Candyshop Developers.

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) 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 General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.
"""
``candyshop.utils`` is a utility module.

This module contains several utilities to process information coming from the
other modules.
"""

import os
import re
import fnmatch


class ModuleProperties(object):
    """
    This class holds the properties of a module.

    It recieves a Dictionary and converts it to class attributes
    for better access.

    For example:

    >>> p = ModuleProperties({'name': 'Vauxoo Module'})
    >>> p.name
    'Vauxoo Module'
    """

    def __init__(self, data):
        """
        Initialize the ``ModuleProperties`` instance.

        :param data: a dictionary containing the properties of a module as
                     specified in the manifest file of an Odoo Module.
        :return: each key-value is assigned as an attribute to this class.

        .. versionadded:: 0.1.0
        """
        for key in data:
            setattr(self, key, data[key])


def strip_comments_and_blanks(strng=None):
    r"""
    Remove single-line comments and blank lines.

    This function receives a string and removes every line containing a comment
    or a blank line.

    :param strng: (string) a string.
    :return: (string) the string without comments or blank lines.

    For example:

    >>> s = '''
    ... # This is a comment
    ...
    ... bar # This is an inline comment
    ...
    ... foo # Another comment
    ... # I comment a lot
    ...
    ... '''
    >>> strip_comments_and_blanks(s)
    'bar\nfoo'

    .. versionadded:: 0.1.0
    """
    return '\n'.join(filter(None, re.sub(r'\s*#.*', '', strng).split('\n')))


def get_path(path=None):
    """
    Build and normalize a path.

    This will resolve symlinks to their destination and convert
    relative to absolute paths. This function does not check if
    the python path really exists.

    :param path: a list with the components of a path.
    :return: a string indicating the full path.

    For example:

    >>> p = ['/usr', 'share', 'logs/vars', 'included', 'hola.txt']
    >>> get_path(p)
    '/usr/share/logs/vars/included/hola.txt'

    .. versionadded:: 0.1.0
    """
    path = path or []
    assert type(path) == list
    return os.path.normpath(os.path.realpath(
        os.path.abspath(os.path.join(*path))))


def find_files(path=None, pattern='*'):
    """
    Search for files.

    Locate all the files matching the supplied filename pattern in and below
    the supplied root directory. If no pattern is supplied, all files will be
    returned.

    :param path: a string containing a path where the files will be looked for.
    :param pattern: a string containing a regular expression.
    :return: a list of files matching the pattern within path (recursive).

    .. versionadded:: 0.1.0
    """
    d = []
    assert type(path) == str
    assert type(pattern) == str
    for directory, subdirs, files in os.walk(os.path.normpath(path)):
        for filename in fnmatch.filter(files, pattern):
            if os.path.isfile(os.path.join(directory, filename)):
                if os.path.islink(os.path.join(directory, filename)):
                    d.append(os.path.join(get_path([directory]), filename))
                else:
                    d.append(get_path([directory, filename]))
    return d