refactor: hacker module (#739)

- hacker module migration from class to functions within hacker namespace Signed-off-by: Guru Mehar Rachaputi <gurumeharrachaputi@gmail.com>
cieslarmichal · Jun 25, 2024 · 859d59f · 859d59f
1 parent bcdb101
commit 859d59f
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 31 deletions.
diff --git a/include/faker-cxx/Hacker.h b/include/faker-cxx/Hacker.h
@@ -2,75 +2,71 @@
 
 #include <string_view>
 
-namespace faker
+namespace faker::hacker
 {
-class Hacker
-{
-public:
     /**
      * @brief Returns a hacker abbreviation.
      *
      * @returns abbreviation.
      *
      * @code
-     * Hacker::abbreviation() // "TCP"
+     * hacker::abbreviation() // "TCP"
      * @endcode
      */
-    static std::string_view abbreviation();
+    std::string_view abbreviation();
 
     /**
      * @brief Returns a random adjective.
      *
      * @returns adjective.
      *
      * @code
-     * Hacker::adjective() // "open-source"
+     * hacker::adjective() // "open-source"
      * @endcode
      */
-    static std::string_view adjective();
+    std::string_view adjective();
 
     /**
      * @brief Returns a random noun.
      *
      * @returns noun.
      *
      * @code
-     * Hacker::noun() // "coder"
+     * hacker::noun() // "coder"
      * @endcode
      */
-    static std::string_view noun();
+    std::string_view noun();
 
     /**
      * @brief Returns a random verb.
      *
      * @returns verb.
      *
      * @code
-     * Hacker::verb() // "run"
+     * hacker::verb() // "run"
      * @endcode
      */
-    static std::string_view verb();
+    std::string_view verb();
 
     /**
      * @brief Returns a random ingverb.
      *
      * @returns ingverb.
      *
      * @code
-     * Hacker::ingverb() // "backing up"
+     * hacker::ingverb() // "backing up"
      * @endcode
      */
-    static std::string_view ingverb();
+    std::string_view ingverb();
 
     /**
      * @brief Returns a random phrase.
      *
      * @return phrase.
      *
      * @code
-     * Hacker::phrase() // "If we bypass the monitor, we can get to the TCP monitor through the neural EXE monitor!"
+     * hacker::phrase() // "If we bypass the monitor, we can get to the TCP monitor through the neural EXE monitor!"
      * @endcode
      */
-    static std::string phrase();
-};
+    std::string phrase();
 }
diff --git a/src/modules/hacker/Hacker.cpp b/src/modules/hacker/Hacker.cpp
@@ -7,34 +7,34 @@
 #include "faker-cxx/Helper.h"
 #include "HackerData.h"
 
-namespace faker
+namespace faker::hacker
 {
-std::string_view Hacker::abbreviation()
+std::string_view abbreviation()
 {
     return Helper::arrayElement(abbreviations);
 }
 
-std::string_view Hacker::adjective()
+std::string_view adjective()
 {
     return Helper::arrayElement(adjectives);
 }
 
-std::string_view Hacker::noun()
+std::string_view noun()
 {
     return Helper::arrayElement(nouns);
 }
 
-std::string_view Hacker::verb()
+std::string_view verb()
 {
     return Helper::arrayElement(verbs);
 }
 
-std::string_view Hacker::ingverb()
+std::string_view ingverb()
 {
     return Helper::arrayElement(ingverbs);
 }
 
-std::string Hacker::phrase()
+std::string phrase()
 {
     const auto splitRandomPhrase = StringHelper::split(static_cast<std::string>(Helper::arrayElement(phrases)));
 

diff --git a/src/modules/hacker/HackerData.h b/src/modules/hacker/HackerData.h
@@ -3,7 +3,7 @@
 #include <array>
 #include <string_view>
 
-namespace faker
+namespace faker::hacker
 {
 const auto abbreviations = std::to_array<std::string_view>({
     "e.g.", "i.e.", "etc.", "Mr.",  "Mrs.", "Ms.", "Dr.", "Prof.",

diff --git a/tests/modules/hacker/HackerTest.cpp b/tests/modules/hacker/HackerTest.cpp
@@ -10,6 +10,7 @@
 
 using namespace ::testing;
 using namespace faker;
+using namespace faker::hacker;
 
 class HackerTest : public Test
 {
@@ -18,47 +19,47 @@ class HackerTest : public Test
 
 TEST_F(HackerTest, shouldGenerateAbbreviation)
 {
-    const auto generatedAbbreviation = Hacker::abbreviation();
+    const auto generatedAbbreviation = abbreviation();
 
     ASSERT_TRUE(std::ranges::any_of(abbreviations, [generatedAbbreviation](const std::string_view& abbreviation)
                                     { return abbreviation == generatedAbbreviation; }));
 }
 
 TEST_F(HackerTest, shouldGenerateAdjective)
 {
-    const auto generatedAdjective = Hacker::adjective();
+    const auto generatedAdjective = adjective();
 
     ASSERT_TRUE(std::ranges::any_of(adjectives, [generatedAdjective](const std::string_view& adjective)
                                     { return adjective == generatedAdjective; }));
 }
 
 TEST_F(HackerTest, shouldGenerateNoun)
 {
-    const auto generatedNoun = Hacker::noun();
+    const auto generatedNoun = noun();
 
     ASSERT_TRUE(
         std::ranges::any_of(nouns, [generatedNoun](const std::string_view& noun) { return noun == generatedNoun; }));
 }
 
 TEST_F(HackerTest, shouldGenerateVerb)
 {
-    const auto generatedVerb = Hacker::verb();
+    const auto generatedVerb = verb();
 
     ASSERT_TRUE(
         std::ranges::any_of(verbs, [generatedVerb](const std::string_view& verb) { return verb == generatedVerb; }));
 }
 
 TEST_F(HackerTest, shouldGenerateIngverb)
 {
-    const auto generatedIngverb = Hacker::ingverb();
+    const auto generatedIngverb = ingverb();
 
     ASSERT_TRUE(std::ranges::any_of(ingverbs, [generatedIngverb](const std::string_view& ingverb)
                                     { return ingverb == generatedIngverb; }));
 }
 
 TEST_F(HackerTest, shouldGeneratePhrase)
 {
-    const auto generatedPhrase = Hacker::phrase();
+    const auto generatedPhrase = phrase();
     bool hasAdjective, hasNoun, hasVerb, hasAbbreviation;
     hasAdjective = hasNoun = hasVerb = hasAbbreviation = false;