-
Notifications
You must be signed in to change notification settings - Fork 106
Separating application.properties into different files based on profile #563
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
base: main
Are you sure you want to change the base?
Changes from 20 commits
1b36230
cb8dbe4
ad78269
75673fa
27b2398
b390d3a
26f3c19
e1eb520
b8c6239
cce5019
780250e
b1e4719
5b65012
0cf74f9
e7398d3
35ae8c7
825d68c
46d75d0
5aef7ae
87e7146
6c3cdd7
4f23297
fbca498
9363b0f
3631135
798caa3
ef99fbb
85a9aa1
dc7d1de
967e809
c90923d
2549403
a6c0f45
cceb6e3
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,179 @@ | ||
/* | ||
* Copyright 2024 the original author or authors. | ||
* <p> | ||
* 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 | ||
* <p> | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* <p> | ||
* 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 org.openrewrite.java.spring; | ||
|
||
import lombok.EqualsAndHashCode; | ||
import lombok.Value; | ||
import org.openrewrite.*; | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
import org.jspecify.annotations.Nullable; | ||
import org.openrewrite.properties.CreatePropertiesFile; | ||
import org.openrewrite.properties.PropertiesVisitor; | ||
import org.openrewrite.properties.tree.Properties; | ||
|
||
import java.util.*; | ||
import java.util.concurrent.atomic.AtomicBoolean; | ||
import java.util.stream.Collectors; | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
import java.util.stream.Stream; | ||
|
||
@Value | ||
@EqualsAndHashCode(callSuper = false) | ||
public class SeparateApplicationPropertiesByProfile extends ScanningRecipe<SeparateApplicationPropertiesByProfile.Accumulator> { | ||
|
||
@Override | ||
public String getDisplayName() { | ||
return "Separate `application.properties` by profile"; | ||
} | ||
|
||
@Override | ||
public String getDescription() { | ||
return "Separating `application.properties` into separate files based on profiles while appending to any existing `application-profile.properties`."; | ||
} | ||
|
||
@Override | ||
public Accumulator getInitialValue(ExecutionContext ctx) { | ||
return new Accumulator(); | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getScanner(Accumulator acc) { | ||
return new TreeVisitor<Tree, ExecutionContext>() { | ||
@Override | ||
public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) { | ||
if (!(tree instanceof Properties.File)) { | ||
return tree; | ||
} | ||
|
||
Properties.File propertyFile = (Properties.File) tree; | ||
String sourcePath = PathUtils.separatorsToUnix(propertyFile.getSourcePath().toString()); | ||
String[] pathArray = sourcePath.split("/"); | ||
|
||
if (sourcePath.matches("(?:.*/)?application.properties")) { | ||
acc.pathToApplicationProperties = getPathToApplicationProperties(pathArray); | ||
acc.propertyFileContent = getNewApplicationPropertyFileInfo(propertyFile.getContent()); | ||
} | ||
|
||
if (sourcePath.matches("(?:.*/)?application-[^/]+\\.properties")) { | ||
acc.fileNameToFilePath.put(pathArray[pathArray.length - 1], sourcePath); | ||
} | ||
|
||
return tree; | ||
} | ||
}; | ||
} | ||
|
||
@Override | ||
public Collection<? extends SourceFile> generate(Accumulator acc, ExecutionContext ctx) { | ||
if (acc.propertyFileContent.isEmpty()) { | ||
return Collections.emptyList(); | ||
} | ||
|
||
Set<SourceFile> newApplicationPropertiesFiles = new HashSet<>(); | ||
|
||
for (Map.Entry<String, List<Properties.Content>> entry : acc.propertyFileContent.entrySet()) { | ||
if (!acc.fileNameToFilePath.containsKey(entry.getKey())) { | ||
newApplicationPropertiesFiles. | ||
add(new CreatePropertiesFile(acc.pathToApplicationProperties + entry.getKey(), "", null). | ||
generate(new AtomicBoolean(true), ctx). | ||
iterator(). | ||
next()); | ||
} | ||
} | ||
|
||
return newApplicationPropertiesFiles; | ||
} | ||
|
||
@Override | ||
public TreeVisitor<?, ExecutionContext> getVisitor(Accumulator acc) { | ||
return new PropertiesVisitor<ExecutionContext>() { | ||
@Override | ||
public Properties visitFile(Properties.File file, ExecutionContext ctx) { | ||
if (acc.propertyFileContent.isEmpty()) { | ||
return file; | ||
} | ||
|
||
String[] filePathArray = file.getSourcePath().toString().split("/"); | ||
String fileName = filePathArray[filePathArray.length - 1]; | ||
|
||
return fileName.matches("application.properties") ? deleteFromApplicationProperties(file) : | ||
appendToExistingPropertiesFile(file, acc.propertyFileContent.get(fileName)); | ||
} | ||
}; | ||
} | ||
|
||
private Properties appendToExistingPropertiesFile(Properties.File file, List<Properties.Content> contentToAppend) { | ||
return file.withContent( | ||
Stream.concat(file.getContent().stream(), contentToAppend.stream()). | ||
collect(Collectors.toList())); | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
} | ||
|
||
private Properties deleteFromApplicationProperties(Properties.File applicationProperties) { | ||
List<Properties.Content> newContent = new ArrayList<>(); | ||
for (Properties.Content c : applicationProperties.getContent()) { | ||
if (isSeparator(c)) { | ||
break; | ||
} | ||
newContent.add(c); | ||
} | ||
return applicationProperties.getContent().equals(newContent) ? applicationProperties : | ||
applicationProperties.withContent(newContent); | ||
} | ||
|
||
private Map<String, List<Properties.Content>> getNewApplicationPropertyFileInfo(List<Properties.Content> contentList) { | ||
Map<String, List<Properties.Content>> map = new HashMap<>(); | ||
int index = 0; | ||
while (index < contentList.size()) { | ||
if (isSeparator(contentList.get(index))) { | ||
List<Properties.Content> newContent = getContentForNewFile(contentList, ++index); | ||
map.put("application-" + ((Properties.Entry) newContent.get(0)).getValue().getText() + ".properties", | ||
newContent.subList(1, newContent.size())); | ||
|
||
} | ||
index++; | ||
} | ||
return map; | ||
} | ||
|
||
private List<Properties.Content> getContentForNewFile(List<Properties.Content> contentList, int index) { | ||
List<Properties.Content> list = new ArrayList<>(); | ||
while (index < contentList.size() && !isSeparator(contentList.get(index))) { | ||
if (contentList.get(index) instanceof Properties.Entry && | ||
((Properties.Entry) contentList.get(index)).getKey().equals | ||
("spring.config.activate.on-profile")) { | ||
list.add(0, contentList.get(index)); | ||
} else { | ||
list.add(contentList.get(index)); | ||
} | ||
index++; | ||
} | ||
return list; | ||
} | ||
|
||
private String getPathToApplicationProperties(String[] pathArray) { | ||
return pathArray.length == 1 ? "" : String.join("/", Arrays.copyOfRange(pathArray, 0, pathArray.length - 1)) + "/"; | ||
} | ||
|
||
private boolean isSeparator(Properties.Content c) { | ||
return c instanceof Properties.Comment && | ||
((Properties.Comment) c).getMessage().equals("---") && | ||
((((Properties.Comment) c).getDelimiter().equals(Properties.Comment.Delimiter.valueOf("HASH_TAG"))) || | ||
((Properties.Comment) c).getDelimiter().equals(Properties.Comment.Delimiter.valueOf("EXCLAMATION_MARK"))); | ||
timtebeek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
} | ||
|
||
public static class Accumulator { | ||
String pathToApplicationProperties = ""; | ||
Map<String, String> fileNameToFilePath = new HashMap<>(); | ||
Map<String, List<Properties.Content>> propertyFileContent = new HashMap<>(); | ||
timtebeek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.