yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DataType refactoring preparation - Entity refactoring

Browse Source
This commit is contained in:
Stephan
2018-01-15 13:44:49 +01:00
parent d23933a5b1
commit cc47276095
16 changed files with 59 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/Umbraco.Core/Models/ContentBase.cs
View File

@@ -21,7 +21,6 @@ namespace Umbraco.Core.Models
{
private static readonly Lazy<PropertySelectors> Ps = new Lazy<PropertySelectors>();
private IDictionary<string, object> _additionalData;
private int _contentTypeId;
protected IContentTypeComposition ContentTypeBase;
private int _writerId;
@@ -74,17 +73,6 @@ namespace Umbraco.Core.Models
public readonly PropertyInfo WriterSelector = ExpressionHelper.GetPropertyInfo<ContentBase, int>(x => x.WriterId);
}
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[DataMember]
[DoNotClone]
IDictionary<string, object> IUmbracoEntity.AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[IgnoreDataMember]
bool IUmbracoEntity.HasAdditionalData => _additionalData != null;
protected void PropertiesChanged(object sender, NotifyCollectionChangedEventArgs e)
{
OnPropertyChanged(Ps.Value.PropertyCollectionSelector);

12
src/Umbraco.Core/Models/ContentTypeBase.cs
View File

@@ -21,7 +21,6 @@ namespace Umbraco.Core.Models
{
private static readonly Lazy<PropertySelectors> Ps = new Lazy<PropertySelectors>();
private IDictionary<string, object> _additionalData;
private string _alias;
private string _description;
private string _icon = "icon-folder";
@@ -71,17 +70,6 @@ namespace Umbraco.Core.Models
_variations = ContentVariation.InvariantNeutral;
}
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[DataMember]
[DoNotClone]
IDictionary<string, object> IUmbracoEntity.AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[IgnoreDataMember]
bool IUmbracoEntity.HasAdditionalData => _additionalData != null;
/// <summary>
/// Gets a value indicating whether the content type is publishing.
/// </summary>

12
src/Umbraco.Core/Models/DataType.cs
View File

@@ -15,7 +15,6 @@ namespace Umbraco.Core.Models
public class DataType : TreeEntityBase, IDataType
{
private static readonly Lazy<PropertySelectors> Ps = new Lazy<PropertySelectors>();
private IDictionary<string, object> _additionalData;
private string _propertyEditorAlias;
private DataTypeDatabaseType _databaseType;
@@ -45,17 +44,6 @@ namespace Umbraco.Core.Models
public readonly PropertyInfo DatabaseTypeSelector = ExpressionHelper.GetPropertyInfo<DataType, DataTypeDatabaseType>(x => x.DatabaseType);
}
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[DataMember]
[DoNotClone]
IDictionary<string, object> IUmbracoEntity.AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[IgnoreDataMember]
bool IUmbracoEntity.HasAdditionalData => _additionalData != null;
/// <inheritdoc />
[DataMember]
public string EditorAlias

15
src/Umbraco.Core/Models/Entities/IEntitySlim.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
namespace Umbraco.Core.Models.Entities
{
@@ -21,5 +22,19 @@ namespace Umbraco.Core.Models.Entities
/// Gets a value indicating whether the entity is a container.
/// </summary>
bool IsContainer { get; }
/// <summary>
/// Gets additional data for this entity.
/// </summary>
/// <remarks>Can be empty, but never null. To avoid allocating, do not
/// test for emptyness, but use <see cref="HasAdditionalData"/> instead.</remarks>
IDictionary<string, object> AdditionalData { get; }
/// <summary>
/// Determines whether this entity has additional data.
/// </summary>
/// <remarks>Use this property to check for additional data without
/// getting <see cref="AdditionalData"/>, to avoid allocating.</remarks>
bool HasAdditionalData { get; }
}
}

16
src/Umbraco.Core/Models/Entities/IUmbracoEntity.cs
View File

@@ -11,19 +11,5 @@ namespace Umbraco.Core.Models.Entities
/// <para>An IUmbracoEntity can participate in notifications.</para>
/// </remarks>
public interface IUmbracoEntity : ITreeEntity, IRememberBeingDirty
{
/// <summary>
/// Gets additional data for this entity.
/// </summary>
/// <remarks>Can be empty, but never null. To avoid allocating, do not
/// test for emptyness, but use <see cref="HasAdditionalData"/> instead.</remarks>
IDictionary<string, object> AdditionalData { get; }
/// <summary>
/// Determines whether this entity has additional data.
/// </summary>
/// <remarks>Use this property to check for additional data without
/// getting <see cref="AdditionalData"/>, to avoid allocating.</remarks>
bool HasAdditionalData { get; }
}
{ }
}

12
src/Umbraco.Core/Models/EntityContainer.cs
View File

@@ -13,7 +13,6 @@ namespace Umbraco.Core.Models
public sealed class EntityContainer : TreeEntityBase, IUmbracoEntity
{
private readonly Guid _containedObjectType;
private IDictionary<string, object> _additionalData;
private static readonly Dictionary<Guid, Guid> ObjectTypeMap = new Dictionary<Guid, Guid>
{
@@ -87,16 +86,5 @@ namespace Umbraco.Core.Models
throw new ArgumentException("Not a container object type.", nameof(containerObjectType));
return contained;
}
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[DataMember]
[DoNotClone]
IDictionary<string, object> IUmbracoEntity.AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[IgnoreDataMember]
bool IUmbracoEntity.HasAdditionalData => _additionalData != null;
}
}

7
src/Umbraco.Core/Models/EntityExtensions.cs
View File

@@ -18,5 +18,12 @@ namespace Umbraco.Core.Models
{
return entity.WasPropertyDirty("Id");
}
// fixme - MOVE!
public static object GetAdditionalDataValueIgnoreCase(this IMember entity, string key, object defaultVal)
{
if (entity.AdditionalData.ContainsKeyIgnoreCase(key) == false) return defaultVal;
return entity.AdditionalData.GetValueIgnoreCase(key, defaultVal);
}
}
}

15
src/Umbraco.Core/Models/IMember.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using Umbraco.Core.Models.Membership;
namespace Umbraco.Core.Models
@@ -14,5 +15,19 @@ namespace Umbraco.Core.Models
/// Gets the ContentType used by this content object
/// </summary>
IMemberType ContentType { get; }
/// <summary>
/// Gets additional data for this entity.
/// </summary>
/// <remarks>Can be empty, but never null. To avoid allocating, do not
/// test for emptyness, but use <see cref="HasAdditionalData"/> instead.</remarks>
IDictionary<string, object> AdditionalData { get; }
/// <summary>
/// Determines whether this entity has additional data.
/// </summary>
/// <remarks>Use this property to check for additional data without
/// getting <see cref="AdditionalData"/>, to avoid allocating.</remarks>
bool HasAdditionalData { get; }
}
}

14
src/Umbraco.Core/Models/Member.cs
View File

@@ -1,11 +1,13 @@
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Reflection;
using System.Runtime.Serialization;
using Umbraco.Core.Composing;
using Umbraco.Core.Exceptions;
using Umbraco.Core.Logging;
using Umbraco.Core.Models.Entities;
namespace Umbraco.Core.Models
{
@@ -16,6 +18,7 @@ namespace Umbraco.Core.Models
[DataContract(IsReference = true)]
public class Member : ContentBase, IMember
{
private IDictionary<string, object> _additionalData;
private IMemberType _contentType;
private readonly string _contentTypeAlias;
private string _username;
@@ -588,5 +591,16 @@ namespace Umbraco.Core.Models
return clone;
}
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[DataMember]
[DoNotClone]
public IDictionary<string, object> AdditionalData => _additionalData ?? (_additionalData = new Dictionary<string, object>());
/// <inheritdoc />
[EditorBrowsable(EditorBrowsableState.Never)]
[IgnoreDataMember]
public bool HasAdditionalData => _additionalData != null;
}
}

2
src/Umbraco.Core/Models/PathValidationExtensions.cs
View File

@@ -88,7 +88,7 @@ namespace Umbraco.Core.Models
if (entity.ValidatePath() == false)
{
logger.Warn(typeof(UmbracoEntityExtensions), $"The content item {entity.Id} has an invalid path: {entity.Path} with parentID: {entity.ParentId}");
logger.Warn(typeof(PathValidationExtensions), $"The content item {entity.Id} has an invalid path: {entity.Path} with parentID: {entity.ParentId}");
if (entity.ParentId == -1)
{
entity.Path = string.Concat("-1,", entity.Id);

14
src/Umbraco.Core/Models/UmbracoEntityExtensions.cs
View File

@@ -1,14 +0,0 @@
using Umbraco.Core.Models.Entities;
namespace Umbraco.Core.Models
{
// fixme - this needs to go or be refactored!
internal static class UmbracoEntityExtensions
{
public static object GetAdditionalDataValueIgnoreCase(this IUmbracoEntity entity, string key, object defaultVal)
{
if (entity.AdditionalData.ContainsKeyIgnoreCase(key) == false) return defaultVal;
return entity.AdditionalData.GetValueIgnoreCase(key, defaultVal);
}
}
}

1
src/Umbraco.Core/Umbraco.Core.csproj
View File

@@ -773,7 +773,6 @@
<Compile Include="Models\TemplateOnDisk.cs" />
<Compile Include="Models\UmbracoDomain.cs" />
<Compile Include="Models\Entities\EntitySlim.cs" />
<Compile Include="Models\UmbracoEntityExtensions.cs" />
<Compile Include="Models\UmbracoObjectTypes.cs" />
<Compile Include="Models\ObjectTypes.cs" />
<Compile Include="Models\UserExtensions.cs" />

10
src/Umbraco.Tests/Models/ContentTests.cs
View File

@@ -212,9 +212,6 @@ namespace Umbraco.Tests.Models
content.UpdateDate = DateTime.Now;
content.WriterId = 23;
((IUmbracoEntity)content).AdditionalData.Add("test1", 123);
((IUmbracoEntity)content).AdditionalData.Add("test2", "hello");
var runtimeCache = new ObjectCacheRuntimeCacheProvider();
runtimeCache.InsertCacheItem(content.Id.ToString(CultureInfo.InvariantCulture), () => content);
@@ -274,9 +271,6 @@ namespace Umbraco.Tests.Models
content.UpdateDate = DateTime.Now;
content.WriterId = 23;
((IUmbracoEntity)content).AdditionalData.Add("test1", 123);
((IUmbracoEntity)content).AdditionalData.Add("test2", "hello");
// Act
var clone = (Content)content.DeepClone();
@@ -285,7 +279,6 @@ namespace Umbraco.Tests.Models
Assert.AreEqual(clone, content);
Assert.AreEqual(clone.Id, content.Id);
Assert.AreEqual(clone.VersionId, content.VersionId);
Assert.AreEqual(((IUmbracoEntity)clone).AdditionalData, ((IUmbracoEntity)content).AdditionalData);
Assert.AreNotSame(clone.ContentType, content.ContentType);
Assert.AreEqual(clone.ContentType, content.ContentType);
Assert.AreEqual(clone.ContentType.PropertyGroups.Count, content.ContentType.PropertyGroups.Count);
@@ -380,9 +373,6 @@ namespace Umbraco.Tests.Models
content.UpdateDate = DateTime.Now;
content.WriterId = 23;
((IUmbracoEntity)content).AdditionalData.Add("test1", 123);
((IUmbracoEntity)content).AdditionalData.Add("test2", "hello");
var result = ss.ToStream(content);
var json = result.ResultStream.ToJsonString();
Debug.Print(json);

22
src/Umbraco.Tests/Models/ContentTypeTests.cs
View File

@@ -137,9 +137,6 @@ namespace Umbraco.Tests.Models
contentType.Trashed = false;
contentType.UpdateDate = DateTime.Now;
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
var proflog = GetTestProfilingLogger();
using (proflog.DebugDuration<ContentTypeTests>("STARTING PERF TEST"))
@@ -190,9 +187,6 @@ namespace Umbraco.Tests.Models
contentType.Trashed = false;
contentType.UpdateDate = DateTime.Now;
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
// Act
var clone = (ContentType)contentType.DeepClone();
@@ -200,7 +194,6 @@ namespace Umbraco.Tests.Models
Assert.AreNotSame(clone, contentType);
Assert.AreEqual(clone, contentType);
Assert.AreEqual(clone.Id, contentType.Id);
Assert.AreEqual(((IUmbracoEntity)clone).AdditionalData, ((IUmbracoEntity)contentType).AdditionalData);
Assert.AreEqual(clone.AllowedTemplates.Count(), contentType.AllowedTemplates.Count());
for (var index = 0; index < contentType.AllowedTemplates.Count(); index++)
{
@@ -291,9 +284,6 @@ namespace Umbraco.Tests.Models
contentType.Trashed = false;
contentType.UpdateDate = DateTime.Now;
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
var result = ss.ToStream(contentType);
var json = result.ResultStream.ToJsonString();
Debug.Print(json);
@@ -325,9 +315,6 @@ namespace Umbraco.Tests.Models
contentType.Trashed = false;
contentType.UpdateDate = DateTime.Now;
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
// Act
var clone = (MediaType)contentType.DeepClone();
@@ -335,7 +322,6 @@ namespace Umbraco.Tests.Models
Assert.AreNotSame(clone, contentType);
Assert.AreEqual(clone, contentType);
Assert.AreEqual(clone.Id, contentType.Id);
Assert.AreEqual(((IUmbracoEntity)clone).AdditionalData, ((IUmbracoEntity)contentType).AdditionalData);
Assert.AreEqual(clone.PropertyGroups.Count, contentType.PropertyGroups.Count);
for (var index = 0; index < contentType.PropertyGroups.Count; index++)
{
@@ -396,9 +382,6 @@ namespace Umbraco.Tests.Models
contentType.Trashed = false;
contentType.UpdateDate = DateTime.Now;
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
var result = ss.ToStream(contentType);
var json = result.ResultStream.ToJsonString();
Debug.Print(json);
@@ -431,8 +414,6 @@ namespace Umbraco.Tests.Models
contentType.UpdateDate = DateTime.Now;
contentType.SetMemberCanEditProperty("title", true);
contentType.SetMemberCanViewProperty("bodyText", true);
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
// Act
var clone = (MemberType)contentType.DeepClone();
@@ -441,7 +422,6 @@ namespace Umbraco.Tests.Models
Assert.AreNotSame(clone, contentType);
Assert.AreEqual(clone, contentType);
Assert.AreEqual(clone.Id, contentType.Id);
Assert.AreEqual(((IUmbracoEntity)clone).AdditionalData, ((IUmbracoEntity)contentType).AdditionalData);
Assert.AreEqual(clone.PropertyGroups.Count, contentType.PropertyGroups.Count);
for (var index = 0; index < contentType.PropertyGroups.Count; index++)
{
@@ -504,8 +484,6 @@ namespace Umbraco.Tests.Models
contentType.UpdateDate = DateTime.Now;
contentType.SetMemberCanEditProperty("title", true);
contentType.SetMemberCanViewProperty("bodyText", true);
((IUmbracoEntity)contentType).AdditionalData.Add("test1", 123);
((IUmbracoEntity)contentType).AdditionalData.Add("test2", "hello");
var result = ss.ToStream(contentType);
var json = result.ResultStream.ToJsonString();

10
src/Umbraco.Tests/Models/MemberTests.cs
View File

@@ -45,8 +45,8 @@ namespace Umbraco.Tests.Models
member.SortOrder = 5;
member.Trashed = false;
member.UpdateDate = DateTime.Now;
((IUmbracoEntity)member).AdditionalData.Add("test1", 123);
((IUmbracoEntity)member).AdditionalData.Add("test2", "hello");
member.AdditionalData.Add("test1", 123);
member.AdditionalData.Add("test2", "hello");
// Act
var clone = (Member)member.DeepClone();
@@ -56,7 +56,7 @@ namespace Umbraco.Tests.Models
Assert.AreEqual(clone, member);
Assert.AreEqual(clone.Id, member.Id);
Assert.AreEqual(clone.VersionId, member.VersionId);
Assert.AreEqual(((IUmbracoEntity)clone).AdditionalData, ((IUmbracoEntity)member).AdditionalData);
Assert.AreEqual(clone.AdditionalData, member.AdditionalData);
Assert.AreNotSame(clone.ContentType, member.ContentType);
Assert.AreEqual(clone.ContentType, member.ContentType);
Assert.AreEqual(clone.ContentType.PropertyGroups.Count, member.ContentType.PropertyGroups.Count);
@@ -144,8 +144,8 @@ namespace Umbraco.Tests.Models
member.SortOrder = 5;
member.Trashed = false;
member.UpdateDate = DateTime.Now;
((IUmbracoEntity)member).AdditionalData.Add("test1", 123);
((IUmbracoEntity)member).AdditionalData.Add("test2", "hello");
member.AdditionalData.Add("test1", 123);
member.AdditionalData.Add("test2", "hello");
var result = ss.ToStream(member);
var json = result.ResultStream.ToJsonString();

1
src/Umbraco.Web/Models/Mapping/MemberMapperProfile.cs
View File

@@ -198,6 +198,7 @@ namespace Umbraco.Web.Models.Mapping
// only when creating a new member and we want to have a generated password pre-filled.
Value = new Dictionary<string, object>
{
// fixme why ignoreCase, what are we doing here?!
{"generatedPassword", member.GetAdditionalDataValueIgnoreCase("GeneratedPassword", null)},
{"newPassword", member.GetAdditionalDataValueIgnoreCase("NewPassword", null)},
},