Refactor tests

.github/ISSUE_TEMPLATE/bugs.md

@@ -2,7 +2,7 @@
 name: Bug Report
 about: Bug Report for this project
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 ---
 

.github/ISSUE_TEMPLATE/documentation.md

@@ -2,7 +2,7 @@
 name: Documentation request
 about: Suggest a documentation for this project
 title: ''
-labels: ''
+labels: 'documentation'
 assignees: ''
 ---
 

.github/ISSUE_TEMPLATE/feature.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: ''
-labels: ''
+labels: 'enhancement'
 assignees: ''
 ---
 

.github/ISSUE_TEMPLATE/refactoring.md

@@ -0,0 +1,70 @@
+---
+name: Code Refactoring Request
+about: Propose improvements to the codebase through refactoring.
+title: "[Refactor] "
+labels: enhancement, refactor
+assignees: ''
+---
+
+## 🎯 Reason for Refactoring
+
+<!-- Describe why this refactoring is necessary. What problem are we trying to solve? -->
+Example:  
+The current code works as expected but has issues such as maintainability challenges, tight coupling, or violations of best practices. Refactoring will ensure better quality, readability, and scalability for the future.
+
+---
+
+## 🔍 Current Code Description
+
+<!-- Explain how the code is currently implemented and identify areas for improvement. -->
+Example:  
+- The `processData()` function has multiple responsibilities.  
+- The `Module X` relies on several external classes, making reuse difficult.  
+- There is inappropriate use of global variables.
+
+---
+
+## ✅ Proposed Solution
+
+<!-- Describe how the code can be refactored to address the identified issues. -->
+Example:  
+1. Apply the Single Responsibility Principle (SRP) to split the function/module into smaller components.  
+2. Remove global variables and replace them with dependency injection.  
+3. Modularize the code to allow reuse in different contexts.
+
+---
+
+## 📈 Expected Impact
+
+<!-- List the benefits this refactoring will bring. -->
+Example:  
+- Improve code readability.  
+- Enhance test coverage and simplify the testing process.  
+- Reduce coupling and improve modularity.  
+- Make the system better prepared for future feature additions.
+
+---
+
+## 🛠️ Completion Checklist
+
+- [ ] Identify all impacted areas of the existing code.  
+- [ ] Ensure the refactoring maintains current functionality.  
+- [ ] Update or create unit and integration tests as needed.  
+- [ ] Update documentation (if applicable).  
+
+---
+
+## 📂 Related References
+
+<!-- Include links to related issues, pull requests, or discussions. -->
+- Documentation link:  
+- Related discussion link:  
+- Previous pull request link:  
+
+---
+
+## 💡 Additional Notes
+
+<!-- Include any other relevant information or suggestions for contributors working on this task. -->
+Example:  
+This refactoring should be performed alongside issue #123 to ensure compatibility with the proposed new architecture.

.github/config.yml

@@ -0,0 +1,21 @@
+# Configuration for welcome - https://github.com/behaviorbot/welcome
+
+# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
+
+# Comment to be posted to on first time issues
+newIssueWelcomeComment: >
+  Thanks for opening your first issue here! Be sure to follow the issue template!
+
+# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
+
+# Comment to be posted to on PRs from first time contributors in your repository
+newPRWelcomeComment: >
+  Thanks for opening this pull request! Please check out our contributing guidelines.
+
+# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
+
+# Comment to be posted to on pull requests merged by a first time user
+firstPRMergeComment: >
+  Congrats on merging your first pull request! We here at behaviorbot are proud of you!
+
+# It is recommended to include as many gifs and emojis as possible!

.github/workflows/cmake-multi-platform.yml

@@ -3,9 +3,21 @@ name: CMake Build and Test
 on:
   push:
     branches: [ "main" ]
+    paths:
+      - 'CMakeLists.txt'
+      - '**/*.cpp'
+      - '**/*.hpp'
+      - '**/*.h'
+      - '**/*.c'
   pull_request:
     branches: [ "main" ]
-
+    paths:
+      - 'CMakeLists.txt'
+      - '**/*.cpp'
+      - '**/*.hpp'
+      - '**/*.h'
+      - '**/*.c'
+
 permissions:
   contents: read
   actions: read

CMakeLists.txt

@@ -7,5 +7,10 @@ project(search_engine VERSION 1.0)
 
 add_subdirectory(lib)
 
-include(FetchContent)
-add_subdirectory(tests/unit-tests)
+option(BUILD_TESTS "Build and enable tests" ON)
+
+if (BUILD_TESTS)
+    enable_testing()
+    include(FetchContent)
+    add_subdirectory(tests/unit-tests)
+endif()

README.md

@@ -13,8 +13,6 @@
 
 **Search Engine** is a simple, efficient engine that builds a reverse index for keyword searching and ranks results using the **PageRank** algorithm.
 
-Aqui está o arquivo Markdown corrigido, com os emojis adicionados nos títulos para manter o padrão e com a seção "Requirements" ajustada para contribuições:
-
 ## ⚙️ Installation
 
 Please create a virtual environment using `venv`, as the project is still in alpha testing and in its initial implementations.  

build.py

@@ -25,7 +25,7 @@ def build_lib_cpp(path: str):
         old_path = os.getcwd()
         os.makedirs(path)
         os.chdir(path)
-        subprocess.run(["cmake", ".."])
+        subprocess.run(["cmake", "..", "-DBUILD_TESTS=OFF"])
         subprocess.run(["make"])
         os.chdir(old_path)
 
@@ -43,6 +43,7 @@ def build(setup_kwargs):
 
     extensions = []
 
+
     for lib in libs_names:
         ext = Extension(
             f"{lib}",

tests/unit-tests/CMakeLists.txt

@@ -19,4 +19,8 @@ add_executable(
 
 target_include_directories(LibUnitTests PRIVATE ${CMAKE_SOURCE_DIR}/lib/include/)
 
-target_link_libraries(LibUnitTests PRIVATE gtest_main search_engine)
+target_link_libraries(LibUnitTests PRIVATE gtest_main search_engine)
+
+# Add command cmake test
+include(GoogleTest)
+gtest_discover_tests(LibUnitTests)