// Copyright (C) Stichting Deltares 2021. All rights reserved.
//
// This file is part of Riskeer.
//
// Riskeer is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using Core.Common.Util;
using Migration.Scripts.Data.Exceptions;

namespace Migration.Scripts.Data
{
    /// <summary>
    /// Class that provides methods for the creating an <see cref="IVersionedFile"/> for a specific version.
    /// </summary>
    public abstract class CreateScript
    {
        private readonly string version;

        /// <summary>
        /// Creates a new instance of the <see cref="CreateScript"/> class.
        /// </summary>
        /// <param name="version">The version for this <see cref="CreateScript"/>.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="version"/> is empty 
        /// or <c>null</c>.</exception>
        protected CreateScript(string version)
        {
            if (string.IsNullOrEmpty(version))
            {
                throw new ArgumentException(@"Version must have a value.", nameof(version));
            }

            this.version = version;
        }

        /// <summary>
        /// Creates a new <see cref="IVersionedFile"/> at <paramref name="location"/>.
        /// </summary>
        /// <param name="location">The location to store the <see cref="IVersionedFile"/>.</param>
        /// <returns>A new <see cref="IVersionedFile"/>.</returns>
        /// <exception cref="ArgumentException">Thrown when <paramref name="location"/>:
        /// <list type="bullet">
        /// <item>is empty or <c>null</c>,</item>
        /// <item>consists out of only whitespace characters,</item>
        /// <item>contains an invalid character,</item>
        /// <item>ends with a directory or path separator (empty file name).</item>
        /// </list></exception>
        /// <exception cref="CriticalMigrationException">Thrown when creating <see cref="IVersionedFile"/> 
        /// failed.</exception>
        /// <remarks>Creates the file if it does not exist.</remarks>
        public IVersionedFile CreateEmptyVersionedFile(string location)
        {
            IOUtils.CreateFileIfNotExists(location);
            return GetEmptyVersionedFile(location);
        }

        /// <summary>
        /// Returns the version <see cref="CreateScript"/> was created for.
        /// </summary>
        /// <returns>The version.</returns>
        public string GetVersion()
        {
            return version;
        }

        /// <summary>
        /// Creates a new <see cref="IVersionedFile"/> at <paramref name="location"/>.
        /// </summary>
        /// <param name="location">The location to store the <see cref="IVersionedFile"/>.</param>
        /// <returns>A new <see cref="IVersionedFile"/>.</returns>
        /// <remarks>The <paramref name="location"/> has been verified in <see cref="CreateEmptyVersionedFile"/>.</remarks>
        /// <exception cref="CriticalMigrationException">Thrown when creating <see cref="IVersionedFile"/> 
        /// failed.</exception>
        protected abstract IVersionedFile GetEmptyVersionedFile(string location);
    }
}