TocItemViewModel.cs

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

namespace Microsoft.DocAsCode.DataContracts.Common
{
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;

    using Newtonsoft.Json;
    using YamlDotNet.Serialization;

    using Microsoft.DocAsCode.Common;
    using Microsoft.DocAsCode.YamlSerialization;

    [Serializable]
    public class TocItemViewModel
    {
        [YamlMember(Alias = Constants.PropertyName.Uid)]
        [JsonProperty(Constants.PropertyName.Uid)]
        public string Uid { get; set; }

        [YamlMember(Alias = Constants.PropertyName.Name)]
        [JsonProperty(Constants.PropertyName.Name)]
        public string Name { get; set; }

        [YamlMember(Alias = Constants.PropertyName.DisplayName)]
        [JsonProperty(Constants.PropertyName.DisplayName)]
        public string DisplayName { get; set; }

        [ExtensibleMember(Constants.ExtensionMemberPrefix.Name)]
        [JsonIgnore]
        public SortedList<string, string> NameInDevLangs { get; } = new SortedList<string, string>();

        [YamlIgnore]
        [JsonIgnore]
        public string NameForCSharp
        {
            get
            {
                NameInDevLangs.TryGetValue(Constants.DevLang.CSharp, out string result);
                return result;
            }
            set { NameInDevLangs[Constants.DevLang.CSharp] = value; }
        }

        [YamlIgnore]
        [JsonIgnore]
        public string NameForVB
        {
            get
            {
                NameInDevLangs.TryGetValue(Constants.DevLang.VB, out string result);
                return result;
            }
            set { NameInDevLangs[Constants.DevLang.VB] = value; }
        }

        [YamlMember(Alias = Constants.PropertyName.Href)]
        [JsonProperty(Constants.PropertyName.Href)]
        public string Href { get; set; }

        [YamlMember(Alias = "originalHref")]
        [JsonProperty("originalHref")]
        public string OriginalHref { get; set; }

        [YamlMember(Alias = Constants.PropertyName.TocHref)]
        [JsonProperty(Constants.PropertyName.TocHref)]
        public string TocHref { get; set; }

        [YamlMember(Alias = "originalTocHref")]
        [JsonProperty("originalTocHref")]
        public string OriginalTocHref { get; set; }

        [YamlMember(Alias = Constants.PropertyName.TopicHref)]
        [JsonProperty(Constants.PropertyName.TopicHref)]
        public string TopicHref { get; set; }

        [YamlMember(Alias = "originalTopicHref")]
        [JsonProperty("originalTopicHref")]
        public string OriginalTopicHref { get; set; }

        [YamlIgnore]
        [JsonIgnore]
        public string AggregatedHref { get; set; }

        [YamlMember(Alias = "includedFrom")]
        [JsonProperty("includedFrom")]
        public string IncludedFrom { get; set; }

        [YamlMember(Alias = "homepage")]
        [JsonProperty("homepage")]
        public string Homepage { get; set; }

        [YamlMember(Alias = "originallHomepage")]
        [JsonProperty("originallHomepage")]
        public string OriginalHomepage { get; set; }

        [YamlMember(Alias = "homepageUid")]
        [JsonProperty("homepageUid")]
        public string HomepageUid { get; set; }

        [YamlMember(Alias = Constants.PropertyName.TopicUid)]
        [JsonProperty(Constants.PropertyName.TopicUid)]
        public string TopicUid { get; set; }

        [YamlIgnore]
        [JsonIgnore]
        public string AggregatedUid { get; set; }

        [YamlMember(Alias = "items")]
        [JsonProperty("items")]
        public TocViewModel Items { get; set; }

        [YamlIgnore]
        [JsonIgnore]
        public bool IsHrefUpdated { get; set; }

        [ExtensibleMember]
        [JsonIgnore]
        public Dictionary<string, object> Metadata { get; set; } = new Dictionary<string, object>();

        [EditorBrowsable(EditorBrowsableState.Never)]
        [YamlIgnore]
        [JsonExtensionData]
        public CompositeDictionary MetadataJson =>
            CompositeDictionary
                .CreateBuilder()
                .Add(Constants.ExtensionMemberPrefix.Name, NameInDevLangs, JTokenConverter.Convert<string>)
                .Add(string.Empty, Metadata)
                .Create();

        public TocItemViewModel Clone()
        {
            var cloned = (TocItemViewModel)this.MemberwiseClone();
            if (cloned.Items != null)
            {
                cloned.Items = Items.Clone();
            }
            return cloned;
        }

        public override string ToString()
        {
            var result = string.Empty;
            result += PropertyInfo(nameof(Name), Name);
            result += PropertyInfo(nameof(Href), Href);
            result += PropertyInfo(nameof(TopicHref), TopicHref);
            result += PropertyInfo(nameof(TocHref), TocHref);
            result += PropertyInfo(nameof(Uid), Uid);
            result += PropertyInfo(nameof(TopicUid), TopicUid);
            return result;

            string PropertyInfo(string name, string value)
            {
                if (string.IsNullOrEmpty(value))
                {
                    return string.Empty;
                }
                return $"{name}:{value} ";
            }
        }
    }
}