stringutil: Contains - #142
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
==========================================
+ Coverage 79.11% 79.27% +0.16%
==========================================
Files 33 33
Lines 1915 1930 +15
==========================================
+ Hits 1515 1530 +15
Misses 354 354
Partials 46 46 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a Contains utility function to check for the presence of a class in a space-separated string, along with a comprehensive set of tests. The implementation of Contains is efficient as it avoids memory allocations, but it incorrectly handles whitespace by only considering spaces as separators. My main feedback is to refactor it to correctly handle all whitespace characters as per HTML standards, which also simplifies the code. I've also suggested expanding the test suite to cover these cases.
| func Contains(classAttr, classVal string) bool { | ||
| n := len(classAttr) | ||
| m := len(classVal) | ||
| if m == 0 { | ||
| return false | ||
| } | ||
|
|
||
| i := 0 | ||
| for i < n { | ||
| // Skip whitespace | ||
| for i < n && classAttr[i] == ' ' { | ||
| i++ | ||
| } | ||
| // Mark the start of the current token | ||
| start := i | ||
| // Advance to the end of the token | ||
| for i < n && classAttr[i] != ' ' { | ||
| i++ | ||
| } | ||
| // Exact match against classCheck | ||
| if i-start == m && classAttr[start:i] == classVal { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } |
There was a problem hiding this comment.
The current implementation manually parses the space-separated string. While this is allocation-efficient, it has a few drawbacks:
- It's less readable than using the standard library.
- It only considers ASCII space (
' ') as a separator. HTML class attributes can be separated by any whitespace character (space, tab, newline, etc.), which means this implementation is not fully compliant and can lead to incorrect behavior.
A more robust and idiomatic Go implementation would use strings.Fields, which handles all Unicode whitespace characters correctly and is much simpler to read and maintain. The performance impact of allocations is often negligible for this kind of utility function.
You will need to add import "strings" to the file.
func Contains(classAttr, classVal string) bool {
if classVal == "" {
return false
}
for _, s := range strings.Fields(classAttr) {
if s == classVal {
return true
}
}
return false
}| classVal: "qux", | ||
| want: false, | ||
| }, | ||
| } |
There was a problem hiding this comment.
The test suite is very thorough. To make it even more robust, consider adding test cases for other types of whitespace separators, as defined by the HTML spec for class attributes. This would include tabs (\t), newlines (\n), etc. For example:
{
name: "tab separator",
classAttr: "foo\tbar",
classVal: "bar",
want: true,
},
{
name: "mixed whitespace",
classAttr: " foo \t bar\n baz ",
classVal: "baz",
want: true,
},This will help ensure the Contains function is fully compliant with how class attributes are parsed in browsers.
1 participant
No description provided.