refactor: improve Conan v2 support

Author: gegles

.gitignore

@@ -4,8 +4,8 @@ build-*/
 log/
 .idea
 cmake-build-debug
-/CMakeUserPresets.json
-/conan.lock
-/conanbuildinfo.txt
-/conaninfo.txt
-/graph_info.json
+CMakeUserPresets.json
+conan.lock
+conanbuildinfo.txt
+conaninfo.txt
+graph_info.json

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## v1.1.0
 - Complete revamp
-- Conan support
+- Conan v2 support
 
 ## v0.3.2
 

CMakeLists.txt

@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.16)
 project(spdlog_setup
     LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 20)
+set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 

README.md

@@ -3,46 +3,17 @@
 ## Overview
 
 Header-only [`spdlog`](https://github.com/gabime/spdlog) file-based setup
-library for convenience in initializing spdlog. Inspired by
-[`spdlog-config`](https://github.com/objectx/spdlog-config) for using
+library for convenience in initializing spdlog. It is using
 [`TOML`](https://github.com/toml-lang/toml) configuration, a format that is
 simple and easy-to-read.
 
-[![Build Status](https://travis-ci.org/guangie88/spdlog_setup.svg?branch=master)](https://travis-ci.org/guangie88/spdlog_setup)
-[![Build status](https://ci.appveyor.com/api/projects/status/srek5xih80104eds/branch/master?svg=true)](https://ci.appveyor.com/project/guangie88/spdlog-setup/branch/master)
-[![codecov](https://codecov.io/gh/guangie88/spdlog_setup/branch/master/graph/badge.svg)](https://codecov.io/gh/guangie88/spdlog_setup)
-
 ## Requirements
 
-Requires at least `CMake 3.3`, `g++-4.9` for Linux, or `MSVC2015` with `MSBuild`
-for Windows, providing sufficient C++11 features.
-
-`g++-4.8` will notably fail because of the missing `std::regex` implementation.
-`MSVC2013` will fail too as it does not accept `noexcept`, which is used in some
-of the functions.
-
-Tested against:
-
-- `g++-4.9`
-- `g++-5`
-- `g++-6`
-- `g++-7`
-- `g++-8`
-- `clang-3.6`
-- `clang-3.7`
-- `clang-3.8`
-- `clang-3.9`
-- `clang-4.0`
-- `clang-5.0`
-- `clang-6.0`
-- `clang-7`
-- `cl` (v140 / MSVC2015)
-- `cl` (v141 / MSVC2017)
+Requires at least `Conan v1.59` or `Conan v2.x`
 
 ## Features
 
-- Header-only (check [`How to Install`](#how-to-install) to extract out the
-  header files).
+- Header-only
 - Initialization of `spdlog` sinks, patterns and loggers based on `TOML`
   configuration file.
 - Tag replacement (e.g. "{tagname}-log.txt") within the `TOML` configuration
@@ -53,94 +24,19 @@ Tested against:
 
 See [CHANGELOG.md](./CHANGELOG.md) for more details.
 
-## Repository Checkout
-
-Since this repository has other git-based dependencies as `git` submodules, use
-the command:
-`git clone --recursive https://github.com/guangie88/spdlog_setup.git` in order
-to clone all the submodule dependencies.
-
-If the repository has already been cloned without the submodules, then instead
-run: `git submodule update --init --recursive` in order to clone all the
-submodule dependencies.
-
 ## Dependencies
 
 This repository uses the following external dependencies directly:
 
 - [`Catch`](https://github.com/philsquared/Catch) (only for unit-tests, not
   included in installation)
 - [`spdlog`](https://github.com/gabime/spdlog)
-
-In addition, the following dependencies are inlined as part of the include:
-
 - [`cpptoml`](https://github.com/skystrife/cpptoml)
 - [`fmt`](https://github.com/fmtlib/fmt.git)
 
 ## How to Build
 
-This guide prefers a `CMake` out-of-source build style. For build with unit
-tests, add `-DSPDLOG_SETUP_INCLUDE_UNIT_TESTS=ON` during the CMake
-configuration.
-
-## How to Install
-
-If a recent enough `spdlog` is already available, and unit tests are not to be
-run, it is possible to just copy the `spdlog_setup` directory within `include`
-into another solution for header-only include, as long as `spdlog` can be found
-in that solution.
-
-If `spdlog` is not available, the installation step of `CMake` can copy out the
-entire list of header files required for `spdlog_setup` into the installation
-directory, including `spdlog`. To change the installation directory, add
-`-DCMAKE_INSTALL_PREFIX=<path-to-install>` during the CMake configuration.
-
-### Linux (`GCC`)
-
-In the root directory after `git` cloning:
-
-#### Debug without Installation
-
-- `mkdir build-debug`
-- `cd build-debug`
-- `cmake .. -DCMAKE_BUILD_TYPE=Debug -DSPDLOG_SETUP_INCLUDE_UNIT_TESTS=ON`
-- `cmake --build .`
-
-Now the unit test executable should be compiled and residing in
-`build-debug/spdlog_setup_unit_test`.
-
-#### Release with Installation
-
-- `mkdir build-release`
-- `cd build-release`
-- `cmake .. -DCMAKE_BUILD_TYPE=Release -DSPDLOG_SETUP_INCLUDE_UNIT_TESTS=ON -DCMAKE_INSTALL_PREFIX=install`
-- `cmake --build . --target install`
-
-Now the unit test executable should be compiled and residing in
-`build-release/spdlog_setup_unit_test`.
-
-The header files should be installed in `build-release/install/include`.
-
-### Windows (`MSVC2015` as Example)
-
-Ensure that [`Microsoft Build Tools 2015`](https://www.microsoft.com/en-sg/download/details.aspx?id=48159)
-and [`Visual C++ Build Tools 2015`](http://landinghub.visualstudio.com/visual-cpp-build-tools)
-(or `Visual Studio 2015`) have been installed.
-
-In the root directory after `git` cloning:
-
-- `mkdir build`
-- `cd build`
-- `cmake .. -G "Visual Studio 14 Win64" -DSPDLOG_SETUP_INCLUDE_UNIT_TESTS=ON -DCMAKE_INSTALL_PREFIX=install`
-- (Debug) `cmake --build . --config Debug`
-- (Release with installation) `cmake --build . --config Release --target install`
-
-Now the unit test executable should be compiled and residing in
-
-- (Debug) `build/Debug/spdlog_setup_unit_test.exe` or
-- (Release) `build/Release/spdlog_setup_unit_test.exe`.
-
-The header files should be installed in `build/install/include`.
+- `conan build -b mising .`
 
 ## Supported Sinks
 
@@ -391,7 +287,6 @@ level = "trace"
 
 ```c++
 #include <spdlog_setup/spdlog_setup.hpp>
-
 #include <iostream>
 #include <string>
 
@@ -422,7 +317,6 @@ int main() {
 
 ```c++
 #include <spdlog_setup/spdlog_setup.hpp>
-
 #include <string>
 
 int main(const int argc, const char * argv[]) {
@@ -475,23 +369,8 @@ all the source code files.
 Please try to run
 
 ```bash
-./run-clang-format.sh
+./reformat.sh
 ```
 
 which will pull the appropriate Docker image to run the formatting command over
 the entire repository directory.
-
-If your `docker` command requires `sudo`, then you will need to run it as
-
-```bash
-sudo sh ./run-clang-format.sh
-```
-
-Alternatively, you could also try to set up your own `clang-format` (currently
-this repository uses version 7), and run
-
-```bash
-clang-format -i path_to_h_cpp_file
-```
-
-over the changed files.

conanfile.py

@@ -1,42 +1,73 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
 from conan import ConanFile
-from conan.tools.files import copy
-from conan.tools.cmake import CMake, cmake_layout
+from conan.errors import ConanInvalidConfiguration
 from conan.tools.build import check_min_cppstd
+from conan.tools.files import copy
+from conan.tools.scm import Version
+from conan.tools.cmake import CMake, CMakeToolchain, CMakeDeps, cmake_layout
+
+import os
+
+required_conan_version = ">=1.52.0"
 
 
 class SpdlogSetupConan(ConanFile):
     name = "spdlog_setup"
     version = "1.1.0"
-    description = "TOML config for spdlog"
-    url = "https://github.com/gegles/spdlog_setup"
-    topics = ("spdlog", "logging", "header-only", "TOML", "cpptoml")
+    description = "Setup spdlog via a TOML config file"
     license = "MIT"
-
+    url = "https://github.com/conan-io/conan-center-index"
+    homepage = "https://github.com/gegles/spdlog_setup"
+    topics = ('spdlog', 'logging', 'header-only', 'TOML', 'cpptoml')
+    package_type = "header-library"
     settings = "os", "arch", "compiler", "build_type"
     exports_sources = "include/*", "test/*", "CMakeLists.txt"
     no_copy_source = True
-    generators = "CMakeToolchain", "CMakeDeps"
+    default_options = {"fmt/*:header_only": True,
+                       "spdlog/*:header_only": True}
+
+    @property
+    def _min_cppstd(self):
+        return 17
+
+    @property
+    def _compilers_minimum_version(self):
+        return {
+            "Visual Studio": "16",
+            "msvc": "192",
+            "gcc": "8",
+            "clang": "7",
+            "apple-clang": "12.0",
+        }
 
-    def config_options(self):
-        self.options["fmt"].header_only = True
-        self.options["spdlog"].header_only = True
+    def layout(self):
+        cmake_layout(self)
 
     def build_requirements(self):
-        self.test_requires("catch2/[>=3.1.0]")
+        self.test_requires("catch2/3.3.2")
 
     def requirements(self):
-        self.requires("cpptoml/[>=0.1.1]")
-        self.requires("spdlog/[>=1.11.0]")
-        self.requires("fmt/[>=9.1.0]")
+        self.requires("cpptoml/0.1.1", transitive_headers=True)
+        self.requires("spdlog/1.11.0", transitive_headers=True, transitive_libs=True)
+        self.requires("fmt/9.1.0", transitive_headers=True, transitive_libs=True)
+
+    def package_id(self):
+        self.info.clear()
 
     def validate(self):
-        check_min_cppstd(self, 17)
+        if self.settings.compiler.get_safe("cppstd"):
+            check_min_cppstd(self, self._min_cppstd)
+        minimum_version = self._compilers_minimum_version.get(str(self.settings.compiler), False)
+        if minimum_version and Version(self.settings.compiler.version) < minimum_version:
+            raise ConanInvalidConfiguration(
+                f"{self.ref} requires C++{self._min_cppstd}, which your compiler does not support."
+            )
 
-    def layout(self):
-        cmake_layout(self)
+    def generate(self):
+        if not self.conf.get("tools.build:skip_test", default=False):
+            tc = CMakeToolchain(self)
+            tc.generate()
+            deps = CMakeDeps(self)
+            deps.generate()
 
     def build(self):
         if not self.conf.get("tools.build:skip_test", default=False):
@@ -46,7 +77,22 @@ def build(self):
             cmake.test()
 
     def package(self):
-        copy(self, "*.hpp", self.source_folder, self.package_folder)
+        copy(self, pattern="LICENSE", dst=os.path.join(self.package_folder, "licenses"), src=self.source_folder)
+        copy(
+            self,
+            pattern="*.hpp",
+            dst=os.path.join(self.package_folder, "include"),
+            src=os.path.join(self.source_folder, "include"),
+        )
 
-    def package_id(self):
-        self.info.clear()
+    def package_info(self):
+        self.cpp_info.bindirs = []
+        self.cpp_info.libdirs = []
+        self.cpp_info.set_property("cmake_file_name", "spdlog_setup")
+        self.cpp_info.set_property("cmake_target_name", "spdlog_setup::spdlog_setup")
+
+        # TODO: to remove in conan v2 once cmake_find_package_* generators removed
+        self.cpp_info.filenames["cmake_find_package"] = "SPDLOG_SETUP"
+        self.cpp_info.filenames["cmake_find_package_multi"] = "spdlog_setup"
+        self.cpp_info.names["cmake_find_package"] = "SPDLOG_SETUP"
+        self.cpp_info.names["cmake_find_package_multi"] = "spdlog_setup"