refactor!: Rename states -> projects

tony · tony · commit 79c3184aa100 · 2022-04-14T17:12:41.000-05:00
diff --git a/CHANGES b/CHANGES
@@ -16,7 +16,7 @@ $ pip install --user --upgrade --pre libvcs
 ### Breaking
 
 - `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been moved to
-  `libvcs.states.{module}.{Module}Repo`
+  `libvcs.projects.{module}.{Module}Repo`
 - `repo_dir` param is renamed to `dir`:
 
   Before: `GitRepo(url='...', repo_dir='...')`
@@ -26,7 +26,7 @@ $ pip install --user --upgrade --pre libvcs
   {issue}`#324`
 
 - `dir` to `pathlib`, `BaseRepo.path` -> `BaseRepo.dir`
-- Logging functions moved to {attr}`libvcs.states.base.BaseRepo.log` ({issue}`#322`)
+- Logging functions moved to {attr}`libvcs.projects.base.BaseRepo.log` ({issue}`#322`)
 - Rename `RepoLoggingAdapter` to `CmdLoggingAdapter`
 - `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
 
@@ -51,7 +51,7 @@ $ pip install --user --upgrade --pre libvcs
     - {meth}`libvcs.cmd.hg.Hg.run`
     - {meth}`libvcs.cmd.hg.Hg.clone`
 
-- {class}`libvcs.states.git.GitRepo` now accepts remotes in `__init__`
+- {class}`libvcs.projects.git.GitRepo` now accepts remotes in `__init__`
 
   ```python
   repo = GitRepo(
@@ -76,7 +76,7 @@ $ pip install --user --upgrade --pre libvcs
   )
   ```
 
-- {meth}`libvcs.states.git.GitRepo.update_repo` now accepts `set_remotes=True`
+- {meth}`libvcs.projects.git.GitRepo.update_repo` now accepts `set_remotes=True`
 
 ### Compatibility
 
@@ -94,9 +94,9 @@ $ pip install --user --upgrade --pre libvcs
   ({issue}`#316`)
 - New constants for `str` -> class mappings
 
-  - {data}`libvcs.states.constants.DEFAULT_VCS_CLASS_MAP`
-  - {data}`libvcs.states.constants.DEFAULT_VCS_CLASS_UNION`
-  - {data}`libvcs.states.constants.DEFAULT_VCS_LITERAL`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_CLASS_MAP`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_CLASS_UNION`
+  - {data}`libvcs.projects.constants.DEFAULT_VCS_LITERAL`
 
 - Remove tox and tox-poetry-installer. It turns out installing poetry inside a poetry project
   doesn't work well. (`poetry update`, `poetry publish`, etc. commands would fail)
diff --git a/README.md b/README.md
@@ -39,14 +39,14 @@ git = Git(dir=pathlib.Path.cwd() / 'my_git_repo')
 git.clone(url='https://github.com/vcs-python/libvcs.git')
 ```
 
-## States
+## Projects
 
-Create a [`GitRepo`](https://libvcs.git-pull.com/states/git.html#libvcs.states.git.GitRepo) object
-of the project to inspect / checkout / update:
+Create a [`GitRepo`](https://libvcs.git-pull.com/projects/git.html#libvcs.projects.git.GitRepo)
+object of the project to inspect / checkout / update:
 
 ```python
 import pathlib
-from libvcs.states.git import GitRepo
+from libvcs.projects.git import GitRepo
 
 repo = GitRepo(
    url="https://github.com/vcs-python/libvcs",
diff --git a/docs/index.md b/docs/index.md
@@ -10,7 +10,7 @@
 
 quickstart
 cmd/index
-states/index
+projects/index
 ```
 
 ```{toctree}
diff --git a/docs/projects/base.md b/docs/projects/base.md
@@ -1,18 +1,18 @@
-# `libvcs.states.base`
+# `libvcs.projects.base`
 
-Base objects / classes for states.
+Base objects / classes for projects.
 
 Adding your own VCS / Extending libvcs can be done through subclassing `BaseRepo`.
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.base.BaseRepo
+   libvcs.projects.base.BaseRepo
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.base
+.. automodule:: libvcs.projects.base
    :members:
    :show-inheritance:
 ```
diff --git a/docs/projects/git.md b/docs/projects/git.md
@@ -1,22 +1,22 @@
-# `libvcs.states.git`
+# `libvcs.projects.git`
 
 For `git(1)`.
 
 Compare to:
 [`fabtools.require.git`](https://fabtools.readthedocs.io/en/0.19.0/api/require/git.html),
-[`salt.states.git`](https://docs.saltproject.io/en/latest/ref/states/all/salt.states.git.html),
+[`salt.projects.git`](https://docs.saltproject.io/en/latest/ref/projects/all/salt.projects.git.html),
 [`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.git.GitRemote
-   libvcs.states.git.GitRepo
+   libvcs.projects.git.GitRemote
+   libvcs.projects.git.GitRepo
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.git
+.. automodule:: libvcs.projects.git
    :members:
    :show-inheritance:
    :undoc-members:
diff --git a/docs/projects/hg.md b/docs/projects/hg.md
@@ -1,16 +1,16 @@
-# `libvcs.states.hg`
+# `libvcs.projects.hg`
 
 For mercurial, aka `hg(1)`.
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.hg.MercurialRepo
+   libvcs.projects.hg.MercurialRepo
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.hg
+.. automodule:: libvcs.projects.hg
    :members:
    :show-inheritance:
    :undoc-members:
diff --git a/docs/projects/index.md b/docs/projects/index.md
@@ -1,10 +1,10 @@
-(states)=
+(projects)=
 
-# `libvcs.states`
+# `libvcs.projects`
 
 Compare to:
 [`fabtools.require.git`](https://fabtools.readthedocs.io/en/0.19.0/api/require/git.html),
-[`salt.states.git`](https://docs.saltproject.io/en/latest/ref/states/all/salt.states.git.html),
+[`salt.projects.git`](https://docs.saltproject.io/en/latest/ref/projects/all/salt.projects.git.html),
 [`ansible.builtin.git`](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/git_module.html)
 
 :::{warning}
@@ -38,7 +38,7 @@ See examples below of git, mercurial, and subversion.
 ## Constants
 
 ```{eval-rst}
-.. automodule:: libvcs.states.constants
+.. automodule:: libvcs.projects.constants
    :members:
 ```
 
diff --git a/docs/projects/svn.md b/docs/projects/svn.md
@@ -1,16 +1,16 @@
-# `libvcs.states.svn`
+# `libvcs.projects.svn`
 
 For subversion, aka `svn(1)`
 
 ```{eval-rst}
 .. autosummary::
    :recursive:
 
-   libvcs.states.svn.SubversionRepo
+   libvcs.projects.svn.SubversionRepo
 ```
 
 ```{eval-rst}
-.. automodule:: libvcs.states.svn
+.. automodule:: libvcs.projects.svn
    :members:
    :show-inheritance:
    :undoc-members:
diff --git a/docs/redirects.txt b/docs/redirects.txt
@@ -1,5 +1,5 @@
-"api.md" "states/index.md"
-"api/base.md" "states/base.md"
-"api/git.md" "states/git.md"
-"api/hg.md" "states/hg.md"
-"api/svn.md" "states/svn.md"
+"api.md" "projects/index.md"
+"api/base.md" "projects/base.md"
+"api/git.md" "projects/git.md"
+"api/hg.md" "projects/hg.md"
+"api/svn.md" "projects/svn.md"
diff --git a/libvcs/__init__.py b/libvcs/__init__.py
@@ -2,10 +2,10 @@
 import logging
 
 from .cmd.core import CmdLoggingAdapter
-from .states.base import BaseRepo
-from .states.git import GitRepo
-from .states.hg import MercurialRepo
-from .states.svn import SubversionRepo
+from .projects.base import BaseRepo
+from .projects.git import GitRepo
+from .projects.hg import MercurialRepo
+from .projects.svn import SubversionRepo
 
 __all__ = [
     "GitRepo",
diff --git a/libvcs/conftest.py b/libvcs/conftest.py
@@ -11,7 +11,7 @@
 from faker import Faker
 
 from libvcs.cmd.core import run, which
-from libvcs.states.git import GitRemoteDict, GitRepo
+from libvcs.projects.git import GitRemoteDict, GitRepo
 
 skip_if_git_missing = pytest.mark.skipif(
     not which("git"), reason="git is not available"
diff --git a/libvcs/projects/__init__.py b/libvcs/projects/__init__.py
diff --git a/libvcs/projects/base.py b/libvcs/projects/base.py
diff --git a/libvcs/projects/constants.py b/libvcs/projects/constants.py
diff --git a/libvcs/projects/git.py b/libvcs/projects/git.py
@@ -21,7 +21,11 @@
 from urllib import parse as urlparse
 
 from .. import exc
-from ..states.base import BaseRepo, VCSLocation, convert_pip_url as base_convert_pip_url
+from ..projects.base import (
+    BaseRepo,
+    VCSLocation,
+    convert_pip_url as base_convert_pip_url,
+)
 
 logger = logging.getLogger(__name__)
 
diff --git a/libvcs/projects/hg.py b/libvcs/projects/hg.py
diff --git a/libvcs/projects/svn.py b/libvcs/projects/svn.py
diff --git a/tests/projects/test_base.py b/tests/projects/test_base.py
@@ -4,8 +4,8 @@
 
 import pytest
 
+from libvcs.projects.base import BaseRepo, convert_pip_url
 from libvcs.shortcuts import create_repo
-from libvcs.states.base import BaseRepo, convert_pip_url
 
 
 def test_repr():
diff --git a/tests/projects/test_conftest.py b/tests/projects/test_conftest.py
diff --git a/tests/projects/test_git.py b/tests/projects/test_git.py
@@ -12,14 +12,14 @@
 from libvcs import exc
 from libvcs.cmd.core import run, which
 from libvcs.conftest import CreateRepoCallbackFixtureProtocol
-from libvcs.shortcuts import create_repo_from_pip_url
-from libvcs.states.git import (
+from libvcs.projects.git import (
     GitFullRemoteDict,
     GitRemote,
     GitRepo,
     convert_pip_url as git_convert_pip_url,
     extract_status,
 )
+from libvcs.shortcuts import create_repo_from_pip_url
 
 if not which("git"):
     pytestmark = pytest.mark.skip(reason="git is not available")
diff --git a/tests/projects/test_hg.py b/tests/projects/test_hg.py
diff --git a/tests/projects/test_svn.py b/tests/projects/test_svn.py
@@ -6,8 +6,8 @@
 
 from libvcs.cmd.core import which
 from libvcs.conftest import CreateRepoCallbackFixtureProtocol
+from libvcs.projects.svn import SubversionRepo
 from libvcs.shortcuts import create_repo_from_pip_url
-from libvcs.states.svn import SubversionRepo
 
 if not which("svn"):
     pytestmark = pytest.mark.skip(reason="svn is not available")
