-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ModuleAttribute.cs
360 lines (336 loc) · 14.3 KB
/
ModuleAttribute.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
using System;
using System.Collections.Generic;
using System.Linq;
namespace OrchardCore.Modules.Manifest
{
/// <summary>
/// Defines a Module which is composed of features. If the Module has only one default
/// feature, it may be defined there.
/// </summary>
[AttributeUsage(AttributeTargets.Assembly, AllowMultiple = false, Inherited = false)]
public class ModuleAttribute : FeatureAttribute
{
/// <summary>
/// ""
/// </summary>
internal const string DefaultAuthor = "";
/// <summary>
/// ""
/// </summary>
internal const string DefaultWebsiteUrl = "";
/// <summary>
/// "0.0"
/// </summary>
internal const string DefaultVersionZero = "0.0";
/// <summary>
/// ""
/// </summary>
internal const string DefaultTags = "";
/// <summary>
/// Default parameterless ctor.
/// </summary>
public ModuleAttribute() : base()
{
}
/// <summary>
/// Ctor allowing <paramref name="author"/>, as well as defaults for
/// <paramref name="websiteUrl"/>, <paramref name="semVer"/>, and <paramref name="tags"/>.
/// </summary>
/// <param name="id">The identifier for the Module.</param>
/// <param name="description">A simple feature description.</param>
/// <param name="author">The module author name.</param>
/// <param name="semVer">Semantic Version string.</param>
/// <param name="websiteUrl">The module website URL.</param>
/// <param name="featureDependencies">Zero or more delimited feature dependencies,
/// corresponding to each of the feature <see cref="FeatureAttribute.Name"/>
/// properties.</param>
/// <param name="tags">Tags associated with the Module.</param>
/// <param name="defaultTenant">Whether considered default tenant only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <param name="alwaysEnabled">Whether feature is always enabled.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <see cref="!:https://semver.org">Semantic Versioning</see>
/// <remarks>At least <paramref name="author" /> expected herein to differentiate with
/// parameterless ctor.</remarks>
/// <param name="enabledByDependencyOnly">Whether feature is enabled by dependency only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
public ModuleAttribute(
string id
, string description
, string author
, string semVer
, string websiteUrl
, string featureDependencies
, string tags
, object defaultTenant
, object alwaysEnabled
, object enabledByDependencyOnly
) : this(
id
, default
, default
, default
, description
, author
, semVer
, websiteUrl
, featureDependencies
, tags
, defaultTenant
, alwaysEnabled
, enabledByDependencyOnly
)
{
}
/// <summary>
/// Ctor allowing <paramref name="author"/>, as well as defaults for
/// <paramref name="websiteUrl"/>, <paramref name="semVer"/>, and <paramref name="tags"/>.
/// </summary>
/// <param name="id">The identifier for the Module.</param>
/// <param name="name">The feature name, defaults to <see cref="FeatureAttribute.Id"/>
/// when null or blank.</param>
/// <param name="description">A simple feature description.</param>
/// <param name="author">The module author name.</param>
/// <param name="semVer">Semantic Version string.</param>
/// <param name="websiteUrl">The module website URL.</param>
/// <param name="featureDependencies">Zero or more delimited feature dependencies,
/// corresponding to each of the feature <see cref="FeatureAttribute.Name"/>
/// properties.</param>
/// <param name="tags">Tags associated with the Module.</param>
/// <param name="defaultTenant">Whether considered default tenant only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <param name="alwaysEnabled">Whether feature is always enabled.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <see cref="!:https://semver.org">Semantic Versioning</see>
/// <remarks>At least <paramref name="author" /> expected herein to differentiate with
/// parameterless ctor.</remarks>
/// <param name="enabledByDependencyOnly">Whether feature is enabled by dependency only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
public ModuleAttribute(
string id
, string name
, string description
, string author
, string semVer
, string websiteUrl
, string featureDependencies
, string tags
, object defaultTenant
, object alwaysEnabled
, object enabledByDependencyOnly
) : this(
id
, name
, default
, default
, description
, author
, semVer
, websiteUrl
, featureDependencies
, tags
, defaultTenant
, alwaysEnabled
, enabledByDependencyOnly
)
{
}
/// <summary>
/// Ctor allowing <paramref name="author"/>, as well as defaults for
/// <paramref name="websiteUrl"/>, <paramref name="semVer"/>, and <paramref name="tags"/>.
/// </summary>
/// <param name="id">The identifier for the Module.</param>
/// <param name="name">The feature name, defaults to <see cref="FeatureAttribute.Id"/>
/// when null or blank.</param>
/// <param name="category">A simple feature category.</param>
/// <param name="priority">Priority for the Module.</param>
/// <param name="description">A simple feature description.</param>
/// <param name="author">The module author name.</param>
/// <param name="semVer">Semantic Version string.</param>
/// <param name="featureDependencies">Zero or more delimited feature dependencies,
/// corresponding to each of the feature <see cref="FeatureAttribute.Name"/>
/// properties.</param>
/// <param name="websiteUrl">The module website URL.</param>
/// <param name="tags">Tags associated with the Module.</param>
/// <param name="defaultTenant">Whether considered default tenant only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <param name="alwaysEnabled">Whether feature is always enabled.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <see cref="!:https://semver.org">Semantic Versioning</see>
/// <remarks>At least <paramref name="author" /> expected herein to differentiate with
/// parameterless ctor.</remarks>
/// <param name="enabledByDependencyOnly">Whether feature is enabled by dependency only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
public ModuleAttribute(
string id
, string name
, string category
, string priority
, string description
, string author
, string semVer
, string websiteUrl
, string featureDependencies
, string tags
, object defaultTenant
, object alwaysEnabled
, object enabledByDependencyOnly
) : base(
id
, name
, category
, priority
, description
, featureDependencies
, defaultTenant
, alwaysEnabled
, enabledByDependencyOnly
)
{
Author = author;
Website = websiteUrl;
Version = semVer;
DelimitedTags = tags;
}
/// <summary>
/// Ctor allowing <paramref name="author"/>, as well as defaults for
/// <paramref name="websiteUrl"/>, <paramref name="semVer"/>, and <paramref name="tags"/>.
/// </summary>
/// <param name="id">The identifier for the Module.</param>
/// <param name="name">The feature name, defaults to <see cref="FeatureAttribute.Id"/>
/// when null or blank.</param>
/// <param name="type">User provided type of the Module.</param>
/// <param name="category">A simple feature category.</param>
/// <param name="priority">Priority for the Module.</param>
/// <param name="description">A simple feature description.</param>
/// <param name="author">The module author name.</param>
/// <param name="semVer">Semantic Version string.</param>
/// <param name="featureDependencies">Zero or more delimited feature dependencies,
/// corresponding to each of the feature <see cref="FeatureAttribute.Name"/>
/// properties.</param>
/// <param name="websiteUrl">The module website URL.</param>
/// <param name="tags">Tags associated with the Module.</param>
/// <param name="defaultTenant">Whether considered default tenant only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <param name="alwaysEnabled">Whether feature is always enabled.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
/// <see cref="!:https://semver.org">Semantic Versioning</see>
/// <remarks>At least <paramref name="author" /> expected herein to differentiate with
/// parameterless ctor.</remarks>
/// <param name="enabledByDependencyOnly">Whether feature is enabled by dependency only.
/// Supported types are <see cref="String"/> and <see cref="Boolean"/> only.</param>
public ModuleAttribute(
string id
, string name
, string type
, string category
, string priority
, string description
, string author
, string semVer
, string websiteUrl
, string featureDependencies
, string tags
, object defaultTenant
, object alwaysEnabled
, object enabledByDependencyOnly
) : this(
id
, name
, category
, priority
, description
, author
, semVer
, websiteUrl
, featureDependencies
, tags
, defaultTenant
, alwaysEnabled
, enabledByDependencyOnly
)
{
type = (type ?? String.Empty).Trim();
_type = String.IsNullOrEmpty(type) ? null : type;
}
/// <summary>
/// Returns the <see cref="System.Reflection.MemberInfo.Name"/> less the
/// <see cref="Attribute"/> suffix when present.
/// </summary>
/// <param name="attributeType"></param>
/// <returns></returns>
protected internal static string GetAttributePrefix(Type attributeType)
{
const string attributeSuffix = nameof(Attribute);
// Drops the 'Attribute' suffix from the conventional abbreviation, or leaves it alone
static string GetTypeNamePrefix(string typeName) =>
typeName.EndsWith(attributeSuffix)
? typeName[..^attributeSuffix.Length]
: typeName
;
return GetTypeNamePrefix(attributeType.Name);
}
private string _type;
/// <summary>
/// Gets or sets the Type. Allows authors to identify the attribute by a logical,
/// human-readable Type. Defaults to the abbreviated <see cref="Attribute"/> class name,
/// sans suffix.
/// </summary>
public virtual string Type
{
get => _type ??= GetAttributePrefix(GetType());
protected internal set => _type = value?.Trim();
}
private string _author = DefaultAuthor;
/// <summary>
/// Gets or sets the name of the developer.
/// </summary>
/// <see cref="DefaultAuthor" />
public virtual string Author
{
get => _author;
set => _author = (value ?? DefaultAuthor).Trim();
}
private string _website = DefaultWebsiteUrl;
/// <summary>
/// Gets or sets the URL for the website of the developer.
/// </summary>
/// <see cref="DefaultWebsiteUrl" />
public virtual string Website
{
get => _website;
set => _website = (value ?? DefaultWebsiteUrl).Trim();
}
private string _version = DefaultVersionZero;
/// <summary>
/// Gets or sets the Semantic Version string.
/// </summary>
/// <see cref="!:https://semver.org">Semantic Versioning</see>
/// <see cref="DefaultVersionZero" />
public virtual string Version
{
get => _version;
set => _version = (value ?? DefaultVersionZero).Trim();
}
/// <summary>
/// Set-only <see cref="Tags"/> property.
/// </summary>
private string DelimitedTags
{
set => Tags = (value ?? DefaultTags).Trim().Split(ListDelims, DefaultSplitOptions);
}
private string[] _tags = GetValues<string>().ToArray();
/// <summary>
/// Gets or sets an array of enumerated Tags.
/// </summary>
public virtual string[] Tags
{
get => _tags;
set => _tags = (value ?? GetValues<string>()).Select(_ => _.Trim()).ToArray();
}
/// <summary>
/// Gets a list of Features attributes associated with the Module.
/// </summary>
public virtual List<FeatureAttribute> Features { get; } = GetValues<FeatureAttribute>().ToList();
}
}