Merge pull request #228 from CrowCpp/revamped_setup

Revamped setup

Author: The-EDev

.drone.yml

@@ -17,14 +17,19 @@ steps:
   - export DEBIAN_FRONTEND=noninteractive
   - export TRAVIS_BRANCH=$DRONE_BRANCH
   - export TRAVIS_JOB_ID=$DRONE_BUILD_NUMBER
+  - export COVERALLS_PULL_REQUEST=$DRONE_PULL_REQUEST
   - apt-get -y update
-  - apt-get -y install libboost-all-dev doxygen mkdocs graphviz zlib1g-dev gcc clang make cmake python3 python3-pip git
-  - pip3 install mkdocs-material cpp-coveralls pyyaml
+  - apt-get -y install libboost-all-dev doxygen mkdocs graphviz zlib1g-dev gcc clang make cmake python3 python3-pip git openssl libssl-dev
+  - pip3 install mkdocs-material pyyaml --no-input
+  - git clone https://github.com/CrowCpp/cpp-coveralls.git
+  - cd cpp-coveralls
+  - pip3 install . --no-input
+  - cd ..
   - export CC=/usr/bin/gcc
   - export CXX=/usr/bin/g++
   - mkdir build
   - cd build
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
   - cd ..
@@ -33,7 +38,7 @@ steps:
   - export CXX=/usr/bin/clang++
   - mkdir build-clang
   - cd build-clang
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
 
@@ -58,19 +63,19 @@ steps:
   commands:
   - export DEBIAN_FRONTEND=noninteractive
   - apt-get -y update
-  - apt-get -y install libboost-all-dev zlib1g-dev gcc clang make cmake python3
+  - apt-get -y install libboost-all-dev zlib1g-dev gcc clang make cmake python3 openssl libssl-dev
   - mkdir build
   - cd build
   - cmake --version
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
   - cd ..
   - export CC=/usr/bin/clang
   - export CXX=/usr/bin/clang++
   - mkdir build-clang
   - cd build-clang
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
 
@@ -108,13 +113,17 @@ steps:
   - export TRAVIS_BRANCH=$DRONE_REPO_BRANCH
   - export TRAVIS_JOB_ID=$DRONE_BUILD_NUMBER
   - apt-get -y update
-  - apt-get -y install libboost-all-dev doxygen mkdocs graphviz zlib1g-dev gcc clang make cmake python3 python3-pip git
-  - pip3 install mkdocs-material cpp-coveralls pyyaml
+  - apt-get -y install libboost-all-dev doxygen mkdocs graphviz zlib1g-dev gcc clang make cmake python3 python3-pip git openssl libssl-dev
+  - pip3 install mkdocs-material pyyaml --no-input
+  - git clone https://github.com/CrowCpp/cpp-coveralls.git
+  - cd cpp-coveralls
+  - pip3 install . --no-input
+  - cd ..
   - export CC=/usr/bin/gcc
   - export CXX=/usr/bin/g++
   - mkdir build
   - cd build
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
   - cd ..
@@ -123,7 +132,7 @@ steps:
   - export CXX=/usr/bin/clang++
   - mkdir build-clang
   - cd build-clang
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
   - cd ..
@@ -151,19 +160,19 @@ steps:
   commands:
   - export DEBIAN_FRONTEND=noninteractive
   - apt-get -y update
-  - apt-get -y install libboost-all-dev zlib1g-dev gcc clang make cmake python3
+  - apt-get -y install libboost-all-dev zlib1g-dev gcc clang make cmake python3 openssl libssl-dev
   - mkdir build
   - cd build
   - cmake --version
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
   - cd ..
   - export CC=/usr/bin/clang
   - export CXX=/usr/bin/clang++
   - mkdir build-clang
   - cd build-clang
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
   - make -j4
   - ctest -V -j4
 

.travis.yml

@@ -33,6 +33,7 @@ addons:
       - mkdocs
       - graphviz
       - zlib1g-dev
+      - libssl-dev
 
 before_install:
   - if [ "$TRAVIS_COMPILER" == "gcc" -a "$TRAVIS_CPU_ARCH" == "amd64" ]; then export PUSH_COVERAGE=ON; fi
@@ -45,12 +46,12 @@ before_script:
   - mkdir build
   - cd build
   - cmake --version
-  - cmake ..
+  - cmake .. -DCROW_ENABLE_COMPRESSION=ON -DCROW_ENABLE_SSL=ON -DCROW_AMALGAMATE=ON
 
 script: make -j4 && ctest -V -j4
 
 after_success:
   - cd ..
-  - if [ "$PUSH_COVERAGE" == "ON" ]; then coveralls -i include --exclude-pattern .*/http_parser_merged.h --exclude-pattern .*/TinySHA1.hpp --gcov-options '\-lp'; fi
+  - if [ "$PUSH_COVERAGE" == "ON" ]; then coveralls -i include --exclude-pattern .*/http_parser_merged.h --exclude-pattern .*/TinySHA1.hpp  --gcov-options '\-lp'; fi
   - chmod +x scripts/generateDocumentationAndDeploy.sh
   - if [ "$TRAVIS_BUILD_DOCS" == "ON" ]; then ./scripts/generateDocumentationAndDeploy.sh; fi

CMakeLists.txt

@@ -3,68 +3,104 @@
 #####################################
 cmake_minimum_required(VERSION 3.15.0 FATAL_ERROR)
 
-# Define the Project Name and Description
-project (crow_all LANGUAGES CXX)
+# Define the project name and language
+project(Crow
+	LANGUAGES CXX
+)
 
-# Define the module path
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/")
+# Check if Crow is the main project
+set(CROW_IS_MAIN_PROJECT OFF)
+if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+  set(CROW_IS_MAIN_PROJECT ON)
+endif()
 
-# Set required C++ Standard
+# Set required C++ standard
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 
-if (NOT CMAKE_BUILD_TYPE)
-	message(STATUS "No build type selected, default to Release")
-	set(CMAKE_BUILD_TYPE "Release")
+# Default to build type "Release" unless tests are being built
+if(NOT CMAKE_BUILD_TYPE)
+	if (NOT CROW_BUILD_TESTS)
+		message(STATUS "No build type selected, default to Release")
+		set(CMAKE_BUILD_TYPE "Release")
+	else()
+		message(STATUS "No build type selected but tests are being built, default to Debug")
+		set(CMAKE_BUILD_TYPE "Debug")
+	endif()
 endif()
 
 #####################################
 # Define Options
 #####################################
-option(BUILD_EXAMPLES "Builds the examples in the project" ON)
-option(BUILD_TESTING  "Builds the tests in the project"    ON)
+option(CROW_BUILD_EXAMPLES     "Build the examples in the project"      ${CROW_IS_MAIN_PROJECT})
+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 )
 
-#####################################
-# Define CMake Module Imports
-#####################################
-include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/dependencies.cmake)
-include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/compiler_options.cmake)
+option(CROW_ENABLE_SSL         "Enable SSL capabilities (OpenSSL)"      OFF)
+option(CROW_ENABLE_COMPRESSION "Enable compression capabilities (ZLIB)" OFF)
 
 #####################################
-# Define project-wide imports
+# Define Targets
 #####################################
-# this can be alternatively (and as recommended way) done with target_include_directories()
-if(BUILD_EXAMPLES OR BUILD_TESTING)
-	set(PROJECT_INCLUDE_DIR
-		${CMAKE_CURRENT_SOURCE_DIR}/include
-	)
+add_library(Crow INTERFACE)
+add_library(Crow::Crow ALIAS Crow)
 
-	include_directories("${PROJECT_INCLUDE_DIR}")
-	include_directories("${CMAKE_CURRENT_SOURCE_DIR}")
-	include_directories("${CMAKE_CURRENT_BINARY_DIR}")  # To include crow_all.h
-endif()
+target_include_directories(Crow
+	INTERFACE
+		$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+		$<INSTALL_INTERFACE:include>
+)
 
-#####################################
-# Define Targets
-#####################################
-add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/crow_all.h
-	COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/scripts/merge_all.py
-	${CMAKE_CURRENT_SOURCE_DIR}/include
-	${CMAKE_CURRENT_BINARY_DIR}/crow_all.h
-	WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-	DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h ${CMAKE_CURRENT_SOURCE_DIR}/include/crow/*.h ${CMAKE_CURRENT_SOURCE_DIR}/include/crow/middlewares/*.h
+find_package(Boost 1.64 COMPONENTS system date_time REQUIRED)
+find_package(Threads REQUIRED)
+
+target_link_libraries(Crow
+	INTERFACE
+		Boost::boost Boost::system Boost::date_time
+		Threads::Threads
 )
 
-# Amalgamation
-add_custom_target(amalgamation ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/crow_all.h)
+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(CROW_ENABLE_SSL)
+	find_package(OpenSSL REQUIRED)
+	target_link_libraries(Crow INTERFACE OpenSSL::SSL)
+	target_compile_definitions(Crow INTERFACE CROW_ENABLE_SSL)
+endif()
+
+if(CROW_AMALGAMATE)
+	add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/crow_all.h
+		COMMAND python3 ${CMAKE_CURRENT_SOURCE_DIR}/scripts/merge_all.py
+		${CMAKE_CURRENT_SOURCE_DIR}/include
+		${CMAKE_CURRENT_BINARY_DIR}/crow_all.h
+		WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+		DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h ${CMAKE_CURRENT_SOURCE_DIR}/include/crow/*.h ${CMAKE_CURRENT_SOURCE_DIR}/include/crow/middlewares/*.h
+	)
+
+	add_custom_target(crow_amalgamated ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/crow_all.h)
+endif()
 
 # Examples
-if(BUILD_EXAMPLES)
+if(CROW_BUILD_EXAMPLES)
 	add_subdirectory(examples)
 endif()
 
 # Tests
-if (NOT MSVC AND BUILD_TESTING)
+if(NOT MSVC AND CROW_BUILD_TESTS)
+	if(NOT CROW_ENABLE_COMPRESSION)
+		message(STATUS "Compression tests are omitted. (Configure with CROW_ENABLE_COMPRESSION=ON to enable them)")
+	endif()
+	if(NOT CROW_ENABLE_SSL)
+		message(STATUS "SSL tests are omitted. (Configure with CROW_ENABLE_SSL=ON to enable them)")
+	else()
+		add_test(NAME ssl_test COMMAND ${CMAKE_CURRENT_BINARY_DIR}/tests/ssl/ssltest)
+	endif()
+
 	add_subdirectory(tests)
 	enable_testing()
 	add_test(NAME crow_test COMMAND ${CMAKE_CURRENT_BINARY_DIR}/tests/unittest)
@@ -74,10 +110,35 @@ endif()
 #####################################
 # Install Files
 #####################################
-install(FILES ${CMAKE_CURRENT_BINARY_DIR}/crow_all.h DESTINATION include)
+if(CROW_INSTALL)
+	install(TARGETS Crow EXPORT CrowTargets)
+	install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/ DESTINATION include)
+
+	install(EXPORT CrowTargets
+		FILE CrowTargets.cmake
+		NAMESPACE Crow::
+		DESTINATION lib/cmake/Crow
+	)
+
+	include(CMakePackageConfigHelpers)
+	configure_package_config_file(
+		"${CMAKE_CURRENT_SOURCE_DIR}/cmake/CrowConfig.cmake.in"
+		"${CMAKE_CURRENT_BINARY_DIR}/CrowConfig.cmake"
+		INSTALL_DESTINATION lib/cmake/Crow
+	)
+	install(FILES
+    "${CMAKE_CURRENT_BINARY_DIR}/CrowConfig.cmake"
+    DESTINATION lib/cmake/Crow
+  )
+endif()
 
 set(CPACK_GENERATOR "DEB")
+set(CPACK_PACKAGE_NAME "Crow")
 set(CPACK_DEBIAN_PACKAGE_MAINTAINER "CrowCpp")
+set(CPACK_PACKAGE_VENDOR "CrowCpp")
+set(CPACK_PACKAGE_DESCRIPTION "A Fast and Easy to use C++ microframework for the web.")
+set(CPACK_PACKAGE_HOMEPAGE_URL "https://crowcpp.org")
+set(CPACK_DEBIAN_PACKAGE_DEBUG OFF)
 set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS ON)
 
 include(CPack)

LICENSE

@@ -1,3 +1,5 @@
+BSD 3-Clause License
+
 Copyright (c) 2014-2017, ipkn
               2020-2021, CrowCpp
 All rights reserved.
@@ -27,4 +29,4 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-The Crow logo and other graphic material (excluding third party logos) used are under Copyright (c) 2021, Farook Al-Sammarraie (The-EDev), All rights reserved.
+The Crow logo and other graphic material (excluding third party logos) used are under exclusive Copyright (c) 2021, Farook Al-Sammarraie (The-EDev), All rights reserved.

README.md

@@ -5,7 +5,7 @@
 <a href="https://cloud.drone.io/CrowCpp/Crow"><img src="https://cloud.drone.io/api/badges/CrowCpp/Crow/status.svg" alt="Build Status"></a>
 <a href="https://coveralls.io/github/CrowCpp/Crow?branch=master"><img src="https://coveralls.io/repos/github/CrowCpp/Crow/badge.svg?branch=master" alt="Coverage Status"></a>
 <a href="https://crowcpp.org"><img src="https://img.shields.io/badge/-Documentation-informational" alt="Documentation"></a>
-<a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/crowfork/community.svg" alt="Gitter"></a>
+<a href="https://gitter.im/crowfork/community?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://img.shields.io/gitter/room/crowfork/community?color=8DDEC5&logo=gitter" alt="Gitter"></a>
 <a href="https://opencollective.com/crow"><img alt="Open Collective" src="https://img.shields.io/opencollective/all/crow?label=Support%20Crow&logo=opencollective"></a>
 </p>
 

cmake/CrowConfig.cmake.in

@@ -0,0 +1,37 @@
+@PACKAGE_INIT@
+
+include(CMakeFindDependencyMacro)
+find_dependency(Boost 1.64 COMPONENTS system date_time)
+find_dependency(Threads)
+
+if(CROW_ENABLE_COMPRESSION)
+  find_dependency(ZLIB)
+endif()
+
+if(CROW_ENABLE_SSL)
+  find_dependency(OpenSSL)
+endif()
+
+include("${CMAKE_CURRENT_LIST_DIR}/CrowTargets.cmake")
+check_required_components("@PROJECT_NAME@")
+
+get_target_property(_CROW_ILL Crow::Crow INTERFACE_LINK_LIBRARIES)
+get_target_property(_CROW_ICD Crow::Crow INTERFACE_COMPILE_DEFINITIONS)
+
+list(REMOVE_ITEM _CROW_ILL "ZLIB::ZLIB" "OpenSSL::SSL")
+list(REMOVE_ITEM _CROW_ICD "CROW_ENABLE_SSL" "CROW_ENABLE_COMPRESSION")
+
+if(CROW_ENABLE_COMPRESSION)
+  list(APPEND _CROW_ILL "ZLIB::ZLIB")
+  list(APPEND _CROW_ICD "CROW_ENABLE_COMPRESSION")
+endif()
+
+if(CROW_ENABLE_SSL)
+  list(APPEND _CROW_ILL "OpenSSL::SSL")
+  list(APPEND _CROW_ICD "CROW_ENABLE_SSL")
+endif()
+
+set_target_properties(Crow::Crow PROPERTIES
+  INTERFACE_COMPILE_DEFINITIONS "${_CROW_ICD}"
+  INTERFACE_LINK_LIBRARIES "${_CROW_ILL}"
+)