refactor: Move Mono.Cecil extension methods not specific to either ap…

…ireference or commandlinehelp to Common assembly
ap0llo · Jun 6, 2020 · aeae588 · aeae588
1 parent a577cce
commit aeae588
Show file tree

Hide file tree

Showing 31 changed files with 131 additions and 117 deletions.
diff --git a/src/MdDocs.ApiReference/Model/IndexerOverloadDocumentation.cs b/src/MdDocs.ApiReference/Model/IndexerOverloadDocumentation.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Grynwald.MdDocs.ApiReference.Model.XmlDocs;
+using Grynwald.MdDocs.Common;
 using Mono.Cecil;
 
 namespace Grynwald.MdDocs.ApiReference.Model

diff --git a/src/MdDocs.ApiReference/Model/MethodLikeOverloadDocumentation.cs b/src/MdDocs.ApiReference/Model/MethodLikeOverloadDocumentation.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Grynwald.MdDocs.ApiReference.Model.XmlDocs;
+using Grynwald.MdDocs.Common;
 using Mono.Cecil;
 
 namespace Grynwald.MdDocs.ApiReference.Model

diff --git a/src/MdDocs.ApiReference/Model/SimpleMemberDocumentation.cs b/src/MdDocs.ApiReference/Model/SimpleMemberDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using Grynwald.MdDocs.ApiReference.Model.XmlDocs;
+using Grynwald.MdDocs.Common;
 using Grynwald.Utilities.Collections;
 using Mono.Cecil;
 

diff --git a/src/MdDocs.ApiReference/Model/TypeDocumentation.cs b/src/MdDocs.ApiReference/Model/TypeDocumentation.cs
@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Grynwald.MdDocs.ApiReference.Model.XmlDocs;
+using Grynwald.MdDocs.Common;
 using Grynwald.Utilities.Collections;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;

diff --git a/src/MdDocs.ApiReference/Model/_Extensions/TypeDefinitionExtensions.cs b/src/MdDocs.ApiReference/Model/_Extensions/TypeDefinitionExtensions.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Grynwald.Utilities.Collections;
 using Mono.Cecil;
 
@@ -98,13 +99,13 @@ public static IEnumerable<CustomAttribute> GetCustomAttributes(this TypeDefiniti
             return type.CustomAttributes
                 .Where(attribute =>
                 {
-                    if (typeKind == TypeKind.Class && attribute.AttributeType.FullName == Constants.DefaultMemberAttributeFullName)
+                    if (typeKind == TypeKind.Class && attribute.AttributeType.FullName == SystemTypeNames.DefaultMemberAttributeFullName)
                         return false;
 
-                    if (typeKind == TypeKind.Class && attribute.AttributeType.FullName == Constants.ExtensionAttributeFullName)
+                    if (typeKind == TypeKind.Class && attribute.AttributeType.FullName == SystemTypeNames.ExtensionAttributeFullName)
                         return false;
 
-                    if (typeKind == TypeKind.Struct && attribute.AttributeType.FullName == Constants.IsReadOnlyAttributeFullName)
+                    if (typeKind == TypeKind.Struct && attribute.AttributeType.FullName == SystemTypeNames.IsReadOnlyAttributeFullName)
                         return false;
 
                     if (!attribute.AttributeType.Resolve().IsPublic)

diff --git a/src/MdDocs.ApiReference/Model/_Helpers/CSharpDefinitionFormatter.cs b/src/MdDocs.ApiReference/Model/_Helpers/CSharpDefinitionFormatter.cs
@@ -463,7 +463,7 @@ private static void AppendTypeModifiers(StringBuilder definitionBuilder, TypeDef
                     break;
 
                 case TypeKind.Struct:
-                    if (type.CustomAttributes.Any(a => a.AttributeType.FullName == Constants.IsReadOnlyAttributeFullName))
+                    if (type.CustomAttributes.Any(a => a.AttributeType.FullName == SystemTypeNames.IsReadOnlyAttributeFullName))
                     {
                         definitionBuilder.Append("readonly ");
                     }
@@ -477,7 +477,7 @@ private static void AppendBaseTypes(TypeDefinition type, TypeKind typeKind, Stri
             if (typeKind == TypeKind.Enum)
             {
                 var underlyingType = type.Fields.Single(f => f.Name == "value__").FieldType;
-                if (underlyingType.FullName != Constants.Int32FullName)
+                if (underlyingType.FullName != SystemTypeNames.Int32FullName)
                 {
                     definitionBuilder.Append(" : ");
                     definitionBuilder.Append(GetDisplayName(underlyingType));
@@ -488,8 +488,8 @@ private static void AppendBaseTypes(TypeDefinition type, TypeKind typeKind, Stri
                 // get the default (implicit) base type: "object" for classes, "System.ValueType" for structs
                 // if the base type is the default type, the base type will not be explicitly included in the definition
                 var defaultBaseType = typeKind == TypeKind.Struct
-                    ? Constants.ValueTypeFullName
-                    : (typeKind == TypeKind.Class ? Constants.ObjectFullName : "");
+                    ? SystemTypeNames.ValueTypeFullName
+                    : (typeKind == TypeKind.Class ? SystemTypeNames.ObjectFullName : "");
 
                 if (type.HasInterfaces)
                 {
@@ -594,7 +594,7 @@ private static string GetLiteral(TypeReference typeReference, object value)
             var typeDefinition = typeReference.Resolve();
 
             // string => put in quotation marks
-            if (typeReference.FullName == Constants.StringFullName)
+            if (typeReference.FullName == SystemTypeNames.StringFullName)
             {
                 if (value is null)
                 {
@@ -694,7 +694,7 @@ private static string GetLiteral(TypeReference typeReference, object value)
             }
         }
 
-        private static bool IsFlagsEnum(TypeDefinition type) => type.CustomAttributes.Any(a => a.AttributeType.FullName == Constants.FlagsAttributeFullName);
+        private static bool IsFlagsEnum(TypeDefinition type) => type.CustomAttributes.Any(a => a.AttributeType.FullName == SystemTypeNames.FlagsAttributeFullName);
 
         private static string GetDisplayName(TypeReference typeReference)
         {
@@ -718,7 +718,7 @@ private static string GetDefinition(ParameterDefinition parameter)
             AppendCustomAttributes(definitionBuilder, parameter.GetCustomAttributes(), singleLine: true);
 
             // add "params" prefix if method allows multiple values
-            if (parameter.CustomAttributes.Any(a => a.AttributeType.FullName == Constants.ParamArrayAttributeFullName))
+            if (parameter.CustomAttributes.Any(a => a.AttributeType.FullName == SystemTypeNames.ParamArrayAttributeFullName))
             {
                 definitionBuilder.Append("params ");
             }

diff --git a/src/MdDocs.CommandLineHelp/Constants.cs → ...andLineHelp/CommandLineParserTypeNames.cs b/src/MdDocs.CommandLineHelp/Constants.cs → ...andLineHelp/CommandLineParserTypeNames.cs
@@ -1,17 +1,15 @@
 #pragma warning disable IDE1006 // Naming Styles: Ignore hint that const strings should be prefixed with 's_' as all these fields are public
 namespace Grynwald.MdDocs.CommandLineHelp
 {
-    internal static class Constants
+    /// <summary>
+    /// Defines constants for names of type names defined by the "CommandLineParser" library
+    /// </summary>
+    internal static class CommandLineParserTypeNames
     {
         public const string VerbAttributeFullName = "CommandLine.VerbAttribute";
         public const string OptionAttributeFullName = "CommandLine.OptionAttribute";
         public const string ValueAttributeFullName = "CommandLine.ValueAttribute";
         public const string AssemblyUsageAttributeFullName = "CommandLine.Text.AssemblyUsageAttribute";
-
-        public const string AssemblyTitleAttributeFullName = "System.Reflection.AssemblyTitleAttribute";
-        public const string AssemblyInformationalVersionAttribute = "System.Reflection.AssemblyInformationalVersionAttribute";
-
-        public const string BooleanFullName = "System.Boolean";
     }
 }
 #pragma warning restore IDE1006 // Naming Styles
diff --git a/src/MdDocs.CommandLineHelp/Grynwald.MdDocs.CommandLineHelp.csproj b/src/MdDocs.CommandLineHelp/Grynwald.MdDocs.CommandLineHelp.csproj
@@ -23,4 +23,10 @@
     <ProjectReference Include="..\MdDocs.Common\Grynwald.MdDocs.Common.csproj" />
   </ItemGroup>
 
+
+
+  <ItemGroup>
+    <Compile Include="../shared/Nullable.cs" />
+  </ItemGroup>
+
 </Project>
diff --git a/src/MdDocs.CommandLineHelp/Model/_Application/ApplicationDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Application/ApplicationDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Grynwald.MdDocs.Common.Model;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
@@ -36,14 +37,14 @@ public static ApplicationDocumentation FromAssemblyFile(string filePath, ILogger
             {
                 var types = definition.MainModule.Types.Where(x => !x.IsAbstract);
 
-                if (types.Any(x => x.HasAttribute(Constants.VerbAttributeFullName)))
+                if (types.Any(x => x.HasAttribute(CommandLineParserTypeNames.VerbAttributeFullName)))
                 {
-                    logger.LogInformation($"Found a class attributed with '{Constants.VerbAttributeFullName}'. Assuming application has sub-commands");
+                    logger.LogInformation($"Found a class attributed with '{CommandLineParserTypeNames.VerbAttributeFullName}'. Assuming application has sub-commands");
                     return MultiCommandApplicationDocumentation.FromAssemblyDefinition(definition, logger);
                 }
                 else
                 {
-                    logger.LogInformation($"Found *no* class attributed with '{Constants.VerbAttributeFullName}'. Assuming application without sub-commands");
+                    logger.LogInformation($"Found *no* class attributed with '{CommandLineParserTypeNames.VerbAttributeFullName}'. Assuming application without sub-commands");
                     return SingleCommandApplicationDocumentation.FromAssemblyDefinition(definition, logger);
                 }
             }
@@ -53,7 +54,7 @@ public static ApplicationDocumentation FromAssemblyFile(string filePath, ILogger
         protected static string LoadApplicationName(AssemblyDefinition definition)
         {
             var name = definition
-                .GetAttributeOrDefault(Constants.AssemblyTitleAttributeFullName)
+                .GetAttributeOrDefault(SystemTypeNames.AssemblyTitleAttributeFullName)
                 ?.ConstructorArguments?.Single().Value as string;
 
             if (name == null || String.IsNullOrEmpty(name))
@@ -68,7 +69,7 @@ protected static string LoadApplicationName(AssemblyDefinition definition)
         protected static string? LoadApplicationVersion(AssemblyDefinition definition)
         {
             var version = definition
-              .GetAttributeOrDefault(Constants.AssemblyInformationalVersionAttribute)
+              .GetAttributeOrDefault(SystemTypeNames.AssemblyInformationalVersionAttribute)
               ?.ConstructorArguments.Single().Value as string;
 
             if (String.IsNullOrEmpty(version))
@@ -82,7 +83,7 @@ protected static string LoadApplicationName(AssemblyDefinition definition)
 
         protected static IReadOnlyList<string> LoadAssemblyUsage(AssemblyDefinition definition)
         {
-            var assemblyUsageAttribute = definition.GetAttributeOrDefault(Constants.AssemblyUsageAttributeFullName);
+            var assemblyUsageAttribute = definition.GetAttributeOrDefault(CommandLineParserTypeNames.AssemblyUsageAttributeFullName);
 
             return assemblyUsageAttribute == null
                 ? Array.Empty<string>()

diff --git a/src/MdDocs.CommandLineHelp/Model/_Application/MultiCommandApplicationDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Application/MultiCommandApplicationDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -42,8 +43,8 @@ private IReadOnlyList<CommandDocumentation> LoadCommands(AssemblyDefinition defi
         {
             return definition.MainModule.Types
                 .Where(x => !x.IsAbstract)
-                .WithAttribute(Constants.VerbAttributeFullName)
-                .Where(x => !x.GetAttribute(Constants.VerbAttributeFullName).GetPropertyValueOrDefault<bool>("Hidden"))
+                .WithAttribute(CommandLineParserTypeNames.VerbAttributeFullName)
+                .Where(x => !x.GetAttribute(CommandLineParserTypeNames.VerbAttributeFullName).GetPropertyValueOrDefault<bool>("Hidden"))
                 .Select(type => CommandDocumentation.FromTypeDefinition(this, type, logger))
                 .ToArray();
         }

diff --git a/src/MdDocs.CommandLineHelp/Model/_Application/SingleCommandApplicationDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Application/SingleCommandApplicationDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -38,7 +39,7 @@ private UnnamedCommandDocumentation LoadCommand(AssemblyDefinition definition, I
         {
             bool IsCommandLineParameter(PropertyDefinition property)
             {
-                return property.HasAttribute(Constants.OptionAttributeFullName) || property.HasAttribute(Constants.ValueAttributeFullName);
+                return property.HasAttribute(CommandLineParserTypeNames.OptionAttributeFullName) || property.HasAttribute(CommandLineParserTypeNames.ValueAttributeFullName);
             }
 
             // get all types with at least one property attributed as either [Option] or [Value]

diff --git a/src/MdDocs.CommandLineHelp/Model/_Commands/CommandDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Commands/CommandDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -43,7 +44,7 @@ public static CommandDocumentation FromTypeDefinition(MultiCommandApplicationDoc
             if (definition is null)
                 throw new ArgumentNullException(nameof(definition));
 
-            var verbAttribute = definition.GetAttribute(Constants.VerbAttributeFullName);
+            var verbAttribute = definition.GetAttribute(CommandLineParserTypeNames.VerbAttributeFullName);
 
             var name = (string)verbAttribute.ConstructorArguments.First(x => x.Type.FullName == "System.String").Value;
 

diff --git a/src/MdDocs.CommandLineHelp/Model/_Commands/CommandDocumentationBase.cs b/src/MdDocs.CommandLineHelp/Model/_Commands/CommandDocumentationBase.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -53,7 +54,7 @@ protected internal CommandDocumentationBase(
         protected static IReadOnlyList<OptionDocumentation> LoadOptions(TypeDefinition definition, ILogger logger)
         {
             return definition.GetAllProperties()
-                .WithAttribute(Constants.OptionAttributeFullName)
+                .WithAttribute(CommandLineParserTypeNames.OptionAttributeFullName)
                 .Select(property => OptionDocumentation.FromPropertyDefinition(property, logger))
                 .Where(option => !option.Hidden)
                 .ToArray();
@@ -62,7 +63,7 @@ protected static IReadOnlyList<OptionDocumentation> LoadOptions(TypeDefinition d
         protected static IReadOnlyList<ValueDocumentation> LoadValues(TypeDefinition definition, ILogger logger)
         {
             return definition.GetAllProperties()
-                .WithAttribute(Constants.ValueAttributeFullName)
+                .WithAttribute(CommandLineParserTypeNames.ValueAttributeFullName)
                 .Select(property => ValueDocumentation.FromPropertyDefinition(property, logger))
                 .Where(value => !value.Hidden)
                 .ToArray();

diff --git a/src/MdDocs.CommandLineHelp/Model/_Commands/UnnamedCommandDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Commands/UnnamedCommandDocumentation.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -26,7 +27,7 @@ public static UnnamedCommandDocumentation FromTypeDefinition(ApplicationDocument
                 throw new ArgumentNullException(nameof(definition));
 
             // unnamed commands must not have a "verb" attribute
-            if (definition.HasAttribute(Constants.VerbAttributeFullName))
+            if (definition.HasAttribute(CommandLineParserTypeNames.VerbAttributeFullName))
                 throw new ArgumentException("Cannot create unnamed command from type definition annotated with a Verb attribute", nameof(definition));
 
             return new UnnamedCommandDocumentation(application, LoadOptions(definition, logger), LoadValues(definition, logger));

diff --git a/src/MdDocs.CommandLineHelp/Model/_Parameters/OptionDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Parameters/OptionDocumentation.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
 using Mono.Cecil;
@@ -46,7 +47,7 @@ internal OptionDocumentation(
         }
 
         private OptionDocumentation(PropertyDefinition definition, ILogger logger)
-            : base(definition, definition.GetAttribute(Constants.OptionAttributeFullName))
+            : base(definition, definition.GetAttribute(CommandLineParserTypeNames.OptionAttributeFullName))
         {
             m_Logger = logger ?? throw new ArgumentNullException(nameof(logger));
 
@@ -55,7 +56,7 @@ private OptionDocumentation(PropertyDefinition definition, ILogger logger)
             // special handling for bool options:
             // bool options are treated as "switch" parameters that do not require a value to be passed in,
             // e.g. the option is set using "--option" not "--option true"
-            if (definition.PropertyType.FullName == Constants.BooleanFullName)
+            if (definition.PropertyType.FullName == SystemTypeNames.BooleanFullName)
             {
                 IsSwitchParameter = true;
 
@@ -92,7 +93,7 @@ public static OptionDocumentation FromPropertyDefinition(PropertyDefinition defi
         {
             string? name = default;
             char? shortName = default;
-            foreach (var arg in definition.GetAttribute(Constants.OptionAttributeFullName).ConstructorArguments)
+            foreach (var arg in definition.GetAttribute(CommandLineParserTypeNames.OptionAttributeFullName).ConstructorArguments)
             {
                 if (arg.Type.FullName == typeof(string).FullName)
                 {

diff --git a/src/MdDocs.CommandLineHelp/Model/_Parameters/ValueDocumentation.cs b/src/MdDocs.CommandLineHelp/Model/_Parameters/ValueDocumentation.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using Grynwald.MdDocs.Common;
 using Microsoft.Extensions.Logging;
 using Mono.Cecil;
 
@@ -28,9 +29,9 @@ internal ValueDocumentation(
             Name = name;
         }
 
-        private ValueDocumentation(PropertyDefinition property) : base(property, property.GetAttribute(Constants.ValueAttributeFullName))
+        private ValueDocumentation(PropertyDefinition property) : base(property, property.GetAttribute(CommandLineParserTypeNames.ValueAttributeFullName))
         {
-            var valueAttribute = property.GetAttribute(Constants.ValueAttributeFullName);
+            var valueAttribute = property.GetAttribute(CommandLineParserTypeNames.ValueAttributeFullName);
 
             Index = (int)valueAttribute.ConstructorArguments.Single().Value;
             Name = valueAttribute.GetPropertyValueOrDefault<string>("MetaName");

diff --git a/src/MdDocs.CommandLineHelp/_Extensions/CustomAttributeProviderExtensions.cs b/src/MdDocs.CommandLineHelp/_Extensions/CustomAttributeProviderExtensions.cs
diff --git a/src/MdDocs.Common.Test/Grynwald.MdDocs.Common.Test.csproj b/src/MdDocs.Common.Test/Grynwald.MdDocs.Common.Test.csproj
@@ -18,6 +18,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\MdDocs.Common\Grynwald.MdDocs.Common.csproj" />
+    <ProjectReference Include="..\MdDocs.TestHelpers\Grynwald.MdDocs.TestHelpers.csproj" />
   </ItemGroup>
 
 </Project>