Skip to content
This repository was archived by the owner on Dec 19, 2018. It is now read-only.

Commit ab88a63

Browse files
author
NTaylorMullen
committed
Add TagHelperDescriptorResolver.
- This involved also adding a TagHelperTypeResolver and TagHelperDescriptorFactory. - The TagHelperTypeResolver is responsible for determining the format of lookup text's used throughout the tag helper system. By default it handles the following formats: "assemblyName" "specificType, assemblyName" - It also restricts what types are considered TagHelpers. In this implementation we only accept public, non-nested, non-abstract, non-generic TagHelpers. - The TagHelperDescriptorFactory is responsible for converting a Type to a TagHelperDescriptor. - Added tests to validate TagHelperDescriptorResolver, TagHelperTypeResolver and TagHelperDescriptorFactory. #99 #158
1 parent da3051a commit ab88a63

File tree

15 files changed

+501
-32
lines changed

15 files changed

+501
-32
lines changed

‎src/Microsoft.AspNet.Razor.Runtime/AssemblyInfo.cs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System.Runtime.CompilerServices;
5+
6+
[assembly: InternalsVisibleTo("Microsoft.AspNet.Razor.Runtime.Test")]

‎src/Microsoft.AspNet.Razor.Runtime/NotNullArgument.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
6+
namespace Microsoft.AspNet.Razor.Runtime
7+
{
8+
[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false)]
9+
internal sealed class NotNullAttribute : Attribute
10+
{
11+
}
12+
}

‎src/Microsoft.AspNet.Razor.Runtime/Properties/Resources.Designer.cs‎

Lines changed: 82 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Microsoft.AspNet.Razor.Runtime/Resources.resx‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="TagHelperDescriptorResolver_InvalidTagHelperLookupText" xml:space="preserve">
121+
<value>Invalid tag helper directive look up text '{0}'. The correct look up text formats are:
122+
"assemblyName"
123+
"typeName, assemblyName"</value>
124+
</data>
125+
<data name="TagHelperTypeResolver_CannotResolveTagHelperAssembly" xml:space="preserve">
126+
<value>Cannot resolve TagHelper containing assembly '{0}'. Error: '{1}'.</value>
127+
</data>
128+
<data name="TagHelperTypeResolver_TagHelperAssemblyNameCannotBeEmptyOrNull" xml:space="preserve">
129+
<value>Tag helper directive assembly name cannot be null or empty.</value>
130+
</data>
131+
</root>

‎src/Microsoft.AspNet.Razor.Runtime/TagHelpers/ITagHelper.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
6+
namespace Microsoft.AspNet.Razor.Runtime.TagHelpers
7+
{
8+
public interface ITagHelper
9+
{
10+
// TODO: Will be implemented in https://github.com/aspnet/razor/issues/154
11+
}
12+
}

‎src/Microsoft.AspNet.Razor.Runtime/TagHelpers/TagHelperDescriptorFactory.cs‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using System.Reflection;
8+
using Microsoft.AspNet.Razor.TagHelpers;
9+
10+
namespace Microsoft.AspNet.Razor.Runtime.TagHelpers
11+
{
12+
/// <summary>
13+
/// Factory for <see cref="TagHelperDescriptor"/>s from <see cref="Type"/>s.
14+
/// </summary>
15+
public static class TagHelperDescriptorFactory
16+
{
17+
private const string TagHelperNameEnding = "TagHelper";
18+
19+
// TODO: Investigate if we should cache TagHelperDescriptors for types:
20+
// https://github.com/aspnet/Razor/issues/165
21+
22+
/// <summary>
23+
/// Creates a <see cref="TagHelperDescriptor"/> from the given <paramref name="type"/>.
24+
/// </summary>
25+
/// <param name="type">The type to create a <see cref="TagHelperDescriptor"/> from.</param>
26+
/// <returns>A <see cref="TagHelperDescriptor"/> that describes the given <paramref name="type"/>.</returns>
27+
public static TagHelperDescriptor CreateDescriptor(Type type)
28+
{
29+
var tagName = GetTagName(type);
30+
var typeName = type.FullName;
31+
var attributeDescriptors = GetAttributeDescriptors(type);
32+
var contentBehavior = GetContentBehavior(type);
33+
34+
return new TagHelperDescriptor(tagName,
35+
typeName,
36+
contentBehavior,
37+
attributeDescriptors);
38+
}
39+
40+
// TODO: Make this method support TagNameAttribute tag names: https://github.com/aspnet/Razor/issues/120
41+
private static string GetTagName(Type tagHelperType)
42+
{
43+
var name = tagHelperType.Name;
44+
45+
if (name.EndsWith(TagHelperNameEnding, StringComparison.OrdinalIgnoreCase))
46+
{
47+
name = name.Substring(0, name.Length - TagHelperNameEnding.Length);
48+
}
49+
50+
return name;
51+
}
52+
53+
private static IEnumerable<TagHelperAttributeDescriptor> GetAttributeDescriptors(Type type)
54+
{
55+
var typeInfo = type.GetTypeInfo();
56+
var properties = typeInfo.DeclaredProperties.Where(IsValidProperty);
57+
var attributeDescriptors = properties.Select(ToAttributeDescriptor);
58+
59+
return attributeDescriptors;
60+
}
61+
62+
// TODO: Make the HTML attribute name support names from a AttributeNameAttribute:
63+
// https://github.com/aspnet/Razor/issues/121
64+
private static TagHelperAttributeDescriptor ToAttributeDescriptor(PropertyInfo property)
65+
{
66+
return new TagHelperAttributeDescriptor(property.Name, property);
67+
}
68+
69+
// TODO: Make the content behavior pull from a ContentBehaviorAttribute: https://github.com/aspnet/Razor/issues/122
70+
private static ContentBehavior GetContentBehavior(Type type)
71+
{
72+
return ContentBehavior.None;
73+
}
74+
75+
private static bool IsValidProperty(PropertyInfo property)
76+
{
77+
return property.GetMethod != null &&
78+
property.GetMethod.IsPublic &&
79+
property.SetMethod != null &&
80+
property.SetMethod.IsPublic;
81+
}
82+
}
83+
}

0 commit comments

Comments
 (0)