Change Credits module to Credit #212

app-test/CommandLineParserTests.cs

@@ -7,7 +7,7 @@ public class CommandLineParserTests
     [Fact]
     public void TestParseNoun()
     {
-        Assert.Equal(Noun.Credits, parser.ParseNoun("credits"));
+        Assert.Equal(Noun.Credit, parser.ParseNoun("credit"));
     }
 
     [Fact]
@@ -19,7 +19,7 @@ public void TestParseNounWithBlock()
     [Fact]
     public void TestParseVerb()
     {
-        Assert.Equal(Verb.List, parser.ParseVerb("list", Noun.Credits));
+        Assert.Equal(Verb.List, parser.ParseVerb("list", Noun.Credit));
     }
 
     [Fact]
@@ -31,15 +31,15 @@ public void TestParseVerbInvalidNoun()
     [Fact]
     public void TestParseVerbInvalidVerb()
     {
-        Assert.Equal(Verb.Invalid, parser.ParseVerb("abc", Noun.Credits));
+        Assert.Equal(Verb.Invalid, parser.ParseVerb("abc", Noun.Credit));
     }
 
     [Fact]
-    public void TestParseCredits()
+    public void TestParseCredit()
     {
-        string[] args = { "credits", "list" };
-        ((Noun noun, Verb verb), string[] commandArgs) = parser.ParseWithArgs(args);
-        Assert.Equal(Noun.Credits, noun);
+        string[] args = { "credit", "list" };
+        (Noun noun, Verb verb) = parser.Parse(args);
+        Assert.Equal(Noun.Credit, noun);
         Assert.Equal(Verb.List, verb);
     }
 
@@ -64,36 +64,36 @@ public void TestParseBlock()
     [Fact]
     public void TestCommandLineArgs()
     {
-        string[] args = { "credits", "list" };
+        string[] args = { "credit", "list" };
         string[] commandLineArgs = parser.GetCommandLineArgs(args);
         Assert.Equal(new string[] {}, commandLineArgs);
     }
 
     [Fact]
     public void TestCommandLineArgsMultiple()
     {
-        string[] args = { "credits", "list", "abc" };
+        string[] args = { "credit", "list", "abc" };
         string[] commandLineArgs = parser.GetCommandLineArgs(args);
         Assert.Equal(new string[] { "abc" }, commandLineArgs);
     }
 
     [Fact]
     public void TestCommandLineArgsInvalid()
     {
-        string[] args = { "credits" };
+        string[] args = { "credit" };
         string[] commandLineArgs = parser.GetCommandLineArgs(args);
         Assert.Equal(new string[] {}, commandLineArgs);
     }
 
     [Fact]
     public void TestParseWithArgs()
     {
-        string[] args = { "credits", "list", "abc" };
+        string[] args = { "credit", "list", "abc" };
         ((Noun noun, Verb verb), string[] commandLineArgs) = parser.ParseWithArgs(args);
-        Assert.Equal(Noun.Credits, noun);
+        Assert.Equal(Noun.Credit, noun);
         Assert.Equal(Verb.List, verb);
         Assert.Equal(new string[] { "abc" }, commandLineArgs);
     }
 
 
-}
+}

app-test/CreditsTests.cs → app-test/CreditTests.cs

@@ -1,35 +1,35 @@
-namespace credits_tests;
-
-public class CreditsTests
-{
-    Credits credits = new Credits();
-
-    [Fact]
-    public void TestGetCreditsType()
-    {
-        Assert.True(typeof(string[]) == credits.GetCredits().GetType());
-    }
-
-    [Fact]
-    public void TestGetCreditsLength()
-    {
-        Assert.Equal(12, credits.GetCredits().Length);
-    }
-
-    [Fact]
-    public void TestGetCreditsContent()
-    {
-        Assert.Equal("Emil Harvey", credits.GetCredits()[0]);
-        Assert.Equal("Parth Gajjar", credits.GetCredits()[1]);
-        Assert.Equal("Boa Im", credits.GetCredits()[2]);
-        Assert.Equal("Nimeshkumar Chaudhari", credits.GetCredits()[3]);
-        Assert.Equal("Daphne Duong", credits.GetCredits()[4]);
-        Assert.Equal("Shaik Mathar Syed", credits.GetCredits()[5]);
-        Assert.Equal("Bharat Chauhan", credits.GetCredits()[6]);
-        Assert.Equal("Prabhdeep Singh", credits.GetCredits()[7]);
-        Assert.Equal("Tao Boyce", credits.GetCredits()[8]);
-        Assert.Equal("Zumhliansang Lung Ler", credits.GetCredits()[9]);
-        Assert.Equal("Daeseong Yu", credits.GetCredits()[10]);
-        Assert.Equal("Tian Yang", credits.GetCredits()[11]);
-    }
+namespace credit_tests;
+
+public class CreditTests
+{
+    Credit credits = new Credit();
+
+    [Fact]
+    public void TestGetCreditsType()
+    {
+        Assert.True(typeof(string[]) == credits.GetCredits().GetType());
+    }
+
+    [Fact]
+    public void TestGetCreditsLength()
+    {
+        Assert.Equal(12, credits.GetCredits().Length);
+    }
+
+    [Fact]
+    public void TestGetCreditsContent()
+    {
+        Assert.Equal("Emil Harvey", credits.GetCredits()[0]);
+        Assert.Equal("Parth Gajjar", credits.GetCredits()[1]);
+        Assert.Equal("Boa Im", credits.GetCredits()[2]);
+        Assert.Equal("Nimeshkumar Chaudhari", credits.GetCredits()[3]);
+        Assert.Equal("Daphne Duong", credits.GetCredits()[4]);
+        Assert.Equal("Shaik Mathar Syed", credits.GetCredits()[5]);
+        Assert.Equal("Bharat Chauhan", credits.GetCredits()[6]);
+        Assert.Equal("Prabhdeep Singh", credits.GetCredits()[7]);
+        Assert.Equal("Tao Boyce", credits.GetCredits()[8]);
+        Assert.Equal("Zumhliansang Lung Ler", credits.GetCredits()[9]);
+        Assert.Equal("Daeseong Yu", credits.GetCredits()[10]);
+        Assert.Equal("Tian Yang", credits.GetCredits()[11]);
+    }
 }

app/CommandLineParser.cs

@@ -5,7 +5,7 @@
 /// </summary>
 enum Noun
 {
-    Credits, // Represents the "credits" noun.
+    Credit, // Represents the "credit" noun.
     WorkItem, // Represents work item
     Block, // Represents the "block" noun.
     Progress, // Represents Progerss item
@@ -69,7 +69,8 @@ class CommandLineParser : ICommandLineParser
 {
     private readonly Dictionary<Noun, HashSet<Verb>> ValidVerbs = new Dictionary<Noun, HashSet<Verb>>
     {
-        { Noun.Credits, new HashSet<Verb> { Verb.List } },
+        // Credit supports just the List verb.
+        { Noun.Credit, new HashSet<Verb> { Verb.List } },
         { Noun.WorkItem, new HashSet<Verb> { Verb.List, Verb.Create, Verb.Edit, Verb.Delete } },
         { Noun.Block, new HashSet<Verb> { Verb.List, Verb.Create, Verb.Edit, Verb.Delete } },
         { Noun.Progress, new HashSet<Verb> { Verb.Edit, Verb.Delete} },

app/Credits.cs → app/Credit.cs

@@ -5,14 +5,14 @@ It was created to fulfill #16
 
 using Lms;
 
-class Credits : ICommand {
+class Credit : ICommand {
     private LmsDbContext? db;
 
-    public Credits() {
+    public Credit() {
         this.db =  null;
     }
 
-    public Credits(LmsDbContext db) {
+    public Credit(LmsDbContext db) {
         this.db = db;
     }
 

app/Program.cs

@@ -27,14 +27,13 @@
     case Noun.Invalid:
         Console.WriteLine("Invalid noun.");
         return 400; // 400 Bad Request
-    case Noun.Credits:
-        Credits credits = new Credits(dbContext); // initialize here to avoid unnecessary instantiation
-        credits.Execute(verb, commandArgs);
-        return 200; // 200 OK
+    case Noun.Credit:
+        Credit credits = new Credit(dbContext); // initialize here to avoid unnecessary instantiation
+        credits.Execute(verb);
+	return 200;
     case Noun.Block:
         Blockers blockers = new Blockers(dbContext);
         blockers.Execute(verb, commandArgs);
-
         return 200; // 200 OK
     case Noun.WorkItem:
         WorkItem work_item = new WorkItem(dbContext);

app/Properties/launchSettings.json

@@ -2,7 +2,7 @@
   "profiles": {
     "showCredits": {
       "commandName": "Project",
-      "commandLineArgs": "Credits List"
+      "commandLineArgs": "Credit List"
     }
   }
 }

wiki/announcements/Iteration 2 starting soon.md

@@ -21,7 +21,7 @@ As an overview:
 ## CLI
 I completed #48. This adds super basic CLI (command-line interface) functionality for this project. At a super high level, the app works with a `noun verb` pattern. For example:
 ```
-$ dotnet run credits list
+$ dotnet run credit list
 Credits
 -------
 Emil Harvey

wiki/development/CLI Standards.md

@@ -9,9 +9,9 @@ Our CLI should adopt a "noun" "verb" pattern. This means that the first argument
 # Architecture
 The `CommandLineParser` class handles command line parsing. The `parse` function receives command line arguments (via the magic `args` variable). It has several functions that help you along.
 - `Parse` is a simple function that receives command line `args` and returns both the `Noun` and the `Verb`
-	- E.g., `credits list` -> `(Credits, List)`
+	- E.g., `credit list` -> `(Credit, List)`
 - `GetCommandLineArgs` returns the arguments *after* the `Noun` and `Verb`
-	- E.g., `credits list` -> `[]`
-	- E.g., `credits list abc` -> `["abc"]`
+	- E.g., `credit list` -> `[]`
+	- E.g., `credit list abc` -> `["abc"]`
 - `ParseWithArgs` is a combination of both `Parse` and `GetCommandLineArgs`
-	- E.g., `credits list abc` -> `((Credits, List), ["abc"]`
+	- E.g., `credit list abc` -> `((Credit, List), ["abc"]`