Merge branch 'cpp-redis:master' into master

Author: kwach

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "gitsubmodule" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "cpp-redis/dev"

.github/workflows/format.yml

@@ -0,0 +1,10 @@
+name: Clang Format Checker
+on: [push, pull_request]
+jobs:
+  clang-format-checking:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: RafikFarhad/clang-format-github-action@v2.1.0
+        with:
+          sources: "src/**/*.h,src/**/*.c,test/**/*.c"

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "tacopie"]
-	path = tacopie
-	url = https://github.com/Cylix/tacopie.git
+    path = tacopie
+    url = https://github.com/cpp-redis/tacopie.git
+[submodule "googletest"]
+	path = googletest
+	url = https://github.com/google/googletest.git

.travis.yml

@@ -23,14 +23,28 @@ addons:
       - clang
 
 before_install:
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install llvm; fi
+  - source scripts/prepare.sh
 
 install:
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install ccache; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/ccache/libexec:$PATH"; fi
-  - if [[ "$TRAVIS_OS_NAME" != "osx" && "$CXX" = "g++" ]]; then export CXX="g++-4.8" CC="gcc-4.8"; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install redis; fi
-  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then (redis-server&); fi
-
-script: mkdir build && cd build && cmake .. -DBUILD_TESTS=true -DBUILD_EXAMPLES=true && make && GTEST_COLOR=1 ctest -VV
+  - source scripts/install-osx-dependencies.sh
+  - source scripts/install-cmake.sh
+before_script:
+  - source scripts/start-redis.sh
+  # create a build folder for the out-of-source build
+  - mkdir build
+  # switch to build directory
+  - cd build
+  # run cmake; here we assume that the project's
+  # top-level CMakeLists.txt is located at '..'
+  - ls ${CMAKE_INSTALL_DIR}
+  - ls ${CMAKE_INSTALL_DIR}/bin
+  - env
+  - which cmake
+  - cmake --version
+  - cmake .. -DBUILD_TESTS=true -DBUILD_EXAMPLES=true
+
+script:
+  # once CMake has done its job we just build using make as usual
+  - make
+  # if the project uses ctest we can run the tests like this
+  - GTEST_COLOR=1 ctest -VV

BUILD.bazel

@@ -73,7 +73,10 @@ cc_binary(
 
 cc_binary(
     name = "example_cpp_redis_client",
-    srcs = ["examples/cpp_redis_client.cpp"],
+    srcs = [
+        "examples/cpp_redis_client.cpp",
+        "examples/winsock_initializer.h"
+    ],
     # TODO (steple): For windows, link ws2_32 instead.
     linkopts = ["-lpthread"],
     deps = ["cpp_redis"],

CMakeLists.txt

@@ -20,110 +20,90 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+cmake_minimum_required(VERSION 3.13)
+
 ###
-# config
+# project
 ###
-cmake_minimum_required(VERSION 2.8.7)
+if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.12)
+  cmake_policy(SET CMP0048 NEW)
+  project(cpp_redis
+    VERSION 4.4.0
+    DESCRIPTION "Lightweight C++11 Redis Client"
+    HOMEPAGE_URL "https://github.com/cpp-redis/cpp_redis"
+    LANGUAGES CXX)
+else ()
+  # for cmake >= 3.0
+  project(cpp_redis VERSION 4.4.0 LANGUAGES CXX)
+endif ()
+if (POLICY CMP0077)
+  cmake_policy(SET CMP0077 NEW)
+endif ()
+
 set(CMAKE_MACOSX_RPATH 1)
-include(${CMAKE_ROOT}/Modules/ExternalProject.cmake)
+set(CMAKE_CXX_STANDARD 11)
 
+set(EXPORT_TARGET_NAME ${PROJECT_NAME} CACHE STRING "Name of the exported CMake target used in install(EXPORT)")
 
 ###
 # verbose make
 ###
 # set(CMAKE_VERBOSE_MAKEFILE TRUE)
 
-
-###
-# project
-###
-set(PROJECT cpp_redis)
-project(${PROJECT} CXX)
-
+include(sources.cmake)
 
 ###
 # compilation options
 ###
 if (MSVC)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W3 /O2 /bigobj")
-
-	# was causing conflics with gtest build
-	string(REPLACE "/RTC1" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG})
-
-	if ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "")
-		set(MSVC_RUNTIME_LIBRARY_CONFIG "/MT")
-	endif ()
-
-	foreach (flag_var CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE)
-		if ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "/MT")
-			string(REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
-		elseif ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "/MD")
-			string(REPLACE "/MT" "/MD" ${flag_var} "${${flag_var}}")
-		else ()
-			string(REPLACE "/MD" "${MSVC_RUNTIME_LIBRARY_CONFIG}" ${flag_var} "${${flag_var}}")
-			string(REPLACE "/MT" "${MSVC_RUNTIME_LIBRARY_CONFIG}" ${flag_var} "${${flag_var}}")
-		endif ()
-	endforeach ()
-
-	add_definitions(-D_UNICODE)
-	add_definitions(-DUNICODE)
-	add_definitions(-DWIN32_LEAN_AND_MEAN)
+  add_compile_options(/W3 /O2 /bigobj)
+
+  # was causing conflics with gtest build
+  string(REPLACE "/RTC1" "" CMAKE_CXX_FLAGS_DEBUG ${CMAKE_CXX_FLAGS_DEBUG})
+
+  if ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "")
+    set(MSVC_RUNTIME_LIBRARY_CONFIG "/MT")
+  endif ()
+
+  foreach (flag_var CMAKE_CXX_FLAGS CMAKE_CXX_FLAGS_DEBUG CMAKE_CXX_FLAGS_RELEASE)
+    if ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "/MT")
+      string(REPLACE "/MD" "/MT" ${flag_var} "${${flag_var}}")
+    elseif ("${MSVC_RUNTIME_LIBRARY_CONFIG}" STREQUAL "/MD")
+      string(REPLACE "/MT" "/MD" ${flag_var} "${${flag_var}}")
+    else ()
+      string(REPLACE "/MD" "${MSVC_RUNTIME_LIBRARY_CONFIG}" ${flag_var} "${${flag_var}}")
+      string(REPLACE "/MT" "${MSVC_RUNTIME_LIBRARY_CONFIG}" ${flag_var} "${${flag_var}}")
+    endif ()
+  endforeach ()
+
+  add_definitions(-D_UNICODE)
+  add_definitions(-DUNICODE)
+  add_definitions(-DWIN32_LEAN_AND_MEAN)
 else ()
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -W -Wall -Wextra -O3")
+  add_compile_options(-W -Wall -Wextra -O3)
 endif ()
 
-
 ###
-# variables
+# tacopie
 ###
-find_path(TACOPIE_INCLUDE_DIR tacopie/tacopie PATHS ${PROJECT_SOURCE_DIR}/tacopie/includes/)
-find_library(TACOPIE_LIBRARY tacopie)
-set(CPP_REDIS_INCLUDES ${PROJECT_SOURCE_DIR}/includes)
-set(DEPS_INCLUDES ${PROJECT_SOURCE_DIR}/deps/include)
-
-if (NOT USE_CUSTOM_TCP_CLIENT)
-	set(DEPS_INCLUDES ${DEPS_INCLUDES} ${TACOPIE_INCLUDE_DIR})
+if (NOT tacopie_library AND NOT USE_CUSTOM_TCP_CLIENT)
+  # requires CMP0077 set to NEW
+  set(BUILD_EXAMPLES OFF)
+  set(BUILD_TESTS OFF)
+  add_subdirectory(tacopie)
+  # TODO: add alias library
 endif ()
 
-set(DEPS_LIBRARIES ${PROJECT_SOURCE_DIR}/deps/lib)
-
-
-###
-# includes
-###
-include_directories(${CPP_REDIS_INCLUDES} ${DEPS_INCLUDES})
-
-
-###
-# sources
-###
-set(SRC_DIRS "sources"
-	"sources/builders"
-	"sources/core"
-	"sources/misc"
-	"sources/network"
-	"includes/cpp_redis"
-	"includes/cpp_redis/builders"
-	"includes/cpp_redis/core"
-	"includes/cpp_redis/misc"
-	"includes/cpp_redis/network")
+set(cpp_redis_includes ${CMAKE_CURRENT_LIST_DIR}/includes)
+set(deps_includes ${CMAKE_CURRENT_LIST_DIR}/deps/include)
 
-foreach (dir ${SRC_DIRS})
-	# get directory sources and headers
-	file(GLOB s_${dir} "${dir}/*.cpp")
-	file(GLOB h_${dir} "${dir}/*.hpp")
-	file(GLOB i_${dir} "${dir}/*.ipp")
+set(deps_libraries ${PROJECT_SOURCE_DIR}/deps/lib)
 
-	# set sources
-	set(SOURCES ${SOURCES} ${s_${dir}} ${h_${dir}} ${i_${dir}})
-endforeach ()
 # filter tcp_client if no tacopie
 if (USE_CUSTOM_TCP_CLIENT)
-	file(GLOB tacopie_cpp "sources/network/tcp_client.cpp")
-	file(GLOB tacopie_h "includes/cpp_redis/network/tcp_client.hpp")
-	list(REMOVE_ITEM SOURCES ${tacopie_cpp} ${tacopie_h})
-endif (USE_CUSTOM_TCP_CLIENT)
-
+  file(GLOB tacopie_cpp "sources/network/tcp_client.cpp")
+  list(REMOVE_ITEM ${cpp_redis_sources} ${tacopie_cpp})
+endif ()
 
 ###
 # outputs
@@ -136,88 +116,83 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 ###
 # pkg-config
 ###
-configure_file("cpp_redis.pc.in" "${CMAKE_PKGCONFIG_OUTPUT_DIRECTORY}/cpp_redis.pc" @ONLY)
+configure_file("${PROJECT_NAME}.pc.in" "${CMAKE_PKGCONFIG_OUTPUT_DIRECTORY}/${PROJECT_NAME}.pc" @ONLY)
 
 ###
-# executable
+# main target
 ###
-add_library(${PROJECT} ${SOURCES})
-set_property(TARGET ${PROJECT} PROPERTY POSITION_INDEPENDENT_CODE ON)
+add_library(${PROJECT_NAME} SHARED ${cpp_redis_sources})
 
-if (WIN32)
-	set_target_properties(${PROJECT}
-						  PROPERTIES COMPILE_PDB_NAME ${PROJECT}
-						  COMPILE_PDB_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
-endif (WIN32)
+###
+# includes
+###
+target_include_directories(${PROJECT_NAME} PUBLIC
+  $<BUILD_INTERFACE:${cpp_redis_includes}>
+  $<INSTALL_INTERFACE:include>)
 
 if (WIN32)
-	target_link_libraries(${PROJECT} ws2_32)
-else ()
-	target_link_libraries(${PROJECT} pthread)
-endif (WIN32)
+  set_target_properties(${PROJECT_NAME} PROPERTIES
+    COMPILE_PDB_NAME ${PROJECT_NAME}
+    COMPILE_PDB_OUTPUT_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
+endif ()
 
-if (TACOPIE_LIBRARY)
-	target_link_libraries(${PROJECT} ${TACOPIE_LIBRARY})
-else ()
-	target_link_libraries(${PROJECT} tacopie)
-endif (TACOPIE_LIBRARY)
+set_target_properties(${PROJECT_NAME} PROPERTIES
+  SOVERSION ${PROJECT_VERSION}
+  RESOURCE ${CMAKE_PKGCONFIG_OUTPUT_DIRECTORY}/${PROJECT_NAME}.pc)
+
+find_package(Threads REQUIRED)
+target_link_libraries(${PROJECT_NAME} PRIVATE Threads::Threads)
 
+if (tacopie_library)
+  target_link_libraries(${PROJECT_NAME} PUBLIC ${tacopie_library})
+else ()
+  target_link_libraries(${PROJECT_NAME} PUBLIC tacopie)
+endif ()
 
-# __CPP_REDIS_READ_SIZE
-if (READ_SIZE)
-	set_property(TARGET ${PROJECT} APPEND_STRING PROPERTY COMPILE_DEFINITIONS " __CPP_REDIS_READ_SIZE=${READ_SIZE}")
-endif (READ_SIZE)
+###
+# parameters
+###
+set(READ_SIZE "4096" CACHE STRING "Number of bytes read from sockets")
+if (READ_SIZE MATCHES "^[1-9]+")
+  target_compile_definitions(${PROJECT_NAME} PRIVATE __CPP_REDIS_READ_SIZE=${READ_SIZE})
+endif ()
 
-# __CPP_REDIS_LOGGING_ENABLED
+option(LOGGING_ENABLED "If true enables logging calls to cpp_redis::level()" OFF)
 if (LOGGING_ENABLED)
-	set_property(TARGET ${PROJECT} APPEND_STRING PROPERTY COMPILE_DEFINITIONS " __CPP_REDIS_LOGGING_ENABLED=${LOGGING_ENABLED}")
-endif (LOGGING_ENABLED)
+  target_compile_definitions(${PROJECT_NAME} PRIVATE __CPP_REDIS_LOGGING_ENABLED)
+endif ()
 
-# __CPP_REDIS_USE_CUSTOM_TCP_CLIENT
+option(USE_CUSTOM_TCP_CLIENT "If true user must provide a custom tcp_client_iface instance, otherwise uses tacopie" OFF)
 if (USE_CUSTOM_TCP_CLIENT)
-	set_property(TARGET ${PROJECT} APPEND_STRING PROPERTY COMPILE_DEFINITIONS " __CPP_REDIS_USE_CUSTOM_TCP_CLIENT=${USE_CUSTOM_TCP_CLIENT}")
-endif (USE_CUSTOM_TCP_CLIENT)
-
+  target_compile_definitions(${PROJECT_NAME} PRIVATE __CPP_REDIS_USE_CUSTOM_TCP_CLIENT)
+endif ()
 
 ###
 # install
 ###
-# ensure lib and bin directories exist
-install(CODE "FILE(MAKE_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})")
-install(CODE "FILE(MAKE_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})")
-# install cpp_redis
-install(DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/ DESTINATION lib USE_SOURCE_PERMISSIONS)
-install(DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ DESTINATION bin USE_SOURCE_PERMISSIONS)
-install(DIRECTORY ${CPP_REDIS_INCLUDES}/ DESTINATION include USE_SOURCE_PERMISSIONS)
+install(DIRECTORY ${cpp_redis_includes}/ DESTINATION include USE_SOURCE_PERMISSIONS)
 
+include(GNUInstallDirs)
+install(TARGETS ${PROJECT_NAME} EXPORT ${EXPORT_TARGET_NAME}
+  LIBRARY
+  RESOURCE DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
+install(EXPORT ${EXPORT_TARGET_NAME} DESTINATION lib/${PROJECT_NAME} EXPORT_LINK_INTERFACE_LIBRARIES)
 
 ###
 # examples
 ###
 if (BUILD_EXAMPLES)
-	add_subdirectory(examples)
-	# Reset variable to false to ensure tacopie does no build examples
-	set(BUILD_EXAMPLES false)
-endif (BUILD_EXAMPLES)
+  add_subdirectory(examples)
+endif ()
 
 ###
 # tests
 ###
 if (BUILD_TESTS)
-	enable_testing()
-	add_subdirectory(tests)
-	ExternalProject_Add("googletest"
-						GIT_REPOSITORY "https://github.com/google/googletest.git"
-						CMAKE_ARGS "-DCMAKE_INSTALL_PREFIX=${PROJECT_SOURCE_DIR}/deps")
-	# Reset variable to false to ensure tacopie does no build tests
-	set(BUILD_TESTS false)
-endif (BUILD_TESTS)
-
-
-###
-# tacopie
-###
-if (NOT TACOPIE_LIBRARY AND NOT USE_CUSTOM_TCP_CLIENT)
-	set(SOURCES)  # reset the SOURCES var so that the tacopie project won't include the cpp_redis sources too
-	add_subdirectory(tacopie)
-endif (NOT TACOPIE_LIBRARY AND NOT USE_CUSTOM_TCP_CLIENT)
+  enable_testing()
+  if (NOT TARGET gtest)
+    set(INSTALL_GTEST OFF)
+    add_subdirectory(googletest)
+  endif ()
+  add_subdirectory(tests)
+endif ()