oak: Refactor RequestStub to its own private header file

Author: cassava

oak/CMakeLists.txt

@@ -25,6 +25,8 @@ set_target_properties(${target} PROPERTIES
     CXX_STANDARD_REQUIRED ON
 )
 target_include_directories(${target}
+  PRIVATE
+    "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>"
   PUBLIC
     "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>"
     "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>"

oak/include/oak/server.hpp

@@ -39,19 +39,6 @@ namespace oak {
 class ServerImplHandler;
 using ServerImpl = boost::network::http::server<ServerImplHandler>;
 
-class RequestStub : public cloe::Request {
- public:
-  cloe::RequestMethod method() const override { throw ERROR; }
-  cloe::ContentType type() const override { throw ERROR; }
-  const std::string& body() const override { throw ERROR; }
-  const std::string& uri() const override { throw ERROR; }
-  const std::string& endpoint() const override { throw ERROR; }
-  const std::map<std::string, std::string>& query_map() const override { throw ERROR; }
-
- private:
-  const std::logic_error ERROR = std::logic_error("using the request in any way is erroneous");
-};
-
 /**
  * ServerImplHandler is the main request handler for the server.
  *

oak/src/oak/registrar.cpp

@@ -28,6 +28,7 @@
 
 #include <cloe/core.hpp>   // for Json, logger::get
 #include "oak/server.hpp"  // for Server
+#include "oak/request_stub.hpp"  // for RequestStub
 
 namespace oak {
 

oak/src/oak/request_stub.hpp

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2023 Robert Bosch GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * \file oak/request_stub.hpp
+ */
+
+#pragma once
+
+#include <cloe/handler.hpp> // for Request
+
+namespace oak {
+
+class RequestStub : public cloe::Request {
+ public:
+  cloe::RequestMethod method() const override { throw ERROR; }
+  cloe::ContentType type() const override { throw ERROR; }
+  const std::string& body() const override { throw ERROR; }
+  const std::string& uri() const override { throw ERROR; }
+  const std::string& endpoint() const override { throw ERROR; }
+  const std::map<std::string, std::string>& query_map() const override { throw ERROR; }
+
+ private:
+  const std::logic_error ERROR = std::logic_error("using the request in any way is erroneous");
+};
+
+}  // namespace oak

oak/src/oak/server.cpp

@@ -40,6 +40,8 @@
 #include <cloe/handler.hpp>  // for Request
 using namespace cloe;        // NOLINT(build/namespaces)
 
+#include "oak/request_stub.hpp"  // for RequestStub
+
 namespace oak {
 
 namespace {