Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Rework code to reuse calculation on hash code processing and bump guava and define getter reused many times #898

Merged
merged 3 commits into from
Jun 4, 2024
Merged

Rework code to reuse calculation on hash code processing and bump guava and define getter reused many times #898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4bc407d
[pom] Bump guava to 33.2.1-jre
hazendaz Jun 4, 2024
bcc8fca
[rework] Reduce reused code by using common calculate hash code method
hazendaz Jun 4, 2024
f87d77f
[cleanup] Reuse file.getName() as a string as its called many times
hazendaz Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>33.2.0-jre</version>
<version>33.2.1-jre</version>
</dependency>
<dependency>
<!-- override vulnerable transitive version from commons-digester3 -->
Expand Down
90 changes: 50 additions & 40 deletions src/main/java/net/revelc/code/formatter/FormatterMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -699,26 +699,9 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
throws IOException, BadLocationException, MojoFailureException, MojoExecutionException {
final var log = this.getLog();
log.debug("Processing file: " + file);
final var fileName = file.getName();
final var originalCode = this.readFileAsString(file);

// Default to original hashing for unknown type otherwise include formatter options
String originalHash;
if (file.getName().endsWith(".java")) {
originalHash = this.sha512hash(originalCode + this.javaFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".js")) {
originalHash = this.sha512hash(originalCode + this.jsFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".html")) {
originalHash = this.sha512hash(originalCode + this.htmlFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".xml")) {
originalHash = this.sha512hash(originalCode + this.xmlFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".json")) {
originalHash = this.sha512hash(originalCode + this.jsonFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".css")) {
originalHash = this.sha512hash(originalCode + this.cssFormatter.getOptions().hashCode());
} else {
originalHash = this.sha512hash(originalCode);
}

final var originalHash = this.calculateHash(fileName, originalCode);
final var canonicalPath = file.getCanonicalPath();
final var path = canonicalPath.substring(basedirPath.length());
final var cachedHash = hashCache.getProperty(path);
Expand All @@ -730,50 +713,50 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro

Result result = null;
String formattedCode = null;
if (file.getName().endsWith(".java") && this.javaFormatter.isInitialized()) {
if (fileName.endsWith(".java") && this.javaFormatter.isInitialized()) {
if (this.skipJavaFormatting) {
log.debug(Type.JAVA + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.javaFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else if (file.getName().endsWith(".js") && this.jsFormatter.isInitialized()) {
} else if (fileName.endsWith(".js") && this.jsFormatter.isInitialized()) {
if (this.skipJsFormatting) {
log.debug(Type.JAVASCRIPT + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.jsFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else if (file.getName().endsWith(".html") && this.htmlFormatter.isInitialized()) {
} else if (fileName.endsWith(".html") && this.htmlFormatter.isInitialized()) {
if (this.skipHtmlFormatting) {
log.debug(Type.HTML + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.htmlFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else if (file.getName().endsWith(".xml") && this.xmlFormatter.isInitialized()) {
} else if (fileName.endsWith(".xml") && this.xmlFormatter.isInitialized()) {
if (this.skipXmlFormatting) {
log.debug(Type.XML + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.xmlFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else if (file.getName().endsWith(".json") && this.jsonFormatter.isInitialized()) {
} else if (fileName.endsWith(".json") && this.jsonFormatter.isInitialized()) {
if (this.skipJsonFormatting) {
log.debug(Type.JSON + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.jsonFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else if (file.getName().endsWith(".css") && this.cssFormatter.isInitialized()) {
} else if (fileName.endsWith(".css") && this.cssFormatter.isInitialized()) {
if (this.skipCssFormatting) {
log.debug(Type.CSS + FormatterMojo.FORMATTING_IS_SKIPPED);
result = Result.SKIPPED;
} else {
formattedCode = this.cssFormatter.formatFile(file, originalCode, this.lineEnding);
}
} else {
log.debug("No formatter found or initialization failed for file " + file.getName());
log.debug("No formatter found or initialization failed for file " + fileName);
result = Result.SKIPPED;
}

Expand Down Expand Up @@ -804,21 +787,8 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
String formattedHash;
if (Result.SKIPPED.equals(result)) {
formattedHash = originalHash;
// Default to formatted hashing for unknown type otherwise include formatter options
} else if (file.getName().endsWith(".java")) {
formattedHash = this.sha512hash(formattedCode + this.javaFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".js")) {
formattedHash = this.sha512hash(formattedCode + this.jsFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".html")) {
formattedHash = this.sha512hash(formattedCode + this.htmlFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".xml")) {
formattedHash = this.sha512hash(formattedCode + this.xmlFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".json")) {
formattedHash = this.sha512hash(formattedCode + this.jsonFormatter.getOptions().hashCode());
} else if (file.getName().endsWith(".css")) {
formattedHash = this.sha512hash(formattedCode + this.cssFormatter.getOptions().hashCode());
} else {
formattedHash = this.sha512hash(formattedCode);
formattedHash = this.calculateHash(fileName, formattedCode);
}
hashCache.setProperty(path, formattedHash);
this.hashCacheWritten = true;
Expand All @@ -842,6 +812,46 @@ protected void doFormatFile(final File file, final ResultCollector rc, final Pro
}
}

/**
* Calculate Hash.
*
* @param fileType
* the file type being processed
* @param code
* the code file for generating the hash
*
* @return the calculated hash for the file
*/
private String calculateHash(final String fileType, final String code) {
// Include formatter options with each known type
if (fileType.endsWith(".java")) {
return this.sha512hash(code + this.javaFormatter.getOptions().hashCode());
}

if (fileType.endsWith(".js")) {
return this.sha512hash(code + this.jsFormatter.getOptions().hashCode());
}

if (fileType.endsWith(".html")) {
return this.sha512hash(code + this.htmlFormatter.getOptions().hashCode());
}

if (fileType.endsWith(".xml")) {
return this.sha512hash(code + this.xmlFormatter.getOptions().hashCode());
}

if (fileType.endsWith(".json")) {
return this.sha512hash(code + this.jsonFormatter.getOptions().hashCode());
}

if (fileType.endsWith(".css")) {
return this.sha512hash(code + this.cssFormatter.getOptions().hashCode());
}

// Default to formatted hashing for unknown type
return this.sha512hash(code);
}

/**
* sha512hash.
*
Expand Down