feat(CssBuilder): add AddStyle method #5272
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis pull request introduces the AddStyle method to the CssBuilder class, enabling the addition of CSS styles. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @ArgoZhang - I've reviewed your changes - here's some feedback:
Overall Comments:
- Minor typo in test assertions: 'widht' should be 'width' in AddStyle_When test method
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟡 Testing: 2 issues found
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| return this; | ||
| } | ||
|
|
||
| /// <summary> |
Contributor
There was a problem hiding this comment.
issue (complexity): Consider simplifying the AddStyle overloads by using a parameter object to reduce the number of methods and centralize the logic.
The multiple AddStyle overloads can be simplified into a more maintainable pattern using a parameter object approach. This reduces complexity while maintaining all functionality:
public record StyleOptions
{
public string Key { get; init; } = "";
public string? Value { get; init; }
public Func<string?>? ValueFactory { get; init; }
public bool? When { get; init; }
public Func<bool>? WhenFactory { get; init; }
}
public CssBuilder AddStyle(StyleOptions options)
{
if (ShouldAddStyle(options))
{
var value = GetStyleValue(options);
if (!string.IsNullOrEmpty(value))
stringBuffer.Add($"{options.Key}: {value};");
}
return this;
}
// Convenience overload for the most common case
public CssBuilder AddStyle(string key, string? value, bool when = true) =>
AddStyle(new StyleOptions { Key = key, Value = value, When = when });
private static bool ShouldAddStyle(StyleOptions options) =>
(options.WhenFactory?.Invoke() ?? options.When ?? true);
private static string? GetStyleValue(StyleOptions options) =>
options.ValueFactory?.Invoke() ?? options.Value;This approach:
- Reduces the number of overloads from 8 to 2
- Makes the API more extensible for future additions
- Maintains all current functionality
- Improves maintainability with centralized logic
- Keeps the simple cases simple while supporting complex scenarios
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5272 +/- ##
===========================================
- Coverage 100.00% 99.99% -0.01%
===========================================
Files 639 639
Lines 28767 28777 +10
Branches 4085 4091 +6
===========================================
+ Hits 28767 28775 +8
- Partials 0 2 +2 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add AddStyle method
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号
Description
fixes #5271
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
New Features:
AddStylemethod to theCssBuilderclass to conditionally add styles based on boolean values or functions.