// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Diagnostics.CodeAnalysis;

using Microsoft.VisualStudio.TestPlatform.CoreUtilities;

namespace Microsoft.VisualStudio.TestPlatform.ObjectModel.Utilities;

/// <summary>
/// Utility methods for manipulating strings.
/// </summary>
public static class StringUtilities
{
    /// <summary>
    /// Prepares the string for output by converting null values to the "(null)" string
    /// and removing any trailing new lines.
    /// </summary>
    /// <param name="input">The input string.</param>
    /// <returns>The string that is prepared for output.</returns>
    public static string PrepareForOutput(string? input)
    {
        string? result = input;
        result ??= Resources.Resources.NullString;

        result = result.TrimEnd(Environment.NewLine.ToCharArray());

        return result;
    }

    /// <summary>
    /// Checks if given string is null or a whitespace.
    /// </summary>
    /// <param name="input">string to check</param>
    /// <returns>True if string is null or a whitespace, false otherwise</returns>
    public static bool IsNullOrWhiteSpace([NotNullWhen(false)] string? input)
    {
        if (input != null)
        {
            input = input.Trim();
        }

        return input.IsNullOrEmpty();
    }
}