add namespace support (#10)

* first try

* automatically add ::
update readme

* fix the introduced bug

* first try

* fix ns typo

* fix ns package

* fix typo

* make suggested changes, remove unnecessary lines from CI

* add automatical alias generation

Author: MichaelUnknown

.github/workflows/test.yml

@@ -10,29 +10,30 @@ on:
 
 env:
   CTEST_OUTPUT_ON_FAILURE: 1
-  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
 
     - name: test local build
       run: |
-        cmake -Htest -Bbuild/local
+        cmake -S test -B build/local
         cmake --build build/local 
         ./build/local/test
 
-    - name: install dependency
+    - name: install dependencies
       run: |
-        cmake -Htest/dependency -Bbuild/dependency
+        cmake -S test/dependency -B build/dependency
         sudo cmake --build build/dependency --target install
+        cmake -S test/namespaced_dependency -B build/namespaced_dependency
+        sudo cmake --build build/namespaced_dependency --target install
 
     - name: test installed build
       run: |
-        cmake -Htest -Bbuild/installed -DTEST_INSTALLED_VERSION=1
+        cmake -S test -B build/installed -D TEST_INSTALLED_VERSION=1
         cmake --build build/installed 
         ./build/installed/test

.gitignore

@@ -1 +1,3 @@
-/build
+/build
+/out
+/.vs

CMakeLists.txt

@@ -13,7 +13,7 @@ function(packageProject)
   cmake_parse_arguments(
     PROJECT
     ""
-    "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY;VERSION_HEADER"
+    "NAME;VERSION;INCLUDE_DIR;INCLUDE_DESTINATION;BINARY_DIR;COMPATIBILITY;VERSION_HEADER;NAMESPACE"
     "DEPENDENCIES"
     ${ARGN}
   )
@@ -23,6 +23,13 @@ function(packageProject)
     set(PROJECT_COMPATIBILITY AnyNewerVersion)
   endif()
 
+  # we wanto to automatically add :: to our namespace, so only append if a namespace was given in the first place
+  # we also provide an alias to ensure that local and installed versions have the same name
+  if (DEFINED PROJECT_NAMESPACE)
+    set(PROJECT_NAMESPACE ${PROJECT_NAMESPACE}::)
+    add_library(${PROJECT_NAMESPACE}${PROJECT_NAME} ALIAS ${PROJECT_NAME})
+  endif()
+
   if (DEFINED PROJECT_VERSION_HEADER)
     set(PROJECT_VERSION_INCLUDE_DIR ${PROJECT_BINARY_DIR}/PackageProjectInclude)
     string(TOUPPER ${PROJECT_NAME} UPPERCASE_PROJECT_NAME)
@@ -69,6 +76,7 @@ function(packageProject)
   install(
     EXPORT ${PROJECT_NAME}Targets
     DESTINATION lib/cmake/${PROJECT_NAME}-${PROJECT_VERSION}
+    NAMESPACE ${PROJECT_NAMESPACE}
   )
 
   install(

README.md

@@ -35,6 +35,8 @@ packageProject(
   # (optional) create a header containing the version info
   # note that the path should be lowercase 
   VERSION_HEADER "${PROJECT_NAME}/version.h"
+  # (optional) install your library with a namespace (do NOT add extra '::')
+  NAMESPACE ${PROJECT_NAMESPACE}
 )
 ```
 

test/CMakeLists.txt

@@ -9,9 +9,11 @@ project(PackageProjectTest
 
 if (TEST_INSTALLED_VERSION)
   find_package(dependency 1.2.3 REQUIRED)
+  find_package(namespaced_dependency 4.5.6 REQUIRED)
 else()
   add_subdirectory(dependency)
+  add_subdirectory(namespaced_dependency)
 endif()
 
 add_executable(test main.cpp)
-target_link_libraries(test dependency)
+target_link_libraries(test dependency ns::namespaced_dependency)

test/main.cpp

@@ -1,8 +1,11 @@
 #include <dependency/dependency.h>
 #include <dependency/version.h>
+#include <namespaced_dependency/namespaced_dependency.h>
+#include <namespaced_dependency/version.h>
 #include <string>
 
 int main() {
   dependencyFunction();
-  return DEPENDENCY_VERSION == std::string("1.2.3") ? 0 : 1;
+  ns::namespacedDependencyFunction();
+  return DEPENDENCY_VERSION == std::string("1.2.3") && NAMESPACED_DEPENDENCY_VERSION == std::string("4.5.6") ? 0 : 1;
 }

test/namespaced_dependency/CMakeLists.txt

@@ -0,0 +1,30 @@
+cmake_minimum_required(VERSION 3.14 FATAL_ERROR)
+
+project(namespaced_dependency
+  VERSION 4.5.6
+  LANGUAGES CXX
+)
+
+set(PROJECT_NAMESPACE "ns")
+add_library(${PROJECT_NAME} source/namespaced_dependency.cpp)
+# the alias ${PROJECT_NAMESPACE}::${PROJECT_NAME} is automatically provided by PackageProject.cmake
+# if we use the `NAMESPACE` parameter
+
+target_include_directories(namespaced_dependency
+  PUBLIC
+    $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
+    $<INSTALL_INTERFACE:include/${PROJECT_NAME}-${PROJECT_VERSION}>
+)
+
+add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/PackageProject)
+
+packageProject(
+  NAME ${PROJECT_NAME}
+  VERSION ${PROJECT_VERSION}
+  NAMESPACE ${PROJECT_NAMESPACE}
+  BINARY_DIR ${PROJECT_BINARY_DIR}
+  INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include
+  INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}
+  VERSION_HEADER "namespaced_dependency/version.h"
+  DEPENDENCIES ""
+)

test/namespaced_dependency/include/namespaced_dependency/namespaced_dependency.h

@@ -0,0 +1,9 @@
+#pragma once
+
+#include <iostream>
+
+namespace ns {
+
+	void namespacedDependencyFunction();
+
+}

test/namespaced_dependency/source/namespaced_dependency.cpp

@@ -0,0 +1,8 @@
+#include <iostream>
+#include <namespaced_dependency/version.h>
+
+namespace ns {
+	void namespacedDependencyFunction() {
+		std::cout << "Using namespaced_dependency version " << NAMESPACED_DEPENDENCY_VERSION << std::endl;
+	}
+}