refactor!(url): MATCHERS -> RULES

Author: tony

src/libvcs/url/base.py

@@ -173,18 +173,18 @@ def register(self, cls: Rule) -> None:
 
         **Example: git URLs + pip-style git URLs:**
 
-        This is already in :class:`GitURL` via :data:`PIP_DEFAULT_MATCHERS`. For the
+        This is already in :class:`GitURL` via :data:`PIP_DEFAULT_RULES`. For the
         sake of showing how extensibility works, here is a recreation based on
         :class:`GitBaseURL`:
 
         >>> from libvcs.url.git import GitBaseURL
 
-        >>> from libvcs.url.git import DEFAULT_MATCHERS, PIP_DEFAULT_MATCHERS
+        >>> from libvcs.url.git import DEFAULT_RULES, PIP_DEFAULT_RULES
 
         >>> @dataclasses.dataclass(repr=False)
         ... class GitURLWithPip(GitBaseURL):
         ...    rule_map: RuleMap = RuleMap(
-        ...        _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+        ...        _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         ...    )
 
         >>> GitURLWithPip.is_valid(url="git+ssh://[email protected]/tony/AlgoXY.git")

src/libvcs/url/git.py

@@ -60,7 +60,7 @@
 # Some https repos have .git at the end, e.g. https://github.com/org/repo.git
 
 
-DEFAULT_MATCHERS: list[Rule] = [
+DEFAULT_RULES: list[Rule] = [
     Rule(
         label="core-git-https",
         description="Vanilla git pattern, URL ending with optional .git suffix",
@@ -125,7 +125,7 @@
 """
 
 
-PIP_DEFAULT_MATCHERS: list[Rule] = [
+PIP_DEFAULT_RULES: list[Rule] = [
     Rule(
         label="pip-url",
         description="pip-style git URL",
@@ -191,7 +191,7 @@
 - https://pip.pypa.io/en/stable/topics/vcs-support/
 """  # NOQA: E501
 
-NPM_DEFAULT_MATCHERS: list[Rule] = []
+NPM_DEFAULT_RULES: list[Rule] = []
 """NPM-style git URLs.
 
 Git URL pattern (from docs.npmjs.com)::
@@ -262,7 +262,7 @@ class GitBaseURL(URLProtocol, SkipDefaultFieldsReprMixin):
     suffix: Optional[str] = None
 
     rule: Optional[str] = None
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_MATCHERS})
+    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
 
     def __post_init__(self) -> None:
         url = self.url
@@ -370,7 +370,7 @@ class GitPipURL(GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
     # commit-ish (rev): tag, branch, ref
     rev: Optional[str] = None
 
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_MATCHERS})
+    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in PIP_DEFAULT_RULES})
 
     def to_url(self) -> str:
         """Exports a pip-compliant URL.
@@ -479,7 +479,7 @@ class GitURL(GitPipURL, GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin):
     """
 
     rule_map: RuleMap = RuleMap(
-        _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+        _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
     )
 
     @classmethod

src/libvcs/url/hg.py

@@ -43,7 +43,7 @@
     )
 """
 
-DEFAULT_MATCHERS: list[Rule] = [
+DEFAULT_RULES: list[Rule] = [
     Rule(
         label="core-hg",
         description="Vanilla hg pattern",
@@ -74,7 +74,7 @@
     )
 """
 
-PIP_DEFAULT_MATCHERS: list[Rule] = [
+PIP_DEFAULT_RULES: list[Rule] = [
     Rule(
         label="pip-url",
         description="pip-style hg URL",
@@ -176,7 +176,7 @@ class HgURL(URLProtocol, SkipDefaultFieldsReprMixin):
 
     rule: Optional[str] = None
     # name of the :class:`Rule`
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_MATCHERS})
+    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
 
     def __post_init__(self) -> None:
         url = self.url

src/libvcs/url/svn.py

@@ -47,7 +47,7 @@
     )
 """
 
-DEFAULT_MATCHERS: list[Rule] = [
+DEFAULT_RULES: list[Rule] = [
     Rule(
         label="core-svn",
         description="Vanilla svn pattern",
@@ -78,7 +78,7 @@
     )
 """
 
-PIP_DEFAULT_MATCHERS: list[Rule] = [
+PIP_DEFAULT_RULES: list[Rule] = [
     Rule(
         label="pip-url",
         description="pip-style svn URL",
@@ -170,7 +170,7 @@ class SvnURL(URLProtocol, SkipDefaultFieldsReprMixin):
     ref: Optional[str] = None
 
     rule: Optional[str] = None
-    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_MATCHERS})
+    rule_map: RuleMap = RuleMap(_rule_map={m.label: m for m in DEFAULT_RULES})
 
     def __post_init__(self) -> None:
         url = self.url

tests/url/test_git.py

@@ -4,7 +4,7 @@
 
 from libvcs.sync.git import GitSync
 from libvcs.url.base import RuleMap
-from libvcs.url.git import DEFAULT_MATCHERS, PIP_DEFAULT_MATCHERS, GitBaseURL, GitURL
+from libvcs.url.git import DEFAULT_RULES, PIP_DEFAULT_RULES, GitBaseURL, GitURL
 
 
 class GitURLFixture(typing.NamedTuple):
@@ -143,7 +143,7 @@ def test_git_url_extension_pip(
 ) -> None:
     class GitURLWithPip(GitBaseURL):
         rule_map: RuleMap = RuleMap(
-            _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+            _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         )
 
     git_url_kwargs["url"] = git_url_kwargs["url"].format(local_repo=git_repo.dir)
@@ -256,7 +256,7 @@ def test_git_revs(
 ) -> None:
     class GitURLWithPip(GitURL):
         rule_map: RuleMap = RuleMap(
-            _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+            _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         )
 
     git_url = GitURLWithPip(**git_url_kwargs)

tests/url/test_hg.py

@@ -4,7 +4,7 @@
 
 from libvcs.sync.hg import HgSync
 from libvcs.url.base import RuleMap
-from libvcs.url.hg import DEFAULT_MATCHERS, PIP_DEFAULT_MATCHERS, HgURL
+from libvcs.url.hg import DEFAULT_RULES, PIP_DEFAULT_RULES, HgURL
 
 
 class HgURLFixture(typing.NamedTuple):
@@ -108,7 +108,7 @@ def test_hg_url_extension_pip(
 ) -> None:
     class HgURLWithPip(HgURL):
         rule_map: RuleMap = RuleMap(
-            _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+            _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         )
 
     hg_url_kwargs["url"] = hg_url_kwargs["url"].format(local_repo=hg_repo.dir)

tests/url/test_svn.py

@@ -4,7 +4,7 @@
 
 from libvcs.sync.svn import SvnSync
 from libvcs.url.base import RuleMap
-from libvcs.url.svn import DEFAULT_MATCHERS, PIP_DEFAULT_MATCHERS, SvnURL
+from libvcs.url.svn import DEFAULT_RULES, PIP_DEFAULT_RULES, SvnURL
 
 
 class SvnURLFixture(typing.NamedTuple):
@@ -125,7 +125,7 @@ def test_svn_url_extension_pip(
 ) -> None:
     class SvnURLWithPip(SvnURL):
         rule_map: RuleMap = RuleMap(
-            _rule_map={m.label: m for m in [*DEFAULT_MATCHERS, *PIP_DEFAULT_MATCHERS]}
+            _rule_map={m.label: m for m in [*DEFAULT_RULES, *PIP_DEFAULT_RULES]}
         )
 
     svn_url_kwargs["url"] = svn_url_kwargs["url"].format(local_repo=svn_repo.dir)