about summary refs log tree commit diff stats
path: root/pkgs/by-name/up/update-vim-plugins/update_vim_plugins/nix.py
blob: 66a8df4cad4702f67b903c95c3d0d56e2c332c87 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
import abc
import enum
import json
import subprocess


def nix_prefetch_url(url):
    """Return the sha256 hash of the given url."""
    subprocess_output = subprocess.check_output(
        ["nix-prefetch-url", "--type", "sha256", url],
        stderr=subprocess.DEVNULL,
    )
    sha256 = subprocess_output.decode("utf-8").strip()
    return sha256


def nix_prefetch_git(url):
    """Return the sha256 hash of the given git url."""
    subprocess_output = subprocess.check_output(["nix-prefetch-git", url], stderr=subprocess.DEVNULL)
    sha256 = json.loads(subprocess_output)["sha256"]
    return sha256


class Source(abc.ABC):
    """Abstract base class for sources."""

    url: str
    sha256: str

    @abc.abstractmethod
    def __init__(self, url: str) -> None:
        """Initialize a Source."""

    @abc.abstractmethod
    def get_nix_expression(self):
        """Return the nix expression for this source."""

    def __repr__(self):
        """Return the representation of this source."""
        return self.get_nix_expression()


class UrlSource(Source):
    """A source that is a url."""

    def __init__(self, url: str) -> None:
        """Initialize a UrlSource."""
        self.url = url
        self.sha256 = nix_prefetch_url(url)

    def get_nix_expression(self):
        """Return the nix expression for this source."""
        return f'fetchurl {{ url = "{self.url}"; sha256 = "{self.sha256}"; }}'


class GitSource(Source):
    """A source that is a git repository."""

    def __init__(self, url: str, rev: str) -> None:
        """Initialize a GitSource."""
        self.url = url
        self.rev = rev
        self.sha256 = nix_prefetch_git(url)

    def get_nix_expression(self):
        """Return the nix expression for this source."""
        return f'fetchgit {{ url = "{self.url}"; rev = "{self.rev}"; sha256 = "{self.sha256}"; }}'


class License(enum.Enum):
    """An enumeration of licenses."""

    AGPL_3_0 = "agpl3Only"
    APACHE_2_0 = "asf20"
    BSD_2_CLAUSE = "bsd2"
    BSD_3_CLAUSE = "bsd3"
    BSL_1_0 = "bsl1_0"
    CC0_1_0 = "cc0"
    EPL_2_0 = "epl20"
    GPL_2_0 = "gpl2Only"
    GPL_3_0 = "gpl3Only"
    ISCLGPL_2_1 = "lgpl21Only"
    MIT = "mit"
    MPL_2_0 = "mpl20"
    UNLUNLICENSE = "unlicense"
    WTFPL = "wtfpl"
    UNFREE = "unfree"
    UNKNOWN = ""

    @classmethod
    def from_spdx_id(cls, spdx_id: str | None) -> "License":
        """Return the License from the given spdx_id."""
        mapping = {
            "AGPL-3.0": cls.AGPL_3_0,
            "AGPL-3.0-only": cls.AGPL_3_0,
            "Apache-2.0": cls.APACHE_2_0,
            "BSD-2-Clause": cls.BSD_2_CLAUSE,
            "BSD-3-Clause": cls.BSD_3_CLAUSE,
            "BSL-1.0": cls.BSL_1_0,
            "CC0-1.0": cls.CC0_1_0,
            "EPL-2.0": cls.EPL_2_0,
            "GPL-2.0": cls.GPL_2_0,
            "GPL-2.0-only": cls.GPL_2_0,
            "GPL-3.0": cls.GPL_3_0,
            "GPL-3.0-only": cls.GPL_3_0,
            "LGPL-2.1-only": cls.ISCLGPL_2_1,
            "MIT": cls.MIT,
            "MPL-2.0": cls.MPL_2_0,
            "Unlicense": cls.UNLUNLICENSE,
            "WTFPL": cls.WTFPL,
        }

        if spdx_id is None:
            return cls.UNKNOWN

        spdx_id = spdx_id.upper()
        return mapping.get(spdx_id, cls.UNKNOWN)

    def __str__(self):
        """Return the string representation of this license."""
        return self.value