add location module (#50)

* add address module

* add git submodule initialization in github workflow

.github/workflows/buildAndTest.yml

@@ -28,7 +28,10 @@ jobs:
            && sudo launchpad-getkeys \
            && sudo apt-get update -y \
            && sudo apt-get install -y lld-16 ninja-build  build-essential libstdc++-13-dev \
-             clang-16 clang-tools-16 llvm-16 lcov libgtest-dev
+             clang-16 clang-tools-16 llvm-16 lcov
+
+      - name: Initialize submodules
+        run: git submodule update --init --recursive
 
       - name: Configure CMake
         run: |

CMakeLists.txt

@@ -8,34 +8,14 @@ set(CMAKE_CXX_STANDARD_REQUIRED YES)
 
 option(BUILD_TESTS DEFAULT ON)
 
-if(MSVC)
+if (MSVC)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /std:c++20 /permissive-")
-else()
+else ()
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Wconversion -Wformat -Werror")
-endif()
+endif ()
 
 set(LIBRARY_NAME faker-cxx)
 
-set(FAKER_HEADERS
-        include/faker-cxx/types/Country.h
-        include/faker-cxx/types/Hex.h
-        include/faker-cxx/types/Sex.h
-        include/faker-cxx/Book.h
-        include/faker-cxx/Color.h
-        include/faker-cxx/Commerce.h
-        include/faker-cxx/Company.h
-        include/faker-cxx/Datatype.h
-        include/faker-cxx/Date.h
-        include/faker-cxx/Finance.h
-        include/faker-cxx/Helper.h
-        include/faker-cxx/Internet.h
-        include/faker-cxx/Lorem.h
-        include/faker-cxx/Number.h
-        include/faker-cxx/Person.h
-        include/faker-cxx/String.h
-        include/faker-cxx/Word.h
-        )
-
 set(FAKER_SOURCES
         src/Book.cpp
         src/Color.cpp
@@ -46,6 +26,7 @@ set(FAKER_SOURCES
         src/Finance.cpp
         src/Helper.cpp
         src/Internet.cpp
+        src/Location.cpp
         src/Lorem.cpp
         src/Number.cpp
         src/Person.cpp
@@ -63,6 +44,7 @@ set(FAKER_UT_SOURCES
         src/DateTest.cpp
         src/FinanceTest.cpp
         src/InternetTest.cpp
+        src/LocationTest.cpp
         src/LoremTest.cpp
         src/NumberTest.cpp
         src/PersonTest.cpp
@@ -71,13 +53,13 @@ set(FAKER_UT_SOURCES
         src/WordTest.cpp
         )
 
-add_library(${LIBRARY_NAME} ${FAKER_SOURCES} ${FAKER_HEADERS})
+add_library(${LIBRARY_NAME} ${FAKER_SOURCES})
 
 target_include_directories(${LIBRARY_NAME}
         INTERFACE
         "${CMAKE_CURRENT_LIST_DIR}/include"
         PRIVATE
-        ${CMAKE_CURRENT_LIST_DIR}
+        "${CMAKE_CURRENT_LIST_DIR}/include"
         )
 
 if (BUILD_TESTS)

README.md

@@ -56,6 +56,7 @@ target_link_libraries(main faker-cxx)
 ## 💎 Modules
 
 - 🌐 Internet - Generate emails, usernames, passwords, images urls.
+- 🌍 Location - Generate countries, cities, zip codes, street addresses.
 - 🧑 Person - Generate first, last names, job titles, genders, sex.
 - 🛒 Commerce - Generate commerce department, product name, sku, price.
 - 📅 Date - Generate past, future dates.

TODO.md

@@ -2,8 +2,8 @@
 
 ### 🏦 Finance:
 
-- [ ] support for more countries in Finance::iban()
-- [ ] support for more countries in Finance::bic()
+- [ ] support for more iban countries
+- [ ] support for more bic countries
 - [ ] credit card number
 - [ ] credit card CVV
 - [ ] bitcoin address
@@ -19,6 +19,7 @@
 - [x] job title
 - [x] job type
 - [x] prefix
+- [ ] locales
 
 ### 📞 Phone:
 
@@ -47,17 +48,14 @@
 
 ### 🌍 Location:
 
-- [ ] building number
-- [ ] city
-- [ ] country
-- [ ] country code
-- [ ] latitude
-- [ ] longitude
-- [ ] state
-- [ ] street
-- [ ] street address
-- [ ] time zone
-- [ ] zip code
+- [x] country
+- [x] state
+- [x] city
+- [x] zip code
+- [x] street
+- [x] street address
+- [x] building number
+- [ ] locales
 
 ### 🖊️ Lorem:
 
@@ -84,6 +82,7 @@
 - [x] buzz phrase
 - [x] type
 - [x] industry
+- [ ] locales
 
 ### 👕 Commerce:
 

include/faker-cxx/Finance.h

@@ -3,6 +3,8 @@
 #include <optional>
 #include <string>
 
+#include "faker-cxx/types/BicCountry.h"
+#include "faker-cxx/types/IbanCountry.h"
 #include "types/Country.h"
 
 namespace faker
@@ -64,7 +66,7 @@ class Finance
      * Finance::iban(IbanCountry::Poland) // "PL61109010140000071219812874"
      * @endcode
      */
-    static std::string iban(std::optional<Country> country = std::nullopt);
+    static std::string iban(std::optional<IbanCountry> country = std::nullopt);
 
     /**
      * Generates a random bic.
@@ -75,10 +77,10 @@ class Finance
      * @returns BIC.
      *
      * @code
-     * Finance::bic(IbanCountry::Poland) // "BREXPLPWMUL"
+     * Finance::bic(BicCountry::Poland) // "BREXPLPWMUL"
      * @endcode
      */
-    static std::string bic(std::optional<Country> country = std::nullopt);
+    static std::string bic(std::optional<BicCountry> country = std::nullopt);
 
     /**
      * Generates a random account number.

include/faker-cxx/Location.h

@@ -0,0 +1,100 @@
+#pragma once
+
+#include <string>
+
+#include "types/Country.h"
+
+namespace faker
+{
+class Location
+{
+public:
+    /**
+     * @brief Returns a random country name.
+     *
+     * @returns Country name.
+     *
+     * @code
+     * Location::country() // "Poland"
+     * @endcode
+     */
+    static std::string country();
+
+    /**
+     * @brief Returns a random USA state.
+     *
+     * @returns USA state.
+     *
+     * @code
+     * Location::state() // "Arizona"
+     * @endcode
+     */
+    static std::string state();
+
+    /**
+     * @brief Returns a random city for given country.
+     *
+     * @param country The country to generate city from. Defaults to `Country::Usa`.
+     *
+     * @returns City.
+     *
+     * @code
+     * Location::city() // "Boston"
+     * @endcode
+     */
+    static std::string city(Country country = Country::Usa);
+
+    /**
+     * @brief Returns a random zip code for given country.
+     *
+     * @param country The country to generate zip code from. Defaults to `Country::Usa`.
+     *
+     * @returns Zip code.
+     *
+     * @code
+     * Location::zipCode() // "47683-9880"
+     * Location::zipCode(Country::Poland) // "31-881"
+     * @endcode
+     */
+    static std::string zipCode(Country country = Country::Usa);
+
+    /**
+     * @brief Returns a random street address for given country.
+     *
+     * @param country The country to generate street address from. Defaults to `Country::Usa`.
+     *
+     * @returns Street address including building number and street name.
+     *
+     * @code
+     * Location::streetAddress() // "34830 Erdman Hollow"
+     * @endcode
+     */
+    static std::string streetAddress(Country country = Country::Usa);
+
+    /**
+     * @brief Returns a random street for given country.
+     *
+     * @param country The country to generate street from. Defaults to `Country::Usa`.
+     *
+     * @returns Street name.
+     *
+     * @code
+     * Location::street() // "Schroeder Isle"
+     * @endcode
+     */
+    static std::string street(Country country = Country::Usa);
+
+    /**
+     * @brief Returns a random building number for given country.
+     *
+     * @param country The country to generate building number from. Defaults to `Country::Usa`.
+     *
+     * @returns Building number.
+     *
+     * @code
+     * Location::buildingNumber() // "505"
+     * @endcode
+     */
+    static std::string buildingNumber(Country country = Country::Usa);
+};
+}

include/faker-cxx/types/BicCountry.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include <vector>
+
+namespace faker
+{
+enum class BicCountry
+{
+    Poland,
+};
+
+const std::vector<BicCountry> supportedBicCountries{BicCountry::Poland};
+
+}

include/faker-cxx/types/Country.h

@@ -6,6 +6,7 @@ namespace faker
 {
 enum class Country
 {
+    Usa,
     Poland,
     France,
     Germany,

include/faker-cxx/types/IbanCountry.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include <vector>
+
+namespace faker
+{
+enum class IbanCountry
+{
+    Poland,
+    France,
+    Germany,
+    Italy
+};
+
+const std::vector<IbanCountry> supportedIbanCountries{IbanCountry::Poland, IbanCountry::France, IbanCountry::Germany,
+                                                      IbanCountry::Italy};
+
+}

src/Book.cpp

@@ -1,11 +1,11 @@
-#include "include/faker-cxx/Book.h"
+#include "faker-cxx/Book.h"
 
 #include "data/book/Authors.h"
 #include "data/book/Genres.h"
 #include "data/book/Publishers.h"
 #include "data/book/Titles.h"
-#include "include/faker-cxx/Helper.h"
-#include "include/faker-cxx/String.h"
+#include "faker-cxx/Helper.h"
+#include "faker-cxx/String.h"
 
 namespace faker
 {

src/BookTest.cpp

@@ -1,4 +1,4 @@
-#include "include/faker-cxx/Book.h"
+#include "faker-cxx/Book.h"
 
 #include "gtest/gtest.h"
 

src/Color.cpp

@@ -1,12 +1,12 @@
-#include "include/faker-cxx/Color.h"
+#include "faker-cxx/Color.h"
 
 #include <format>
 #include <sstream>
 
 #include "data/Colors.h"
-#include "include/faker-cxx/Helper.h"
-#include "include/faker-cxx/Number.h"
-#include "include/faker-cxx/String.h"
+#include "faker-cxx/Helper.h"
+#include "faker-cxx/Number.h"
+#include "faker-cxx/String.h"
 
 namespace faker
 {

src/ColorTest.cpp

@@ -1,4 +1,4 @@
-#include "include/faker-cxx/Color.h"
+#include "faker-cxx/Color.h"
 
 #include "gtest/gtest.h"
 

src/Commerce.cpp

@@ -1,11 +1,11 @@
-#include "include/faker-cxx/Commerce.h"
+#include "faker-cxx/Commerce.h"
 
 #include <format>
 
 #include "data/Commerce.h"
-#include "include/faker-cxx/Finance.h"
-#include "include/faker-cxx/Helper.h"
-#include "include/faker-cxx/String.h"
+#include "faker-cxx/Finance.h"
+#include "faker-cxx/Helper.h"
+#include "faker-cxx/String.h"
 
 namespace faker
 {

src/CommerceTest.cpp

@@ -1,4 +1,4 @@
-#include "include/faker-cxx/Commerce.h"
+#include "faker-cxx/Commerce.h"
 
 #include "gtest/gtest.h"
 

src/Company.cpp

@@ -1,4 +1,4 @@
-#include "include/faker-cxx/Company.h"
+#include "faker-cxx/Company.h"
 
 #include <format>
 
@@ -11,8 +11,8 @@
 #include "data/company/CompanyTypes.h"
 #include "data/company/Industries.h"
 #include "data/company/Suffixes.h"
-#include "include/faker-cxx/Helper.h"
-#include "include/faker-cxx/Person.h"
+#include "faker-cxx/Helper.h"
+#include "faker-cxx/Person.h"
 
 namespace faker
 {