Convert console/file logger creators to free functions

fly::logger::Logger::create_console_logger was just a bit verbose.

Author: trflynn89

bench/main.cpp

@@ -70,7 +70,7 @@ CATCH_REGISTER_REPORTER("libfly", SilentReporter)
 
 int main(int argc, char **argv)
 {
-    fly::logger::Logger::set_default_logger(fly::logger::Logger::create_logger(
+    fly::logger::Logger::set_default_logger(fly::logger::Logger::create(
         "silent",
         std::make_shared<fly::logger::LoggerConfig>(),
         std::make_unique<DropSink>()));

fly/logger/logger.cpp

@@ -11,6 +11,63 @@
 
 namespace fly::logger {
 
+//==================================================================================================
+std::shared_ptr<Logger> create_file_logger(
+    std::string name,
+    std::shared_ptr<LoggerConfig> logger_config,
+    std::shared_ptr<fly::coders::CoderConfig> coder_config,
+    std::filesystem::path logger_directory)
+{
+    return create_file_logger(
+        std::move(name),
+        nullptr,
+        std::move(logger_config),
+        std::move(coder_config),
+        std::move(logger_directory));
+}
+
+//==================================================================================================
+std::shared_ptr<Logger> create_file_logger(
+    std::string name,
+    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
+    std::shared_ptr<LoggerConfig> logger_config,
+    std::shared_ptr<fly::coders::CoderConfig> coder_config,
+    std::filesystem::path logger_directory)
+{
+    auto sink = std::make_unique<detail::FileSink>(
+        logger_config,
+        std::move(coder_config),
+        std::move(logger_directory));
+
+    return Logger::create(
+        std::move(name),
+        std::move(task_runner),
+        std::move(logger_config),
+        std::move(sink));
+}
+
+//==================================================================================================
+std::shared_ptr<Logger>
+create_console_logger(std::string name, std::shared_ptr<LoggerConfig> logger_config)
+{
+    return create_console_logger(std::move(name), nullptr, logger_config);
+}
+
+//==================================================================================================
+std::shared_ptr<Logger> create_console_logger(
+    std::string name,
+    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
+    std::shared_ptr<LoggerConfig> logger_config)
+{
+    auto sink = std::make_unique<detail::ConsoleSink>();
+
+    return Logger::create(
+        std::move(name),
+        std::move(task_runner),
+        std::move(logger_config),
+        std::move(sink));
+}
+
 //==================================================================================================
 Logger::Logger(
     std::string name,
@@ -32,16 +89,16 @@ Logger::~Logger()
 }
 
 //==================================================================================================
-std::shared_ptr<Logger> Logger::create_logger(
+std::shared_ptr<Logger> Logger::create(
     std::string name,
     std::shared_ptr<LoggerConfig> logger_config,
     std::unique_ptr<Sink> &&sink)
 {
-    return create_logger(std::move(name), nullptr, std::move(logger_config), std::move(sink));
+    return create(std::move(name), nullptr, std::move(logger_config), std::move(sink));
 }
 
 //==================================================================================================
-std::shared_ptr<Logger> Logger::create_logger(
+std::shared_ptr<Logger> Logger::create(
     std::string name,
     std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
     std::shared_ptr<LoggerConfig> logger_config,
@@ -79,63 +136,6 @@ std::shared_ptr<Logger> Logger::create_logger(
     return nullptr;
 }
 
-//==================================================================================================
-std::shared_ptr<Logger> Logger::create_file_logger(
-    std::string name,
-    std::shared_ptr<LoggerConfig> logger_config,
-    std::shared_ptr<fly::coders::CoderConfig> coder_config,
-    std::filesystem::path logger_directory)
-{
-    return create_file_logger(
-        std::move(name),
-        nullptr,
-        std::move(logger_config),
-        std::move(coder_config),
-        std::move(logger_directory));
-}
-
-//==================================================================================================
-std::shared_ptr<Logger> Logger::create_file_logger(
-    std::string name,
-    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
-    std::shared_ptr<LoggerConfig> logger_config,
-    std::shared_ptr<fly::coders::CoderConfig> coder_config,
-    std::filesystem::path logger_directory)
-{
-    auto sink = std::make_unique<detail::FileSink>(
-        logger_config,
-        std::move(coder_config),
-        std::move(logger_directory));
-
-    return create_logger(
-        std::move(name),
-        std::move(task_runner),
-        std::move(logger_config),
-        std::move(sink));
-}
-
-//==================================================================================================
-std::shared_ptr<Logger>
-Logger::create_console_logger(std::string name, std::shared_ptr<LoggerConfig> logger_config)
-{
-    return create_console_logger(std::move(name), nullptr, logger_config);
-}
-
-//==================================================================================================
-std::shared_ptr<Logger> Logger::create_console_logger(
-    std::string name,
-    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
-    std::shared_ptr<LoggerConfig> logger_config)
-{
-    auto sink = std::make_unique<detail::ConsoleSink>();
-
-    return create_logger(
-        std::move(name),
-        std::move(task_runner),
-        std::move(logger_config),
-        std::move(sink));
-}
-
 //==================================================================================================
 void Logger::set_default_logger(std::shared_ptr<Logger> default_logger)
 {

fly/logger/logger.hpp

@@ -109,13 +109,73 @@ class SequencedTaskRunner;
 
 namespace fly::logger {
 
+class Logger;
 class LoggerConfig;
 class Sink;
 
 namespace detail {
     class Registry;
 } // namespace detail
 
+/**
+ * Create a synchronous file logger.
+ *
+ * @param name Name of the logger to create.
+ * @param logger_config Reference to the logger configuration.
+ * @param coder_config Reference to the coder configuration.
+ * @param logger_directory Path to store log files.
+ *
+ * @return The created logger, or null if the logger could not be initialized.
+ */
+std::shared_ptr<Logger> create_file_logger(
+    std::string name,
+    std::shared_ptr<LoggerConfig> logger_config,
+    std::shared_ptr<fly::coders::CoderConfig> coder_config,
+    std::filesystem::path logger_directory);
+
+/**
+ * Create an asynchronous file logger.
+ *
+ * @param name Name of the logger to create.
+ * @param task_runner The sequence on which logs are streamed.
+ * @param logger_config Reference to the logger configuration.
+ * @param coder_config Reference to the coder configuration.
+ * @param logger_directory Path to store log files.
+ *
+ * @return The created logger, or null if the logger could not be initialized.
+ */
+std::shared_ptr<Logger> create_file_logger(
+    std::string name,
+    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
+    std::shared_ptr<LoggerConfig> logger_config,
+    std::shared_ptr<fly::coders::CoderConfig> coder_config,
+    std::filesystem::path logger_directory);
+
+/**
+ * Create a synchronous console logger.
+ *
+ * @param name Name of the logger to create.
+ * @param logger_config Reference to the logger configuration.
+ *
+ * @return The created logger, or null if the logger could not be initialized.
+ */
+std::shared_ptr<Logger>
+create_console_logger(std::string name, std::shared_ptr<LoggerConfig> logger_config);
+
+/**
+ * Create an asynchronous console logger.
+ *
+ * @param name Name of the logger to create.
+ * @param task_runner The sequence on which logs are streamed.
+ * @param logger_config Reference to the logger configuration.
+ *
+ * @return The created logger, or null if the logger could not be initialized.
+ */
+std::shared_ptr<Logger> create_console_logger(
+    std::string name,
+    std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
+    std::shared_ptr<LoggerConfig> logger_config);
+
 /**
  * Logging class to provide configurable instrumentation. There are 4 levels of instrumentation:
  *
@@ -159,7 +219,7 @@ class Logger : public std::enable_shared_from_this<Logger>
      *
      * @return The created logger, or null if the logger could not be initialized.
      */
-    static std::shared_ptr<Logger> create_logger(
+    static std::shared_ptr<Logger> create(
         std::string name,
         std::shared_ptr<LoggerConfig> logger_config,
         std::unique_ptr<Sink> &&sink);
@@ -174,71 +234,12 @@ class Logger : public std::enable_shared_from_this<Logger>
      *
      * @return The created logger, or null if the logger could not be initialized.
      */
-    static std::shared_ptr<Logger> create_logger(
+    static std::shared_ptr<Logger> create(
         std::string name,
         std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
         std::shared_ptr<LoggerConfig> logger_config,
         std::unique_ptr<Sink> &&sink);
 
-    /**
-     * Create a synchronous file logger.
-     *
-     * @param name Name of the logger to create.
-     * @param logger_config Reference to the logger configuration.
-     * @param coder_config Reference to the coder configuration.
-     * @param logger_directory Path to store log files.
-     *
-     * @return The created logger, or null if the logger could not be initialized.
-     */
-    static std::shared_ptr<Logger> create_file_logger(
-        std::string name,
-        std::shared_ptr<LoggerConfig> logger_config,
-        std::shared_ptr<fly::coders::CoderConfig> coder_config,
-        std::filesystem::path logger_directory);
-
-    /**
-     * Create an asynchronous file logger.
-     *
-     * @param name Name of the logger to create.
-     * @param task_runner The sequence on which logs are streamed.
-     * @param logger_config Reference to the logger configuration.
-     * @param coder_config Reference to the coder configuration.
-     * @param logger_directory Path to store log files.
-     *
-     * @return The created logger, or null if the logger could not be initialized.
-     */
-    static std::shared_ptr<Logger> create_file_logger(
-        std::string name,
-        std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
-        std::shared_ptr<LoggerConfig> logger_config,
-        std::shared_ptr<fly::coders::CoderConfig> coder_config,
-        std::filesystem::path logger_directory);
-
-    /**
-     * Create a synchronous console logger.
-     *
-     * @param name Name of the logger to create.
-     * @param logger_config Reference to the logger configuration.
-     *
-     * @return The created logger, or null if the logger could not be initialized.
-     */
-    static std::shared_ptr<Logger>
-    create_console_logger(std::string name, std::shared_ptr<LoggerConfig> logger_config);
-
-    /**
-     * Create an asynchronous console logger.
-     *
-     * @param name Name of the logger to create.
-     * @param task_runner The sequence on which logs are streamed.
-     * @param logger_config Reference to the logger configuration.
-     *
-     * @return The created logger, or null if the logger could not be initialized.
-     */
-    static std::shared_ptr<Logger> create_console_logger(
-        std::string name,
-        std::shared_ptr<fly::task::SequencedTaskRunner> task_runner,
-        std::shared_ptr<LoggerConfig> logger_config);
-
     /**
      * Set the default logger instance for the LOG* macro functions. If the provided logger is null,
      * the default logger is reset to the initial synchronous console logger.

test/logger/console_logger.cpp

@@ -11,9 +11,8 @@
 
 CATCH_TEST_CASE("ConsoleLogger", "[logger]")
 {
-    auto logger = fly::logger::Logger::create_console_logger(
-        "test",
-        std::make_shared<fly::logger::LoggerConfig>());
+    auto logger =
+        fly::logger::create_console_logger("test", std::make_shared<fly::logger::LoggerConfig>());
 
     CATCH_SECTION("Debug log points")
     {

test/logger/file_logger.cpp

@@ -106,8 +106,7 @@ CATCH_TEST_CASE("FileLogger", "[logger]")
     auto coder_config = std::make_shared<MutableCoderConfig>();
     fly::test::PathUtil::ScopedTempDirectory path;
 
-    auto logger =
-        fly::logger::Logger::create_file_logger("test", logger_config, coder_config, path());
+    auto logger = fly::logger::create_file_logger("test", logger_config, coder_config, path());
 
     CATCH_SECTION("Valid logger file paths should be created after creating logger")
     {
@@ -119,8 +118,7 @@ CATCH_TEST_CASE("FileLogger", "[logger]")
 
     CATCH_SECTION("Cannot start logger with a bad file path")
     {
-        logger =
-            fly::logger::Logger::create_file_logger("test", logger_config, coder_config, __FILE__);
+        logger = fly::logger::create_file_logger("test", logger_config, coder_config, __FILE__);
         CATCH_CHECK(logger == nullptr);
     }