VkParameters.cs

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Runtime.Serialization;

namespace VkNet.Utils;

/// <inheritdoc />
/// <summary>
/// Параметры запроса к ВКонтакте.
/// </summary>
[Serializable]
public class VkParameters : Dictionary<string, string>
{
	/// <inheritdoc />
	/// <summary>
	/// Инициализирует новый экземпляр класса VkParameters
	/// </summary>
	public VkParameters()
	{
	}

	/// <summary>
	/// Инициализирует новый экземпляр класса <see cref="VkParameters" />
	/// </summary>
	protected VkParameters(SerializationInfo serializationInfo, StreamingContext streamingContext)
	{
	}

	/// <inheritdoc />
	/// <summary>
	/// Инициализирует новый экземпляр класса VkParameters
	/// </summary>
	/// <param name="parameters">
	/// Параметры запроса.
	/// </param>
	public VkParameters(IDictionary<string, string> parameters) : base(dictionary: parameters)
	{
	}

	/// <summary>
	/// Параметры для запроса без параметров.
	/// </summary>
	public static VkParameters Empty => new();

	/// <summary>
	/// Добавляет параметр запроса.
	/// </summary>
	/// <typeparam name="T"> Тип значения параметра запроса. </typeparam>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра запроса. </param>
	public void Add<T>(string name, T value)
	{
		Remove(key: name);

		// TODO: V3111 http://www.viva64.com/en/w/V3111 Checking value of 'value' for null will always return false when generic type is instantiated with a value type.
		if (value is null)
		{
			return;
		}

		if (typeof(T).IsEnum)
		{
			if (Utilities.IsStringEnum(value.GetType()))
			{
				Add(name, value.ToString()
					.ToSnakeCase());

				return;
			}

			Add(name, (int) (object) value);

			return;
		}

		var stringValue = value.ToString();

		if (!string.IsNullOrWhiteSpace(value: stringValue))
		{
			base.Add(name, stringValue);
		}
	}

	/// <summary>
	/// Добавляет параметр запроса, представляющий собой последовательность элементов
	/// заданного типа.
	/// Последовательность добавляется в виде строкового значения, содержащего ее
	/// элементы, разделенные запятой.
	/// </summary>
	/// <typeparam name="T"> Имя типа элементов последовательности. </typeparam>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="collection">
	/// Последовательность, представляющая значение параметра
	/// запроса.
	/// </param>
	public void Add<T>(string name, IEnumerable<T> collection)
	{
		Remove(key: name);

		if (collection is null)
		{
			return;
		}

		var value = collection.JoinNonEmpty();

		Add(name, value);
	}

	/// <summary>
	/// Добавляет именованный параметр запроса, представляющий собой коллекцию
	/// элементов заданного типа.
	/// Коллекция добавляетсяв виде строкового значения, содержащего ее элементы,
	/// разделенные запятой.
	/// </summary>
	/// <typeparam name="T"> Имя типа элементов коллекции. </typeparam>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="collection"> Коллекция, представляющая значение параметра запроса. </param>
	public void Add<T>(string name, List<T> collection) => Add(name, (IEnumerable<T>) collection);

	/// <summary>
	/// Добавляет параметр запроса.
	/// Если передан null, то добавление параметра не производится.
	/// </summary>
	/// <typeparam name="T"> Тип значения параметра запроса. </typeparam>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="nullableValue"> Значение параметра запроса. </param>
	public void Add<T>(string name, T? nullableValue)
		where T : struct
	{
		Remove(key: name);

		if (nullableValue is null)
		{
			return;
		}

		Add(name, nullableValue.Value);
	}

	/// <summary>
	/// Добавляет параметр-дату.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="dateTime"> Значение параметра. </param>
	public void Add(string name, DateTime dateTime) => Add(name, (DateTime?) dateTime);

	/// <summary>
	/// Добавляет параметр-дату.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="nullableDateTime"> Значение параметра. </param>
	[SuppressMessage("Minor Code Smell", "S6588", Justification = "Не поддерживается в netstandard2.0")]
	public void Add(string name, DateTime? nullableDateTime)
	{
		Remove(key: name);

		if (nullableDateTime is null)
		{
			return;
		}

		var totalSeconds =
			(nullableDateTime.Value.ToUniversalTime()
			- new DateTime(1970,
				1,
				1,
				0,
				0,
				0,
				DateTimeKind.Utc)).TotalSeconds;

		var offset = Convert.ToInt64(value: totalSeconds);

		Add(name, offset);
	}

	/// <summary>
	/// Добавляет логический параметр.
	/// Если передан null или значение параметра false, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="nullableValue"> Значение параметра. </param>
	public void Add(string name, bool? nullableValue)
	{
		Remove(key: name);

		if (!nullableValue.HasValue)
		{
			return;
		}

		base.Add(name, nullableValue.Value
			? "1"
			: "0");
	}

	/// <summary>
	/// Добавляет логический параметр.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, bool value)
	{
		Remove(key: name);

		base.Add(name, value
			? "1"
			: "0");
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, decimal value)
	{
		Remove(key: name);

		base.Add(name, value.ToString(provider: CultureInfo.InvariantCulture));
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, decimal? value)
	{
		Remove(key: name);

		if (value is null)
		{
			return;
		}

		base.Add(name, value.Value.ToString(provider: CultureInfo.InvariantCulture));
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, double value)
	{
		Remove(key: name);

		base.Add(name, value.ToString(provider: CultureInfo.InvariantCulture));
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, double? value)
	{
		Remove(key: name);

		if (value is null)
		{
			return;
		}

		base.Add(name, value.Value.ToString(provider: CultureInfo.InvariantCulture));
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, float value)
	{
		Remove(key: name);

		base.Add(name, value.ToString(provider: CultureInfo.InvariantCulture));
	}

	/// <summary>
	/// Добавляет параметр десятичное число.
	/// Если передан null, то добавление не производится.
	/// </summary>
	/// <param name="name"> Имя параметра запроса. </param>
	/// <param name="value"> Значение параметра. </param>
	public void Add(string name, float? value)
	{
		Remove(key: name);

		if (value is null)
		{
			return;
		}

		base.Add(name, value.Value.ToString(provider: CultureInfo.InvariantCulture));
	}
}