Add unpair command

Author: raphaelstolt

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## [v1.3.0] - 2024-07-15
+
+### Added
+
+- New `unpair` command.
+
 ## [v1.2.2] - 2024-07-12
 
 ### Added
@@ -57,7 +63,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 ## v1.0.0 - 2017-04-03
 - First release.
 
-[Unreleased]: https://github.com/raphaelstolt/git-user-bend/compare/v1.2.2...HEAD
+[Unreleased]: https://github.com/raphaelstolt/git-user-bend/compare/v1.3.0...HEAD
+[v1.3.0]: https://github.com/raphaelstolt/git-user-bend/compare/v1.2.2...v1.3.0
 [v1.2.2]: https://github.com/raphaelstolt/git-user-bend/compare/v1.2.1...v1.2.2
 [v1.2.1]: https://github.com/raphaelstolt/git-user-bend/compare/v1.2.0...v1.2.1
 [v1.2.0]: https://github.com/raphaelstolt/git-user-bend/compare/v1.1.2...v1.2.0

README.md

@@ -92,6 +92,12 @@ used for the Git `user.email` configuration.
 git-user-bend pair "<alias1,aliasN>" [<directory>]
 ```
 
+To end a pair programming session and restore the default `user.name` and `user.email` the `unpair` command is available.
+
+``` bash
+git-user-bend unpair <directory>
+```
+
 To check the persona, pair or respectively the Git user configuration of a repository the `whoami` command is a 
 pleasant shortcut.
 ``` bash

bin/git-user-bend

@@ -23,6 +23,7 @@ if (false === $autoloaded) {
    exit(1);
 }
 
+use Stolt\GitUserBend\Commands\UnpairCommand;
 use Stolt\GitUserBend\Git\Repository;
 use Stolt\GitUserBend\Persona\Storage;
 use Stolt\GitUserBend\Helpers\Str as OsHelper;
@@ -44,7 +45,7 @@ if ((new OsHelper())->isWindows()) {
 
 define('HOME_DIRECTORY', $homeDiretory);
 define('WORKING_DIRECTORY', getcwd());
-define('VERSION', '1.2.2');
+define('VERSION', '1.3.0');
 define(
     'STORAGE_FILE',
     HOME_DIRECTORY . DIRECTORY_SEPARATOR . Storage::FILE_NAME
@@ -59,6 +60,7 @@ $application->add(new AddCommand($storage));
 $application->add(new ImportCommand($storage, $repository));
 $application->add(new ExportCommand($storage, $repository));
 $application->add(new PairCommand($storage, $repository));
+$application->add(new UnpairCommand($repository));
 $application->add(new PersonasCommand($storage));
 $application->add(new RetireCommand($storage));
 $application->add(new UseCommand($storage, $repository));

src/Commands/UnpairCommand.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Stolt\GitUserBend\Commands;
+
+use Stolt\GitUserBend\Exceptions\CommandFailed;
+use Stolt\GitUserBend\Exceptions\Exception;
+use Stolt\GitUserBend\Git\Repository;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class UnpairCommand extends Command
+{
+    /**
+     * @var Repository
+     */
+    private Repository $repository;
+
+    /**
+     * Initialize.
+     *
+     * @param Repository $repository
+     */
+    public function __construct(Repository $repository)
+    {
+        $this->repository = $repository;
+
+        parent::__construct();
+    }
+
+    /**
+     * Command configuration.
+     *
+     * @return void
+     */
+    protected function configure(): void
+    {
+        $this->setName('unpair');
+        $this->setDescription('Finishes current pair programming session');
+
+        $directoryArgumentDescription = 'The directory of the Git repository';
+        $this->addArgument(
+            'directory',
+            InputArgument::OPTIONAL,
+            $directoryArgumentDescription,
+            WORKING_DIRECTORY
+        );
+    }
+
+    /**
+     * Execute command.
+     *
+     * @param InputInterface   $input
+     * @param OutputInterface $output
+     *
+     * @return integer
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $directory = $input->getArgument('directory');
+
+        try {
+            $this->repository->setDirectory((string) $directory);
+
+            $formerPersona = $this->repository->getFormerPersonaFromConfiguration();
+
+            $outputContent = "<info>Reset user config to <comment>"
+                . "'{$formerPersona->getName()} <{$formerPersona->getEmail()}>'</comment>.</info>";
+            $output->writeln($outputContent);
+
+            return self::SUCCESS;
+
+        } catch (Exception $e) {
+            $error = "<error>Error:</error> " . $e->getInforizedMessage();
+            $output->writeln($error);
+
+            return self::FAILURE;
+        }
+    }
+}

src/Git/Repository.php

@@ -10,7 +10,6 @@
 use Stolt\GitUserBend\Exceptions\NotAGitRepository;
 use Stolt\GitUserBend\Exceptions\UnresolvablePair;
 use Stolt\GitUserBend\Exceptions\UnresolvablePersona;
-use Stolt\GitUserBend\Git\User;
 use Stolt\GitUserBend\Persona;
 
 class Repository
@@ -162,6 +161,25 @@ public function getPersonaFromConfiguration(): Persona
         throw new UnresolvablePersona('Unable to resolve persona from Git configuration.');
     }
 
+    /**
+     * @throws UnresolvablePersona
+     * @throws InvalidPersona
+     */
+    public function getFormerPersonaFromConfiguration(): Persona
+    {
+        chdir($this->directory);
+
+        $command = 'git config --get-regexp "^user.former.*"';
+        exec($command, $output, $returnValue);
+
+        if ($returnValue === 0) {
+            $localFormerGitUser = $this->factorFormerUser($output);
+            return $localFormerGitUser->factorPersona();
+        }
+
+        throw new UnresolvablePersona('Unable to resolve former persona from Git configuration.');
+    }
+
     /**
      * @return boolean
      */
@@ -199,13 +217,40 @@ public function getPairUserFromConfiguration(): User
     }
 
     /**
-     * @param  User $user The use to configure locally.
+     * @throws UnresolvablePersona
+     */
+    public function storePreviousUser(): bool
+    {
+        chdir($this->directory);
+
+        $persona = $this->getPersonaFromConfiguration();
+
+        $storageCommands = [
+            "git config --local user.former.email {$persona->getEmail()}",
+            "git config --local user.former.name '{$persona->getName()}'",
+        ];
+
+        foreach ($storageCommands as $command) {
+            exec($command, $output, $returnValue);
+            if ($returnValue !== 0) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * @param User $user The use to configure locally.
+     * @throws UnresolvablePersona
      * @return boolean
      */
     public function setUser(User $user): bool
     {
         chdir($this->directory);
 
+        $this->storePreviousUser();
+
         $commands = [
             "git config --local user.email \"{$user->getEmail()}\"",
             "git config --local user.name \"{$user->getName()}\"",
@@ -239,4 +284,23 @@ private function factorUser(array $output): User
 
         return new User($name, $email, $alias);
     }
+
+    /**
+     * @param  array  $output
+     * @return User
+     */
+    private function factorFormerUser(array $output): User
+    {
+        foreach ($output as $keyValueLine) {
+            list($key, $value) = explode(' ', $keyValueLine, 2);
+            $key = str_replace('user.former.', '', $key);
+            $user[$key] = str_replace("'", '', $value);
+        }
+
+        $name = $user['name'] ?? null;
+        $email = $user['email'] ?? null;
+        $alias = $user['alias'] ?? User::REPOSITORY_USER_ALIAS;
+
+        return new User($name, $email, $alias);
+    }
 }

tests/Commands/PairCommandTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use Stolt\GitUserBend\Commands\PairCommand;
 use Stolt\GitUserBend\Git\Repository;
+use Stolt\GitUserBend\Git\User;
 use Stolt\GitUserBend\Persona;
 use Stolt\GitUserBend\Persona\Collection;
 use Stolt\GitUserBend\Persona\Storage;
@@ -231,7 +232,7 @@ public function returnsExpectedWarningWhenSetPairPersonaFails(): void
     #[Group('integration')]
     public function setsPairPersonasAndIncrementsUsageFrequencies(): void
     {
-        $this->createTemporaryGitRepository();
+        $this->createTemporaryGitRepository(new User('John Doe', '[email protected]'));
 
         $existingStorageContent = <<<CONTENT
 [{"alias":"jd","name":"John Doe","email":"[email protected]","usage_frequency":11},