Cleanup emailer. (#3)

acodcha · Oct 19, 2023 · 4f3c454 · 4f3c454
1 parent 2ae798d
commit 4f3c454
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/source/Messenger/Emailer.hpp b/source/Messenger/Emailer.hpp
@@ -30,7 +30,9 @@
 
 namespace SecretSanta::Messenger {
 
-std::string CreateFullMessageBody(
+// Composes the full email message body for a given gifter. Prefixes a brief
+// greeting to the given main message body and appends the giftee information.
+std::string ComposeFullMessageBody(
     const Participant& gifter, const Participant& giftee,
     const std::string& main_message_body) {
   std::string text;
@@ -41,7 +43,9 @@ std::string CreateFullMessageBody(
 
   text.append("Your giftee is:\n\n");
   text.append(giftee.Name() + "\n");
-  text.append(giftee.Address() + "\n");
+  if (!giftee.Address().empty()) {
+    text.append(giftee.Address() + "\n");
+  }
   if (!giftee.Instructions().empty()) {
     text.append("Special Instructions: " + giftee.Instructions() + "\n");
   }
@@ -50,21 +54,24 @@ std::string CreateFullMessageBody(
   return text;
 }
 
-std::string CreateCommand(
+// Composes the command used to invoke the S-nail utility for a given gifter.
+std::string ComposeCommand(
     const Participant& gifter, const std::string& message_subject,
     const std::string& message_body) {
   return "echo \"" + message_body + "\" | s-nail --subject \"" + message_subject
          + "\" " + gifter.Email();
 }
 
-void SendEmailMessage(
+// Composes and sends an email message to a given gifter. Creates the full body
+// of the message and sends it using the S-nail utility.
+void ComposeAndSendEmailMessage(
     const Participant& gifter, const Participant& giftee,
     const std::string& message_subject, const std::string& main_message_body) {
   const std::string full_message_body =
-      CreateFullMessageBody(gifter, giftee, main_message_body);
+      ComposeFullMessageBody(gifter, giftee, main_message_body);
 
   const std::string command{
-      CreateCommand(gifter, message_subject, full_message_body)};
+      ComposeCommand(gifter, message_subject, full_message_body)};
 
   const int outcome{std::system(command.c_str())};
 
@@ -76,9 +83,11 @@ void SendEmailMessage(
   }
 }
 
-void SendEmailMessages(
+// Composes and sends email messages to all gifters.
+void ComposeAndSendEmailMessages(
     const Configuration& configuration, const Matchings& matchings) {
   for (const Participant& gifter : configuration.Participants()) {
+    // Obtain the gifter and giftee names.
     const std::map<std::string, std::string>::const_iterator
         gifter_name_and_giftee_name =
             matchings.GiftersToGiftees().find(gifter.Name());
@@ -87,6 +96,7 @@ void SendEmailMessages(
       continue;
     }
 
+    // Obtain the giftee information.
     const std::set<Participant>::const_iterator giftee =
         configuration.Participants().find(
             {gifter_name_and_giftee_name->second});
@@ -95,8 +105,9 @@ void SendEmailMessages(
       continue;
     }
 
-    SendEmailMessage(gifter, *giftee, configuration.MessageSubject(),
-                     configuration.MessageBody());
+    // Compose and send the email message to this gifter.
+    ComposeAndSendEmailMessage(gifter, *giftee, configuration.MessageSubject(),
+                               configuration.MessageBody());
   }
 }
 

diff --git a/source/Messenger/Main.cpp b/source/Messenger/Main.cpp
@@ -36,7 +36,7 @@ int main(int argc, char* argv[]) {
 
   const SecretSanta::Matchings matchings{settings.MatchingsFile()};
 
-  SecretSanta::Messenger::SendEmailMessages(configuration, matchings);
+  SecretSanta::Messenger::ComposeAndSendEmailMessages(configuration, matchings);
 
   std::cout << "End of " << SecretSanta::Messenger::Program::Title << "."
             << std::endl;

diff --git a/test/Messenger/Emailer.cpp b/test/Messenger/Emailer.cpp
@@ -32,7 +32,7 @@ namespace SecretSanta::Messenger {
 
 namespace {
 
-TEST(MessengerEmailer, CreateFullMessageBody) {
+TEST(MessengerEmailer, ComposeFullMessageBody) {
   const Participant gifter = CreateSampleParticipantA();
   const Participant giftee = CreateSampleParticipantB();
 
@@ -41,7 +41,7 @@ TEST(MessengerEmailer, CreateFullMessageBody) {
       "Secret Santa gift exchange!"};
 
   const std::string result =
-      CreateFullMessageBody(gifter, giftee, main_message_body);
+      ComposeFullMessageBody(gifter, giftee, main_message_body);
 
   EXPECT_EQ(result,
             "Hello Alice Smith,\n\nYou are receiving this message because you "
@@ -50,12 +50,12 @@ TEST(MessengerEmailer, CreateFullMessageBody) {
             "92345 USA\n\nThank you!");
 }
 
-TEST(MessengerEmailer, CreateCommand) {
+TEST(MessengerEmailer, ComposeCommand) {
   const Participant gifter = CreateSampleParticipantA();
   const std::string message_subject{"My Message Subject"};
   const std::string message_body{"My Message Body"};
 
-  std::string command = CreateCommand(gifter, message_subject, message_body);
+  std::string command = ComposeCommand(gifter, message_subject, message_body);
 
   EXPECT_EQ(command,
             "echo \"My Message Body\" | s-nail --subject \"My Message "