Completed
Pull Request — master (#2397)
by Zatreanu
02:11 queued 01:55
created

GemRequirement.install_command()   A

Complexity

Conditions 2

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
c 1
b 0
f 0
dl 0
loc 16
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 GemRequirement(PackageRequirement):
7
    """
8
    This class is a subclass of ``PackageRequirement``, and helps specifying
9
    requirements from ``gem``, without using the manager name.
10
    """
11
12
    def __init__(self, package, version="", require=""):
13
        """
14
        Constructs a new ``GemRequirement``, using the ``PackageRequirement``
15
        constructor.
16
17
        >>> pr = GemRequirement('setuptools', '19.2', 'flag')
18
        >>> pr.manager
19
        'gem'
20
        >>> pr.package
21
        'setuptools'
22
        >>> pr.version
23
        '19.2'
24
        >>> pr.require
25
        'flag'
26
27
        :param package: A string with the name of the package to be installed.
28
        :param version: A version string. Leave empty to specify latest version.
29
        :param require: A string that specifies any additional flags, that
30
                        would be used with ``require``.
31
        """
32
        PackageRequirement.__init__(self, 'gem', package, version)
33
        self.require = require
34
35
    def install_command(self):
36
        """
37
        Creates the installation command for the instance of the class.
38
39
        >>> GemRequirement('rubocop').install_command()
40
        'gem install rubocop'
41
42
        >>> GemRequirement('scss_lint', '', 'false').install_command()
43
        "gem install 'scss_lint', require: false"
44
45
        :param return: A string with the installation command.
46
        """
47
        if self.require:
48
            return "gem install '{}', require: {}".format(self.package,
49
                                                          self.require)
50
        return "gem install {}".format(self.package)
51
52
    def is_installed(self):
53
        """
54
        Checks if the dependency is installed.
55
56
        :param return: True if dependency is installed, false otherwise.
57
        """
58
        exe = 'gem.bat' if platform.system() == 'Windows' else 'gem'
59
        return not call_without_output([exe, 'list', '-i', self.package])
60