namespace GitConverter.Lib.Logging
{
    /// <summary>
    /// Provides reusable logging formatting utilities for structured log output.
    /// </summary>
    /// <remarks>
    /// - These helpers add visual structure to log files (separators, underlines, boxes).
    /// - All methods are static for convenience and accept an <see cref="IAppLogger"/> instance.
    /// - Useful for creating consistent, readable sections in diagnostic logs.
    /// </remarks>
    public static class LogHelper
    {
        /// <summary>
        /// Log a message with an underline using the specified character.
        /// </summary>
        /// <param name="logger">The logger instance to use.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="underlineChar">Character to use for underline (default: '=').</param>
        /// <remarks>
        /// Creates an underline that matches the message length. Useful for section headers.
        /// </remarks>
        public static void LogWithUnderline(IAppLogger logger, string message, char underlineChar = '=')
        {
            if (logger == null || string.IsNullOrEmpty(message)) return;
            logger.Info(message);
            logger.Info(new string(underlineChar, message.Length));
        }

        /// <summary>
        /// Log a message followed by a separator line of fixed length.
        /// </summary>
        /// <param name="logger">The logger instance to use.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="separatorChar">Character to use for separator (default: '-').</param>
        /// <param name="separatorLength">Length of the separator line (default: 80).</param>
        /// <remarks>
        /// Useful for creating visual sections in log files with consistent formatting.
        /// </remarks>
        public static void LogWithSeparator(IAppLogger logger, string message, char separatorChar = '-', int separatorLength = 80)
        {
            if (logger == null || string.IsNullOrEmpty(message)) return;
            logger.Info(message);
            logger.Info(new string(separatorChar, separatorLength));
        }

        /// <summary>
        /// Log a message within a box/frame.
        /// </summary>
        /// <param name="logger">The logger instance to use.</param>
        /// <param name="message">The message to log.</param>
        /// <param name="borderChar">Character to use for border (default: '=').</param>
        /// <remarks>
        /// Creates a bordered box around the message for emphasis in logs.
        /// </remarks>
        public static void LogWithBox(IAppLogger logger, string message, char borderChar = '=')
        {
            if (logger == null || string.IsNullOrEmpty(message)) return;
            var border = new string(borderChar, message.Length + 4);
            logger.Info(border);
            logger.Info($"| {message} |");
            logger.Info(border);
        }

        /// <summary>
        /// Log a blank line for spacing.
        /// </summary>
        /// <param name="logger">The logger instance to use.</param>
        public static void LogBlankLine(IAppLogger logger)
        {
            if (logger == null) return;
            logger.Info(string.Empty);
        }
    }
}