Completed
Pull Request — master (#2397)
by Zatreanu
02:18
created

NpmRequirement.install_command()   A

Complexity

Conditions 1

Size

Total Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
c 1
b 0
f 0
dl 0
loc 10
rs 9.4285
1
from coalib.bears.requirements.PackageRequirement import PackageRequirement
2
from coalib.misc.Shell import call_without_output
3
import platform
4
5
6
class NpmRequirement(PackageRequirement):
7
    """
8
    This class is a subclass of ``PackageRequirement``, and helps specifying
9
    requirements from ``npm``, without using the manager name.
10
    """
11
12
    def __init__(self, package, version=""):
13
        """
14
        Constructs a new ``NpmRequirement``, using the ``PackageRequirement``
15
        constructor.
16
17
        >>> pr = NpmRequirement('ramllint', '6.2')
18
        >>> pr.manager
19
        'npm'
20
        >>> pr.package
21
        'ramllint'
22
        >>> pr.version
23
        '6.2'
24
25
        :param package: A string with the name of the package to be installed.
26
        :param version: A version string. Leave empty to specify latest version.
27
        """
28
        PackageRequirement.__init__(self, 'npm', package, version)
29
30
    def install_command(self):
31
        """
32
        Creates the installation command for the instance of the class.
33
34
        >>> NpmRequirement('alex', '2').install_command()
35
        'npm install alex@2'
36
37
        :param return: A string with the installation command.
38
        """
39
        return "npm install {}@{}".format(self.package, self.version)
40
41
    def is_installed(self):
42
        """
43
        Checks if the dependency is installed.
44
45
        :param return: True if dependency is installed, false otherwise.
46
        """
47
        cmd = ['npm', 'show', self.package]
48
        if platform.system() == 'Windows':
49
            cmd = ['cmd', '/c'] + cmd
50
        return not call_without_output(cmd)
51