Compare commits

..

No commits in common. "master" and "exceptionHandling" have entirely different histories.

5 changed files with 113 additions and 185 deletions

View File

@ -1,24 +0,0 @@
# 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

View File

@ -5,10 +5,6 @@ public class CommitDetail
private List<string>? _authors; private List<string>? _authors;
private SortedList<string, int>? _commitDetails; private SortedList<string, int>? _commitDetails;
private string _currentBranch; private string _currentBranch;
private string? _outputOption;
private string? _branchOption;
private string? _tagOption;
private string? _selectedDir;
public List<string>? Authors public List<string>? Authors
{ {
@ -28,28 +24,16 @@ public class CommitDetail
set { _currentBranch = value; } set { _currentBranch = value; }
} }
public string? SelectedDir public CommitDetail()
{ {
get { return _selectedDir; }
set { _selectedDir = value; }
}
public CommitDetail(string? dir)
{
_selectedDir = !String.IsNullOrEmpty(dir) ? dir : Directory.GetCurrentDirectory();
_authors = new List<string>(); _authors = new List<string>();
_commitDetails = new SortedList<string, int>(); _commitDetails = new SortedList<string, int>();
_currentBranch = GetCurrentBranch(); _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(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
foreach (var c in repo.Commits) foreach (var c in repo.Commits)
{ {
@ -69,7 +53,7 @@ public class CommitDetail
public void GetCurrentCommitsByEmail() public void GetCurrentCommitsByEmail()
{ {
using (var repo = new Repository(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
foreach (var c in repo.Commits) foreach (var c in repo.Commits)
{ {
@ -89,7 +73,7 @@ public class CommitDetail
public int GetCommitTotal() public int GetCommitTotal()
{ {
using (var repo = new Repository(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
return repo.Commits.Count(); return repo.Commits.Count();
} }
@ -97,7 +81,7 @@ public class CommitDetail
public string GetCurrentBranch() public string GetCurrentBranch()
{ {
using (var repo = new Repository(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
return repo.Head.Reference.TargetIdentifier; return repo.Head.Reference.TargetIdentifier;
} }
@ -105,7 +89,7 @@ public class CommitDetail
public void GetCommitsByBranch(string branchName) public void GetCommitsByBranch(string branchName)
{ {
using (var repo = new Repository(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
var branchResult = repo.Branches[branchName]; var branchResult = repo.Branches[branchName];
@ -142,7 +126,7 @@ public class CommitDetail
public void GetCommitsByTag(string tagName) public void GetCommitsByTag(string tagName)
{ {
using (var repo = new Repository(_selectedDir)) using (var repo = new Repository(Directory.GetCurrentDirectory()))
{ {
try try
{ {

View File

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

View File

@ -22,23 +22,15 @@ static class Program
); );
tagOption.AddAlias("-t"); 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") var rootCommand = new RootCommand("Get a tally of contributors' commits")
{ {
outputOption, outputOption,
branchOption, branchOption,
tagOption, tagOption,
dirOption,
}; };
rootCommand.SetHandler((outputOptionValue, branchOptionValue, tagOptionValue, dirOptionValue) => rootCommand.SetHandler((outputOptionValue, branchOptionValue, tagOptionValue) => {
{ CommitDetail commits = new CommitDetail();
CommitDetail commits = new CommitDetail(dirOptionValue);
switch (outputOptionValue) switch (outputOptionValue)
{ {
@ -46,13 +38,10 @@ static class Program
StdOutDataService outDataService = new StdOutDataService(); StdOutDataService outDataService = new StdOutDataService();
DataAccess dataAccess = new DataAccess(outDataService); DataAccess dataAccess = new DataAccess(outDataService);
if (branchOptionValue != null && tagOptionValue != null) if (branchOptionValue != null && tagOptionValue != null) {
{
Console.WriteLine("Please specify either a branch or a tag"); Console.WriteLine("Please specify either a branch or a tag");
Environment.Exit(2); Environment.Exit(2);
} } else if (branchOptionValue != null && tagOptionValue == null) {
else if (branchOptionValue != null && tagOptionValue == null)
{
switch (branchOptionValue) switch (branchOptionValue)
{ {
case null: case null:
@ -64,9 +53,8 @@ static class Program
dataAccess.WriteData(commits.CommitDetails); dataAccess.WriteData(commits.CommitDetails);
break; break;
} }
} break;
else if (branchOptionValue == null && tagOptionValue != null) } else if (branchOptionValue == null && tagOptionValue != null) {
{
commits.GetCommitsByTag(tagOptionValue); commits.GetCommitsByTag(tagOptionValue);
dataAccess.WriteData(commits.CommitDetails); dataAccess.WriteData(commits.CommitDetails);
} }
@ -75,13 +63,10 @@ static class Program
ExcelDataService excelDataService = new ExcelDataService(); ExcelDataService excelDataService = new ExcelDataService();
DataAccess dataAccessExcelCase = new DataAccess(excelDataService); DataAccess dataAccessExcelCase = new DataAccess(excelDataService);
if (branchOptionValue != null && tagOptionValue != null) if (branchOptionValue != null && tagOptionValue != null) {
{
Console.WriteLine("Please specify either a branch or a tag."); Console.WriteLine("Please specify either a branch or a tag.");
Environment.Exit(2); Environment.Exit(2);
} } else if (branchOptionValue != null && tagOptionValue == null) {
else if (branchOptionValue != null && tagOptionValue == null)
{
switch (branchOptionValue) switch (branchOptionValue)
{ {
case null: case null:
@ -93,9 +78,8 @@ static class Program
dataAccessExcelCase.WriteData(commits.CommitDetails); dataAccessExcelCase.WriteData(commits.CommitDetails);
break; break;
} }
} break;
else if (branchOptionValue == null && tagOptionValue != null) } else if (branchOptionValue == null && tagOptionValue != null) {
{
commits.GetCommitsByTag(tagOptionValue); commits.GetCommitsByTag(tagOptionValue);
dataAccessExcelCase.WriteData(commits.CommitDetails); dataAccessExcelCase.WriteData(commits.CommitDetails);
} }
@ -120,13 +104,10 @@ static class Program
StdOutDataService stdOutDataService = new StdOutDataService(); StdOutDataService stdOutDataService = new StdOutDataService();
DataAccess dataAccessNullCase = new DataAccess(stdOutDataService); DataAccess dataAccessNullCase = new DataAccess(stdOutDataService);
if (branchOptionValue != null && tagOptionValue != null) if (branchOptionValue != null && tagOptionValue != null) {
{
Console.WriteLine("Please specify either a branch or a tag."); Console.WriteLine("Please specify either a branch or a tag.");
Environment.Exit(2); Environment.Exit(2);
} } else if (branchOptionValue != null && tagOptionValue == null) {
else if (branchOptionValue != null && tagOptionValue == null)
{
switch (branchOptionValue) switch (branchOptionValue)
{ {
case null: case null:
@ -138,14 +119,11 @@ static class Program
dataAccessNullCase.WriteData(commits.CommitDetails); dataAccessNullCase.WriteData(commits.CommitDetails);
break; break;
} }
} break;
else if (branchOptionValue == null && tagOptionValue != null) } else if (branchOptionValue == null && tagOptionValue != null) {
{
commits.GetCommitsByTag(tagOptionValue); commits.GetCommitsByTag(tagOptionValue);
dataAccessNullCase.WriteData(commits.CommitDetails); dataAccessNullCase.WriteData(commits.CommitDetails);
} } else {
else
{
commits.GetCurrentCommitsByName(); commits.GetCurrentCommitsByName();
dataAccessNullCase.WriteData(commits.CommitDetails); dataAccessNullCase.WriteData(commits.CommitDetails);
} }
@ -156,7 +134,7 @@ static class Program
break; break;
} }
}, },
outputOption, branchOption, tagOption, dirOption); outputOption, branchOption, tagOption);
rootCommand.Invoke(args); rootCommand.Invoke(args);
} }

View File

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