Merge pull request #52 from zerodha/v2

feat: v2

Author: bhumitattarde

.clang-format

@@ -13,11 +13,12 @@ AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: All
 AllowShortLoopsOnASingleLine: 'true'
 AlwaysBreakBeforeMultilineStrings: 'false'
+AlwaysBreakTemplateDeclarations: 'Yes'
 BinPackArguments: 'true'
 BinPackParameters: 'true'
 BreakBeforeBraces: Attach
 BreakBeforeTernaryOperators: 'false'
-ColumnLimit: '120'
+ColumnLimit: '80'
 CompactNamespaces: 'false'
 Cpp11BracedListStyle: 'false'
 FixNamespaceComments: 'true'

.clang-tidy

@@ -1,2 +1,4 @@
-Checks:          '*, -modernize-use-trailing-return-type, -fuchsia*, -google-runtime-references, -google-readability-todo'
-CheckOptions: 'IgnoreClassesWithAllMemberVariablesBeingPublic'
+Checks:          '*, -modernize-use-trailing-return-type, -fuchsia*, -google-runtime-references, -google-readability-todo, -llvmlibc-*, -altera*, -readability-function-cognitive-complexity, -misc-non-private-member-variables-in-classes, -cppcoreguidelines-non-private-member-variables-in-classes, -cppcoreguidelines-pro-bounds-pointer-arithmetic'
+CheckOptions: 
+    - key: 'misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic'
+      value: 'true'

.git-blame-ignore-revs

@@ -0,0 +1,2 @@
+# change column limit to 80
+39cd0478af477b63ecc925fa8af8b0c82e4566e6

.github/workflows/cppkiteconnect-test.yml

@@ -37,13 +37,13 @@ jobs:
           git clone https://github.com/hoytech/uWebSockets.git
           cd uWebSockets && make && sudo make install && cd ..
           mkdir build && cd build
-          cmake .. && make && make test ARGS="-V"
+          cmake .. -DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON && make && make test ARGS="-V"
 
       # Build & test on macOS
       - name: Build and test on macOS
         if: startsWith(matrix.config.name, 'macOS')
         run: |
-          brew install googletest libuv
+          brew extract --version=1.10.0 googletest homebrew/cask && brew install googletest@1.10.0 libuv
           export PKG_CONFIG_PATH="/usr/local/opt/openssl/lib/pkgconfig"
 
           curl -L https://github.com/hoytech/uWebSockets/archive/refs/tags/v0.14.8.tar.gz > uWebSocketsv-0.14.8.tar.gz
@@ -52,4 +52,4 @@ jobs:
           make && make installDarwin && cd ..
 
           mkdir build && cd build
-          cmake .. && make && make test ARGS="-V"
+          cmake .. -DBUILD_EXAMPLES=ON -DBUILD_TESTS=ON && make && make test ARGS="-V"

.gitignore

@@ -8,7 +8,6 @@ build/
 compile_commands.json
 
 #generated docs
-docs/**
 !docs/config.doxygen
 !docs/mainpage.dox
 !docs/CMakeLists.txt

.gitmodules

@@ -1,3 +1,27 @@
 [submodule "tests/mock_responses"]
 	path = tests/mock_responses
 	url = https://github.com/zerodha/kiteconnect-mocks
+[submodule "include/PicoSHA2"]
+	path = include/PicoSHA2
+	url = https://github.com/okdshin/PicoSHA2.git
+[submodule "include/fmt"]
+	path = include/fmt
+	url = https://github.com/fmtlib/fmt.git
+[submodule "include/rapidjson"]
+	path = include/rapidjson
+	url = https://github.com/Tencent/rapidjson.git
+[submodule "include/cpp-httplib"]
+	path = include/cpp-httplib
+	url = https://github.com/yhirose/cpp-httplib.git
+[submodule "doxygen-awesome-css"]
+	path = doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
+[submodule "docs/doxygen-awesome-css"]
+	path = docs/doxygen-awesome-css
+	url = https://github.com/jothepro/doxygen-awesome-css.git
+[submodule "include/uri-parser"]
+	path = include/uri-parser
+	url = git@github.com:bhumitattarde/uri-parser.git
+[submodule "include/rapidcsv"]
+	path = include/rapidcsv
+	url = git@github.com:d99kris/rapidcsv.git

CMakeLists.txt

@@ -1,32 +1,118 @@
 cmake_minimum_required(VERSION 3.10)
-project(kitepp) 
+project(CppKiteConnect)
 
-#detect Linux (for optional linking of libuv)
+# set variables
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/modules/")
+
+# detect Linux (for optional linking of libuv)
 if(UNIX AND NOT APPLE)
+        message(STATUS "environment set to linux")
         set(LINUX TRUE)
 endif()
 
-#set variables
-set(CMAKE_CXX_STANDARD 11)
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/modules/")
-
-#set project include directory
+# set project include directory
 include_directories("${CMAKE_SOURCE_DIR}/include")
 
-#build examples
-add_subdirectory("examples/example1")
-add_subdirectory("examples/example2")
-add_subdirectory("examples/example3")
-add_subdirectory("examples/example4")
+# find deps
+set(LINUX_AND_UV_NOT_FOUND false)
+
+if(BUILD_EXAMPLES OR BUILD_TESTS)
+        find_package(Threads REQUIRED)
+        find_package(OpenSSL REQUIRED)
+        find_package(ZLIB REQUIRED)
+        find_library(UWS_LIB uWS REQUIRED)
+        find_path(UWS_INCLUDE uWS REQUIRED)
+
+        if(DEFINED LINUX)
+                find_library(UV_LIB uv)
+                find_path(UV_INCLUDE "uv.h")
+        else()
+                find_library(UV_LIB uv REQUIRED)
+                find_path(UV_INCLUDE "uv.h" REQUIRED)
+        endif()
+
+        if(BUILD_TESTS)
+                find_package(GTest REQUIRED)
+                find_package(GMock REQUIRED)
+        endif()
+
+        if((NOT UV_LIB OR NOT UV_INCLUDE) AND DEFINED LINUX)
+                set(LINUX_AND_UV_NOT_FOUND true)
+                message(STATUS "couldn't find libuv")
+        endif()
+endif()
+
+# build examples
+if(BUILD_EXAMPLES)
+        function(build_exmaple example_name)
+                add_executable(${example_name} "${CMAKE_SOURCE_DIR}/examples/${example_name}.cpp")
+
+                if(LINUX_AND_UV_NOT_FOUND)
+                        target_include_directories(${example_name} PUBLIC ${UWS_INCLUDE})
+                        target_link_libraries(${example_name} PUBLIC Threads::Threads OpenSSL::SSL OpenSSL::Crypto ZLIB::ZLIB ${UWS_LIB})
+                else()
+                        target_include_directories(${example_name} PUBLIC ${UWS_INCLUDE} ${UV_INCLUDE})
+                        target_link_libraries(${example_name} PUBLIC Threads::Threads OpenSSL::SSL OpenSSL::Crypto ZLIB::ZLIB ${UWS_LIB} ${UV_LIB})
+                endif()
+        endfunction(build_exmaple)
+
+        build_exmaple(example1)
+        build_exmaple(example2)
+        build_exmaple(example3)
+        build_exmaple(example4)
+endif()
+
+# build tests
+if(BUILD_TESTS)
+        include(CTest)
+        option(CMAKE_USE_WIN32_THREADS_INIT "using WIN32 threads" ON)
+        option(gtest_disable_pthreads "disabling pthreads in gtest" ON)
+
+        # kite-test
+        set(KITE_TEST_BINARY_NAME kiteTest)
+        file(GLOB test_files
+                "${CMAKE_SOURCE_DIR}/tests/unit/kite/*.cpp"
+        )
+        add_executable(${KITE_TEST_BINARY_NAME} ${test_files})
+        target_include_directories(${KITE_TEST_BINARY_NAME} PUBLIC ${GTEST_INCLUDE_DIRS} ${GMOCK_INCLUDE_DIRS})
+        target_link_libraries(${KITE_TEST_BINARY_NAME} PUBLIC OpenSSL::SSL OpenSSL::Crypto ${GTEST_BOTH_LIBRARIES} ${GMOCK_BOTH_LIBRARIES} Threads::Threads)
+        add_test(NAME kite-test COMMAND ${KITE_TEST_BINARY_NAME})
+
+        # ticker-test
+        set(TICKER_TEST_BINARY_NAME tickerTest)
+        add_executable(${TICKER_TEST_BINARY_NAME} "${CMAKE_SOURCE_DIR}/tests/unit/tickertest.cpp")
+
+        if(LINUX_AND_UV_NOT_FOUND)
+                target_include_directories(${TICKER_TEST_BINARY_NAME} PUBLIC ${UWS_INCLUDE} ${GTEST_INCLUDE_DIRS})
+                target_link_libraries(${TICKER_TEST_BINARY_NAME} PUBLIC OpenSSL::SSL OpenSSL::Crypto ZLIB::ZLIB ${UWS_LIB} ${GTEST_LIBRARIES} ${GTEST_MAIN_LIBRARIES} Threads::Threads)
+        else()
+                target_include_directories(${TICKER_TEST_BINARY_NAME} PUBLIC ${UV_INCLUDE} ${UWS_INCLUDE} ${GTEST_INCLUDE_DIRS})
+                target_link_libraries(${TICKER_TEST_BINARY_NAME} PUBLIC OpenSSL::SSL OpenSSL::Crypto ZLIB::ZLIB ${UV_LIB} ${UWS_LIB} ${GTEST_LIBRARIES} ${GTEST_MAIN_LIBRARIES} Threads::Threads)
+        endif()
 
-#build tests
-include(CTest)
-if(BUILD_TESTING)
-        add_subdirectory("tests")
+        add_test(NAME ticker-test COMMAND ${TICKER_TEST_BINARY_NAME})
 endif()
 
-#generate documentation
-add_subdirectory("docs")
+# generate docs
+if(BUILD_DOCS)
+        find_package(Doxygen)
 
+        if(DOXYGEN_FOUND)
+                # set io files and configure doxyfile
+                set(DOXY_FILE Doxyfile.in)
+                set(DOXYGEN_IN ${CMAKE_SOURCE_DIR}/cmake/templates/${DOXY_FILE})
+                set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile.out)
+                configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
 
+                # ! don't add to the `all` target. doing so will build build docs everytime.
+                add_custom_target(docs
+                        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+                        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                        COMMENT "generating documentation with doxygen"
+                        VERBATIM)
+        else(DOXYGEN_FOUND)
+                message(FATAL_ERROR "doxygen is required for generating documentation")
+        endif(DOXYGEN_FOUND)
+endif()