Merge pull request #31 from acd1034/30-fix-ci-and-cmakelists

Resolve: Fix CI and CMakeLists

Author: acd1034

.github/workflows/gen-docs.yml

@@ -6,32 +6,32 @@ name: Generate Documents
 on:
   push:
     branches: [ main ]
-  pull_request:
-    branches: [ main ]
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
+    timeout-minutes: 10
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    - name: Checkout
-      uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+      with:
+        submodules: recursive
 
     - name: Build by Doxygen
       uses: mattnotmitt/doxygen-action@v1.9.2
       with:
-          working-directory: '.'
           doxyfile-path: 'Doxyfile'
+          working-directory: '.'
 
     - name: Deploy
       uses: JamesIves/github-pages-deploy-action@releases/v3
       with:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages # The branch the action should deploy to
-          FOLDER: docs # The folder the action should deploy. Specified by HTML_OUTPUT in Doxyfile
+          FOLDER: html # The folder the action should deploy. Specified by HTML_OUTPUT in Doxyfile
           TARGET_FOLDER: docs

.github/workflows/linux-build.yml

@@ -11,7 +11,8 @@ on:
 jobs:
   build:
     name: ${{matrix.pkg_name}}, C++${{matrix.std}}, ${{matrix.build_type}} build
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
     strategy:
       matrix:
         pkg_name:

.github/workflows/macos-build.yml

@@ -16,6 +16,7 @@ jobs:
     name: ${{matrix.compiler}} ${{matrix.build_type}}
     # The type of runner that the job will run on
     runs-on: macos-latest
+    timeout-minutes: 30
     # A matrix allows you to create multiple jobs by performing variable substitution
     # in a single job definition
     strategy:

CMakeLists.txt

@@ -1,26 +1,58 @@
-cmake_minimum_required(VERSION 3.8)
-project(iris CXX)
+cmake_minimum_required(VERSION 3.12)
+project(StrTpl
+  VERSION 0.1.0
+  LANGUAGES CXX
+)
+include(GNUInstallDirs)
 
-# Specify build type if not
+# Creates a library StrTpl which is an interface (header files only)
+add_library(StrTpl INTERFACE)
+# If you want to use StrTpl prefer to link against StrTpl using this alias target
+add_library(StrTpl::StrTpl ALIAS StrTpl)
+
+# Specify build type ifnot
 if(NOT CMAKE_BUILD_TYPE)
   set(CMAKE_BUILD_TYPE "Release")
   message(STATUS "CMAKE_BUILD_TYPE not specified: Use Release by default.")
 endif(NOT CMAKE_BUILD_TYPE)
 
 # Determine whether this is a standalone project or included by other projects
-set(IRIS_STANDALONE_PROJECT OFF)
-if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-  set(IRIS_STANDALONE_PROJECT ON)
+set(STRTPL_STANDALONE_PROJECT OFF)
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+  set(STRTPL_STANDALONE_PROJECT ON)
 endif()
 
 # Project options
-option(IRIS_TEST "Build and perform iris tests" ${IRIS_STANDALONE_PROJECT})
+option(STRTPL_INSTALL "Generate and install StrTpl target" ${STRTPL_STANDALONE_PROJECT})
+option(STRTPL_TEST "Build and perform StrTpl tests" ${STRTPL_STANDALONE_PROJECT})
 
 # Setup include directory
 add_subdirectory(include)
 
-# Setup test directory
-if (IRIS_TEST)
+if(STRTPL_INSTALL)
+  install(
+    TARGETS StrTpl
+    EXPORT StrTplConfig
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    # RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  )
+  install(
+    DIRECTORY include/strtpl
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  )
+  # Make library importable by other projects
+  install(
+    EXPORT StrTplConfig
+    NAMESPACE StrTpl::
+    FILE StrTplConfig.cmake
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/StrTpl
+    # EXPORT_LINK_INTERFACE_LIBRARIES
+  )
+endif()
+
+if(STRTPL_TEST)
   include(CTest)
   add_subdirectory(tests)
 endif()

README.md

@@ -1,19 +1,47 @@
 # String Template in C++
 [![Linux build status](https://github.com/acd1034/cpp-string-template/actions/workflows/linux-build.yml/badge.svg)](https://github.com/acd1034/cpp-string-template/actions/workflows/linux-build.yml)
-<!--
-[![macOS build status](https://github.com/acd1034/cpp-string-template/actions/workflows/macos-build.yml/badge.svg)](https://github.com/acd1034/cpp-string-template/actions/workflows/macos-build.yml)
--->
 
-Click [here](https://acd1034.github.io/cpp-string-template/index.html) to see the HTML documentation generated by Doxygen.
+## Quick example
+```cpp
+#include <iostream>
+#include <string_view>
+#include <unordered_map>
+#include <strtpl/string_template.hpp>
 
-## Noteworthy Features
+int main() {
+  std::unordered_map<std::string_view, std::string_view> map{
+    {"who", "Alice"},
+    {"what", "bananas"},
+    {"verb", "run"},
+  };
+  { // '$' に続く単語を発見した場合、その単語を map の key として得られる値で置き換えます。
+    std::cout << strtpl::substitute("$who likes $what.", map) << std::endl;
+    // → Alice likes bananas.
+  }
+  { // '$' と単語の後にアルファベットが続く場合は、単語を "{}" で囲みます。
+    std::cout << strtpl::substitute("$who ${verb}s fast.", map) << std::endl;
+    // → Alice runs fast.
+  }
+  // '$' に続く単語が map に含まれない場合、例外を送出します。
+  try {
+    std::cout << strtpl::substitute("$who likes $where.", map) << std::endl;
+  } catch (const std::exception& e) {
+    std::cout << e.what() << std::endl;
+    // → strtpl::at: index out of range
+  }
+  // '$' に続く文字が無効な場合も、例外を送出します。エラーメッセージにはエラーが生じた文字の行番号と列番号を含みます。
+  try {
+    std::cout << strtpl::substitute("$who likes $.", map) << std::endl;
+  } catch (const std::exception& e) {
+    std::cout << e.what() << std::endl;
+    // → Invalid placeholder in string: line 1, col 12
+  }
+}
+```
 
-## Supported Compilers
-<!--
-The code will work on the following compilers:
-- GCC (latest)
-- Clang (latest)
-- Apple clang (version 11.0.0 or later)
--->
-
-## Library Dependencies
+## Note
+- [`include/strtpl/string_template.hpp`](https://github.com/acd1034/cpp-string-template/blob/main/include/strtpl/string_template.hpp)
+  → 文字列置換を行う関数 (`strtpl::substitute` および `wchar_t` に対応した `strtpl::wsubstitute`) が実装されています。
+- [`include/strtpl/regex.hpp`](https://github.com/acd1034/cpp-string-template/blob/main/include/strtpl/regex.hpp),
+  [`include/strtpl/trailing_view.hpp`](https://github.com/acd1034/cpp-string-template/blob/main/include/strtpl/trailing_view.hpp)
+  → std の正規表現ライブラリを range のように扱うためのモジュールで、まだ試験実装です。

examples/quick_example.cpp

@@ -0,0 +1,34 @@
+#include <iostream>
+#include <string_view>
+#include <unordered_map>
+#include <strtpl/string_template.hpp>
+
+int main() {
+  std::unordered_map<std::string_view, std::string_view> map{
+    {"who", "Alice"},
+    {"what", "bananas"},
+    {"verb", "run"},
+  };
+  { // '$' に続く単語を発見した場合、その単語を map の key として得られる値で置き換えます。
+    std::cout << strtpl::substitute("$who likes $what.", map) << std::endl;
+    // → Alice likes bananas.
+  }
+  { // '$' と単語の後にアルファベットが続く場合は、単語を "{}" で囲みます。
+    std::cout << strtpl::substitute("$who ${verb}s fast.", map) << std::endl;
+    // → Alice runs fast.
+  }
+  // '$' に続く単語が map に含まれない場合、例外を送出します。
+  try {
+    std::cout << strtpl::substitute("$who likes $where.", map) << std::endl;
+  } catch (const std::exception& e) {
+    std::cout << e.what() << std::endl;
+    // → strtpl::at: index out of range
+  }
+  // '$' に続く文字が無効な場合も、例外を送出します。エラーメッセージにはエラーが生じた文字の行番号と列番号を含みます。
+  try {
+    std::cout << strtpl::substitute("$who likes $.", map) << std::endl;
+  } catch (const std::exception& e) {
+    std::cout << e.what() << std::endl;
+    // → Invalid placeholder in string: line 1, col 12
+  }
+}

include/CMakeLists.txt

@@ -1,28 +1,13 @@
-# Creates a library iris which is an interface (header files only)
-add_library(iris INTERFACE)
-# If you want to use iris prefer to link against iris using this alias target
-add_library(iris::iris ALIAS iris)
-# Set C++ version
-target_compile_features(iris INTERFACE cxx_std_20)
-set_target_properties(iris PROPERTIES
-  CXX_STANDARD_REQUIRED ON
-  CXX_EXTENSIONS OFF
-)
-
 # Add include folders to the library and targets that consume it the SYSTEM
 # keyword suppresses warnings for users of the library
-if(IRIS_STANDALONE_PROJECT)
-  target_include_directories(iris INTERFACE
+if(STRTPL_STANDALONE_PROJECT)
+  target_include_directories(StrTpl INTERFACE
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
     $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
   )
 else()
-  target_include_directories(iris SYSTEM INTERFACE
+  target_include_directories(StrTpl SYSTEM INTERFACE
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
     $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
   )
 endif()
-
-# Add (header only) external libraries
-# find_package(Boost 1.61.0 REQUIRED)
-# target_link_libraries(iris SYSTEM INTERFACE Boost::boost)

include/strtpl/string_template.hpp

@@ -179,7 +179,7 @@ namespace strtpl {
   at(Map& map, const Key& key) {
     auto i = map.find(key);
     using std::end;
-    return i == end(map) ? throw std::out_of_range("strtpl::at") : get<1>(*i);
+    return i == end(map) ? throw std::out_of_range("strtpl::at: index out of range") : get<1>(*i);
   }
 
   template <class BiIter>

tests/CMakeLists.txt

@@ -1,10 +1,23 @@
-cmake_minimum_required(VERSION 3.8)
-project(iris_tests CXX)
+cmake_minimum_required(VERSION 3.12)
+project(StrTplTests
+  LANGUAGES CXX
+)
 include(CTest)
 
+# Import the globally installed StrTpl ifCMake has been started independently in
+# this directory with tests
+if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
+  find_package(StrTpl REQUIRED)
+endif()
+
 # This interface adds compile options to how the tests are run
-add_library(iris_tests_config INTERFACE)
-target_compile_options(iris_tests_config INTERFACE
+add_library(StrTplTestsConfig INTERFACE)
+target_compile_features(StrTplTestsConfig INTERFACE cxx_std_20)
+set_target_properties(StrTplTestsConfig PROPERTIES
+  CXX_STANDARD_REQUIRED ON
+  CXX_EXTENSIONS OFF
+)
+target_compile_options(StrTplTestsConfig INTERFACE
   -fno-strict-aliasing
   -Wall
   -Wcast-align
@@ -31,12 +44,12 @@ target_compile_options(iris_tests_config INTERFACE
   >
   # $<$<CXX_COMPILER_ID:Clang>:
   #   $<$<AND:$<VERSION_GREATER:$<CXX_COMPILER_VERSION>,4.99>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,6>>:
-  #     $<$<EQUAL:${IRIS_CXX_STANDARD},17>:-Wno-undefined-func-template>
+  #     $<$<EQUAL:${STRTPL_CXX_STANDARD},17>:-Wno-undefined-func-template>
   #   >
   # >
   # $<$<CXX_COMPILER_ID:AppleClang>:
   #   $<$<AND:$<VERSION_GREATER:$<CXX_COMPILER_VERSION>,9.1>,$<VERSION_LESS:$<CXX_COMPILER_VERSION>,10>>:
-  #     $<$<EQUAL:${IRIS_CXX_STANDARD},17>:-Wno-undefined-func-template>
+  #     $<$<EQUAL:${STRTPL_CXX_STANDARD},17>:-Wno-undefined-func-template>
   #   >
   # >
   $<$<CXX_COMPILER_ID:GNU>:
@@ -53,21 +66,12 @@ target_compile_options(iris_tests_config INTERFACE
   >
 )
 
-# Import the globally installed iris if CMake has been started independently in
-# this directory with tests
-if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-  find_package(iris::iris REQUIRED)
-endif()
-
-# Use Catch2 as a unit testing framework
-# find_package(Catch2)
-
 Include(FetchContent)
 FetchContent_Declare(Catch2
   GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-  GIT_TAG        v2.13.6)
+  GIT_TAG        v3.0.1)
 FetchContent_MakeAvailable(Catch2)
 
-add_subdirectory(main)
 add_subdirectory(regex)
+add_subdirectory(string_template)
 add_subdirectory(trailing_view)

tests/regex/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.8)
+cmake_minimum_required(VERSION 3.12)
 project(regex_tests CXX)
 
 # ${CMAKE_PROJECT_NAME}: project name of the root CMakeLists.txt
@@ -8,9 +8,9 @@ add_executable(${PROJECT_NAME}
 )
 
 target_link_libraries(${PROJECT_NAME} PRIVATE
-  iris_tests_config
-  iris::iris
-  Catch2::Catch2
+  StrTpl::StrTpl
+  StrTplTestsConfig
+  Catch2::Catch2WithMain
 )
 
 add_test(${PROJECT_NAME} ${PROJECT_NAME})