Skip to content

fix: replace Append with WriteLine and remove blank spaces #1967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisPulman merged 1 commit into from
Apr 5, 2025
Merged

fix: replace Append with WriteLine and remove blank spaces #1967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
265 changes: 140 additions & 125 deletions InterfaceStubGenerator.Shared/Emitter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,54 +18,54 @@

var attributeText = $$"""

#pragma warning disable
namespace {{model.RefitInternalNamespace}}
{
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.AttributeUsage (global::System.AttributeTargets.Class | global::System.AttributeTargets.Struct | global::System.AttributeTargets.Enum | global::System.AttributeTargets.Constructor | global::System.AttributeTargets.Method | global::System.AttributeTargets.Property | global::System.AttributeTargets.Field | global::System.AttributeTargets.Event | global::System.AttributeTargets.Interface | global::System.AttributeTargets.Delegate)]
sealed class PreserveAttribute : global::System.Attribute
{
//
// Fields
//
public bool AllMembers;

public bool Conditional;
}
}
#pragma warning restore

""";
#pragma warning disable
namespace {{model.RefitInternalNamespace}}
{
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
[global::System.AttributeUsage (global::System.AttributeTargets.Class | global::System.AttributeTargets.Struct | global::System.AttributeTargets.Enum | global::System.AttributeTargets.Constructor | global::System.AttributeTargets.Method | global::System.AttributeTargets.Property | global::System.AttributeTargets.Field | global::System.AttributeTargets.Event | global::System.AttributeTargets.Interface | global::System.AttributeTargets.Delegate)]
sealed class PreserveAttribute : global::System.Attribute
{
//
// Fields
//
public bool AllMembers;

public bool Conditional;
}
}
#pragma warning restore

""";
// add the attribute text
addSource("PreserveAttribute.g.cs", SourceText.From(attributeText, Encoding.UTF8));

var generatedClassText = $$"""

#pragma warning disable
namespace Refit.Implementation
{

/// <inheritdoc />
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.Diagnostics.DebuggerNonUserCode]
[{{model.PreserveAttributeDisplayName}}]
[global::System.Reflection.Obfuscation(Exclude=true)]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
internal static partial class Generated
{
#if NET5_0_OR_GREATER
[System.Runtime.CompilerServices.ModuleInitializer]
[System.Diagnostics.CodeAnalysis.DynamicDependency(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All, typeof(global::Refit.Implementation.Generated))]
public static void Initialize()
{
}
#endif
}
}
#pragma warning restore

""";
#pragma warning disable
namespace Refit.Implementation
{

/// <inheritdoc />
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.Diagnostics.DebuggerNonUserCode]
[{{model.PreserveAttributeDisplayName}}]
[global::System.Reflection.Obfuscation(Exclude=true)]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
internal static partial class Generated
{
#if NET5_0_OR_GREATER
[System.Runtime.CompilerServices.ModuleInitializer]
[System.Diagnostics.CodeAnalysis.DynamicDependency(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All, typeof(global::Refit.Implementation.Generated))]
public static void Initialize()
{
}
#endif
}
}
#pragma warning restore

""";
addSource("Generated.g.cs", SourceText.From(generatedClassText, Encoding.UTF8));
}

Expand All @@ -76,39 +76,53 @@
// if nullability is supported emit the nullable directive
if (model.Nullability != Nullability.None)
{
source.WriteLine("#nullable " + (model.Nullability == Nullability.Enabled ? "enable" : "disable"));
source.WriteLine(
"#nullable " + (model.Nullability == Nullability.Enabled ? "enable" : "disable")
);
}

source.WriteLine(
$@"#pragma warning disable
namespace Refit.Implementation
{{

partial class Generated
{{

/// <inheritdoc />
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.Diagnostics.DebuggerNonUserCode]
[{model.PreserveAttributeDisplayName}]
[global::System.Reflection.Obfuscation(Exclude=true)]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
partial class {model.Ns}{model.ClassDeclaration}
: {model.InterfaceDisplayName}{GenerateConstraints(model.Constraints, false)}

{{
/// <inheritdoc />
public global::System.Net.Http.HttpClient Client {{ get; }}
readonly global::Refit.IRequestBuilder requestBuilder;

/// <inheritdoc />
public {model.Ns}{model.ClassSuffix}(global::System.Net.Http.HttpClient client, global::Refit.IRequestBuilder requestBuilder)
{{
Client = client;
this.requestBuilder = requestBuilder;
}}"
$$"""
#pragma warning disable
namespace Refit.Implementation
{

partial class Generated
{

/// <inheritdoc />
[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
[global::System.Diagnostics.DebuggerNonUserCode]
[{{model.PreserveAttributeDisplayName}}]
[global::System.Reflection.Obfuscation(Exclude=true)]
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
partial class {{model.Ns}}{{model.ClassDeclaration}}
: {{model.InterfaceDisplayName}}
"""
);

source.Indentation += 2;
GenerateConstraints(source, model.Constraints, false);
source.Indentation--;

source.WriteLine(
$$"""
{
/// <inheritdoc />
public global::System.Net.Http.HttpClient Client { get; }
readonly global::Refit.IRequestBuilder requestBuilder;

/// <inheritdoc />
public {{model.Ns}}{{model.ClassSuffix}}(global::System.Net.Http.HttpClient client, global::Refit.IRequestBuilder requestBuilder)
{
Client = client;
this.requestBuilder = requestBuilder;
}

"""
);

source.Indentation++;
var uniqueNames = new UniqueNameBuilder();
uniqueNames.Reserve(model.MemberNames);

Expand All @@ -135,13 +149,15 @@
WriteDisposableMethod(source);
}

source.Indentation -= 2;
source.WriteLine(
@"
}
}
}
"""
}
}
}

#pragma warning restore"
#pragma warning restore
"""
);
return source.ToSourceText();
}
Expand Down Expand Up @@ -172,12 +188,11 @@
ReturnTypeInfo.AsyncVoid => (true, "await (", ").ConfigureAwait(false)"),
ReturnTypeInfo.AsyncResult => (true, "return await (", ").ConfigureAwait(false)"),
ReturnTypeInfo.Return => (false, "return ", ""),
_
=> throw new ArgumentOutOfRangeException(
nameof(methodModel.ReturnTypeMetadata),
methodModel.ReturnTypeMetadata,
"Unsupported value."
)
_ => throw new ArgumentOutOfRangeException(

Check warning on line 191 in InterfaceStubGenerator.Shared/Emitter.cs

View workflow job for this annotation

GitHub Actions / build / build 

Method WriteRefitMethod passes 'ReturnTypeMetadata' as the paramName argument to a ArgumentOutOfRangeException constructor. Replace this argument with one of the method's parameter names. Note that the provided parameter name should have the exact casing as declared on the method. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca2208)
nameof(methodModel.ReturnTypeMetadata),
methodModel.ReturnTypeMetadata,
"Unsupported value."
),
};

WriteMethodOpening(source, methodModel, !isTopLevel, isAsync);
Expand All @@ -204,13 +219,13 @@
? $", new global::System.Type[] {{ {string.Join(", ", genericArray)} }}"
: string.Empty;

source.Append(
@$"
source.WriteLine(
$"""
var ______arguments = {argumentsArrayString};
var ______func = requestBuilder.BuildRestResultFuncForMethod(""{methodModel.Name}"", {parameterTypesExpression}{genericString} );
var ______func = requestBuilder.BuildRestResultFuncForMethod("{methodModel.Name}", {parameterTypesExpression}{genericString} );

{@return}({returnType})______func(this.Client, ______arguments){configureAwait};
"
"""
);

WriteMethodClosing(source);
Expand All @@ -221,29 +236,26 @@
WriteMethodOpening(source, methodModel, true);

source.WriteLine(
@"
throw new global::System.NotImplementedException(""Either this method has no Refit HTTP method attribute or you've used something other than a string literal for the 'path' argument."");");
@"throw new global::System.NotImplementedException(""Either this method has no Refit HTTP method attribute or you've used something other than a string literal for the 'path' argument."");"
);

source.Indentation += 1;
WriteMethodClosing(source);
source.Indentation -= 1;
}

// TODO: This assumes that the Dispose method is a void that takes no parameters.
// The previous version did not.
// Does the bool overload cause an issue here.
private static void WriteDisposableMethod(SourceWriter source)
{
source.Append(
source.WriteLine(
"""


/// <inheritdoc />
void global::System.IDisposable.Dispose()
{
Client?.Dispose();
}
"""
/// <inheritdoc />
void global::System.IDisposable.Dispose()
{
Client?.Dispose();
}
"""
);
}

Expand All @@ -267,12 +279,12 @@
// find a name and generate field declaration.
var typeParameterFieldName = uniqueNames.New(TypeParameterVariableName);
var types = string.Join(", ", methodModel.Parameters.Select(x => $"typeof({x.Type})"));
source.Append(
$$"""

source.WriteLine(
$$"""

private static readonly global::System.Type[] {{typeParameterFieldName}} = new global::System.Type[] {{{types}} };
"""
private static readonly global::System.Type[] {{typeParameterFieldName}} = new global::System.Type[] {{{types}} };
"""
);

return typeParameterFieldName;
Expand All @@ -288,18 +300,17 @@
var visibility = !isExplicitInterface ? "public " : string.Empty;
var async = isAsync ? "async " : "";

source.Append(
@$"

/// <inheritdoc />
{visibility}{async}{methodModel.ReturnType} "
var builder = new StringBuilder();
builder.Append(
@$"/// <inheritdoc />
{visibility}{async}{methodModel.ReturnType} "
);

if (isExplicitInterface)
{
source.Append(@$"{methodModel.ContainingType}.");
builder.Append(@$"{methodModel.ContainingType}.");
}
source.Append(@$"{methodModel.DeclaredMethod}(");
builder.Append(@$"{methodModel.DeclaredMethod}(");

if (methodModel.Parameters.Count > 0)
{
Expand All @@ -311,38 +322,45 @@
list.Add($@"{param.Type}{(annotation ? '?' : string.Empty)} @{param.MetadataName}");
}

source.Append(string.Join(", ", list));
builder.Append(string.Join(", ", list));
}

source.Append(
@$"){GenerateConstraints(methodModel.Constraints, isExplicitInterface)}
{{"
);
builder.Append(")");

Check warning on line 328 in InterfaceStubGenerator.Shared/Emitter.cs

View workflow job for this annotation

GitHub Actions / build / build 

Use 'StringBuilder.Append(char)' instead of 'StringBuilder.Append(string)' when the input is a constant unit string (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1834)

source.WriteLine();
source.WriteLine(builder.ToString());
source.Indentation++;
GenerateConstraints(source, methodModel.Constraints, isExplicitInterface);
source.Indentation--;
source.WriteLine("{");
source.Indentation++;
}

private static void WriteMethodClosing(SourceWriter source) => source.Append(@" }");
private static void WriteMethodClosing(SourceWriter source)
{
source.Indentation--;
source.WriteLine("}");
}

private static string GenerateConstraints(
private static void GenerateConstraints(
SourceWriter writer,
ImmutableEquatableArray<TypeConstraint> typeParameters,
bool isOverrideOrExplicitImplementation
)
{
var source = new StringBuilder();
// Need to loop over the constraints and create them
foreach (var typeParameter in typeParameters)
{
WriteConstraintsForTypeParameter(
source,
writer,
typeParameter,
isOverrideOrExplicitImplementation
);
}

return source.ToString();
}

private static void WriteConstraintsForTypeParameter(
StringBuilder source,
SourceWriter source,
TypeConstraint typeParameter,
bool isOverrideOrExplicitImplementation
)
Expand Down Expand Up @@ -388,10 +406,7 @@

if (parameters.Count > 0)
{
source.Append(
@$"
where {typeParameter.TypeName} : {string.Join(", ", parameters)}"
);
source.WriteLine($"where {typeParameter.TypeName} : {string.Join(", ", parameters)}");
}
}
}
Loading
Loading