Introduce StringCaseLocaleUsage check

[rickie]

Fixes #3809.

[cushon]

Thanks!

[cushon]

Just curious, did you see examples like .toUpperCase /* Comment with parens: (). */() in practice?

It's nice to handle this correctly, but I would normally have just done something like replace(getEndPosition(tree.getMethodSelect()), getEndPosition(tree), "(Locale.ROOT)")

[rickie]

Hmm, no we didn't encounter a lot of problems, we created this after our initial implementation (that was based on a String#replaceFirst) which wasn't correct enough.

It's indeed a bit more complex than what you are proposing. We can do 3 things:
(1) Extract this functionality to a utility class and re-use this setup, which might make it worth that it is slightly more complex.
(2) Keep it as-is.
(3) Use the method you are proposing.

Let me know what you prefer 😄.

[cushon]

I'd suggest creating a helper in SuggestedFixes, but I'm not sure how general it is without a way to choose where the argument is inserted, and I don't have a great ideas for the API. Maybe something like addArgumentToMethod with a parameter for the insertion index?

How about (2) for now, and if you feel like it you can add a TODO to consider promoting it to SuggestedFixes later :)

[rickie]

Deal, let's go for (2), I'll add a TODO.

[cushon]

We'll need the copyright headers, I can also add them during the import if that's easier.

/*
 * Copyright 2023 The Error Prone Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

('The Error Prone Authors' refers to https://github.com/google/error-prone/blob/master/AUTHORS, you're welcome to add yourself there also. There's some more detail about that in https://opensource.google/documentation/reference/releasing/authors)

[rickie]

I will push a commit with the copyright headers.

you're welcome to add yourself there also.

That'd be cool! Added that in the commit.

I can't reach the website with more details though, it asked me to do a sign in with a "@google.com" email, so it's probably an internal thing?

[cushon]

Sorry, there's an external mirror with the same content, I just pasted the wrong link. That should have been https://opensource.google/documentation/reference/releasing/authors

[rickie]

Thanks for the quick responses. Added the commits 😄.