DataType refactoring preparation - Entity refactoring

src/Umbraco.Core/Models/Entities/EntitySlim.cs

@@ -0,0 +1,220 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.Serialization;
+using Umbraco.Core.Exceptions;
+
+namespace Umbraco.Core.Models.Entities
+{
+    // fixme - changing the name of some properties that were in additionalData => must update corresponding javascript?
+
+    /// <summary>
+    /// Implementation of <see cref="IEntitySlim"/> for internal use.
+    /// </summary>
+    /// <remarks>
+    /// <para>Although it implements <see cref="IEntitySlim"/>, this class does not 
+    /// implement <see cref="IRememberBeingDirty"/> and everything this interface defines, throws.</para>
+    /// <para>Although it implements <see cref="IEntitySlim"/>, this class does not
+    /// implement <see cref="IDeepCloneable"/> and deep-cloning throws.</para>
+    /// </remarks>
+    public class EntitySlim : IEntitySlim
+    {
+        private IDictionary<string, object> _additionalData;
+
+        /// <summary>
+        /// Gets an entity representing "root".
+        /// </summary>
+        public static readonly IEntitySlim Root = new EntitySlim { Path = "-1", Name = "root", HasChildren = true };
+
+
+        // implement IEntity
+
+        /// <inheritdoc />
+        [DataMember]
+        public int Id { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public Guid Key { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public DateTime CreateDate { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public DateTime UpdateDate { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public DateTime? DeleteDate { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public bool HasIdentity => Id != 0;
+
+
+        // implement ITreeEntity
+
+        /// <inheritdoc />
+        [DataMember]
+        public string Name { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public int CreatorId { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public int ParentId { get; set; }
+
+        /// <inheritdoc />
+        public void SetParent(ITreeEntity parent) => throw new WontImplementException();
+
+        /// <inheritdoc />
+        [DataMember]
+        public int Level { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public string Path { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public int SortOrder { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public bool Trashed { get; set; }
+
+
+        // implement IUmbracoEntity
+
+        /// <inheritdoc />
+        [DataMember]
+        public IDictionary<string, object> AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
+
+        /// <inheritdoc />
+        [IgnoreDataMember]
+        public bool HasAdditionalData => _additionalData != null;
+
+
+        // implement IEntitySlim
+
+        /// <inheritdoc />
+        [DataMember]
+        public Guid NodeObjectType { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public bool HasChildren { get; set; }
+
+        /// <inheritdoc />
+        [DataMember]
+        public virtual bool IsContainer { get; set; }
+
+
+        /// <summary>
+        /// Represents a lightweight property.
+        /// </summary>
+        public class PropertySlim
+        {
+            /// <summary>
+            /// Initializes a new instance of the <see cref="PropertySlim"/> class.
+            /// </summary>
+            public PropertySlim(string editorAlias, object value)
+            {
+                PropertyEditorAlias = editorAlias;
+                Value = value;
+            }
+
+            /// <summary>
+            /// Gets the property editor alias.
+            /// </summary>
+            public string PropertyEditorAlias { get; }
+
+            /// <summary>
+            /// Gets the property value.
+            /// </summary>
+            public object Value { get; }
+
+            protected bool Equals(PropertySlim other)
+            {
+                return PropertyEditorAlias.Equals(other.PropertyEditorAlias) && Equals(Value, other.Value);
+            }
+
+            public override bool Equals(object obj)
+            {
+                if (ReferenceEquals(null, obj)) return false;
+                if (ReferenceEquals(this, obj)) return true;
+                if (obj.GetType() != GetType()) return false;
+                return Equals((PropertySlim) obj);
+            }
+
+            public override int GetHashCode()
+            {
+                unchecked
+                {
+                    return (PropertyEditorAlias.GetHashCode() * 397) ^ (Value != null ? Value.GetHashCode() : 0);
+                }
+            }
+        }
+
+        #region IDeepCloneable
+
+        /// <inheritdoc />
+        public object DeepClone()
+        {
+            throw new WontImplementException();
+        }
+
+        #endregion
+
+        #region IRememberBeingDirty
+
+        // IEntitySlim does *not* track changes, but since it indirectly implements IUmbracoEntity,
+        // and therefore IRememberBeingDirty, we have to have those methods - which all throw.
+
+        public bool IsDirty()
+        {
+            throw new WontImplementException();
+        }
+
+        public bool IsPropertyDirty(string propName)
+        {
+            throw new WontImplementException();
+        }
+
+        public IEnumerable<string> GetDirtyProperties()
+        {
+            throw new WontImplementException();
+        }
+
+        public void ResetDirtyProperties()
+        {
+            throw new WontImplementException();
+        }
+
+        public bool WasDirty()
+        {
+            throw new WontImplementException();
+        }
+
+        public bool WasPropertyDirty(string propertyName)
+        {
+            throw new WontImplementException();
+        }
+
+        public void ResetWereDirtyProperties()
+        {
+            throw new WontImplementException();
+        }
+
+        public void ResetDirtyProperties(bool rememberDirty)
+        {
+            throw new WontImplementException();
+        }
+
+        #endregion
+    }
+}