-
Notifications
You must be signed in to change notification settings - Fork 49
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.
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
Issue 116 Name and Reuse Repeating Conditions #131
Changes from 14 commits
e275f1b
bf1f21c
b1183b4
e7eaede
980e5e3
ef16c7e
add2194
4b3c180
b00acc0
1e95bd4
8607d31
3dbf928
9bf6f8c
79116cd
cb4e942
e712735
5f2ecfb
4e13818
8e1877b
55e8072
de0a612
8e9ff91
8afaf88
a8b8904
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
/*- | ||
* #%L | ||
* AEM Rules for SonarQube | ||
* %% | ||
* Copyright (C) 2015-2018 Cognifide Limited | ||
* %% | ||
* 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. | ||
* #L% | ||
*/ | ||
package com.cognifide.aemrules.htl.checks; | ||
|
||
import com.cognifide.aemrules.htl.api.ParsingErrorRule; | ||
import com.cognifide.aemrules.metadata.Metadata; | ||
import com.cognifide.aemrules.tag.Tags; | ||
import com.cognifide.aemrules.version.AemVersion; | ||
import java.util.HashSet; | ||
import java.util.List; | ||
import java.util.Optional; | ||
import java.util.Set; | ||
import java.util.stream.Collectors; | ||
import org.apache.sling.scripting.sightly.compiler.expression.Expression; | ||
import org.sonar.check.Priority; | ||
import org.sonar.check.Rule; | ||
import org.sonar.plugins.html.node.Attribute; | ||
import org.sonar.plugins.html.node.TagNode; | ||
|
||
@Rule( | ||
key = NamingAndReusingConditionsCheck.RULE_KEY, | ||
name = NamingAndReusingConditionsCheck.RULE_MESSAGE, | ||
priority = Priority.INFO, | ||
tags = Tags.AEM | ||
) | ||
@AemVersion( | ||
all = true | ||
) | ||
@Metadata( | ||
technicalDebt = "10min" | ||
) | ||
@ParsingErrorRule | ||
public class NamingAndReusingConditionsCheck extends AbstractHtlCheck { | ||
|
||
static final String RULE_KEY = "HTL-5"; | ||
|
||
static final String RULE_MESSAGE = "Consider caching data-sly-test conditions"; | ||
|
||
private static final String SLY_TEST = "data-sly-test"; | ||
|
||
private Set<String> unnamedConditions = new HashSet<>(); | ||
|
||
private Set<String> namedConditions = new HashSet<>(); | ||
|
||
@Override | ||
public void startHtlElement(List<Expression> expressions, TagNode node) { | ||
if (isConditionReused(expressions, node)) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This time also, the method name is misleading since "reused" has a positive connotation whereas in your case reused means "the same condition used couple of times needlessly". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Conditions inverted and method name changed to |
||
createViolation(node.getStartLinePosition(), RULE_MESSAGE); | ||
} | ||
updateConditionSets(expressions, node); | ||
} | ||
|
||
private boolean isConditionReused(List<Expression> expressions, TagNode node) { | ||
String condition = expressions.stream() | ||
.map(Expression::getRawText) | ||
.map(text -> text.replaceAll("[${}]", "")) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please extract 'getRawText' and 'text.replaceAll("[${}]", "")' to method and reuse it in '103' line. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Extracted |
||
.findFirst() | ||
.orElse(""); | ||
|
||
return unnamedConditions.stream() | ||
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
.anyMatch(condition::equals) && // To see if someone is reusing not cached condition | ||
node.getAttributes().stream() | ||
.map(Attribute::getName) | ||
.anyMatch(name -> name.equals(SLY_TEST)); // To see if someone is not declaring new cached condition | ||
} | ||
|
||
private void updateConditionSets(List<Expression> expressions, TagNode node) { | ||
Optional<String> condition = node.getAttributes().stream() | ||
.map(Attribute::getName) | ||
.filter(text -> text.contains(SLY_TEST)) | ||
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
.findFirst(); | ||
if (condition.isPresent() && !condition.get().equals(SLY_TEST)) { | ||
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
condition = Optional.of(condition.get().substring(14)); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what is 14? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed.
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
namedConditions.add(condition.get()); | ||
} else { | ||
unnamedConditions.addAll(expressions.stream() | ||
.map(Expression::getRawText) | ||
.map(text -> text.replaceAll("[${}]", "")) | ||
.filter(text -> !namedConditions.contains(text)) | ||
.collect(Collectors.toSet())); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
Always try to re-use existing conditions, so the code is more readable. | ||
|
||
== Noncompliant Code Example | ||
``` | ||
<!--/* Bad - the same condition is evaluated multiple times */--> | ||
<span class="uber-mode__top-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"> | ||
<div class="my-component"> | ||
Blah blah blah | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe ... ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. fixed
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
</div> | ||
</span> | ||
<span class="uber-mode__bottom-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"></span> | ||
``` | ||
|
||
|
||
|
||
== Compliant Solution | ||
``` | ||
<span class="uber-mode__top-bar" data-sly-test.uberMode="${uberModeHelper.uberModeEnabled || forceUberMode}"> | ||
<div class="my-component"> | ||
Blah blah blah | ||
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
</div> | ||
</span> | ||
<span class="uber-mode__bottom-bar" data-sly-test="${uberMode}"></span> | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1 @@ | ||
<!-- | ||
|
||
#%L | ||
AEM Rules for SonarQube | ||
%% | ||
Copyright (C) 2015-2018 Cognifide Limited | ||
%% | ||
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. | ||
#L% | ||
|
||
--> | ||
<div data-sly-list="${model.value}" class="list"></div> <!--/* Non-Compliant */--> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<span class="uber-mode__top-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"> | ||
<div class="my-component"> | ||
Text | ||
</div> | ||
</span> | ||
|
||
<span class="uber-mode__bottom-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"></span> <!--/* Non-Compliant */--> | ||
|
||
<span class="uber-mode__top-bar" data-sly-test.uberMode="${uberModeHelper.uberModeEnabled || forceUberMode}"> | ||
<div class="my-component"> | ||
Text | ||
</div> | ||
</span> | ||
<span class="uber-mode__top-bar" data-sly-test="${uberMode}"></span> | ||
|
||
<span class="uber-mode__bottom-bar" data-sly-test="${uberModeHelper.uberModeEnabled || forceUberMode}"> <!--/* Non-Compliant */--> | ||
<div class="my-component"> | ||
Text | ||
</div> | ||
</span> | ||
|
||
<span class="uber-mode__bottom-bar" data-sly-test="${uberMode}"></span> | ||
chutch marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/*- | ||
* #%L | ||
* AEM Rules for SonarQube | ||
* %% | ||
* Copyright (C) 2015-2018 Cognifide Limited | ||
* %% | ||
* 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. | ||
* #L% | ||
*/ | ||
package com.cognifide.aemrules.htl.checks; | ||
|
||
import com.cognifide.aemrules.htl.AbstractBaseTest; | ||
import org.junit.Test; | ||
|
||
public class NamingAndReusingConditionsCheckTest extends AbstractBaseTest { | ||
|
||
@Test | ||
public void checkHtlAttributesOrder() { | ||
check = new NamingAndReusingConditionsCheck(); | ||
filename = "src/test/files/checks/htl/NamingAndReusingConditionsCheck.html"; | ||
verify(); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This API has to be rewritten as it decouples expression from the attribute.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@piotr-wilczynski You should take a look at this :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this method is giving You all of the expressions that exists in node, but if You want the have relation between attribute and expresion You can always check if there is any expression in the attribute and proceed somehow. There is a method called htlExpression
default void htlExpression(Expression expression, Node node)
It is probably what You are looking for @chutch ?