-
Notifications
You must be signed in to change notification settings - Fork 744
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rename DurationOfLongTemporalUnit to DurationTemporalUnit and cover d…
…uration.plus(long, TemporalUnit) and duration.minus(long, TemporalUnit). Also ban calls to Instant APIs where the TemporalUnit is not supported. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=250547375
- Loading branch information
1 parent
254f3f2
commit beef3d8
Showing
5 changed files
with
370 additions
and
32 deletions.
There are no files selected for viewing
This file contains 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
89 changes: 89 additions & 0 deletions
89
core/src/main/java/com/google/errorprone/bugpatterns/time/InstantTemporalUnit.java
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright 2019 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. | ||
| */ | ||
| package com.google.errorprone.bugpatterns.time; | ||
|
|
||
| import static com.google.common.collect.Sets.toImmutableEnumSet; | ||
| import static com.google.errorprone.BugPattern.ProvidesFix.NO_FIX; | ||
| import static com.google.errorprone.BugPattern.SeverityLevel.ERROR; | ||
| import static com.google.errorprone.bugpatterns.time.DurationGetTemporalUnit.getInvalidChronoUnit; | ||
| import static com.google.errorprone.matchers.Matchers.allOf; | ||
| import static com.google.errorprone.matchers.Matchers.anyOf; | ||
| import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod; | ||
|
|
||
| import com.google.common.collect.ImmutableSet; | ||
| import com.google.errorprone.BugPattern; | ||
| import com.google.errorprone.VisitorState; | ||
| import com.google.errorprone.bugpatterns.BugChecker; | ||
| import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher; | ||
| import com.google.errorprone.matchers.Description; | ||
| import com.google.errorprone.matchers.Matcher; | ||
| import com.google.errorprone.matchers.Matchers; | ||
| import com.sun.source.tree.ExpressionTree; | ||
| import com.sun.source.tree.MethodInvocationTree; | ||
| import java.time.temporal.ChronoUnit; | ||
| import java.util.Arrays; | ||
|
|
||
| /** | ||
| * Bans calls to {@code Instant} APIs where the {@link java.time.temporal.TemporalUnit} is not one | ||
| * of: {@code NANOS}, {@code MICROS}, {@code MILLIS}, {@code SECONDS}, {@code MINUTES}, {@code | ||
| * HOURS}, {@code HALF_DAYS}, or {@code DAYS}. | ||
| */ | ||
| @BugPattern( | ||
| name = "InstantTemporalUnit", | ||
| summary = | ||
| "Instant APIs only work for NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS, HALF_DAYS and" | ||
| + " DAYS.", | ||
| severity = ERROR, | ||
| providesFix = NO_FIX) | ||
| public final class InstantTemporalUnit extends BugChecker implements MethodInvocationTreeMatcher { | ||
|
|
||
| private static final String INSTANT = "java.time.Instant"; | ||
| private static final String TEMPORAL_UNIT = "java.time.temporal.TemporalUnit"; | ||
|
|
||
| private static final Matcher<ExpressionTree> INSTANT_OF_LONG_TEMPORAL_UNIT = | ||
| allOf( | ||
| anyOf( | ||
| instanceMethod() | ||
| .onExactClass(INSTANT) | ||
| .named("minus") | ||
| .withParameters("long", TEMPORAL_UNIT), | ||
| instanceMethod() | ||
| .onExactClass(INSTANT) | ||
| .named("plus") | ||
| .withParameters("long", TEMPORAL_UNIT), | ||
| instanceMethod() | ||
| .onExactClass(INSTANT) | ||
| .named("until") | ||
| .withParameters("java.time.temporal.Temporal", TEMPORAL_UNIT)), | ||
| Matchers.not(Matchers.packageStartsWith("java."))); | ||
|
|
||
| // This definition comes from Instant.isSupported(TemporalUnit) | ||
| static final ImmutableSet<ChronoUnit> INVALID_TEMPORAL_UNITS = | ||
| Arrays.stream(ChronoUnit.values()) | ||
| .filter(c -> !c.isTimeBased()) | ||
| .filter(c -> !c.equals(ChronoUnit.DAYS)) // DAYS is explicitly allowed | ||
| .collect(toImmutableEnumSet()); | ||
|
|
||
| @Override | ||
| public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) { | ||
| if (INSTANT_OF_LONG_TEMPORAL_UNIT.matches(tree, state)) { | ||
| if (getInvalidChronoUnit(tree.getArguments().get(1), INVALID_TEMPORAL_UNITS).isPresent()) { | ||
| return describeMatch(tree); | ||
| } | ||
| } | ||
| return Description.NO_MATCH; | ||
| } | ||
| } |
This file contains 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
This file contains 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
Oops, something went wrong.