Skip to content

refactor: make ScopeHandler a sealed class to drop untestable equality members #443

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
samtrion merged 1 commit into from
Oct 29, 2026
Merged

refactor: make ScopeHandler a sealed class to drop untestable equality members #443

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
44 changes: 4 additions & 40 deletions src/NetEvolve.CodeBuilder/CSharpCodeBuilder.Scope.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,18 @@ public IDisposable ScopeLine(string? value)
}

/// <summary>
/// A disposable struct that manages indentation scope for a <see cref="CSharpCodeBuilder"/>.
/// A disposable class that manages indentation scope for a <see cref="CSharpCodeBuilder"/>.
/// </summary>
/// <remarks>
/// This struct increments the indentation level when created and decrements it when disposed.
/// This class increments the indentation level when created and decrements it when disposed.
/// It is designed to work with the 'using' statement to provide automatic indentation management.
/// </remarks>
private readonly struct ScopeHandler : IDisposable, IEquatable<ScopeHandler>
private sealed class ScopeHandler : IDisposable
{
private readonly CSharpCodeBuilder _builder;

/// <summary>
/// Initializes a new instance of the <see cref="ScopeHandler"/> struct and increments the indentation level.
/// Initializes a new instance of the <see cref="ScopeHandler"/> class and increments the indentation level.
/// </summary>
/// <param name="builder">The <see cref="CSharpCodeBuilder"/> instance to manage indentation for.</param>
internal ScopeHandler(CSharpCodeBuilder builder)
Expand All @@ -77,41 +77,5 @@ internal ScopeHandler(CSharpCodeBuilder builder)
/// This method is called automatically when the 'using' statement block ends.
/// </remarks>
public void Dispose() => _ = _builder.Append('}');

/// <summary>
/// Determines whether the specified object is equal to the current instance.
/// </summary>
/// <param name="obj">The object to compare with the current instance.</param>
/// <returns>Always returns <see langword="false"/> since ScopeHandler instances should not be compared.</returns>
public override readonly bool Equals(object? obj) => false;

/// <summary>
/// Determines whether the specified ScopeHandler is equal to the current instance.
/// </summary>
/// <param name="other">The ScopeHandler to compare with the current instance.</param>
/// <returns>Always returns <see langword="false"/> since ScopeHandler instances should not be compared.</returns>
public readonly bool Equals(ScopeHandler other) => false;

/// <summary>
/// Returns the hash code for this instance.
/// </summary>
/// <returns>A hash code based on the internal builder reference.</returns>
public override readonly int GetHashCode() => _builder?.GetHashCode() ?? 0;

/// <summary>
/// Determines whether two ScopeHandler instances are equal.
/// </summary>
/// <param name="_">The first instance to compare.</param>
/// <param name="__">The second instance to compare.</param>
/// <returns>Always returns <see langword="false"/> since ScopeHandler instances should not be compared.</returns>
public static bool operator ==(ScopeHandler _, ScopeHandler __) => false;

/// <summary>
/// Determines whether two ScopeHandler instances are not equal.
/// </summary>
/// <param name="_">The first instance to compare.</param>
/// <param name="__">The second instance to compare.</param>
/// <returns>Always returns <see langword="true"/> since ScopeHandler instances should not be compared.</returns>
public static bool operator !=(ScopeHandler _, ScopeHandler __) => true;
}
}
Loading