rebase

Author: filipchristiansen

src/gitingest/clone.py

@@ -7,11 +7,11 @@
 
 from gitingest.config import DEFAULT_TIMEOUT
 from gitingest.utils.git_utils import (
-    is_github_host,
     check_repo_exists,
     create_git_auth_header,
     create_git_command,
     ensure_git_installed,
+    is_github_host,
     run_command,
     validate_github_token,
 )

src/gitingest/utils/git_utils.py

@@ -5,7 +5,6 @@
 import asyncio
 import base64
 import re
-import warnings
 from urllib.parse import urlparse
 
 from gitingest.utils.exceptions import InvalidGitHubTokenError
@@ -14,8 +13,7 @@
 
 
 def is_github_host(url: str) -> bool:
-    """
-    Check if a URL is from a GitHub host (github.com or GitHub Enterprise).
+    """Check if a URL is from a GitHub host (github.com or GitHub Enterprise).
 
     Parameters
     ----------
@@ -26,6 +24,7 @@ def is_github_host(url: str) -> bool:
     -------
     bool
         True if the URL is from a GitHub host, False otherwise
+
     """
     hostname = urlparse(url).hostname or ""
     return hostname == "github.com" or hostname.startswith("github.")
@@ -150,8 +149,6 @@ async def _check_github_repo_exists(url: str, token: str | None = None) -> bool:
 
     Raises
     ------
-    ValueError
-        If the URL is not a valid GitHub repository URL.
     RuntimeError
         If the repository is not found, if the provided URL is invalid, or if the token format is invalid.
 
@@ -214,17 +211,22 @@ def _parse_github_url(url: str) -> tuple[str, str, str]:
     ------
     ValueError
         If the URL is not a valid GitHub repository URL.
+
     """
+    expected_path_length = 2
     parsed = urlparse(url)
     if parsed.scheme not in {"http", "https"}:
-        raise ValueError("URL must start with http:// or https://")
+        msg = f"URL must start with http:// or https://: {url!r}"
+        raise ValueError(msg)
 
     if not parsed.hostname or not parsed.hostname.startswith("github."):
-        raise ValueError(f"Un-recognised GitHub hostname: {parsed.hostname!r}")
+        msg = f"Un-recognised GitHub hostname: {parsed.hostname!r}"
+        raise ValueError(msg)
 
     parts = parsed.path.strip("/").removesuffix(".git").split("/")
-    if len(parts) != 2:
-        raise ValueError("Path must look like /<owner>/<repo>")
+    if len(parts) != expected_path_length:
+        msg = f"Path must look like /<owner>/<repo>: {parsed.path!r}"
+        raise ValueError(msg)
 
     owner, repo = parts
     return parsed.hostname, owner, repo
@@ -293,14 +295,14 @@ def create_git_command(base_cmd: list[str], local_path: str, url: str, token: st
     return cmd
 
 
-def create_git_auth_header(token: str, url: str | None = None) -> str:
+def create_git_auth_header(token: str, url: str = "https://github.com") -> str:
     """Create a Basic authentication header for GitHub git operations.
 
     Parameters
     ----------
     token : str
         GitHub personal access token
-    url : str | None
+    url : str
         The GitHub URL to create the authentication header for.
         Defaults to "https://github.com" if not provided.
 
@@ -310,19 +312,7 @@ def create_git_auth_header(token: str, url: str | None = None) -> str:
         The git config command for setting the authentication header
 
     """
-    if url is None:
-        # TODO: Deprecate implicit github.com URL and require passing the url
-        warnings.warn(
-            "Implicitly assuming 'github.com' as the host is deprecated and will be "
-            "removed in a future release. Explicitly pass the repository `url` to "
-            "create_git_auth_header() instead.",
-            DeprecationWarning,
-            stacklevel=2,
-        )
-        hostname = "github.com"
-    else:
-        hostname = urlparse(url).hostname
-
+    hostname = urlparse(url).hostname
     basic = base64.b64encode(f"x-oauth-basic:{token}".encode()).decode()
     return f"http.https://{hostname}/.extraheader=Authorization: Basic {basic}"
 

tests/test_git_utils.py

@@ -154,7 +154,7 @@ def test_create_git_command_helper_calls(
 
     if should_call:
         validate_mock.assert_called_once_with(token)
-        header_mock.assert_called_once_with(token)
+        header_mock.assert_called_once_with(token, url=url)
         assert "HEADER" in cmd
     else:
         validate_mock.assert_not_called()
@@ -163,7 +163,7 @@ def test_create_git_command_helper_calls(
 
 
 @pytest.mark.parametrize(
-    "url, expected",
+    ("url", "expected"),
     [
         # GitHub.com URLs
         ("https://github.com/owner/repo.git", True),
@@ -187,13 +187,13 @@ def test_create_git_command_helper_calls(
         ("ftp://github.com/owner/repo.git", True),  # Different protocol but still github.com
     ],
 )
-def test_is_github_host(url: str, expected: bool) -> None:
+def test_is_github_host(url: str, *, expected: bool) -> None:
     """Test that ``is_github_host`` correctly identifies GitHub and GitHub Enterprise URLs."""
     assert is_github_host(url) == expected
 
 
 @pytest.mark.parametrize(
-    "token, url, expected_hostname",
+    ("token", "url", "expected_hostname"),
     [
         # GitHub.com URLs (default)
         ("ghp_" + "a" * 36, "https://github.com", "github.com"),
@@ -206,7 +206,7 @@ def test_is_github_host(url: str, expected: bool) -> None:
 )
 def test_create_git_auth_header_with_ghe_url(token: str, url: str, expected_hostname: str) -> None:
     """Test that ``create_git_auth_header`` handles GitHub Enterprise URLs correctly."""
-    header = create_git_auth_header(token, url)
+    header = create_git_auth_header(token, url=url)
     expected_basic = base64.b64encode(f"x-oauth-basic:{token}".encode()).decode()
     expected = f"http.https://{expected_hostname}/.extraheader=Authorization: Basic {expected_basic}"
     assert header == expected
@@ -258,7 +258,7 @@ def test_create_git_command_with_ghe_urls(
     cmd = create_git_command(base_cmd, local_path, url, token)
 
     # Should have base command and -C option
-    expected_prefix = base_cmd + ["-C", local_path]
+    expected_prefix = [*base_cmd, "-C", local_path]
     assert cmd[: len(expected_prefix)] == expected_prefix
 
     # Should have -c and auth header
@@ -290,5 +290,5 @@ def test_create_git_command_ignores_non_github_urls(
     cmd = create_git_command(base_cmd, local_path, url, token)
 
     # Should only have base command and -C option, no auth headers
-    expected = base_cmd + ["-C", local_path]
+    expected = [*base_cmd, "-C", local_path]
     assert cmd == expected