Merge pull request jburzynski#167 from mispencer/CustomHeaderAndBody

Allow specifying custom header and body as an attribute or specification
tterrag1098 · Aug 21, 2023 · 907ec20 · 907ec20
2 parents 981bcf4 + c52629c
commit 907ec20
Show file tree

Hide file tree

Showing 11 changed files with 184 additions and 12 deletions.
diff --git a/src/TypeGen/TypeGen.Core.Test/SpecGeneration/ClassSpecBuilderTest.cs b/src/TypeGen/TypeGen.Core.Test/SpecGeneration/ClassSpecBuilderTest.cs
@@ -57,6 +57,32 @@ public void CustomBase_Invoked_SpecUpdated()
             Assert.Equal(isDefaultExport, ((TsCustomBaseAttribute)attribute).IsDefaultExport);
         }
 
+        [Fact]
+        public void CustomHeader_Invoked_SpecUpdated()
+        {
+            const string header = "header";
+            var spec = new TypeSpec(new ExportTsInterfaceAttribute());
+            var builder = new ClassSpecBuilder(spec);
+
+            builder.CustomHeader(header);
+
+            var attribute = spec.ExportAttribute;
+            Assert.Equal(header, attribute.CustomHeader);
+        }
+
+        [Fact]
+        public void CustomBody_Invoked_SpecUpdated()
+        {
+            const string body = "body";
+            var spec = new TypeSpec(new ExportTsInterfaceAttribute());
+            var builder = new ClassSpecBuilder(spec);
+
+            builder.CustomBody(body);
+
+            var attribute = spec.ExportAttribute;
+            Assert.Equal(body, attribute.CustomBody);
+        }
+
         [Theory]
         [InlineData(true)]
         [InlineData(false)]
@@ -256,4 +282,4 @@ public void Undefined_Invoked_SpecUpdated()
             Assert.IsType<TsUndefinedAttribute>(attribute);
         }
     }
-}
+}
diff --git a/src/TypeGen/TypeGen.Core.Test/SpecGeneration/Generic/InterfaceSpecBuilderTest.cs b/src/TypeGen/TypeGen.Core.Test/SpecGeneration/Generic/InterfaceSpecBuilderTest.cs
@@ -85,6 +85,32 @@ public void CustomBase_Invoked_SpecUpdated()
             Assert.Equal(isDefaultExport, ((TsCustomBaseAttribute)attribute).IsDefaultExport);
         }
 
+        [Fact]
+        public void CustomHeader_Invoked_SpecUpdated()
+        {
+            const string header = "header";
+            var spec = new TypeSpec(new ExportTsInterfaceAttribute());
+            var builder = new TypeGen.Core.SpecGeneration.Builders.Generic.InterfaceSpecBuilder<ExportedClass>(spec);
+
+            builder.CustomHeader(header);
+
+            var attribute = spec.ExportAttribute;
+            Assert.Equal(header, attribute.CustomHeader);
+        }
+
+        [Fact]
+        public void CustomBody_Invoked_SpecUpdated()
+        {
+            const string body = "body";
+            var spec = new TypeSpec(new ExportTsInterfaceAttribute());
+            var builder = new TypeGen.Core.SpecGeneration.Builders.Generic.InterfaceSpecBuilder<ExportedClass>(spec);
+
+            builder.CustomBody(body);
+
+            var attribute = spec.ExportAttribute;
+            Assert.Equal(body, attribute.CustomBody);
+        }
+
         [Theory]
         [InlineData(true)]
         [InlineData(false)]
@@ -271,4 +297,4 @@ public void Undefined_Invoked_SpecUpdated()
             Assert.IsType<TsUndefinedAttribute>(attribute);
         }
     }
-}
+}
diff --git a/src/TypeGen/TypeGen.Core/Generator/Generator.cs b/src/TypeGen/TypeGen.Core/Generator/Generator.cs
@@ -409,8 +409,12 @@ private IEnumerable<string> GenerateClass(Type type, ExportTsClassAttribute clas
             string tsTypeNameFirstPart = tsTypeName.RemoveTypeGenericComponent();
             string filePath = GetFilePath(type, outputDir);
             string filePathRelative = GetRelativeFilePath(type, outputDir);
-            string customHead = _tsContentGenerator.GetCustomHead(filePath);
-            string customBody = _tsContentGenerator.GetCustomBody(filePath, Options.TabLength);
+            string customInFileHead = _tsContentGenerator.GetCustomHead(filePath);
+            string customAttributeHead = classAttribute.CustomHeader;
+            string customHead = string.Join(Environment.NewLine, new[] { customInFileHead, customAttributeHead }.Where(i => !string.IsNullOrWhiteSpace(i)));
+            string customInFileBody = _tsContentGenerator.GetCustomBody(filePath, Options.TabLength);
+            string customAttributeBody = classAttribute.CustomBody;
+            string customBody = string.Join(Environment.NewLine, new[] { customInFileBody, customAttributeBody }.Where(i => !string.IsNullOrWhiteSpace(i)));
             var tsDoc = GetTsDocForType(type);
 
             var content = _typeService.UseDefaultExport(type) ?
@@ -458,8 +462,12 @@ private IEnumerable<string> GenerateInterface(Type type, ExportTsInterfaceAttrib
             string tsTypeNameFirstPart = tsTypeName.RemoveTypeGenericComponent();
             string filePath = GetFilePath(type, outputDir);
             string filePathRelative = GetRelativeFilePath(type, outputDir);
-            string customHead = _tsContentGenerator.GetCustomHead(filePath);
-            string customBody = _tsContentGenerator.GetCustomBody(filePath, Options.TabLength);
+            string customInFileHead = _tsContentGenerator.GetCustomHead(filePath);
+            string customAttributeHead = interfaceAttribute.CustomHeader;
+            string customHead = string.Join(Environment.NewLine, new[] { customInFileHead, customAttributeHead }.Where(i => !string.IsNullOrWhiteSpace(i)));
+            string customInFileBody = _tsContentGenerator.GetCustomBody(filePath, Options.TabLength);
+            string customAttributeBody = interfaceAttribute.CustomBody;
+            string customBody = string.Join(Environment.NewLine, new[] { customInFileBody, customAttributeBody }.Where(i => !string.IsNullOrWhiteSpace(i)));
             var tsDoc = GetTsDocForType(type);
 
             var content = _typeService.UseDefaultExport(type) ?

diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/ClassSpecBuilderBase.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/ClassSpecBuilderBase.cs
@@ -6,6 +6,8 @@ namespace TypeGen.Core.SpecGeneration.Builders
 {
     public abstract class ClassSpecBuilderBase<TSelf> : SpecBuilderBase,
         ICustomBaseTrait<TSelf>,
+        ICustomHeaderTrait<TSelf>,
+        ICustomBodyTrait<TSelf>,
         IDefaultExportTrait<TSelf>,
         IDefaultTypeOutputTrait<TSelf>,
         IDefaultValueTrait<TSelf>,
@@ -26,6 +28,8 @@ public abstract class ClassSpecBuilderBase<TSelf> : SpecBuilderBase,
         where TSelf : SpecBuilderBase
     {
         private readonly CustomBaseTrait<TSelf> _customBaseTrait;
+        private readonly CustomBodyTrait<TSelf> _customBodyTrait;
+        private readonly CustomHeaderTrait<TSelf> _customHeaderTrait;
         private readonly DefaultExportTrait<TSelf> _defaultExportTrait;
         private readonly DefaultTypeOutputTrait<TSelf> _defaultTypeOutputTrait;
         private readonly DefaultValueTrait<TSelf> _defaultValueTrait;
@@ -48,6 +52,8 @@ internal ClassSpecBuilderBase(TypeSpec typeSpec) : base(typeSpec)
         {
             MemberTrait = new MemberTrait<TSelf>(this as TSelf, typeSpec);
             _customBaseTrait = new CustomBaseTrait<TSelf>(this as TSelf, typeSpec);
+            _customBodyTrait = new CustomBodyTrait<TSelf>(this as TSelf, typeSpec);
+            _customHeaderTrait = new CustomHeaderTrait<TSelf>(this as TSelf, typeSpec);
             _defaultExportTrait = new DefaultExportTrait<TSelf>(this as TSelf, typeSpec);
             _defaultTypeOutputTrait = new DefaultTypeOutputTrait<TSelf>(this as TSelf, typeSpec, MemberTrait);
             _defaultValueTrait = new DefaultValueTrait<TSelf>(this as TSelf, typeSpec, MemberTrait);
@@ -75,7 +81,15 @@ public TSelf CustomBase(string @base = null, string importPath = null, string or
         public TSelf CustomBase(string @base = null, string importPath = null, string originalTypeName = null, bool isDefaultExport = false,
             params ImplementedInterface[] implementedInterfaces)
             => _customBaseTrait.CustomBase(@base, importPath, originalTypeName, isDefaultExport, implementedInterfaces);
-
+
+        /// <inheritdoc />
+        public TSelf CustomBody(string body)
+            => _customBodyTrait.CustomBody(body);
+
+        /// <inheritdoc />
+        public TSelf CustomHeader(string header)
+            => _customHeaderTrait.CustomHeader(header);
+
         /// <inheritdoc />
         public TSelf DefaultExport(bool enabled = true) => _defaultExportTrait.DefaultExport(enabled);
 

diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/InterfaceSpecBuilderBase.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/InterfaceSpecBuilderBase.cs
@@ -9,6 +9,8 @@ namespace TypeGen.Core.SpecGeneration.Builders
     /// </summary>
     public abstract class InterfaceSpecBuilderBase<TSelf> : SpecBuilderBase,
         ICustomBaseTrait<TSelf>,
+        ICustomHeaderTrait<TSelf>,
+        ICustomBodyTrait<TSelf>,
         IDefaultExportTrait<TSelf>,
         IDefaultTypeOutputTrait<TSelf>,
         IDefaultValueTrait<TSelf>,
@@ -28,6 +30,8 @@ public abstract class InterfaceSpecBuilderBase<TSelf> : SpecBuilderBase,
         where TSelf : SpecBuilderBase
     {
         private readonly CustomBaseTrait<TSelf> _customBaseTrait;
+        private readonly CustomBodyTrait<TSelf> _customBodyTrait;
+        private readonly CustomHeaderTrait<TSelf> _customHeaderTrait;
         private readonly DefaultExportTrait<TSelf> _defaultExportTrait;
         private readonly DefaultTypeOutputTrait<TSelf> _defaultTypeOutputTrait;
         private readonly DefaultValueTrait<TSelf> _defaultValueTrait;
@@ -49,6 +53,8 @@ internal InterfaceSpecBuilderBase(TypeSpec typeSpec) : base(typeSpec)
         {
             MemberTrait = new MemberTrait<TSelf>(this as TSelf, typeSpec);
             _customBaseTrait = new CustomBaseTrait<TSelf>(this as TSelf, typeSpec);
+            _customBodyTrait = new CustomBodyTrait<TSelf>(this as TSelf, typeSpec);
+            _customHeaderTrait = new CustomHeaderTrait<TSelf>(this as TSelf, typeSpec);
             _defaultExportTrait = new DefaultExportTrait<TSelf>(this as TSelf, typeSpec);
             _defaultTypeOutputTrait = new DefaultTypeOutputTrait<TSelf>(this as TSelf, typeSpec, MemberTrait);
             _defaultValueTrait = new DefaultValueTrait<TSelf>(this as TSelf, typeSpec, MemberTrait);
@@ -75,6 +81,14 @@ public TSelf CustomBase(string @base = null, string importPath = null, string or
         public TSelf CustomBase(string @base = null, string importPath = null, string originalTypeName = null, bool isDefaultExport = false,
             params ImplementedInterface[] implementedInterfaces)
             => _customBaseTrait.CustomBase(@base, importPath, originalTypeName, isDefaultExport, implementedInterfaces);
+
+        /// <inheritdoc />
+        public TSelf CustomBody(string body)
+            => _customBodyTrait.CustomBody(body);
+
+        /// <inheritdoc />
+        public TSelf CustomHeader(string header)
+            => _customHeaderTrait.CustomHeader(header);
 
         /// <inheritdoc />
         public TSelf DefaultExport(bool enabled = true) => _defaultExportTrait.DefaultExport(enabled);
@@ -131,4 +145,4 @@ public TSelf Type(string typeName, string importPath = null, string originalType
         /// <inheritdoc />
         public TSelf Undefined() => _undefinedTrait.Undefined();
     }
-}
+}
diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/CustomBodyTrait.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/CustomBodyTrait.cs
@@ -0,0 +1,21 @@
+using TypeGen.Core.TypeAnnotations;
+
+namespace TypeGen.Core.SpecGeneration.Builders.Traits;
+
+internal class CustomBodyTrait<TSpecBuilder> : ICustomBodyTrait<TSpecBuilder>
+{
+    private readonly TSpecBuilder _this;
+    private readonly TypeSpec _typeSpec;
+
+    public CustomBodyTrait(TSpecBuilder @this, TypeSpec typeSpec)
+    {
+        _this = @this;
+        _typeSpec = typeSpec;
+    }
+
+    public TSpecBuilder CustomBody(string body)
+    {
+        _typeSpec.SetCustomBody(body);
+        return _this;
+    }
+}
diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/CustomHeaderTrait.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/CustomHeaderTrait.cs
@@ -0,0 +1,21 @@
+using TypeGen.Core.TypeAnnotations;
+
+namespace TypeGen.Core.SpecGeneration.Builders.Traits;
+
+internal class CustomHeaderTrait<TSpecBuilder> : ICustomHeaderTrait<TSpecBuilder>
+{
+    private readonly TSpecBuilder _this;
+    private readonly TypeSpec _typeSpec;
+
+    public CustomHeaderTrait(TSpecBuilder @this, TypeSpec typeSpec)
+    {
+        _this = @this;
+        _typeSpec = typeSpec;
+    }
+
+    public TSpecBuilder CustomHeader(string header)
+    {
+        _typeSpec.SetCustomHeader(header);
+        return _this;
+    }
+}
diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/ICustomBodyTrait.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/ICustomBodyTrait.cs
@@ -0,0 +1,10 @@
+namespace TypeGen.Core.SpecGeneration.Builders.Traits;
+
+internal interface ICustomBodyTrait<TSpecBuilder>
+{
+    /// <summary>
+    /// Indicates type has a custom body (equivalent of TsExportAttribute's CustomBody).
+    /// </summary>
+    /// <returns>The current instance of <see cref="TSpecBuilder"/>.</returns>
+    TSpecBuilder CustomBody(string body);
+}
diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/ICustomHeaderTrait.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/Builders/Traits/ICustomHeaderTrait.cs
@@ -0,0 +1,10 @@
+namespace TypeGen.Core.SpecGeneration.Builders.Traits;
+
+internal interface ICustomHeaderTrait<TSpecBuilder>
+{
+    /// <summary>
+    /// Indicates type has a custom header (equivalent of TsExportAttribute's CustomHeader).
+    /// </summary>
+    /// <returns>The current instance of <see cref="TSpecBuilder"/>.</returns>
+    TSpecBuilder CustomHeader(string header);
+}
diff --git a/src/TypeGen/TypeGen.Core/SpecGeneration/TypeSpec.cs b/src/TypeGen/TypeGen.Core/SpecGeneration/TypeSpec.cs
@@ -21,7 +21,7 @@ public TypeSpec(ExportAttribute exportAttribute)
             _memberAttributes = new Dictionary<string, IList<Attribute>>();
             _additionalAttributes = new List<Attribute>();
         }
-        
+
         public void AddMember(string memberName) => _memberAttributes[memberName] = new List<Attribute>();
 
         public void AddCustomBaseAttribute(string @base = null, string importPath = null, string originalTypeName = null, bool isDefaultExport = false,
@@ -32,6 +32,8 @@ public void AddCustomBaseAttribute(string @base = null, string importPath = null
         public void AddDefaultValueAttribute(string memberName, string defaultValue) => AddMemberAttribute(memberName, new TsDefaultValueAttribute(defaultValue));
         public void AddIgnoreAttribute(string memberName) => AddMemberAttribute(memberName, new TsIgnoreAttribute());
         public void AddIgnoreBaseAttribute() => AddAdditionalAttribute(new TsIgnoreBaseAttribute());
+        public void SetCustomHeader(string header) { ExportAttribute.CustomHeader = header; }
+        public void SetCustomBody(string body) { ExportAttribute.CustomBody = body; }
         public void AddMemberNameAttribute(string memberName, string name) => AddMemberAttribute(memberName, new TsMemberNameAttribute(name));
         public void AddNotNullAttribute(string memberName) => AddMemberAttribute(memberName, new TsNotNullAttribute());
         public void AddNotReadonlyAttribute(string memberName) => AddMemberAttribute(memberName, new TsNotReadonlyAttribute());
@@ -48,8 +50,8 @@ public void AddTypeAttribute(string memberName, string typeName, string importPa
         public void AddTypeUnionsAttribute(string memberName, IEnumerable<string> typeUnions) => AddMemberAttribute(memberName, new TsTypeUnionsAttribute(typeUnions));
         public void AddTypeUnionsAttribute(string memberName, params string[] typeUnions) => AddMemberAttribute(memberName, new TsTypeUnionsAttribute(typeUnions));
         public void AddUndefinedAttribute(string memberName) => AddMemberAttribute(memberName, new TsUndefinedAttribute());
-        
+
         private void AddMemberAttribute(string memberName, Attribute attribute) => MemberAttributes[memberName].Add(attribute);
         private void AddAdditionalAttribute(Attribute attribute) => _additionalAttributes.Add(attribute);
     }
-}
+}
diff --git a/src/TypeGen/TypeGen.Core/TypeAnnotations/ExportAttribute.cs b/src/TypeGen/TypeGen.Core/TypeAnnotations/ExportAttribute.cs
@@ -11,7 +11,9 @@ namespace TypeGen.Core.TypeAnnotations
     public abstract class ExportAttribute : Attribute
     {
         private string _outputDir;
-
+        private string _customHeader;
+        private string _customBody;
+
         /// <summary>
         /// TypeScript file output directory
         /// </summary>
@@ -20,5 +22,23 @@ public string OutputDir
             get => _outputDir;
             set => _outputDir = FileSystemUtils.AsDirectory(value);
         }
+
+        /// <summary>
+        /// TypeScript file custom header
+        /// </summary>
+        public string CustomHeader
+        {
+            get => _customHeader;
+            set => _customHeader = value;
+        }
+
+        /// <summary>
+        /// TypeScript file custom body
+        /// </summary>
+        public string CustomBody
+        {
+            get => _customBody;
+            set => _customBody = value;
+        }
     }
 }