SAE-2.01/MCTG/Model/RecipeCollection.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Text;

namespace Model
{
    /// <summary>
    /// Define a collection of <see cref="Recipe"/>.
    /// <br/>This class implement <see cref="IList"/> and <see cref="IEquatable{T}"/>.
    /// </summary>
    public class RecipeCollection : IList<Recipe>, IEquatable<RecipeCollection>
    {
        #region Attributes
        private List<Recipe> recipes;
        private string? _description;
        #endregion

        #region Properties
        /// <summary>
        /// A short description of what this collection contain. <br/>
        /// Set to "No description." when the value passed is null, empty or contain white spaces.
        /// </summary>
        public string? Description
        {
            get => _description;
            set
            {
                if (string.IsNullOrWhiteSpace(value))
                    _description = "No description.";
                else
                    _description = value;
            }
        }

        #region IList Prperties
        public int Count => recipes.Count;
        public bool IsReadOnly => false;
        public Recipe this[int index] { get => recipes[index]; set => recipes[index] = value; }
        #endregion
        #endregion

        #region Constructors
        /// <summary>
        /// Construct a new collection of recipes.
        /// </summary>
        /// <param name="description">A short description of what this list will contain</param>
        /// <param name="recipes">Recipes to add in this new collection</param>
        public RecipeCollection(string? description = null, params Recipe[] recipes)
        {
            this.recipes = new List<Recipe>(recipes);
            Description = description;
        }
        #endregion

        #region Methods
        /// <summary>
        /// Find a recipe in this list by giving the id.
        /// </summary>
        /// <param name="id">The id of the list we are looking for</param>
        /// <returns>The recipe of the id given</returns>
        /// <exception cref="ArgumentException"/>
        public Recipe? GetRecipeById(int id)
        {
            Recipe? recipe = recipes.Find(r => r.Id == id);
            if (recipe == null) throw new ArgumentException("No recipes match the given id.");
            return recipe;
        }

        #region IList Methods
        public int IndexOf(Recipe item)
        {
            return recipes.IndexOf(item);
        }

        public void Insert(int index, Recipe item)
        {
            recipes.Insert(index, item);
        }

        public void RemoveAt(int index)
        {
            recipes.RemoveAt(index);
        }

        public void Add(Recipe item)
        {
            recipes.Add(item);
        }

        public void Clear()
        {
            recipes.Clear();
        }

        public bool Contains(Recipe item)
        {
            return recipes.Contains(item);
        }

        public void CopyTo(Recipe[] array, int arrayIndex)
        {
            recipes.CopyTo(array, arrayIndex);
        }

        public bool Remove(Recipe item)
        {
            return recipes.Remove(item);
        }

        public IEnumerator<Recipe> GetEnumerator()
        {
            return recipes.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return recipes.GetEnumerator();
        }
        #endregion

        public bool Equals(RecipeCollection? other)
        {
            if (other == null) return false;
            if (other == this) return true;
            return Description.Equals(other.Description) && recipes.Equals(other.recipes);
        }

        public override int GetHashCode()
        {
            return Description.GetHashCode() + recipes.GetHashCode();
        }

        public override string ToString()
        {
            StringBuilder sb = new StringBuilder($"[RecipeCollection] - {Description}:\n");
            foreach (Recipe r in recipes)
            {
                sb.AppendFormat("\t - {0}\n", r.ToString());
            }
            return sb.ToString();
        }
        #endregion
    }
}