V2 - Support objects and new query functionality

.gitignore

@@ -3,6 +3,7 @@
 !src/
 !src/**/
 !tests/
+!tests/**/
 !.vscode/
 
 !.gitignore
@@ -14,10 +15,21 @@
 !*.h
 !README.md
 !CMakeLists.txt
+!*.cmake
 
 !vendor/
+!vendor/*
 !vendor/**/
 !LICENSE*
 
 !queries/
-!queries/*.sql
+!queries/*.sql
+
+!*.plantuml
+!docs/
+!docs/**/
+!docs/**/*.svg
+
+!examples/
+!examples/**/
+!examples/**/*.sql

.gitmodules

@@ -0,0 +1,15 @@
+[submodule "vendor/json"]
+        path = vendor/json
+        url = https://github.com/nlohmann/json
+[submodule "vendor/lrucache11"]
+	path = vendor/lrucache11
+	url = https://github.com/enzo418/lrucache11
+[submodule "vendor/spdlog"]
+	path = vendor/spdlog
+	url = https://github.com/gabime/spdlog
+[submodule "vendor/googletest"]
+	path = vendor/googletest
+	url = https://github.com/google/googletest
+[submodule "vendor/magic_enum"]
+	path = vendor/magic_enum
+	url = https://github.com/Neargye/magic_enum

.vscode/launch.json

@@ -8,10 +8,10 @@
             "type": "lldb",
             "request": "launch",
             "name": "Debug",
-            "program": "${workspaceFolder}/build/noLiteDb",
+            "program": "${workspaceFolder}/build/twitter",
             "args": [],
             "preLaunchTask": "build",
-            "cwd": "${workspaceFolder}"
+            "cwd": "${workspaceFolder}/build"
         },
         {
             "type": "lldb",
@@ -20,7 +20,7 @@
             "program": "${workspaceFolder}/build/tests",
             "args": [],
             "preLaunchTask": "build",
-            "cwd": "${workspaceFolder}"
+            "cwd": "${workspaceFolder}/build"
         }
     ]
 }

.vscode/tasks.json

@@ -9,7 +9,7 @@
             "options": {
                 "cwd": "${workspaceFolder}/build"
             },
-            "command": "make -j4"
+            "command": "make -j"
         }
     ]
 }

CMakeLists.txt

@@ -2,53 +2,115 @@ cmake_minimum_required(VERSION 3.22)
 
 project(noLiteDb)
 
-file(GLOB_RECURSE SOURCES src/*.cpp)
+option(BUILD_EXAMPLES "Build examples" OFF)
+
+# -------------------- CONFIGURATION ------------------- #
+
+# A string used to differentiate between a user id and a document id.
+set(NLDB_INTERNAL_ID "_id")
 
-# REMOVE MAIN so we can don't need to compile the code again for the tests
-list(REMOVE_ITEM SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp)
+option(NLDB_SHOW_ID_WARNING "Prints a warning if the requested is not the internal identifier." ON)
 
+# ------------------ CONFIGURATION DEV ----------------- #
+option(NLDB_DEBUG_CACHE_BUFFER "Shows cache hit/miss and buffer warnings" OFF)
 
-# Set cmake cxx flags
-SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++20")
+option(NLDB_DEBUG_QUERY "Displays executed queries and human-readable aliases" OFF)
 
-# clangd:
+option(NLDB_PROFILE "Profile query execution time." OFF)
+
+option(NLDB_SANITIZE_EXAMPLES "Use the compiler sanitizer in the examples." OFF)
+
+# ----------------------- SOURCES ---------------------- #
+file(GLOB_RECURSE SOURCES src/*.cpp)
+
+# Set std version 
+# Note: I do it this way because otherwise export compile commands doesn't export it
+SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -std=c++20")
+
+# clangd
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-include_directories(src/include)
-include_directories(vendor/sqlite)
-include_directories(vendor/logger/include)
-include_directories(vendor/lrucache11)
-include_directories(vendor/others)
+if(NOT CMAKE_BUILD_TYPE )
+  # Compilation type
+  set(CMAKE_BUILD_TYPE DEBUG)
+endif()
 
-# --- YAMLCPP
-# i thought to use yaml-cpp but doesn't have an easy way to get the data type
-# and that was crucial for this library
+include(Dependecy.cmake)
 
-# --- json (nlohmann)
-set(JSON_BuildTests OFF CACHE INTERNAL "")
-set(JSON_Install OFF CACHE INTERNAL "")
-add_subdirectory(vendor/json)
+message(STATUS "NLDB dependencies: ${DEPENDENCY_LIST}")
+message(STATUS "NLDB dependency libs: ${DEPENDENCY_LIBS}")
+message(STATUS "NLDB dependency lib includes: ${DEPENDENCY_INCLUDE_DIR}")
 
-# --- SQLITE library
-add_library(c_sqllite3 vendor/sqlite/sqlite/sqlite3.c)
+include_directories(src/include)
+include_directories(src)
 
-# --- Add nolitedb library
+# --------------------- NOLITE --------------------- #
 add_library(noLitedb_lb ${SOURCES})
-target_link_libraries(noLitedb_lb c_sqllite3 nlohmann_json::nlohmann_json)
 
-set(CMAKE_BUILD_TYPE DEBUG)
+add_dependencies(noLitedb_lb ${DEPENDENCY_LIST})
+target_include_directories(noLitedb_lb PUBLIC ${DEPENDENCY_INCLUDE_DIR} ${DEPENDENCY_INCLUDE_LIST})
 
-# --- Add nolitedb executable
-add_executable(noLiteDb src/main.cpp)
-target_link_libraries(noLiteDb noLitedb_lb)
+target_compile_options(noLitedb_lb PRIVATE -Wall -Wextra -Wpedantic -Werror)
+
+# optional flags, e.g. -DNLDB_LIB_OPTIONAL_FLAGS:STRING="-w"
+target_compile_options(noLitedb_lb PRIVATE "${NLDB_LIB_OPTIONAL_FLAGS}")
+
+# in c++20 the expression Property == Property warns about something we don't care.
+add_compile_options(-Wno-ambiguous-reversed-operator)
+
+# boolean definitions
+foreach(_VAR IN ITEMS
+    NLDB_DEBUG_QUERY
+    NLDB_DEBUG_CACHE_BUFFER
+    NLDB_SHOW_ID_WARNING
+    NLDB_PROFILE
+)
+    if(${_VAR})
+        target_compile_definitions(noLitedb_lb PUBLIC "${_VAR}")
+    endif()
+endforeach()
+
+# valued definitions
+target_compile_definitions(noLitedb_lb 
+    PUBLIC 
+    "NLDB_INTERNAL_ID=\"${NLDB_INTERNAL_ID}\"" 
+)
+
+target_link_libraries(noLitedb_lb PUBLIC ${DEPENDENCY_LIBS})
+target_link_directories(noLitedb_lb PUBLIC ${DEPENDENCY_LIB_DIR})
+
+# ------------------ NOLITE EXECUTABLE ----------------- #
+if (NLDB_SANITIZE_EXAMPLES)
+  set(NLDB_SANITIZER_ARGS -fsanitize=address -fno-omit-frame-pointer)
+  message(STATUS "Using sanitizer options: ${NLDB_SANITIZER_ARGS}")
+endif()
+
+if(BUILD_EXAMPLES OR PROJECT_IS_TOP_LEVEL)
+    file(GLOB nldb_example_files 
+        "examples/*.cpp")
+
+    foreach(filename ${nldb_example_files})
+        STRING(REGEX REPLACE
+        "([/\\][A-Za-z0-9_]+)+[/\\]([A-Za-z0-9_]+)\.c(pp)?"
+        "\\2" nldb_exec_name ${filename}) # get exec output name
+
+        add_executable(${nldb_exec_name} ${filename})
+        target_link_libraries(${nldb_exec_name} noLitedb_lb "-lz")
+
+        if(NLDB_SANITIZE_EXAMPLES)
+          target_compile_options(${nldb_exec_name} PRIVATE ${NLDB_SANITIZER_ARGS})
+          target_link_options(${nldb_exec_name} PRIVATE ${NLDB_SANITIZER_ARGS})
+        endif()
+    endforeach()
+endif()
 
-# --- TESTS
+# ------------------------ TESTS ----------------------- #
 add_subdirectory(vendor/googletest)
 include_directories(vendor/googletest/googletest/include)
 
 enable_testing()
 
-file(GLOB TESTS_SRC tests/*.cpp)
+file(GLOB_RECURSE TESTS_SRC tests/*.cpp)
 
 add_executable(
   tests
@@ -62,9 +124,9 @@ target_link_libraries(
 )
 
 if (CMAKE_BUILD_TYPE MATCHES "DEBUG")
-  add_definitions( -D LOGGER_MAX_LOG_LEVEL_PRINTED=6 ) # trace
+  add_definitions( -DLOGGER_MAX_LOG_LEVEL_PRINTED=6 ) # trace
 else ()
-  add_definitions( -D LOGGER_MAX_LOG_LEVEL_PRINTED=1 ) # error
+  add_definitions( -DLOGGER_MAX_LOG_LEVEL_PRINTED=1 ) # error
 endif()
 
 include(GoogleTest)

Dependecy.cmake

@@ -0,0 +1,64 @@
+include(ExternalProject)
+
+set(DEPENDENCY_INSTALL_DIR ${PROJECT_BINARY_DIR}/install)
+set(DEPENDENCY_INCLUDE_DIR ${DEPENDENCY_INSTALL_DIR}/include)
+set(DEPENDENCY_LIB_DIR ${DEPENDENCY_INSTALL_DIR}/lib)
+
+function(add_dep dep)
+    set(DEPENDENCY_LIST ${DEPENDENCY_LIST} ${dep} PARENT_SCOPE)
+endfunction()
+
+function(add_include include_dir)
+    set(DEPENDENCY_INCLUDE_LIST ${DEPENDENCY_INCLUDE_LIST} ${include_dir} PARENT_SCOPE)
+endfunction()
+
+function(add_lib lib)
+    set(DEPENDENCY_LIBS ${DEPENDENCY_LIBS} ${lib} PARENT_SCOPE)
+endfunction(add_lib)
+
+# ----------------------- SPDLOG ----------------------- #
+ExternalProject_Add(
+    dep-spdlog
+    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/vendor/spdlog
+    UPDATE_COMMAND ""
+    PATCH_COMMAND ""
+    CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${DEPENDENCY_INSTALL_DIR}
+    TEST_COMMAND ""
+)
+
+add_dep(dep-spdlog)
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/spdlog/include)
+add_lib(spdlog)
+
+# ----------------------- SQLITE3 ---------------------- #
+add_library(xsqllite3 ${CMAKE_CURRENT_SOURCE_DIR}/vendor/sqlite/sqlite/sqlite3.c)
+
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/sqlite)
+add_lib(xsqllite3)
+
+# -------------------- NLOHMANN JSON ------------------- #
+ExternalProject_Add(
+    dep-json
+    SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/vendor/json
+    UPDATE_COMMAND ""
+    PATCH_COMMAND ""
+    CMAKE_ARGS
+        -DCMAKE_INSTALL_PREFIX=${DEPENDENCY_INSTALL_DIR}
+        -DNLOHMANN_JSON_INCLUDE_INSTALL_DIR=${DEPENDENCY_INSTALL_DIR}
+        -DJSON_Install=ON
+        -DJSON_BuildTests=OFF
+    TEST_COMMAND ""
+)
+
+add_dep(dep-json)
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/json/include)
+# add_lib(nlohmann_json) # dependecy adds the .Targets file and handles the link_library
+
+# --------------------- MAGIC ENUM --------------------- #
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/magic_enum/include)
+
+# ---------------------- LRU CACHE --------------------- #
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/lrucache11/include)
+
+# ----------------------- OTHERS ----------------------- #
+add_include(${CMAKE_CURRENT_SOURCE_DIR}/vendor/others)