git-project-core-plugins 0.0.22__tar.gz → 0.0.24__tar.gz

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-project-core-plugins
-Version: 0.0.22
+Version: 0.0.24
 Summary: The extensible stupid project manager - core functionality
 Author-email: "David A. Greene" <dag@obbligato.org>
 License-Expression: AGPL-3.0-or-later
@@ -12,9 +12,9 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Version Control :: Git
-Requires-Python: >=3
-Requires-Dist: git-project>=0.0.27
-Requires-Dist: progressbar
+Requires-Python: >=3.9
+Requires-Dist: git-project>=0.0.30
+Requires-Dist: pytest-console-scripts
 Provides-Extra: test
 Requires-Dist: git-project; extra == 'test'
 Requires-Dist: pytest; extra == 'test'

git_project_core_plugins-0.0.24/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.24'
+__version_tuple__ = version_tuple = (0, 0, 24)
+
+__commit_id__ = commit_id = None

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/pyproject.toml

@@ -31,7 +31,7 @@ name = "git-project-core-plugins"
 dynamic = ["dependencies", "readme", "version"]
 description = "The extensible stupid project manager - core functionality"
 license = "AGPL-3.0-or-later"
-requires-python = ">=3"
+requires-python = ">=3.9"
 authors = [
     { name = "David A. Greene", email = "dag@obbligato.org" },
 ]
@@ -95,7 +95,7 @@ cov = [
 ]
 
 [[tool.hatch.envs.all.matrix]]
-python = ["3.7", "3.8", "3.9", "3.10", "3.11"]
+python = ["3.9", "3.10", "3.11"]
 
 [tool.hatch.envs.lint]
 detached = true

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/requirements.txt

@@ -18,5 +18,5 @@
 # You should have received a copy of the GNU Affero General Public License along
 # with git-project. If not, see <https://www.gnu.org/licenses/>.
 
-git-project >= 0.0.27
-progressbar
+git-project >= 0.0.30
+pytest-console-scripts

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/src/git_project_core_plugins/artifact.py

@@ -125,13 +125,28 @@ class Artifact(SubstitutableConfigObject):
     def get_managing_command(cls):
         return 'artifact'
 
+    def rm(self, git, project, clargs, string):
+        """Remove the paths associated with this Artifact.
+
+        git: An object to query the repository and make config changes.
+
+        project: The currently active Project.
+
+        clargs: Command-line arguments
+
+        string: The string on which to perform substitution.
+
+        """
+        for path in self.iter_multival('itempath'):
+            path = self.substitute_value(git, poject, clargs, path)
+
 def command_artifact_add(git, gitproject, project, clargs):
     """Implement git-project artifact add."""
     ident = clargs.subsection
     path = clargs.path
 
     artifact = Artifact.get(git, project.get_section(), ident)
-    artifact.add_item('path', path)
+    artifact.add_item('itempath', path)
 
 def command_artifact_rm(git, gitproject, project, clargs):
     """Implement git-project artifact rm."""
@@ -141,9 +156,9 @@ def command_artifact_rm(git, gitproject, project, clargs):
 
     if hasattr(clargs, 'path') and clargs.path:
         path = clargs.path
-        artifact.rm_item('path', path)
+        artifact.rm_item('itempath', path)
     else:
-        artifact.rm_items('path')
+        artifact.rm_items('itempath')
 
 class ArtifactPlugin(Plugin):
     """
@@ -313,7 +328,7 @@ the final git config section that will hold the artifact path.
                                         self._subsection)
 
             if artifact:
-                for path in artifact.iter_multival('path'):
+                for path in artifact.iter_multival('itempath'):
                     fullpath = artifact.substitute_value(self._git, project, path)
                     run_command_with_shell(f'rm -rf {fullpath}',
                                            show_command=True)

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/src/git_project_core_plugins/run.py

@@ -90,8 +90,7 @@ class RunConfig(ConfigObject):
                            **kwargs)
 
 class RunPlugin(Plugin):
-    """
-    The run command executes commands via a shell.
+    """The run command executes commands via a shell.
 
     Summary:
 
@@ -108,7 +107,7 @@ class RunPlugin(Plugin):
     example:
 
       git <project> run --make-alias build
-      git <project> add build all "make -C {path} all"
+      git <project> add build all "make -C {git_workdir} all"
       git <project> build all
 
     Note that an alias will prevent ``run'' from invoking the command so in the
@@ -125,15 +124,15 @@ class RunPlugin(Plugin):
     In general any project config {key} will be replaced with its value before
     the command is executed.  Substitution occurs recursively, so if a {key}
     value itself contains a substitution string, it will be replaced as well.
-    There are a few special case substitutions.  The {path} key will be replaced
-    by the absolute path to the root of the current workarea.  The {branch} key
-    will be replaced by the currently-active branch nme.  In addition the {run}
-    (or {build}, etc. aliases) will be replaced by their names.  Again, an
-    example will make this more clear:
+    There are a few special case substitutions.  The {git_workdir} key will be
+    replaced by the absolute path to the root of the current workarea.  The
+    {branch} key will be replaced by the currently-active branch nme.  In
+    addition the {run} (or {build}, etc. aliases) will be replaced by their
+    names.  Again, an example will make this more clear:
 
-      git <project> config cmd "make -C {path} BLDDIR=/path/to/{build} {build}"
-      git project add build all "{cmd}"
-      git project add build some "{cmd}"
+      git <project> config cmd "make -C {git_workdir} BLDDIR=/path/to/{build}
+      {build}" git project add build all "{cmd}" git project add build some
+      "{cmd}"
 
     We have configured two different build flavors, each which place build
     results in separate directories and invoke different targets.  Substitution
@@ -142,6 +141,41 @@ class RunPlugin(Plugin):
       git project build all -> make -C /cur/workarea BLDDIR=/path/to/all all
       git project build some -> make -C /cur/workarea BLDDIR=/path/to/some some
 
+    Extra options passed to the run command may be referenced in the command
+    string:
+
+      git project add build extra "echo {options}"
+      git project build extra hello world! -> echo hello world!
+
+    Individual options may also be referenced:
+
+      git project add build extra "echo {options_1} {options_0}"
+      git project build extra hello world! -> echo world! hello
+
+    A special dash-separated "key" string composed of option values may be
+    generated:
+
+      git project add build any "make {option_key}"
+      git project build any target debug -> make target-debug
+
+    A special {option_keysep} substitution will result in a - if there are
+    options and the empty string otherwisa:
+
+      git project add build build any "make my{option_keysep}{option_key}"
+      git project build any target debug -> make my-target-debug
+      git project build any -> make my
+
+    Other substitutions may be used in options:
+
+      git project add build branch "make {options}"
+      git project build branch {branch} -> make dev  # On the dev branch
+
+    A special substitution {option_names} is a space-separated list of option
+    values with no additional substitutions:
+
+      git project add build branch "make {option_names} {options}"
+      git project build branch {branch} -> make branch dev  # On the dev branch
+
     Some plugins may add scoping rules to the project config, such that a scope
     nested inside the project may override the global project config key value.
     For example the worktree plugin adds a ``worktree'' scope.  The worktree may
@@ -358,7 +392,10 @@ class RunPlugin(Plugin):
                     'option_keysep': '-' if len(clargs.options) > 0 else ''
                 }
 
-                run.run(git, project, formats)
+                for i, option in enumerate(clargs.options):
+                    formats[f'options_{i}'] = option
+
+                return run.run(git, project, formats)
 
         run_parser.set_defaults(func=command_run)
 

git_project_core_plugins-0.0.24/test.out

@@ -0,0 +1,8 @@
+============================= test session starts ==============================
+platform darwin -- Python 3.13.2, pytest-8.3.4, pluggy-1.5.0
+rootdir: /Users/dag/projects/git-project-core-plugins/master
+configfile: pyproject.toml
+plugins: console-scripts-1.4.1
+collected 17 items
+
+tests/test_worktree.py ...............

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/tests/test_artifact.py

@@ -95,10 +95,10 @@ def test_artifact_get(reset_directory,
     artifact = Artifact.get(git,
                             project.get_section(),
                             'worktree',
-                            path='{builddir}')
+                            itempath='{builddir}')
 
     assert artifact._section == 'project.artifact.worktree'
-    assert artifact.path == '{builddir}'
+    assert artifact.itempath == '{builddir}'
 
 def test_artifact_add(git_project_runner,
                       git):
@@ -114,7 +114,7 @@ def test_artifact_add(git_project_runner,
                            '{builddir}')
 
     check_config_file('project.artifact.worktree',
-                      'path',
+                      'itempath',
                       {'{builddir}'})
 
 def test_artifact_rm_item(git_project_runner,
@@ -138,7 +138,7 @@ def test_artifact_rm_item(git_project_runner,
                            '{installdir}')
 
     check_config_file('project.artifact.worktree',
-                      'path',
+                      'itempath',
                       {'{builddir}', '{installdir}'})
 
     git_project_runner.run('.*',
@@ -149,7 +149,7 @@ def test_artifact_rm_item(git_project_runner,
                            '\\\\{builddir\\\\}')
 
     check_config_file('project.artifact.worktree',
-                      'path',
+                      'itempath',
                       {'{installdir}'})
 
 def test_artifact_rm_items(git_project_runner,
@@ -174,7 +174,7 @@ def test_artifact_rm_items(git_project_runner,
                            '{installdir}')
 
     check_config_file('project.artifact.worktree',
-                      'path',
+                      'itempath',
                       {'{builddir}', '{installdir}'})
 
     git_project_runner.run('.*',
@@ -184,7 +184,7 @@ def test_artifact_rm_items(git_project_runner,
                            'worktree')
 
     check_config_file('project.artifact.worktree',
-                      'path',
+                      'itempath',
                       {'{builddir}, ''{installdir}'},
                       section_present = False)
 

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/tests/test_run.py

@@ -383,3 +383,26 @@ def test_run_substitute_empty_option_name_key(git_project_runner,
                            '.*',
                            'run',
                            'test')
+
+def test_run_substitute_option_positions(git_project_runner,
+                                         git,
+                                         capsys):
+    workdir = git.get_working_copy_root()
+
+    git_project_runner.chdir(workdir)
+
+    # Add a run.
+    git_project_runner.run('.*',
+                           '',
+                           'add',
+                           'run',
+                           'test',
+                           '{git_workdir}/buildit {options_1} {run} {options_0}')
+
+    # Check run invocation.
+    git_project_runner.run(re.escape(f'{workdir}/buildit foo test master'),
+                           '.*',
+                           'run',
+                           'test',
+                           '{branch}',
+                           'foo')

{git_project_core_plugins-0.0.22 → git_project_core_plugins-0.0.24}/tests/test_worktree.py

@@ -456,6 +456,7 @@ def test_worktree_add(git,
     assert os.path.exists(workarea.parent / 'test')
     assert git.branch_name_to_refname('test') == 'refs/heads/test'
 
+
 def test_worktree_add_subdir(git,
                              git_project_runner,
                              tmp_path_factory):
@@ -472,10 +473,107 @@ def test_worktree_add_subdir(git,
                            '',
                            'worktree',
                            'add',
-                           '../user/test',
+                           '../user/test2',
+                           'master')
+
+    assert os.path.exists(workarea.parent / 'user' / 'test2')
+    os.chdir(workarea.parent / 'user' / 'test2')
+    git = git_project.Git()  # Reinitialize in new workarea.
+    assert git.get_current_branch() == 'user/test2'
+
+
+def test_worktree_rm(git, git_project_runner, tmp_path_factory):
+    workarea = git.get_working_copy_root()
+
+    os.chdir(workarea)
+
+    git = git_project.Git()  # Reinitialize in new workarea.
+
+    assert os.path.exists(workarea / '.git')
+    assert os.path.exists(workarea / 'MergedRemote.txt')
+
+    git_project_runner.chdir(workarea)
+
+    git_project_runner.run('.*',
+                           '',
+                           'worktree',
+                           'add',
+                           '../user/test_rm',
+                           'master')
+
+    assert os.path.exists(workarea.parent / 'user' / 'test_rm')
+    os.chdir(workarea.parent / 'user' / 'test_rm')
+    git = git_project.Git()  # Reinitialize in new workarea.
+    assert git.get_current_branch() == 'user/test_rm'
+
+    assert os.path.exists(workarea.parent / 'user' / 'test_rm')
+
+    os.chdir(workarea)
+    git_project_runner.chdir(workarea)
+
+    git_project_runner.run('.*',
+                           '',
+                           'worktree',
+                           'rm',
+                           'test_rm')
+
+    assert not os.path.exists(workarea.parent / 'user' / 'test_rm')
+
+
+def test_worktree_add_in_workarea(git,
+                                  git_project_runner,
+                                  tmp_path_factory):
+    workarea = git.get_working_copy_root()
+
+    os.chdir(workarea)
+
+    assert os.path.exists(workarea / '.git')
+    assert os.path.exists(workarea / 'MergedRemote.txt')
+
+    git_project_runner.chdir(workarea)
+
+    git_project_runner.run('.*',
+                           '',
+                           'worktree',
+                           'add',
+                           'test_workarea',
                            'master')
 
-    assert os.path.exists(workarea.parent / 'user' / 'test')
-    os.chdir(workarea.parent / 'user' / 'test')
+    assert os.path.exists(workarea / 'test_workarea')
+    os.chdir(workarea / 'test_workarea')
     git = git_project.Git()  # Reinitialize in new workarea.
-    assert git.get_current_branch() == 'user/test'
+    assert git.get_current_branch() == 'test_workarea'
+
+
+def test_worktree_rm_in_workarea(git, git_project_runner, tmp_path_factory):
+    workarea = git.get_working_copy_root()
+
+    os.chdir(workarea)
+
+    assert os.path.exists(workarea / '.git')
+    assert os.path.exists(workarea / 'MergedRemote.txt')
+
+    git_project_runner.chdir(workarea)
+
+    git_project_runner.run('.*',
+                           '',
+                           'worktree',
+                           'add',
+                           'test_rm_workarea',
+                           'master')
+
+    assert os.path.exists(workarea / 'test_rm_workarea')
+    os.chdir(workarea / 'test_rm_workarea')
+    git = git_project.Git()  # Reinitialize in new workarea.
+    assert git.get_current_branch() == 'test_rm_workarea'
+
+    os.chdir(workarea)
+    git_project_runner.chdir(workarea)
+
+    git_project_runner.run('.*',
+                           '',
+                           'worktree',
+                           'rm',
+                           'test_rm_workarea')
+
+    assert not os.path.exists(workarea / 'test_rm_workarea')

git_project_core_plugins-0.0.22/.git

@@ -1 +0,0 @@
-gitdir: /Users/dag/projects/git-project-core-plugins/.git/worktrees/master/

git_project_core_plugins-0.0.22/_version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.0.22'
-__version_tuple__ = version_tuple = (0, 0, 22)

git_project_core_plugins-0.0.22/test.out

@@ -1,38 +0,0 @@
-============================= test session starts ==============================
-platform darwin -- Python 3.13.2, pytest-8.3.4, pluggy-1.5.0
-rootdir: /Users/dag/projects/git-project-core-plugins/master
-configfile: pyproject.toml
-plugins: console-scripts-1.4.1
-collected 56 items
-
-tests/test_artifact.py .......                                           [ 12%]
-tests/test_branch.py ....                                                [ 19%]
-tests/test_clone.py ....                                                 [ 26%]
-tests/test_config.py ....                                                [ 33%]
-tests/test_help.py ...                                                   [ 39%]
-tests/test_init.py .                                                     [ 41%]
-tests/test_run.py ................                                       [ 69%]
-tests/test_worktree.py .................                                 [100%]
-
-=============================== warnings summary ===============================
-tests/test_artifact.py: 9 warnings
-tests/test_config.py: 7 warnings
-tests/test_help.py: 8 warnings
-tests/test_run.py: 33 warnings
-tests/test_worktree.py: 11 warnings
-  /Users/dag/projects/git-project/master/src/git_project/test_support/common.py:453: DeprecationWarning: script_runner commands should be passed as a single sequence, not as multiple arguments.
-  Replace `script_runner.run(a, b, c)` calls with `script_runner.run([a, b, c])`
-    result = self.runner.run(self.command, *args, cwd=self.directory, **kwargs)
-
-tests/test_branch.py::test_branch_status[inprocess]
-  /Users/dag/projects/git-project-core-plugins/master/tests/test_branch.py:118: DeprecationWarning: script_runner commands should be passed as a single sequence, not as multiple arguments.
-  Replace `script_runner.run(a, b, c)` calls with `script_runner.run([a, b, c])`
-    ret = script_runner.run('git-project', 'branch', 'status', '--all')
-
-tests/test_branch.py::test_branch_prune_script[inprocess]
-  /Users/dag/projects/git-project-core-plugins/master/tests/test_branch.py:178: DeprecationWarning: script_runner commands should be passed as a single sequence, not as multiple arguments.
-  Replace `script_runner.run(a, b, c)` calls with `script_runner.run([a, b, c])`
-    ret = script_runner.run('git-project',
-
--- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
-======================= 56 passed, 70 warnings in 18.20s =======================