NpmRequirement

Complexity

Total Complexity

4

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__init__()	0	17	1
A	install_command()	0	11	1
A	is_installed()	0	18	2

from coalib.bears.requirements.PackageRequirement import PackageRequirement
import shutil


class NpmRequirement(PackageRequirement):
    """
    This class is a subclass of ``PackageRequirement``, and helps specifying
    requirements from ``npm``, without using the manager name.
    """

    def __init__(self, package, version=""):
        """
        Constructs a new ``NpmRequirement``, using the ``PackageRequirement``
        constructor.

        >>> pr = NpmRequirement('ramllint', '6.2')
        >>> pr.manager
        'npm'
        >>> pr.package
        'ramllint'
        >>> pr.version
        '6.2'

        :param package: A string with the name of the package to be installed.
        :param version: A version string. Leave empty to specify latest version.
        """
        PackageRequirement.__init__(self, 'npm', package, version)

    def install_command(self):
        """
        Creates the installation command for the instance of the class.

        >>> pr = NpmRequirement('alex', '2')
        >>> pr.install_command()
        'npm install alex@2'

        :param return: A string with the installation command.
        """
        return "npm install {}@{}".format(self.package, self.version)

    def is_installed(self):
        """
        Checks if the dependency is installed.

        >>> pr = NpmRequirement('npm')
        >>> pr.is_installed()
        True

        >>> pr = NpmRequirement('some_package')
        >>> pr.is_installed()
        False

        :param return: True if dependency is installed, false otherwise.
        """
        if shutil.which(self.package):
            return True
        else:
            return False