runner fix

Reviewed-on: #4

.github/workflows/dotnet.yml

@@ -0,0 +1,24 @@
+# This workflow will build a .NET project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-net
+
+name: .NET build
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 6.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    - name: Test
+      run: dotnet test --no-build --verbosity normal

BLL/CommitDetail.cs

@@ -5,13 +5,17 @@ public class CommitDetail
     private List<string>? _authors;
     private SortedList<string, int>? _commitDetails;
     private string _currentBranch;
+    private string? _outputOption;
+    private string? _branchOption;
+    private string? _tagOption;
+    private string? _selectedDir;
 
-    public List<string>? Authors 
-    { 
+    public List<string>? Authors
+    {
         get { return _authors; }
         set { _authors = value; }
     }
-    
+
     public SortedList<string, int>? CommitDetails
     {
         get { return _commitDetails; }
@@ -24,16 +28,28 @@ public class CommitDetail
         set { _currentBranch = value; }
     }
 
-    public CommitDetail()
+    public string? SelectedDir
     {
+        get { return _selectedDir; }
+        set { _selectedDir = value; }
+    }
+
+    public CommitDetail(string? dir)
+    {
+        _selectedDir = !String.IsNullOrEmpty(dir) ? dir : Directory.GetCurrentDirectory();
         _authors = new List<string>();
         _commitDetails = new SortedList<string, int>();
         _currentBranch = GetCurrentBranch();
+
+        // unused, might be used later for a refactor
+        _outputOption = null;
+        _branchOption = null;
+        _tagOption = null;
     }
 
-    public void GetCurrentCommitsByName() 
+    public void GetCurrentCommitsByName()
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
             foreach (var c in repo.Commits)
             {
@@ -42,7 +58,7 @@ public class CommitDetail
                     _authors.Add(c.Author.Name);
                 }
             }
-            
+
             foreach (var a in _authors)
             {
                 int commitCount = repo.Commits.Where(r => r.Author.Name == a).Count();
@@ -53,7 +69,7 @@ public class CommitDetail
 
     public void GetCurrentCommitsByEmail()
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
             foreach (var c in repo.Commits)
             {
@@ -62,7 +78,7 @@ public class CommitDetail
                     _authors.Add(c.Author.Email);
                 }
             }
-            
+
             foreach (var a in _authors)
             {
                 int commitCount = repo.Commits.Where(r => r.Author.Email == a).Count();
@@ -73,7 +89,7 @@ public class CommitDetail
 
     public int GetCommitTotal()
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
             return repo.Commits.Count();
         }
@@ -81,7 +97,7 @@ public class CommitDetail
 
     public string GetCurrentBranch()
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
             return repo.Head.Reference.TargetIdentifier;
         }
@@ -89,15 +105,23 @@ public class CommitDetail
 
     public void GetCommitsByBranch(string branchName)
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
             var branchResult = repo.Branches[branchName];
 
-            if (branchResult == null)
+            try
             {
-                branchResult = repo.Branches[$"origin/{branchName}"];
-                var remoteBranch = repo.CreateBranch(branchName, branchResult.Tip);
-                repo.Branches.Update(remoteBranch, b => b.UpstreamBranch = $"refs/heads/{branchName}");
+                if (branchResult == null)
+                {
+                    branchResult = repo.Branches[$"origin/{branchName}"];
+                    var remoteBranch = repo.CreateBranch(branchName, branchResult.Tip);
+                    repo.Branches.Update(remoteBranch, b => b.UpstreamBranch = $"refs/heads/{branchName}");
+                }
+            }
+            catch (System.Exception)
+            {
+                Console.WriteLine($"Cannot fetch {branchName} branch.");
+                Environment.Exit(1);
             }
 
             foreach (var c in branchResult.Commits)
@@ -107,7 +131,7 @@ public class CommitDetail
                     _authors.Add(c.Author.Name);
                 }
             }
-            
+
             foreach (var a in _authors)
             {
                 int commitCount = branchResult.Commits.Where(r => r.Author.Name == a).Count();
@@ -115,13 +139,41 @@ public class CommitDetail
             }
         }
     }
-    
+
     public void GetCommitsByTag(string tagName)
     {
-        using (var repo = new Repository(Directory.GetCurrentDirectory()))
+        using (var repo = new Repository(_selectedDir))
         {
-            var tagResult = repo.Tags[tagName];
-            System.Console.WriteLine(tagResult);
+            try
+            {
+                var tagResult = repo.Tags[tagName].Target.Sha;
+
+                var commitFilter = new CommitFilter
+                {
+                    IncludeReachableFrom = tagResult,
+                };
+
+                var query = repo.Commits.QueryBy(commitFilter);
+
+                foreach (var c in query)
+                {
+                    if (!_authors.Contains(c.Author.Name))
+                    {
+                        _authors.Add(c.Author.Name);
+                    }
+                }
+
+                foreach (var a in _authors)
+                {
+                    int commitCount = query.Where(r => r.Author.Name == a).Count();
+                    _commitDetails.Add(a, commitCount);
+                }
+            }
+            catch (System.Exception)
+            {
+                Console.WriteLine($"Cannot find the tag {tagName}");
+                Environment.Exit(3);
+            }
         }
     }
 }

DrillSergeant.csproj

@@ -7,6 +7,7 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <AssemblyName>drillsergeant</AssemblyName>
+    <Version>1.2.0</Version>
   </PropertyGroup>
 
   <ItemGroup>

Program.cs

@@ -16,88 +16,147 @@ static class Program
                 );
         branchOption.AddAlias("-b");
 
+        var tagOption = new Option<string>(
+                "--tag",
+                "Specify the tag to filter by"
+                );
+        tagOption.AddAlias("-t");
+
+        var dirOption = new Option<string>(
+                "--file",
+                "Specify a git directory"
+                );
+        dirOption.AddAlias("-f");
+
         var rootCommand = new RootCommand("Get a tally of contributors' commits")
         {
             outputOption,
             branchOption,
+            tagOption,
+            dirOption,
         };
 
-        rootCommand.SetHandler((outputOptionValue, branchOptionValue) => {
-                    CommitDetail commits = new CommitDetail();
-                    
-                    switch (outputOptionValue) 
+        rootCommand.SetHandler((outputOptionValue, branchOptionValue, tagOptionValue, dirOptionValue) =>
+        {
+            CommitDetail commits = new CommitDetail(dirOptionValue);
+
+            switch (outputOptionValue)
+            {
+                case "stdout":
+                    StdOutDataService outDataService = new StdOutDataService();
+                    DataAccess dataAccess = new DataAccess(outDataService);
+
+                    if (branchOptionValue != null && tagOptionValue != null)
                     {
-                        case "stdout":
-                            StdOutDataService outDataService = new StdOutDataService();
-                            DataAccess dataAccess = new DataAccess(outDataService);
+                        Console.WriteLine("Please specify either a branch or a tag");
+                        Environment.Exit(2);
+                    }
+                    else if (branchOptionValue != null && tagOptionValue == null)
+                    {
+                        switch (branchOptionValue)
+                        {
+                            case null:
+                                commits.GetCurrentCommitsByName();
+                                dataAccess.WriteData(commits.CommitDetails);
+                                break;
+                            default:
+                                commits.GetCommitsByBranch(branchOptionValue);
+                                dataAccess.WriteData(commits.CommitDetails);
+                                break;
+                        }
+                    }
+                    else if (branchOptionValue == null && tagOptionValue != null)
+                    {
+                        commits.GetCommitsByTag(tagOptionValue);
+                        dataAccess.WriteData(commits.CommitDetails);
+                    }
+                    break;
+                case "xlsx":
+                    ExcelDataService excelDataService = new ExcelDataService();
+                    DataAccess dataAccessExcelCase = new DataAccess(excelDataService);
 
-                            switch (branchOptionValue) 
-                            {
-                                case null:
-                                    commits.GetCurrentCommitsByName();
-                                    dataAccess.WriteData(commits.CommitDetails);
-                                    break;
-                                default:
-                                    commits.GetCommitsByBranch(branchOptionValue);
-                                    dataAccess.WriteData(commits.CommitDetails);
-                                    break;
-                            }
-                            break;
-                        case "xlsx":
-                            ExcelDataService excelDataService = new ExcelDataService();
-                            DataAccess dataAccessExcelCase = new DataAccess(excelDataService);
+                    if (branchOptionValue != null && tagOptionValue != null)
+                    {
+                        Console.WriteLine("Please specify either a branch or a tag.");
+                        Environment.Exit(2);
+                    }
+                    else if (branchOptionValue != null && tagOptionValue == null)
+                    {
+                        switch (branchOptionValue)
+                        {
+                            case null:
+                                commits.GetCurrentCommitsByName();
+                                dataAccessExcelCase.WriteData(commits.CommitDetails);
+                                break;
+                            default:
+                                commits.GetCommitsByBranch(branchOptionValue);
+                                dataAccessExcelCase.WriteData(commits.CommitDetails);
+                                break;
+                        }
+                    }
+                    else if (branchOptionValue == null && tagOptionValue != null)
+                    {
+                        commits.GetCommitsByTag(tagOptionValue);
+                        dataAccessExcelCase.WriteData(commits.CommitDetails);
+                    }
+                    break;
+                case "pdf":
+                    PdfDataService pdfDataService = new PdfDataService();
+                    DataAccess dataAccessPdfCase = new DataAccess(pdfDataService);
 
-                            switch (branchOptionValue)
-                            {
-                                case null:
-                                    commits.GetCurrentCommitsByName();
-                                    dataAccessExcelCase.WriteData(commits.CommitDetails);
-                                    break;
-                                default:
-                                    commits.GetCommitsByBranch(branchOptionValue);
-                                    dataAccessExcelCase.WriteData(commits.CommitDetails);
-                                    break;
-                            }
-                            break;
-                        case "pdf":
-                            PdfDataService pdfDataService = new PdfDataService();
-                            DataAccess dataAccessPdfCase = new DataAccess(pdfDataService);
-
-                            switch (branchOptionValue) 
-                            {
-                                case null:
-                                    commits.GetCurrentCommitsByName();
-                                    dataAccessPdfCase.WriteData(commits.CommitDetails);
-                                    break;
-                                default:
-                                    commits.GetCommitsByBranch(branchOptionValue);
-                                    dataAccessPdfCase.WriteData(commits.CommitDetails);
-                                    break;
-                            }
-                            break;
+                    switch (branchOptionValue)
+                    {
                         case null:
-                            StdOutDataService stdOutDataService = new StdOutDataService();
-                            DataAccess dataAccessNullCase = new DataAccess(stdOutDataService);
-
-                            switch (branchOptionValue)
-                            {
-                                case null:
-                                    commits.GetCurrentCommitsByName();
-                                    dataAccessNullCase.WriteData(commits.CommitDetails);
-                                    break;
-                                default:
-                                    commits.GetCommitsByBranch(branchOptionValue);
-                                    dataAccessNullCase.WriteData(commits.CommitDetails);
-                                    break;
-                            }
+                            commits.GetCurrentCommitsByName();
+                            dataAccessPdfCase.WriteData(commits.CommitDetails);
                             break;
                         default:
-                            System.Console.WriteLine("This should not happen...");
-                            Environment.Exit(90);
+                            commits.GetCommitsByBranch(branchOptionValue);
+                            dataAccessPdfCase.WriteData(commits.CommitDetails);
                             break;
                     }
-                },
-                outputOption, branchOption);
+                    break;
+                case null:
+                    StdOutDataService stdOutDataService = new StdOutDataService();
+                    DataAccess dataAccessNullCase = new DataAccess(stdOutDataService);
+
+                    if (branchOptionValue != null && tagOptionValue != null)
+                    {
+                        Console.WriteLine("Please specify either a branch or a tag.");
+                        Environment.Exit(2);
+                    }
+                    else if (branchOptionValue != null && tagOptionValue == null)
+                    {
+                        switch (branchOptionValue)
+                        {
+                            case null:
+                                commits.GetCurrentCommitsByName();
+                                dataAccessNullCase.WriteData(commits.CommitDetails);
+                                break;
+                            default:
+                                commits.GetCommitsByBranch(branchOptionValue);
+                                dataAccessNullCase.WriteData(commits.CommitDetails);
+                                break;
+                        }
+                    }
+                    else if (branchOptionValue == null && tagOptionValue != null)
+                    {
+                        commits.GetCommitsByTag(tagOptionValue);
+                        dataAccessNullCase.WriteData(commits.CommitDetails);
+                    }
+                    else
+                    {
+                        commits.GetCurrentCommitsByName();
+                        dataAccessNullCase.WriteData(commits.CommitDetails);
+                    }
+                    break;
+                default:
+                    System.Console.WriteLine("This should not happen...");
+                    Environment.Exit(4);
+                    break;
+            }
+        },
+                outputOption, branchOption, tagOption, dirOption);
 
         rootCommand.Invoke(args);
     }

README.md

@@ -37,6 +37,7 @@ To use this command-line application, you must be in a git project. Otherwise, a
   -o, --output <pdf|stdout|xlsx>  Specify the output given to the user
   -b, --branch <branch>           Specify the branch to filter by
   -t, --tag <tag>                 Specify the tag to filter by
+  -f, --file <file>               Specify a git directory
 ```
 
 Throw the `-h` flag for quick assistance. Throw the `--version` flag for version information.
@@ -73,6 +74,14 @@ To get a commit report to a PDF file filtered by the `devel` branch:
 drillsergeant -o pdf -b devel
 ```
 
+To get a tally based on a directory:
+
+```bash
+drillsergeant -f /home/user/drillsergeant
+```
+
+This also works on enviroment variables too!
+
 Got too many contributors to fit onto your terminal? Run this by installing [bat](https://github.com/sharkdp/bat):
 
 ```bash
@@ -142,7 +151,7 @@ Then, you can find the binary in the `publish/` directory. You can move this exe
 
 ## Known Issues
 
-- A user must be in the root of a git project in order for this program to run.
+- A user must be in the root of a git project in order for this program to run (unless the user runs the `-f` flag when invoking `drillsergeant`).
 
 ## Next Steps/Contributing