Merge branch 'master' into unix_socket

Author: na-trium-144

.github/workflows/build_and_test.yml

@@ -24,8 +24,8 @@ jobs:
       matrix:
         os: [ ubuntu-latest,
               windows-latest,
-              ubuntu-20.04,
               macos-latest,
+              ubuntu-20.04,
               macos-11
             ]
             # ubuntu-18.04 does not work due to compile error on asio
@@ -55,21 +55,24 @@ jobs:
          if [ "$RUNNER_OS" == "Windows" ]; then
               cmake \
                 -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake  \
-                -DCROW_FEATURES="ssl;compression" \
+                -DCROW_ENABLE_SSL=ON \
+                -DCROW_ENABLE_COMPRESSION=ON \
                 -DCROW_AMALGAMATE=ON \
                 -DCROW_BUILD_TESTS=ON \
                 -B build
           elif [ "$RUNNER_OS" == "macOS" ]; then
               LDFLAGS="-L/usr/local/opt/openssl@1.1/lib" \
               CPPFLAGS="-I/usr/local/opt/openssl@1.1/include" \
               cmake \
-                -DCROW_FEATURES="ssl;compression" \
+                -DCROW_ENABLE_SSL=ON \
+                -DCROW_ENABLE_COMPRESSION=ON \
                 -DCROW_AMALGAMATE=ON \
                 -DCROW_BUILD_TESTS=ON \
                 -B build
          else
               cmake \
-                -DCROW_FEATURES="ssl;compression" \
+                -DCROW_ENABLE_SSL=ON \
+                -DCROW_ENABLE_COMPRESSION=ON \
                 -DCROW_AMALGAMATE=ON \
                 -DCROW_BUILD_TESTS=ON \
                 -B build

.github/workflows/doxygen-gh-pages.yml

@@ -33,10 +33,7 @@ jobs:
         run: |
           git config --global user.name Docs deploy
           git config --global user.email docs@dummy.bot.com
-      - name: run mike
-        run: mike deploy master
-      - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          folder: site # The folder the action should deploy.
-          target-folder: master # deploy to versioned directory
+      - name: run mike (Deploy 🚀)
+        run: |
+          git fetch origin gh-pages --depth=1
+          mike deploy master --push

CMakeLists.txt

@@ -46,9 +46,11 @@ option(CROW_BUILD_EXAMPLES     "Build the examples in the project"      ${CROW_I
 option(CROW_BUILD_TESTS        "Build the tests in the project"         ${CROW_IS_MAIN_PROJECT})
 option(CROW_AMALGAMATE         "Combine all headers into one"           OFF)
 option(CROW_INSTALL            "Add install step for Crow"              ON )
+option(CROW_USE_BOOST          "Use Boost.Asio for Crow"                OFF)
+
+option(CROW_ENABLE_SSL "Enable Crow's SSL feature for supporting https" OFF)
+option(CROW_ENABLE_COMPRESSION "Enable Crow's Compression feature for supporting compressed http content" OFF)
 
-# Possible values: ssl, compression
-option(CROW_FEATURES					 "Enable features extending Crow's abilities" "")
 
 #####################################
 # Define Targets
@@ -62,22 +64,30 @@ target_include_directories(Crow
 		$<INSTALL_INTERFACE:include>
 )
 
-find_package(asio REQUIRED)
-
-target_link_libraries(Crow
-	INTERFACE
-		asio::asio
-)
+if(CROW_USE_BOOST)
+	find_package(Boost 1.64 COMPONENTS system date_time REQUIRED)
+	target_link_libraries(Crow
+		INTERFACE
+			Boost::boost Boost::system Boost::date_time
+	)
+	target_compile_definitions(Crow INTERFACE CROW_USE_BOOST)
+else()
+    find_package(asio REQUIRED)
+	target_link_libraries(Crow
+		INTERFACE
+			asio::asio
+	)
+endif()
 
 target_compile_definitions(Crow INTERFACE "")
 
-if("compression" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_COMPRESSION)
 	find_package(ZLIB REQUIRED)
 	target_link_libraries(Crow INTERFACE ZLIB::ZLIB)
 	target_compile_definitions(Crow INTERFACE CROW_ENABLE_COMPRESSION)
 endif()
 
-if("ssl" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_SSL)
 	find_package(OpenSSL REQUIRED)
 	target_link_libraries(Crow INTERFACE OpenSSL::SSL)
 	target_compile_definitions(Crow INTERFACE CROW_ENABLE_SSL)
@@ -110,11 +120,11 @@ if(CROW_BUILD_TESTS)
     COMMAND ${CMAKE_CURRENT_BINARY_DIR}/tests/unittest
   )
 
-  if(NOT "compression" IN_LIST CROW_FEATURES)
-    message(STATUS "Compression tests are omitted. (Configure with CROW_FEATURES containing 'compression' to enable them)")
+  if(NOT CROW_ENABLE_COMPRESSION)
+    message(STATUS "Compression tests are omitted. (Configure with CROW_ENABLE_COMPRESSION to enable them)")
   endif()
-  if(NOT "ssl" IN_LIST CROW_FEATURES)
-    message(STATUS "SSL tests are omitted. (Configure with CROW_FEATURES containing 'ssl' to enable them)")
+  if(NOT CROW_ENABLE_SSL)
+    message(STATUS "SSL tests are omitted. (Configure with CROW_ENABLE_SSL to enable them)")
   else()
     if(NOT MSVC)
       add_test(

Doxyfile

@@ -772,7 +772,7 @@ SHOW_FILES             = YES
 # Folder Tree View (if specified).
 # The default value is: YES.
 
-SHOW_NAMESPACES        = NO
+SHOW_NAMESPACES        = YES
 
 # The FILE_VERSION_FILTER tag can be used to specify a program or script that
 # doxygen should invoke to get the current version for each file (typically from

cmake/CrowConfig.cmake.in

@@ -14,11 +14,11 @@ if(NOT DEFINED CROW_FEATURES)
   set(CROW_FEATURES ${CROW_INSTALLED_FEATURES})
 endif()
 
-if("compression" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_COMPRESSION)
   find_dependency(ZLIB)
 endif()
 
-if("ssl" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_SSL)
   find_dependency(OpenSSL)
 endif()
 
@@ -38,12 +38,12 @@ endif()
 list(REMOVE_ITEM _CROW_ILL "ZLIB::ZLIB" "OpenSSL::SSL")
 list(REMOVE_ITEM _CROW_ICD "CROW_ENABLE_SSL" "CROW_ENABLE_COMPRESSION")
 
-if("compression" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_COMPRESSION)
   list(APPEND _CROW_ILL "ZLIB::ZLIB")
   list(APPEND _CROW_ICD "CROW_ENABLE_COMPRESSION")
 endif()
 
-if("ssl" IN_LIST CROW_FEATURES)
+if(CROW_ENABLE_SSL)
   list(APPEND _CROW_ILL "OpenSSL::SSL")
   list(APPEND _CROW_ICD "CROW_ENABLE_SSL")
 endif()

docs/getting_started/a_simple_webpage.md

@@ -1,7 +1,7 @@
 Hello World is a good start, but what if you want something a bit more fancy.. Something like an HTML document saying "Hello World". If that's what you want, follow along:
 
 ## Basic Webpage
-Let's start our webpage with.. well.. a webpage. But before we create a webpage we need to place it somewhere Crow recognizes, for now this directory is going to be called `templates`, but we can [change it later](../../guides/templating/#page).
+Let's start our webpage with.. well.. a webpage. But before we create a webpage we need to place it somewhere Crow recognizes, for now this directory is going to be called `templates`, but we can [change it later](../guides/templating.md#page).
 
 Once our `templates` folder is created, we can create our HTML document inside it, let's call it `fancypage.html`.
 
@@ -80,13 +80,17 @@ Once the code is done compiling, if we call `http://localhost:18080/` we get our
 
 !!! note
 
-    Compilation instructions are available for [Linux](../setup/linux#compiling-your-project), [MacOS](../setup/macos#compiling-using-a-compiler-directly), and [Windows](../setup/windows#getting-and-compiling-crow)
+    Compilation instructions are available for 
+	[Linux](setup/linux.md#compiling-your-project), 
+	[MacOS](setup/macos.md#compiling-using-a-compiler-directly), 
+	and 
+	[Windows](setup/windows.md#getting-and-compiling-crow)
 
 
 ## Template Webpage with a variable
 But we can make things even more exciting, we can greet a user by their name instead!!
 
-Let's start with our webpage, and modify it with a little bit of [mustache](../../guides/templating) syntax:
+Let's start with our webpage, and modify it with a little bit of [mustache](../guides/templating.md) syntax:
 ``` html title="templates/fancypage.html" hl_lines="4"
 <!DOCTYPE html>
 <html>
@@ -121,9 +125,9 @@ int main()
 
 1. We are adding a `string` variable to the URL and a counterpart (`std::string name`) to our route - this can be anything the user wants.
 2. We are using `load()` instead of `load_text()` since we have an actual variable now.
-3. We are creating a new [context](../../guides/templating/#context) containing the `person` variable from our template and the `name` we got from the URL.
+3. We are creating a new [context](../guides/templating.md#context) containing the `person` variable from our template and the `name` we got from the URL.
 4. We are using `render(ctx)` to apply our context to the template.
 
 Now (after compiling the code and running the executable a second time) calling `http://localhost:18080/Bob` should return a webpage containing "Hello Bob!". **We did it!**
 
-For more details on templates and HTML pages in Crow please go [here](../../guides/templating/)
+For more details on templates and HTML pages in Crow please go [here](../guides/templating.md)

docs/getting_started/setup/linux.md

@@ -45,7 +45,9 @@ You can also download the `crow_all.h` file and simply include that into your pr
 
 !!! note
 
-    While building you can set the `CROW_FEATURES` variable (as a `;` separated list). You can use an argument such as `-DCROW_FEATURES="ssl;compression"`.
+    While building you can set:
+	  the `CROW_ENABLE_SSL` variable to enable the support for https
+	  the `CROW_ENABLE_COMPRESSION` variable to enable the support for http compression
 
 !!! note
 
@@ -83,7 +85,10 @@ target_link_libraries(your_project PUBLIC Crow::Crow)
 From there CMake should handle compiling and linking your project.
 !!! note
 
-    For optional features like HTTP Compression or HTTPS you can set the `CROW_FEATURES` variable using lines such as `set(CROW_FEATURES "ssl;compression")`, `set(CROW_FEATURES ssl compression)`, or `set(CROW_FEATURES ssl)`.
+    For optional features like HTTP Compression or HTTPS you can set
+	
+	  the `CROW_ENABLE_SSL` variable to enable the support for https
+	  the `CROW_ENABLE_COMPRESSION` variable to enable the support for http compression
 
 ### Directly using a compiler
 All you need to do is run the following command:

docs/getting_started/setup/macos.md

@@ -61,7 +61,10 @@ This will generate a `crow_all.h` file which you can use in the following steps
     4. `make -j12`
 !!! note
 
-        You can add options like `-DCROW_FEATURES="ssl;compression"` or `-DCROW_AMALGAMATE` to `cmake ..` to build optional tests/examples for HTTP Compression or HTTPS.
+        You can add options like `-DCROW_ENABLE_COMPRESSION=ON` 
+		or `-DCROW_ENABLE_SSL=ON` 
+		or `-DCROW_AMALGAMATE` 
+		to `cmake ..` to build optional tests/examples for HTTP Compression or HTTPS.
 
 ## Compiling using a compiler directly
 All you need to do is run the following command:

docs/getting_started/your_first_application.md

@@ -16,7 +16,7 @@ int main()
 }
 ```
 The App (or SimpleApp) class organizes all the different parts of Crow and provides the developer (you) a simple interface to interact with these parts.
-For more information, please go [here](../../guides/app).
+For more information, please go [here](../guides/app.md).
 
 ## 3. Adding routes
 Once you have your app, the next step is to add routes (or endpoints). You can do so with the `CROW_ROUTE` macro.
@@ -25,7 +25,7 @@ CROW_ROUTE(app, "/")([](){
     return "Hello world";
 });
 ```
-For more details on routes, please go [here](../../guides/routes).
+For more details on routes, please go [here](../guides/routes.md).
 
 ## 4. Running the app
 Once you're happy with how you defined all your routes, you're going to want to instruct Crow to run your app. This is done using the `run()` method.
@@ -56,6 +56,9 @@ int main()
 }
 ```
 
-You then need to compile your code on your [Linux](../setup/linux#compiling-your-project), [MacOS](../setup/macos#compiling-using-a-compiler-directly), or [Windows](../setup/windows#getting-and-compiling-crow) machine
+You then need to compile your code on your 
+[Linux](setup/linux.md#compiling-your-project), 
+[MacOS](setup/macos.md#compiling-using-a-compiler-directly), or 
+[Windows](setup/windows.md#getting-and-compiling-crow) machine
 
 After building your `.cpp` file and running the resulting executable, you should be able to access your endpoint at [http://localhost:18080](http://localhost:18080). Opening this URL in your browser will show a white screen with "Hello world" typed on it.

docs/guides/app.md

@@ -34,5 +34,5 @@ app.bindaddr("192.168.1.2")
 
 <br><br>
 
-For more info on middlewares, check out [this page](../middleware).<br><br>
+For more info on middlewares, check out [this page](middleware.md).<br><br>
 For more info on what functions are available to a Crow app, go [here](../reference/classcrow_1_1_crow.html).