lsm/Orchard
1
0
Fork 0
mirror of https://github.com/OrchardCMS/Orchard.git synced 2025-10-08 00:14:31 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Orchard.Layouts: Simplifying Snippet Manifest parsing (#8149)

Browse Source
This commit is contained in:
Lombiq
2018-12-18 13:02:51 +01:00
parent bb8e109582
commit c91bd63fca
5 changed files with 45 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Orchard.Web/Modules/Orchard.Layouts/Models/SnippetFieldDescriptor.cs
View File

@@ -7,6 +7,6 @@ namespace Orchard.Layouts.Models {
public LocalizedString DisplayName { get; set; }
public LocalizedString Description { get; set; }
public bool IsValid => !(string.IsNullOrEmpty(Name) || string.IsNullOrEmpty(Type));
public bool IsValid => !string.IsNullOrEmpty(Name);
}
}

1
src/Orchard.Web/Modules/Orchard.Layouts/Orchard.Layouts.csproj
View File

@@ -363,6 +363,7 @@
<Compile Include="Helpers\SnippetHtmlExtensions.cs" />
<Compile Include="Helpers\StringHelper.cs" />
<Compile Include="Permissions.cs" />
<Compile Include="Serialization\LocalizedStringYamlConverter.cs" />
<Compile Include="Services\FormElementServices.cs" />
<Compile Include="Services\ICurrentThemeShapeBindingResolver.cs" />
<Compile Include="Services\CurrentThemeShapeBindingResolver.cs" />

70
src/Orchard.Web/Modules/Orchard.Layouts/Providers/SnippetElementHarvester.cs
View File

@@ -13,6 +13,7 @@ using Orchard.Layouts.Framework.Elements;
using Orchard.Layouts.Framework.Harvesters;
using Orchard.Layouts.Helpers;
using Orchard.Layouts.Models;
using Orchard.Layouts.Serialization;
using Orchard.Layouts.Services;
using Orchard.Layouts.Shapes;
using Orchard.Layouts.ViewModels;
@@ -20,7 +21,7 @@ using Orchard.Localization;
using Orchard.Themes.Services;
using Orchard.Tokens;
using Orchard.Utility.Extensions;
using YamlDotNet.RepresentationModel;
using YamlDotNet.Serialization;
namespace Orchard.Layouts.Providers {
[OrchardFeature("Orchard.Layouts.Snippets")]
@@ -35,6 +36,8 @@ namespace Orchard.Layouts.Providers {
private readonly Work<ITokenizer> _tokenizer;
private readonly IWorkContextAccessor _wca;
public Localizer T;
public SnippetElementHarvester(
IWorkContextAccessor workContextAccessor,
@@ -54,6 +57,8 @@ namespace Orchard.Layouts.Providers {
_tokenizer = tokenizer;
_currentThemeShapeBindingResolver = currentThemeShapeBindingResolver;
_wca = workContextAccessor;
T = NullLocalizer.Instance;
}
@@ -107,7 +112,7 @@ namespace Orchard.Layouts.Providers {
}
viewModel.FieldEditors = descriptor.Fields.Select(x => {
var fieldEditorTemplateName = String.Format("Elements.Snippet.Field.{0}", x.Type ?? "Text");
var fieldEditorTemplateName = $"Elements.Snippet.Field.{x.Type ?? "Text"}";
var fieldDescriptorViewModel = new SnippetFieldViewModel {
Descriptor = x,
Value = context.Element.Data.Get(x.Name)
@@ -151,64 +156,33 @@ namespace Orchard.Layouts.Providers {
if (!File.Exists(fullPath)) return null;
// Reading and parsing the manifest.
var manifestText = File.ReadAllText(fullPath);
var yaml = new YamlStream();
var deserializer = new DeserializerBuilder()
.IgnoreUnmatchedProperties()
.WithTypeConverter(new LocalizedStringYamlConverter())
.Build();
var descriptor = deserializer.Deserialize<SnippetDescriptor>(File.OpenText(fullPath));
yaml.Load(new StringReader(manifestText));
var manifest = (YamlMappingNode)yaml.Documents?[0]?.RootNode;
// Checking the validity of the parsed values, include those of the Snippet's Fields.
if (string.IsNullOrEmpty(descriptor.Category))
descriptor.Category = snippetElement.Category;
if (!manifest?.Children?.Any() ?? true) return null;
if (string.IsNullOrEmpty(descriptor.Description?.Text))
descriptor.Description = T("An element that renders the {0} shape.", shape.ShapeType);
// Extracting the main properties of the manifest.
var category = GetYamlMappingNodeChildByName(manifest, nameof(SnippetDescriptor.Category))?.ToString();
if (string.IsNullOrEmpty(category)) category = snippetElement.Category;
var description = GetYamlMappingNodeChildByName(manifest, nameof(SnippetDescriptor.Description))?.ToString();
if (string.IsNullOrEmpty(description)) description = $"An element that renders the {shape.ShapeType} shape.";
var displayName = GetYamlMappingNodeChildByName(manifest, nameof(SnippetDescriptor.DisplayName))?.ToString();
if (string.IsNullOrEmpty(displayName)) {
if (string.IsNullOrEmpty(descriptor.DisplayName?.Text)) {
var fileName = Path.GetFileNameWithoutExtension(shape.BindingSource) ?? "";
var lastIndex = fileName.IndexOf(SnippetShapeSuffix, StringComparison.OrdinalIgnoreCase);
displayName = fileName.Substring(0, lastIndex).CamelFriendly();
descriptor.DisplayName = T(fileName.Substring(0, lastIndex).CamelFriendly());
}
var toolboxIcon = GetYamlMappingNodeChildByName(manifest, nameof(SnippetDescriptor.ToolboxIcon))?.ToString();
if (string.IsNullOrEmpty(toolboxIcon)) toolboxIcon = snippetElement.ToolboxIcon;
if (string.IsNullOrEmpty(descriptor.ToolboxIcon))
descriptor.ToolboxIcon = snippetElement.ToolboxIcon;
var descriptor = new SnippetDescriptor {
Category = category,
Description = new LocalizedString(description),
DisplayName = new LocalizedString(displayName),
ToolboxIcon = toolboxIcon
};
// Extracting the editor fields from the manifest.
var fields = (YamlSequenceNode)GetYamlMappingNodeChildByName(manifest, nameof(SnippetDescriptor.Fields));
if (fields?.Any() ?? false) {
foreach (YamlMappingNode field in fields) {
descriptor.Fields.Add(new SnippetFieldDescriptor {
Description = new LocalizedString(GetYamlMappingNodeChildByName(field, nameof(SnippetFieldDescriptor.Description))?.ToString() ?? ""),
DisplayName = new LocalizedString(GetYamlMappingNodeChildByName(field, nameof(SnippetFieldDescriptor.DisplayName))?.ToString() ?? ""),
Name = GetYamlMappingNodeChildByName(field, nameof(SnippetFieldDescriptor.Name))?.ToString(),
Type = GetYamlMappingNodeChildByName(field, nameof(SnippetFieldDescriptor.Type))?.ToString()
});
}
descriptor.Fields = descriptor.Fields.Where(field => field.IsValid).ToList();
}
descriptor.Fields = descriptor.Fields.Where(field => field.IsValid).ToList();
return descriptor;
}
private YamlNode GetYamlMappingNodeChildByName(YamlMappingNode parent, string childNodeName) {
YamlNode yamlNode = null;
parent?.Children?.TryGetValue(new YamlScalarNode(childNodeName), out yamlNode);
return yamlNode;
}
private SnippetDescriptor DescribeSnippet(string shapeType, Snippet element) {
var shape = (dynamic)_shapeFactory.Value.Create(shapeType);
shape.Element = element;

16
src/Orchard.Web/Modules/Orchard.Layouts/Serialization/LocalizedStringYamlConverter.cs Normal file
View File

@@ -0,0 +1,16 @@
using System;
using Orchard.Localization;
using YamlDotNet.Core;
using YamlDotNet.Core.Events;
using YamlDotNet.Serialization;
namespace Orchard.Layouts.Serialization {
public class LocalizedStringYamlConverter : IYamlTypeConverter {
public bool Accepts(Type type) => type == typeof(LocalizedString);
public object ReadYaml(IParser parser, Type type) => new LocalizedString(parser.Expect<Scalar>()?.Value);
public void WriteYaml(IEmitter emitter, object value, Type type) =>
emitter.Emit(new Scalar((value as LocalizedString)?.Text ?? ""));
}
}

6
src/Orchard.Web/Modules/Orchard.Layouts/Views/EditorTemplates/Elements.Snippet.Field.Text.cshtml
View File

@@ -1,10 +1,14 @@
@model Orchard.Layouts.ViewModels.SnippetFieldViewModel
@{
var field = Model;
}
<div class="form-group">
@Html.Label(field.Descriptor.Name, field.Descriptor.DisplayName.ToString())
@Html.Label(field.Descriptor.Name, field.Descriptor.DisplayName?.Text ?? field.Descriptor.Name)
@Html.TextBox(field.Descriptor.Name, field.Value, new { @class = "text large" })
@if (field.Descriptor.Description != null) {
@Html.Hint(field.Descriptor.Description)
}