Skip to content

Commit

Permalink
Adding helpful methods for ContentPart, ContentType builders and Cont… (
Browse files Browse the repository at this point in the history 
#14717)
  • Loading branch information
@MikeAlhayek
MikeAlhayek committed Dec 1, 2023
1 parent c179620 commit abce5b6
Show file tree
Hide file tree
Showing 4 changed files with 124 additions and 62 deletions.
72 changes: 62 additions & 10 deletions src/OrchardCore/OrchardCore.ContentManagement.Abstractions/ContentItemExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,70 @@ namespace OrchardCore.ContentManagement
{
public static class ContentItemExtensions
{
/// <summary>
/// Tries to get a content part by its type.
/// </summary>
/// <typeparam name="TPart">The type of the content part.</typeparam>
/// <param name="contentItem">The <see cref="ContentItem"/>.</param>
/// <param name="part">The <see cref="ContentPart"/> if one existed.</param>
/// <returns>true if a part found, otherwise false.</returns>
public static bool TryGet<TPart>(this ContentItem contentItem, out TPart part) where TPart : ContentPart
=> contentItem.TryGet(typeof(TPart).Name, out part);

/// <summary>
/// Tries to get a content part by its type.
/// </summary>
/// <typeparam name="TPart">The type of the content part.</typeparam>
/// <param name="contentItem">The <see cref="ContentItem"/>.</param>
/// <param name="name">The name of the content part.</param>
/// <param name="part">The <see cref="ContentPart"/> if one existed.</param>
/// <returns>true if a part found, otherwise false.</returns>
public static bool TryGet<TPart>(this ContentItem contentItem, string name, out TPart part) where TPart : ContentPart
{
ArgumentException.ThrowIfNullOrEmpty(name, nameof(name));

try
{
part = contentItem.Get<TPart>(name);
}
catch
{
part = null;
}

return part != null;
}

/// <summary>
/// Tries to get a content part by its type.
/// </summary>
/// <param name="contentItem">The <see cref="ContentItem"/>.</param>
/// <param name="contentElementType">The type of the content part.</param>
/// <param name="name">The name of the content part.</param>
/// <param name="part">The <see cref="ContentPart"/> if one existed.</param>
/// <returns>true if a part found, otherwise false.</returns>
public static bool TryGet(this ContentItem contentItem, Type contentElementType, string name, out ContentElement part)
{
try
{
part = contentItem.Get(contentElementType, name);
}
catch
{
part = null;
}

return part != null;
}

/// <summary>
/// Gets a content part by its type.
/// </summary>
/// <param name="contentItem">The <see cref="ContentItem"/>.</param>
/// <typeparam name="TPart">The type of the content part.</typeparam>
/// <returns>The content part or <code>null</code> if it doesn't exist.</returns>
public static TPart As<TPart>(this ContentItem contentItem) where TPart : ContentPart
{
return contentItem.Get<TPart>(typeof(TPart).Name);
}
=> contentItem.Get<TPart>(typeof(TPart).Name);

/// <summary>
/// Gets a content part by its type or create a new one.
Expand All @@ -24,19 +78,15 @@ public static class ContentItemExtensions
/// <typeparam name="TPart">The type of the content part.</typeparam>
/// <returns>The content part instance or a new one if it doesn't exist.</returns>
public static TPart GetOrCreate<TPart>(this ContentItem contentItem) where TPart : ContentPart, new()
{
return contentItem.GetOrCreate<TPart>(typeof(TPart).Name);
}
=> contentItem.GetOrCreate<TPart>(typeof(TPart).Name);

/// <summary>
/// Removes a content part by its type.
/// </summary>
/// <param name="contentItem">The <see cref="ContentItem"/>.</param>
/// <typeparam name="TPart">The type of the content part.</typeparam>
public static void Remove<TPart>(this ContentItem contentItem) where TPart : ContentPart, new()
{
contentItem.Remove(typeof(TPart).Name);
}
=> contentItem.Remove(typeof(TPart).Name);

/// <summary>
/// Adds a content part by its type.
Expand All @@ -48,6 +98,7 @@ public static void Remove<TPart>(this ContentItem contentItem) where TPart : Con
public static ContentItem Weld<TPart>(this ContentItem contentItem, TPart part) where TPart : ContentPart
{
contentItem.Weld(typeof(TPart).Name, part);

return contentItem;
}

Expand All @@ -61,6 +112,7 @@ public static void Remove<TPart>(this ContentItem contentItem) where TPart : Con
public static ContentItem Apply<TPart>(this ContentItem contentItem, TPart part) where TPart : ContentPart
{
contentItem.Apply(typeof(TPart).Name, part);

return contentItem;
}

Expand Down Expand Up @@ -111,7 +163,7 @@ public static ContentItem Merge(this ContentItem contentItem, object properties,
contentItem.Data.Merge(props, jsonMergeSettings);
contentItem.Elements.Clear();

// Return to original value or it will be interpreated as a different object by YesSql.
// Return to original value or it will be interpreted as a different object by YesSql.
contentItem.Id = originalDocumentId;

// After merging content here we need to remove all the well known properties from the Data jObject
Expand Down
53 changes: 28 additions & 25 deletions ...hardCore.ContentManagement.Abstractions/Metadata/Builders/ContentPartDefinitionBuilder.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public ContentPartDefinitionBuilder(ContentPartDefinition existing)
if (existing == null)
{
_fields = new List<ContentPartFieldDefinition>();
_settings = new JObject();
_settings = [];
}
else
{
Expand Down Expand Up @@ -106,10 +106,7 @@ public ContentPartDefinitionBuilder MergeSettings<T>(Action<T> setting) where T

public ContentPartDefinitionBuilder WithSettings<T>(T settings)
{
if (settings == null)
{
throw new ArgumentNullException(nameof(settings));
}
ArgumentNullException.ThrowIfNull(settings, nameof(settings));

var jObject = JObject.FromObject(settings, ContentBuilderSettings.IgnoreDefaultValuesSerializer);
_settings[typeof(T).Name] = jObject;
Expand All @@ -118,16 +115,11 @@ public ContentPartDefinitionBuilder WithSettings<T>(T settings)
}

public ContentPartDefinitionBuilder WithField(string fieldName)
{
return WithField(fieldName, configuration => { });
}
=> WithField(fieldName, configuration => { });

public ContentPartDefinitionBuilder WithField(string fieldName, Action<ContentPartFieldDefinitionBuilder> configuration)
{
if (string.IsNullOrWhiteSpace(fieldName))
{
throw new ArgumentException($"'{nameof(fieldName)}' cannot be null or empty.");
}
ArgumentException.ThrowIfNullOrWhiteSpace(fieldName, nameof(fieldName));

var existingField = _fields.FirstOrDefault(x => string.Equals(x.Name, fieldName, StringComparison.OrdinalIgnoreCase));
if (existingField != null)
Expand All @@ -151,12 +143,28 @@ public ContentPartDefinitionBuilder WithField(string fieldName, Action<ContentPa
return this;
}

public ContentPartDefinitionBuilder WithField<TField>(string fieldName)
=> WithField(fieldName, configuration => configuration.OfType(typeof(TField).Name));

public ContentPartDefinitionBuilder WithField<TField>(string fieldName, Action<ContentPartFieldDefinitionBuilder> configuration)
=> WithField(fieldName, field =>
{
configuration(field);
field.OfType(typeof(TField).Name);
});

public Task<ContentPartDefinitionBuilder> WithFieldAsync<TField>(string fieldName, Func<ContentPartFieldDefinitionBuilder, Task> configuration)
=> WithFieldAsync(fieldName, async field =>
{
await configuration(field);
field.OfType(typeof(TField).Name);
});

public async Task<ContentPartDefinitionBuilder> WithFieldAsync(string fieldName, Func<ContentPartFieldDefinitionBuilder, Task> configurationAsync)
{
if (string.IsNullOrWhiteSpace(fieldName))
{
throw new ArgumentException($"'{nameof(fieldName)}' cannot be null or empty.");
}
ArgumentException.ThrowIfNullOrWhiteSpace(fieldName, nameof(fieldName));

var existingField = _fields.FirstOrDefault(x => string.Equals(x.Name, fieldName, StringComparison.OrdinalIgnoreCase));

Expand Down Expand Up @@ -214,19 +222,14 @@ public override ContentPartFieldDefinition Build()
}

public override string Name
{
get { return _fieldName; }
}
=> _fieldName;

public override string FieldType
{
get { return _fieldDefinition.Name; }
}
=> _fieldDefinition.Name;


public override string PartName
{
get { return _partDefinition.Name; }
}
=> _partDefinition.Name;

public override ContentPartFieldDefinitionBuilder OfType(ContentFieldDefinition fieldDefinition)
{
Expand Down
43 changes: 20 additions & 23 deletions ...hardCore.ContentManagement.Abstractions/Metadata/Builders/ContentTypeDefinitionBuilder.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class ContentTypeDefinitionBuilder
private readonly IList<ContentTypePartDefinition> _parts;
private readonly JObject _settings;

public ContentTypeDefinition Current { get; private set; }
public ContentTypeDefinition Current { get; }

public ContentTypeDefinitionBuilder()
: this(new ContentTypeDefinition(null, null))
Expand All @@ -29,7 +29,7 @@ public ContentTypeDefinitionBuilder(ContentTypeDefinition existing)
if (existing == null)
{
_parts = new List<ContentTypePartDefinition>();
_settings = new JObject();
_settings = [];
}
else
{
Expand Down Expand Up @@ -123,24 +123,13 @@ public ContentTypeDefinitionBuilder RemovePart(string partName)
}

public ContentTypeDefinitionBuilder WithPart(string partName)
{
return WithPart(partName, configuration => { });
}
=> WithPart(partName, configuration => { });

public ContentTypeDefinitionBuilder WithPart(string name, string partName)
{
return WithPart(name, new ContentPartDefinition(partName), configuration => { });
}

public ContentTypeDefinitionBuilder WithPart(string name, string partName, Action<ContentTypePartDefinitionBuilder> configuration)
{
return WithPart(name, new ContentPartDefinition(partName), configuration);
}
=> WithPart(name, new ContentPartDefinition(partName), configuration => { });

public ContentTypeDefinitionBuilder WithPart(string partName, Action<ContentTypePartDefinitionBuilder> configuration)
{
return WithPart(partName, new ContentPartDefinition(partName), configuration);
}
=> WithPart(partName, new ContentPartDefinition(partName), configuration);

public ContentTypeDefinitionBuilder WithPart(string name, ContentPartDefinition partDefinition, Action<ContentTypePartDefinitionBuilder> configuration)
{
Expand All @@ -163,15 +152,23 @@ public ContentTypeDefinitionBuilder WithPart(string name, ContentPartDefinition
return this;
}

public ContentTypeDefinitionBuilder WithPart(string name, string partName, Action<ContentTypePartDefinitionBuilder> configuration)
=> WithPart(name, new ContentPartDefinition(partName), configuration);

public ContentTypeDefinitionBuilder WithPart<TPart>() where TPart : ContentPart
=> WithPart(typeof(TPart).Name, configuration => { });

public ContentTypeDefinitionBuilder WithPart<TPart>(string name) where TPart : ContentPart
=> WithPart(name, new ContentPartDefinition(typeof(TPart).Name), configuration => { });

public ContentTypeDefinitionBuilder WithPart<TPart>(string name, Action<ContentTypePartDefinitionBuilder> configuration) where TPart : ContentPart
=> WithPart(name, new ContentPartDefinition(typeof(TPart).Name), configuration);

public Task<ContentTypeDefinitionBuilder> WithPartAsync(string name, string partName, Func<ContentTypePartDefinitionBuilder, Task> configurationAsync)
{
return WithPartAsync(name, new ContentPartDefinition(partName), configurationAsync);
}
=> WithPartAsync(name, new ContentPartDefinition(partName), configurationAsync);

public Task<ContentTypeDefinitionBuilder> WithPartAsync(string partName, Func<ContentTypePartDefinitionBuilder, Task> configurationAsync)
{
return WithPartAsync(partName, new ContentPartDefinition(partName), configurationAsync);
}
=> WithPartAsync(partName, new ContentPartDefinition(partName), configurationAsync);

public async Task<ContentTypeDefinitionBuilder> WithPartAsync(string name, ContentPartDefinition partDefinition, Func<ContentTypePartDefinitionBuilder, Task> configurationAsync)
{
Expand All @@ -183,7 +180,7 @@ public async Task<ContentTypeDefinitionBuilder> WithPartAsync(string name, Conte
}
else
{
existingPart = new ContentTypePartDefinition(name, partDefinition, new JObject())
existingPart = new ContentTypePartDefinition(name, partDefinition, [])
{
ContentTypeDefinition = Current,
};
Expand Down
18 changes: 14 additions & 4 deletions src/OrchardCore/OrchardCore.Infrastructure.Abstractions/Entities/EntityExtensions.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,23 @@ public static bool Has<T>(this IEntity entity)
/// <param name="name">The name of the property to check.</param>
/// <returns>True if the property was found, otherwise false.</returns>
public static bool Has(this IEntity entity, string name)
{
return entity.Properties[name] != null;
}
=> entity.Properties[name] != null;

public static IEntity Put<T>(this IEntity entity, T aspect) where T : new()
=> entity.Put(typeof(T).Name, aspect);

public static bool TryGet<T>(this IEntity entity, out T aspect) where T : new()
{
return entity.Put(typeof(T).Name, aspect);
if (entity.Properties.TryGetValue(typeof(T).Name, out var value))
{
aspect = value.ToObject<T>();

return true;
}

aspect = default;

return false;
}

public static IEntity Put(this IEntity entity, string name, object property)
Expand Down

0 comments on commit abce5b6

Please sign in to comment.