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

git_project_core_plugins-0.0.22/.git

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

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

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

{git_project_core_plugins-0.0.21 → git_project_core_plugins-0.0.22}/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.21'
-__version_tuple__ = version_tuple = (0, 0, 21)
+__version__ = version = '0.0.22'
+__version_tuple__ = version_tuple = (0, 0, 22)

git_project_core_plugins-0.0.22/build/lib/git_project_core_plugins/__init__.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 David A. Greene
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+from .artifact import Artifact, ArtifactPlugin
+from .branch import BranchPlugin
+from .run import RunPlugin
+from .clone import ClonePlugin
+from .common import add_plugin_version_argument
+from .config import ConfigPlugin
+from .help import Help, HelpPlugin
+from .init import InitPlugin
+from .worktree import Worktree, WorktreePlugin

git_project_core_plugins-0.0.22/build/lib/git_project_core_plugins/branch.py

@@ -0,0 +1,222 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 David A. Greene
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+"""A plugin to add a 'branch' command to git-project.  The branch command allows
+query of branch status with respect to the project and pruning of 'finished'
+branches.
+
+Summary:
+
+git-project branch status [<pattern>]
+git-project branch prune [--no-ask] [<pattern>]
+
+"""
+from git_project import Git, RunnableConfigObject, Plugin
+from git_project import add_top_level_command, Project, GitProjectException
+
+from git_project_core_plugins.common import add_plugin_version_argument
+
+import getpass
+
+def query_yes_no(question, default="yes"):
+    """Ask a yes/no question via input() and return their answer.
+
+    "question" is a string that is presented to the user.
+    "default" is the presumed answer if the user just hits <Enter>.
+        It must be "yes" (the default), "no" or None (meaning
+        an answer is required of the user).
+
+    The "answer" return value is True for "yes" or False for "no".
+    """
+    valid = {"yes": True, "y": True, "ye": True,
+             "no": False, "n": False}
+    if default is None:
+        prompt = " [y/n] "
+    elif default == "yes":
+        prompt = " [Y/n] "
+    elif default == "no":
+        prompt = " [y/N] "
+    else:
+        raise ValueError("invalid default answer: '%s'" % default)
+
+    while True:
+        sys.stdout.write(question + prompt)
+        choice = input().lower()
+        if default is not None and choice == '':
+            return valid[default]
+        elif choice in valid:
+            return valid[choice]
+        else:
+            sys.stdout.write("Please respond with 'yes' or 'no' "
+                             "(or 'y' or 'n').\n")
+
+def command_branch_status(git, gitproject, project, clargs):
+    """Implement git-project branch status."""
+    ref = clargs.name_or_ref
+
+    if not ref:
+        if clargs.all_user:
+            ref = 'refs/heads/user/' + getpass.getuser()
+        elif clargs.all:
+            ref = 'refs/heads'
+        else:
+            raise GitProjectException('merged requires branch name, pattern, --all-user or --all')
+    else:
+        if not ref.startswith('refs/'):
+            ref = 'refs/heads/' + ref
+
+    target = clargs.target if clargs.target else None
+
+    branch_width = 45
+    status_width = 8
+    separator_width = branch_width + 2 * status_width - (status_width - len('merged'))
+
+    print('-' * separator_width)
+    print('{:<{branch_width}s}{:<{status_width}s}{:<{status_width}s}'.
+          format('branch', 'merged', 'pushed',
+                 branch_width=branch_width, status_width=status_width))
+    print('-' * separator_width)
+
+    for branch in git.iterrefnames([ref]):
+        merge_status = 'no'
+        if target:
+            merge_status = 'yes' if git.branch_is_merged(branch, target) else 'no'
+        else:
+            merge_status = 'yes' if project.branch_is_merged(branch) else 'no'
+
+        push_status = 'yes' if project.branch_is_pushed(branch) else 'no'
+
+        print('{:<{branch_width}s}{:<{status_width}s}{:<{status_width}s}'.
+              format(branch[:branch_width-2], merge_status, push_status,
+                     branch_width=branch_width, status_width=status_width))
+    print('-' * separator_width)
+
+def command_branch_prune(git, gitproject, project, clargs):
+    """Implement git-project branch prune."""
+    ref = clargs.name_or_ref
+    if not ref:
+        if clargs.all_user:
+            ref = 'refs/heads/user/' + getpass.getuser()
+        else:
+            raise GitProjectException('Prune requires branch name, pattern or --all-user')
+    else:
+        ref = Git.branch_name_to_refname(ref)
+
+    branch_width = 45
+    status_width = 15
+    separator_width = branch_width + 2 * status_width
+
+    print('-' * separator_width)
+    print('{:<{branch_width}s}{:<{status_width}s}{:<{status_width}s}'.
+          format('branch', 'local status', 'remote status',
+                 branch_width=branch_width, status_width=status_width))
+    print('-' * separator_width)
+
+    for branch in git.iterrefnames([ref]):
+        status = 'merged' if project.branch_is_merged(branch) else 'unmerged'
+
+        print('{:<{branch_width}s}{:<{status_width}s}'.
+              format(branch[:branch_width-2], status,
+                     branch_width=branch_width, status_width=status_width))
+        if clargs.force or status == 'merged':
+            if clargs.no_ask or query_yes_no('Prune?', default=None):
+                project.prune_branch(branch)
+
+class BranchPlugin(Plugin):
+    """
+    The branch command queries the status of branches against known project
+    branches and provides methods to prune old branches.
+
+    Summary:
+
+      git <project> branch status [--all] [<refish>]
+      git <project> branch prune [--force] [--no-ask]
+
+    The branch status command checks the given <refish> (or all local branches
+    with the --all option) against the project-configured branches.  The command
+    outputs a table of branches and whether they are merged to a project branch
+    and/or pushed to a remote.  For example:
+
+      git <project> config --add branch release
+      git <project> branch status mybranch
+
+    The report will show whether mybranch is merged to the release or master
+    branches (master is always a configured project branch) and whether the
+    commit pointed to mybranch is pushed to a remote.
+
+    The branch prune command computes the same information and if the branch is
+    merged to a project branch and that project branch is pushed to a remote,
+    will ask whether mybranch should be deleted.  If the user indicates yes,
+    both the local mybranch and its remote counterpart, if any, will be deleted.
+
+    With --force, branches will be pruneed regardless of merge/push status.
+    With --no-ask branch prune operates in batch mode, assuming all merged and
+    pushed branches should be pruned.
+
+    See also:
+
+      config
+
+    """
+    def __init__(self):
+        super().__init__('branch')
+
+    def add_arguments(self,
+                      git,
+                      gitproject,
+                      project,
+                      parser_manager,
+                      plugin_manager):
+        """Add arguments for 'git project branch.'"""
+        # branch
+        branch_parser = add_top_level_command(parser_manager,
+                                              'branch',
+                                              'branch',
+                                              help='Manipulate branches')
+
+        add_plugin_version_argument(branch_parser)
+
+        branch_subparser = parser_manager.add_subparser(branch_parser,
+                                                        'branch_command',
+                                                        help='branch commands')
+
+        # branch status
+        branch_status_parser = parser_manager.add_parser(branch_subparser,
+                                                         'status',
+                                                         'branch-status',
+                                                         help='Show branch status')
+
+        branch_status_parser.set_defaults(func=command_branch_status)
+
+        branch_status_parser.add_argument('name_or_ref', nargs='?', help='Branch or pattern to filter branches')
+        branch_status_parser.add_argument('target', nargs='?', help='Target branch to check against')
+        branch_status_parser.add_argument('--all', action='store_true', help='Show all branches')
+        branch_status_parser.add_argument('--all-user', action='store_true', help='Show all user\'s branches')
+
+        # branch prune
+        branch_prune_parser = parser_manager.add_parser(branch_subparser,
+                                                        'prune',
+                                                        'branch-prune',
+                                                        help='Delete merged branches')
+
+        branch_prune_parser.set_defaults(func=command_branch_prune)
+
+        branch_prune_parser.add_argument('name_or_ref', nargs='?', help='Branch name or pattern to filter branches')
+        branch_prune_parser.add_argument('--all-user', action='store_true', help='Prune all user\'s branches')
+        branch_prune_parser.add_argument('--force', action='store_true', help='Prune even if unmerged')
+        branch_prune_parser.add_argument('--no-ask', action='store_true', help='Do not ask before pruning')

git_project_core_plugins-0.0.22/build/lib/git_project_core_plugins/clone.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 David A. Greene
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+"""A plugin to add a 'clone' command to git-project.  The clone command clones a
+repository and optionally initializes a master worktree environment.
+
+Summary:
+
+git-project clone <url> [path] [--bare] [--no-master-worktree]
+
+"""
+
+from git_project import add_top_level_command, Plugin
+
+from git_project_core_plugins.common import add_plugin_version_argument
+
+import getpass
+import os
+from pathlib import Path
+import pygit2
+
+def command_clone(git, gitproject, project, clargs):
+    """Implement git-project clone"""
+    gitdir = git.clone(clargs.url,
+                       path=clargs.path if hasattr(clargs, 'path') else None,
+                       bare=clargs.bare)
+
+    # Now that we have a repository, add sensible project defaults.  We know
+    # there is no existing project in the config file since we just cloned.
+    # This will have the effect of adding a project section.
+    project.set_defaults()
+
+    return gitdir
+
+class ClonePlugin(Plugin):
+    """
+    The clone command clones a repository.
+
+    Summary:
+
+      git <project> clone <url> [<path>] [--bare]
+
+    By itself clone has just the very basic funcionality of the built-in git
+    clone command.  Plugins may add options to give the clone command more
+    features.  For example, the woktree command adds a --worktree option to have
+    clone create a ``worktree layout.''
+
+    See also:
+
+      worktree
+
+    """
+
+    def __init__(self):
+        super().__init__('clone')
+
+    def add_arguments(self,
+                      git,
+                      gitproject,
+                      project,
+                      parser_manager,
+                      plugin_manager):
+        """Add arguments for 'git-project clone.'"""
+        # clone
+        clone_parser = add_top_level_command(parser_manager,
+                                             'clone',
+                                             'clone',
+                                             help='Clone project')
+
+        add_plugin_version_argument(clone_parser)
+
+        clone_parser.set_defaults(func=command_clone)
+
+        clone_parser.add_argument('url',
+                                  help='URL to clone')
+
+        clone_parser.add_argument('path',
+                                  nargs='?',
+                                  help='Local repository location')
+
+        clone_parser.add_argument('--bare',
+                                  action='store_true',
+                                  help='Clone a bare repository')

git_project_core_plugins-0.0.22/build/lib/git_project_core_plugins/common.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 David A. Greene
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+from git_project.commandline import add_version_argument
+
+def add_plugin_version_argument(parser):
+    add_version_argument(parser, 'git-project-core-plugins')

git_project_core_plugins-0.0.22/build/lib/git_project_core_plugins/config.py

@@ -0,0 +1,169 @@
+#!/usr/bin/env python3
+#
+# Copyright 2020 David A. Greene
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+"""A plugin to add a 'config' command to git-project.  The config command sets
+project-wide git configuration values and prints their values to stdout.
+
+Summary:
+
+git-project config <key> [--unset] [<value>]
+
+"""
+
+from git_project import ConfigObject, RunnableConfigObject
+from git_project import Plugin, Project, GitProjectException
+
+from git_project_core_plugins.common import add_plugin_version_argument
+
+def command_config(git, gitproject, project, clargs):
+    """Implement git-project config."""
+    getter = clargs.getter
+    exister = clargs.exister
+    classname = clargs.classname
+
+    subsection = None
+    if hasattr(clargs, 'subsection'):
+        subsection = clargs.subsection
+
+    ident = None
+    if hasattr(clargs, 'ident'):
+        ident = clargs.ident
+
+    if not exister(git, project.get_section(), subsection, ident):
+        if ident:
+            raise GitProjectException(f'{classname} \'{ident}\' does not exist')
+        else:
+            raise GitProjectException(f'No {classname} configured')
+
+    configitem = getter(git, project, ident) if ident else getter(git, project.get_section())
+
+    if clargs.value:
+        if clargs.unset:
+            configitem.rm_item(clargs.name, clargs.value)
+        else:
+            if clargs.add:
+                configitem.add_item(clargs.name, clargs.value)
+            else:
+                setattr(configitem, clargs.name, clargs.value)
+    elif clargs.unset:
+        delattr(configitem, clargs.name)
+    else:
+        value = getattr(configitem, clargs.name)
+        print(value)
+
+class ConfigPlugin(Plugin):
+    """
+    The config command manages git config settings under the <project> section.
+
+    Summary:
+
+      git <project> config [--add] [--unset] <name> [<value>]
+
+    The config command operates much like git's built-in config command, except
+    all configuration keys are prefixed with <project>, keeping values under a
+    single project namespace.  This is a convenient way to store parameters for
+    other commands.  For example:
+
+      git <project> config builddir /path/to/build
+      git <project> add run build "make BUILDDIR={builddir} all"
+
+    Configuration kays may have their values substituted into other
+    configuration values via the {key} specifier.  Special commands like build
+    perform the substitution recursively, so configuration vaalues may contain
+    substitutions of other configuration values which themselves contain
+    substitutions, and so on.  Importantly, substitution only happens when
+    commands are run.  Commands should document whether or not they perform
+    substitutions.
+
+    A git config ``sub-section'' may be substituted with its identifier.  For
+    example:
+
+      git <project> worktree add myworktree
+      git <project> config builddir /path/to/{worktree}/build
+
+    Here, myworktree is the identifier of a specific worktree sub-section.  If
+    myworktree is the currently active worktree (that is, the current directory
+    is under the myworktree root), then ``myworktree'' will substitute for
+    {woktree}.
+
+    See also:
+
+      run
+      worktree
+
+    """
+    def __init__(self):
+        super().__init__('config')
+
+    def _add_config_parser(self, cls, project, parser_manager):
+        command = cls.get_managing_command()
+        config_key = command + '-config' if command else 'config'
+        config_parser = parser_manager.find_parser(config_key)
+
+        if not config_parser:
+            # Create a config parser under the managing command.
+            command_subparser_key = command + '-command' if command else 'command'
+            command_subparser = parser_manager.find_subparser(command_subparser_key)
+            if not command_subparser:
+                # This plugin doesn't have subcommands, so don't add one.
+                return
+
+            config_help = 'Configure ' + command if command else 'Configure git-project'
+            config_parser = parser_manager.add_parser(command_subparser,
+                                                      'config',
+                                                      config_key,
+                                                      help=config_help)
+
+            config_parser.set_defaults(func=command_config)
+            config_parser.set_defaults(getter=cls.get)
+            config_parser.set_defaults(exister=cls.exists)
+            config_parser.set_defaults(classname=cls.__name__)
+
+            if hasattr(cls, 'subsection'):
+                config_parser.set_defaults(subsection=cls.subsection())
+                config_parser.add_argument('ident', help=f'{cls.__name__} to modify')
+
+            if not command:
+                # This is the top-level 'config' command.
+                add_plugin_version_argument(config_parser)
+
+            config_parser.add_argument('name', help='Property name')
+            config_parser.add_argument('value', nargs='?', help='Property value to set')
+            config_parser.add_argument('--add', action='store_true',
+                                       help='Add a value to a property')
+            config_parser.add_argument('--unset', action='store_true',
+                                       help='Remove a value from a property')
+
+    def add_arguments(self,
+                      git,
+                      gitproject,
+                      project,
+                      parser_manager,
+                      plugin_manager):
+        """Add arguments for 'git-project config'"""
+        self._add_config_parser(Project, project, parser_manager)
+
+    def modify_arguments(self, git, gitproject, project, parser_manager, plugin_manager):
+        """Modify arguments for 'git-project config.'"""
+
+        # Find all plugins with classes that derive from ConfigObject and add
+        # config commands to them.
+        for plugin in plugin_manager.iterplugins():
+            for cls in plugin.iterclasses():
+                if (issubclass(cls, ConfigObject)):
+                    self._add_config_parser(cls, project, parser_manager)