parse-git-url 2.0.0__tar.gz

parse_git_url-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Dewey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

parse_git_url-2.0.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: parse-git-url
+Version: 2.0.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# giturlparse
+
+A simple git URL parser.
+
+Special thanks to the original author @retr0h and the author who inspired them, @FriendCode.
+
+## License
+
+MIT
+
+## Contributing
+
+Thanks for your interest, feel free to submit issues or PRs and I'll take a peek when I can.
+
+Formatting:
+`uv run ruff format`
+
+Testing:
+`uv run pytest --cov=src/`
+
+Doc:
+`uv run pdoc --output-dir=docs src/`
+
+PRs will be squashed before merging into (conventional commits)[https://www.conventionalcommits.org/en/v1.0.0/].
+

parse_git_url-2.0.0/README.md

@@ -0,0 +1,25 @@
+# giturlparse
+
+A simple git URL parser.
+
+Special thanks to the original author @retr0h and the author who inspired them, @FriendCode.
+
+## License
+
+MIT
+
+## Contributing
+
+Thanks for your interest, feel free to submit issues or PRs and I'll take a peek when I can.
+
+Formatting:
+`uv run ruff format`
+
+Testing:
+`uv run pytest --cov=src/`
+
+Doc:
+`uv run pdoc --output-dir=docs src/`
+
+PRs will be squashed before merging into (conventional commits)[https://www.conventionalcommits.org/en/v1.0.0/].
+

parse_git_url-2.0.0/pyproject.toml

@@ -0,0 +1,15 @@
+[project]
+name = "parse-git-url"
+version = "2.0.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = []
+
+[dependency-groups]
+dev = [
+    "pdoc>=16.0.0",
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.15.15",
+]

parse_git_url-2.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

parse_git_url-2.0.0/src/__init__.py

@@ -0,0 +1,35 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright (c) 2017 John Dewey
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+from importlib.metadata import version, PackageNotFoundError
+from .parser import GitUrl
+
+try:
+    __version__ = version("git-url-parse")
+except PackageNotFoundError:
+    # pkg not installed
+    __version__ = "0.0.0.0"
+
+
+def parse(url: str) -> GitUrl:  # pragma: no cover
+    """Parses a remote URL for a Git repository"""
+    return GitUrl.from_str(url)

parse_git_url-2.0.0/src/parse_git_url.egg-info/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: parse-git-url
+Version: 2.0.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# giturlparse
+
+A simple git URL parser.
+
+Special thanks to the original author @retr0h and the author who inspired them, @FriendCode.
+
+## License
+
+MIT
+
+## Contributing
+
+Thanks for your interest, feel free to submit issues or PRs and I'll take a peek when I can.
+
+Formatting:
+`uv run ruff format`
+
+Testing:
+`uv run pytest --cov=src/`
+
+Doc:
+`uv run pdoc --output-dir=docs src/`
+
+PRs will be squashed before merging into (conventional commits)[https://www.conventionalcommits.org/en/v1.0.0/].
+

parse_git_url-2.0.0/src/parse_git_url.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/__init__.py
+src/parser.py
+src/parse_git_url.egg-info/PKG-INFO
+src/parse_git_url.egg-info/SOURCES.txt
+src/parse_git_url.egg-info/dependency_links.txt
+src/parse_git_url.egg-info/top_level.txt
+test/test_parser.py

parse_git_url-2.0.0/src/parse_git_url.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

parse_git_url-2.0.0/src/parse_git_url.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+parser

parse_git_url-2.0.0/src/parser.py

@@ -0,0 +1,101 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright (c) 2017 John Dewey
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+from __future__ import annotations
+import collections
+from typing import NamedTuple
+import re
+
+
+POSSIBLE_REGEXES = (
+    re.compile(
+        r"^(?P<protocol>https?|git|ssh|rsync)\://"
+        r"(?:(?P<user>.+)@)*"
+        r"(?P<resource>[a-z0-9_.-]*)"
+        r"[:/]*"
+        r"(?P<port>[\d]+){0,1}"
+        r"(?P<pathname>\/((?P<owner>[\w\-]+)\/)?"
+        r"((?P<name>[\w\-\.]+?)(\.git|\/)?)?)$"
+    ),
+    re.compile(
+        r"(git\+)?"
+        r"((?P<protocol>\w+)://)"
+        r"((?P<user>\w+)@)?"
+        r"((?P<resource>[\w\.\-]+))"
+        r"(:(?P<port>\d+))?"
+        r"(?P<pathname>(\/(?P<owner>\w+)/)?"
+        r"(\/?(?P<name>[\w\-]+)(\.git|\/)?)?)$"
+    ),
+    re.compile(
+        r"^(?:(?P<user>.+)@)*"
+        r"(?P<resource>[a-z0-9_.-]*)[:]*"
+        r"(?P<port>[\d]+){0,1}"
+        r"(?P<pathname>\/?(?P<owner>.+)/(?P<name>.+).git)$"
+    ),
+    re.compile(
+        r"((?P<user>\w+)@)?"
+        r"((?P<resource>[\w\.\-]+))"
+        r"[\:\/]{1,2}"
+        r"(?P<pathname>((?P<owner>\w+)/)?"
+        r"((?P<name>[\w\-]+)(\.git|\/)?)?)$"
+    ),
+)
+
+
+type MaybeStr = str | None
+
+
+class ParseError(Exception):
+    """Error raised when a URL can't be parsed."""
+
+    pass
+
+
+class GitUrl(NamedTuple):
+    pathname: MaybeStr = None
+    protocols: str | list[str] = []
+    protocol: str = "ssh"
+    href: MaybeStr = None
+    resource: str | None = None
+    user: MaybeStr = None
+    port: MaybeStr = None
+    name: MaybeStr = None
+    owner: MaybeStr = None
+
+    @staticmethod
+    def from_str(url: str) -> GitUrl:
+        for regex in POSSIBLE_REGEXES:
+            if match := regex.search(url):
+                data = match.groupdict()
+                data["href"] = url
+                data["protocols"] = _get_protocols(url)
+                return GitUrl(**data)
+        raise ParseError(f"Invalid URL '{url}'")
+
+
+def _get_protocols(url: str) -> list[str]:
+    try:
+        idx = url.index("://")
+        return url[:idx].split("+")
+    except (ValueError, IndexError):
+        return []
+

parse_git_url-2.0.0/test/test_parser.py

@@ -0,0 +1,72 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright (c) 2017 John Dewey
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+from src.parser import GitUrl
+import pytest
+
+from src import parser
+
+
+@pytest.mark.parametrize(
+    "test_input",
+    [
+        "first_match_urls",
+        "second_match_urls",
+        "third_match_urls",
+        "fourth_match_urls",
+    ],
+)
+def test_parse(request, test_input):
+    url_data = request.getfixturevalue(test_input)
+    for url, d in url_data.items():
+        result = GitUrl.from_str(url)
+
+        assert d["pathname"] == result.pathname
+        assert d["protocols"] == result.protocols
+        assert d["protocol"] == result.protocol
+        assert d["href"] == result.href
+        assert d["resource"] == result.resource
+        assert d["user"] == result.user
+        assert d["port"] == result.port
+        assert d["name"] == result.name
+        assert d["owner"] == result.owner
+
+
+def test_parse_raises_on_invalid_string(invalid_strings):
+    for invalid_string in invalid_strings:
+        with pytest.raises(parser.ParseError):
+            GitUrl.from_str(invalid_string)
+
+
+def test_get_protocol_multiple_protocols():
+    parsed = parser._get_protocols("git+ssh://git@example.com/Owner/Repository.git")
+    assert ["git", "ssh"] == parsed
+
+
+def test_get_protocol_no_protocols():
+    assert [] == parser._get_protocols("//example.com/foo")
+
+
+def test_get_protocol_one_protocols():
+    parsed = parser._get_protocols("ssh://git@example.com/Owner/Repository.git")
+
+    assert ["ssh"] == parsed