refactor(git)!: Use dataclass for GitRemote

Author: tony

libvcs/projects/git.py

@@ -14,6 +14,7 @@
     - [`GitProject.get_revision`](libvcs.git.GitProject.get_revision)
     - [`GitProject.get_git_version`](libvcs.git.GitProject.get_git_version)
 """  # NOQA: E501
+import dataclasses
 import logging
 import pathlib
 import re
@@ -26,23 +27,27 @@
 logger = logging.getLogger(__name__)
 
 
-class GitRemote(NamedTuple):
-    """Structure containing git repo information.
-
-    Supports `collections.namedtuple._asdict()`
-    """
+class GitRemoteDict(TypedDict):
+    """For use when hydrating GitProject via dict."""
 
-    name: str
     fetch_url: str
     push_url: str
 
 
-class GitRemoteDict(TypedDict):
-    """For use when hydrating GitProject via dict."""
+@dataclasses.dataclass
+class GitRemote:
+    """Structure containing git working copy information."""
 
+    name: str
     fetch_url: str
     push_url: str
 
+    def to_dict(self):
+        return dataclasses.asdict(self)
+
+    def to_tuple(self):
+        return dataclasses.astuple(self)
+
 
 GitProjectRemoteDict = Dict[str, GitRemote]
 GitFullRemoteDict = Dict[str, GitRemoteDict]
@@ -487,7 +492,7 @@ def remotes(self, flat=False) -> Dict:
 
         for remote_name in ret:
             remotes[remote_name] = (
-                self.remote(remote_name) if flat else self.remote(remote_name)._asdict()
+                self.remote(remote_name) if flat else self.remote(remote_name).to_dict()
             )
         return remotes
 

tests/projects/test_git.py

@@ -315,7 +315,7 @@ def test_remotes(
             expected_remote_name,
             expected_remote_url,
             expected_remote_url,
-        ) == git_repo.remote(expected_remote_name)
+        ) == git_repo.remote(expected_remote_name).to_tuple()
 
 
 @pytest.mark.parametrize(
@@ -493,7 +493,7 @@ def test_remotes_preserves_git_ssh(
     git_repo.set_remote(name=remote_name, url=remote_url)
 
     assert (
-        GitRemote(remote_name, remote_url, remote_url)._asdict()
+        GitRemote(remote_name, remote_url, remote_url).to_dict()
         in git_repo.remotes().values()
     )
 
@@ -553,9 +553,12 @@ def test_get_remotes(git_repo: GitProject):
 def test_set_remote(git_repo: GitProject, repo_name: str, new_repo_url: str):
     mynewremote = git_repo.set_remote(name=repo_name, url="file:///")
 
-    assert "file:///" in mynewremote, "set_remote returns remote"
+    assert "file:///" in mynewremote.fetch_url, "set_remote returns remote"
 
-    assert "file:///" in git_repo.remote(name=repo_name), "remote returns remote"
+    assert isinstance(
+        git_repo.remote(name=repo_name), GitRemote
+    ), "remote() returns GitRemote"
+    assert "file:///" in git_repo.remote(name=repo_name).fetch_url, "new value set"
 
     assert "myrepo" in git_repo.remotes(), ".remotes() returns new remote"
 
@@ -567,8 +570,8 @@ def test_set_remote(git_repo: GitProject, repo_name: str, new_repo_url: str):
 
     mynewremote = git_repo.set_remote(name="myrepo", url=new_repo_url, overwrite=True)
 
-    assert new_repo_url in git_repo.remote(
-        name="myrepo"
+    assert (
+        new_repo_url in git_repo.remote(name="myrepo").fetch_url
     ), "Running remove_set should overwrite previous remote"