diff --git a/src/ModuleCore/Git/GitManager.cs b/src/ModuleCore/Git/GitManager.cs index 0d5af37..702d0e1 100644 --- a/src/ModuleCore/Git/GitManager.cs +++ b/src/ModuleCore/Git/GitManager.cs @@ -1,4 +1,6 @@ -namespace ModuleCore.Git; +using System.Collections.Concurrent; + +namespace ModuleCore.Git; // TODO: better name for this public class GitManager @@ -11,23 +13,19 @@ public class GitManager /// internal static GitManager InternalFreshInstance => new(); - /// - /// Simply .ToString() - /// - private static readonly string DirectorySeparator = Path.DirectorySeparatorChar.ToString(); + private class GitRegistration + { + public required string Name { get; set; } + public required string Location { get; set; } + } - private readonly InternalDirectory _repositories; - private readonly Lock _readWriteLock = new(); + private readonly ConcurrentDictionary _registrations; private GitManager() { Console.WriteLine($"{nameof(GitManager)} init"); - // Initialise the root container - _repositories = new InternalDirectory() - { - Name = DirectorySeparator, - InternalPath = DirectorySeparator - }; + + _registrations = new ConcurrentDictionary(); } /// @@ -39,124 +37,45 @@ public class GitManager /// The normalised string the repository was registered against public string RegisterRepo(string absoluteRepositoryLocation, string registrationName) { - // Depending on the caller, it might be possible that they've scripted automatic repo registration. Because I - // don't really want to account to all the subtle ways that can be parallised, I just naively lock on every - // registration attempt. This method should be quick regardless, and I could use ConcurrentDictionary except - // that means every instance of InternalDirectory would need it and yeah nah fuck that I can just lock at the - // top level - lock (_readWriteLock) + registrationName = string.IsNullOrWhiteSpace(registrationName) + ? new DirectoryInfo(absoluteRepositoryLocation).Name + : registrationName; + + if (_registrations.TryAdd(registrationName, new GitRegistration() + { + Name = registrationName, + Location = absoluteRepositoryLocation, + })) { - var normalisedName = NormaliseNamePath(string.IsNullOrWhiteSpace(registrationName) - ? new DirectoryInfo(absoluteRepositoryLocation).Name - : registrationName); - - // Regardless of if we get a name or not, the fully qualified version for us - // starts with a / - var directorySegmentsFromName = NameToSegments(normalisedName); - - var added = _repositories.Add(absoluteRepositoryLocation, directorySegmentsFromName); - - // Not sure about this, the Add should throw any exceptions on duplicate/failures but for now I'll leave this - // here - if (added == null) - { - throw new Exception("Failed to register location"); - } - - return normalisedName; + return registrationName; } + + throw new Exception($"Git repo already registered with the name {registrationName}"); } - /// - /// Takes a name and returns it as a queue of its parts, starting with a root of - /// - /// - /// - private Queue NameToSegments(string name) + public List ListRepos() { - var segments = name.Split(DirectorySeparator); - - return segments.Length == 1 - ? new Queue([DirectorySeparator, name]) - : new Queue([DirectorySeparator, ..segments]); + return _registrations.Select(x => new GitReg() { Name = x.Value.Name, Location = x.Value.Location }).ToList(); } - /// - /// Normalises the path separators in the given string to use Path.DirectorySeparatorChar - /// - /// - /// - private string NormaliseNamePath(string name) + public string GetRepo(string? registeredName) { - // Feels a bit hacky, but this will actually normalise a path to a valid form. So if the input is - // some/directory/paths, Path.GetRelativePath will normalise it to some\directory\paths, relative to ./ - // which is kind of handy but I also just wish there was a Path method that would do this for me. I know that - // the whole point of Path is that it's based on a file system, but file systems can also be arbitrary and not - // always be drive rooted. - // Either way, this works and saves me having to reimplement a worse method when it's more important that users - // are able to use file paths in whatever form they prefer, which means we leverage the internal implementation - // in a weird way. - return Path.GetRelativePath("./", name); - } - - private class InternalDirectory - { - /// - /// Name of the folder this - /// - public string Name { get; set; } = null!; - - public Dictionary Children { get; set; } = []; - - internal string InternalPath { get; set; } - - /// - /// If not null, this is the absolute location of a registered git repository - /// - public string? FullRepositoryPath { get; set; } - - /// - /// - /// - /// - /// - /// - /// - internal InternalDirectory? Add(string absoluteRepositoryLocation, Queue directorySegmentsFromName) + if (string.IsNullOrEmpty(registeredName)) { - var topStack = directorySegmentsFromName.Dequeue(); - - if (topStack != Name) - { - // logically it shouldn't be possible to have a value on top of the stack that _doesn't_ exist, but - // just incase we throw as this should only happen if an Add is attempted on the root and the queue was - // not correctly rooted to / - throw new Exception($"Directory segment does not seem to exist: {topStack}"); - } - - // We're at the end of the directory segments so we can safely say we're at the end of the tree so - // we add it to the relevant dictionary - if (directorySegmentsFromName.Count == 0) - { - FullRepositoryPath = absoluteRepositoryLocation; - return this; - } - - var nextSegment = directorySegmentsFromName.Peek(); - - // Attempt to get the next level of the directory. If we don't have a key entry, create one - if (!Children.TryGetValue(nextSegment, out var nextChild)) - { - nextChild = new InternalDirectory() - { - Name = nextSegment, - InternalPath = Path.Combine(InternalPath, nextSegment) - }; - Children.Add(nextSegment, nextChild); - } - - // add the next - return nextChild.Add(absoluteRepositoryLocation, directorySegmentsFromName); + throw new Exception("Name cannot be null"); } + + if (_registrations.TryGetValue(registeredName, out var registration)) + { + return registration.Location; + } + + throw new Exception($"No git repo has been registered with the name {registeredName}"); } +} + +public class GitReg +{ + public required string Name { get; set; } + public required string Location { get; set; } } \ No newline at end of file diff --git a/src/PowershellModule/Git/Commands/GetGitRepoCommand.cs b/src/PowershellModule/Git/Commands/GetGitRepoCommand.cs new file mode 100644 index 0000000..1859375 --- /dev/null +++ b/src/PowershellModule/Git/Commands/GetGitRepoCommand.cs @@ -0,0 +1,17 @@ +using System.Management.Automation; +using ModuleCore.Git; + +namespace PowershellModule.Git.Commands; + +[Cmdlet(VerbsCommon.Get, GitCommands.GitRepoNoun)] +public class ListGitRepoCommand : PSCmdlet +{ + protected override void BeginProcessing() + { + var repos = GitManager.Instance.ListRepos(); + + WriteObject(repos); + + base.BeginProcessing(); + } +} \ No newline at end of file diff --git a/src/PowershellModule/Git/Commands/GitCommands.cs b/src/PowershellModule/Git/Commands/GitCommands.cs new file mode 100644 index 0000000..2d5c888 --- /dev/null +++ b/src/PowershellModule/Git/Commands/GitCommands.cs @@ -0,0 +1,6 @@ +namespace PowershellModule.Git.Commands; + +public class GitCommands +{ + public const string GitRepoNoun = "GitRepo"; +} \ No newline at end of file diff --git a/src/PowershellModule/Git/NewGitRepoCommand.cs b/src/PowershellModule/Git/Commands/NewGitRepoCommand.cs similarity index 95% rename from src/PowershellModule/Git/NewGitRepoCommand.cs rename to src/PowershellModule/Git/Commands/NewGitRepoCommand.cs index 2b4bf6a..5aabd59 100644 --- a/src/PowershellModule/Git/NewGitRepoCommand.cs +++ b/src/PowershellModule/Git/Commands/NewGitRepoCommand.cs @@ -4,13 +4,11 @@ using System.IO; using System.Management.Automation; using ModuleCore.Git; -namespace PowershellModule.Git; +namespace PowershellModule.Git.Commands; -[Cmdlet(VerbsCommon.New, Noun)] -public class NewGitRepoCommand : PSCmdlet +[Cmdlet(VerbsCommon.New, GitCommands.GitRepoNoun)] +public sealed class NewGitRepoCommand : PSCmdlet { - private const string Noun = "GitRepo"; - [Parameter( Position = 0, ValueFromPipeline = true, diff --git a/src/PowershellModule/Git/SetGitRepoCommand.cs b/src/PowershellModule/Git/Commands/SetGitRepoCommand.cs similarity index 66% rename from src/PowershellModule/Git/SetGitRepoCommand.cs rename to src/PowershellModule/Git/Commands/SetGitRepoCommand.cs index 9d6a7f1..69c4a34 100644 --- a/src/PowershellModule/Git/SetGitRepoCommand.cs +++ b/src/PowershellModule/Git/Commands/SetGitRepoCommand.cs @@ -2,13 +2,12 @@ using System.Management.Automation; using ModuleCore.Git; -namespace PowershellModule.Git; +namespace PowershellModule.Git.Commands; -[Cmdlet(VerbsCommon.Set, Noun)] +// TODO: decide if I want to use this verb instead of show. Currently this implementation is under Show-GitRepo +[Cmdlet(VerbsCommon.Set, GitCommands.GitRepoNoun)] public class SetGitRepoCommand : PSCmdlet { - private const string Noun = "GitRepo"; - public SetGitRepoCommand() { Console.WriteLine($"{nameof(NewGitRepoCommand)} init"); diff --git a/src/PowershellModule/Git/Commands/ShowGitRepoCommand.cs b/src/PowershellModule/Git/Commands/ShowGitRepoCommand.cs new file mode 100644 index 0000000..3394ef3 --- /dev/null +++ b/src/PowershellModule/Git/Commands/ShowGitRepoCommand.cs @@ -0,0 +1,43 @@ +using System; +using System.Management.Automation; +using ModuleCore.Git; + +namespace PowershellModule.Git.Commands; + +[Cmdlet(VerbsCommon.Show, GitCommands.GitRepoNoun)] +public class ShowGitRepoCommand : PSCmdlet +{ + [Parameter( + Position = 0, + ValueFromPipeline = true, + Mandatory = true, + HelpMessage = "Reference name for the repo")] + public string? Name { get; set; } + + [Parameter( + Mandatory = false, + HelpMessage = "Changes directory directly instead of using Set-Location")] + [Alias("NoSetLocation")] + public SwitchParameter NoStack { get; set; } + + protected override void BeginProcessing() + { + var location = GitManager.Instance.GetRepo(Name); + + // By default instead of doing the same as cd, we instead do pushd so a user can popd straight back to where + // they came from. + // TODO: incorporate this into the custom prompt when I develop that + if (!NoStack) + { + // Push the current location to the stack + // TODO: support named stacks. PowerShell *-Location commands support named stacks, but I don't personally + // use them myself so I haven't implemented them initially. I would like to in the future though, but right + // now it's low value to me. + // https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.management/set-location?view=powershell-7.6#example-4-set-the-current-location-to-a-named-stack + SessionState.Path.PushCurrentLocation(null); + } + + SessionState.Path.SetLocation(location); + base.BeginProcessing(); + } +} \ No newline at end of file diff --git a/tests/ModuleTests/Git/AddRegistrationTests.cs b/tests/ModuleTests/Git/AddRegistrationTests.cs index 6de31d6..511833a 100644 --- a/tests/ModuleTests/Git/AddRegistrationTests.cs +++ b/tests/ModuleTests/Git/AddRegistrationTests.cs @@ -74,4 +74,44 @@ public class AddRegistrationTests Assert.Equal("repo", whitespaceName); } + + [Fact] + public void DuplicateRepoRegistrationShouldFail() + { + Settings.UseFileName(nameof(RepoRegistrationWithWhitespaceName)); + + var gitManager = GitManager.InternalFreshInstance; + var testRepoAbsolutePath = "Test:/some/test/repo"; + string[] paths = ["test", "nested", "path"]; + var names = (NormalSeparator: string.Join(Path.DirectorySeparatorChar, paths), AltSeparator: string.Join(Path.AltDirectorySeparatorChar, paths)); + + var firstRegistration = gitManager.RegisterRepo(testRepoAbsolutePath, names.NormalSeparator); + // TODO: make nested registrations fail in both directions and test + var secondRegistration = gitManager.RegisterRepo(testRepoAbsolutePath, Path.Combine(paths[..1])); + + Assert.Equal(Path.Combine(paths), firstRegistration); + Assert.Equal(Path.Combine(paths[..1]), secondRegistration); + + Assert.Throws(() => gitManager.RegisterRepo(testRepoAbsolutePath, Path.Combine(paths[..1]))); + } + + [Fact] + public void DuplicateRepoRegistrationDifferentSlashShouldNotFail() + { + Settings.UseFileName(nameof(RepoRegistrationWithWhitespaceName)); + + var gitManager = GitManager.InternalFreshInstance; + var testRepoAbsolutePath = "Test:/some/test/repo"; + string[] paths = ["test", "nested", "path"]; + var names = (NormalSeparator: string.Join(Path.DirectorySeparatorChar, paths), AltSeparator: string.Join(Path.AltDirectorySeparatorChar, paths)); + + var firstRegistration = gitManager.RegisterRepo(testRepoAbsolutePath, names.NormalSeparator); + // TODO: make nested registrations fail in both directions and test + var secondRegistration = gitManager.RegisterRepo(testRepoAbsolutePath, Path.Combine(paths[..1])); + var differentPathSeparatorRegistration = gitManager.RegisterRepo(testRepoAbsolutePath, names.AltSeparator); + + Assert.Equal(Path.Combine(paths), firstRegistration); + Assert.Equal(Path.Combine(paths[..1]), secondRegistration); + Assert.Equal(names.AltSeparator, differentPathSeparatorRegistration); + } } \ No newline at end of file diff --git a/tests/ModuleTests/Git/Snapshots/AddRegistrationTests/BasicRepoRegistration_2.verified.txt b/tests/ModuleTests/Git/Snapshots/AddRegistrationTests/BasicRepoRegistration_2.verified.txt index 3c0b092..7f2c4e6 100644 --- a/tests/ModuleTests/Git/Snapshots/AddRegistrationTests/BasicRepoRegistration_2.verified.txt +++ b/tests/ModuleTests/Git/Snapshots/AddRegistrationTests/BasicRepoRegistration_2.verified.txt @@ -1,2 +1,2 @@ Attempted to register: other/path -Registration result: other\path +Registration result: other/path