Skip to content

Configurable code repository #75

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ public class Assistancer {
@Reference
private Executor executor;

@Reference
private CodeRepository codeRepository;

private List<ClassInfo> classCache = Collections.emptyList();

private Integer classCacheHashCode;
Expand Down Expand Up @@ -103,7 +106,7 @@ public Assistance forWord(ResourceResolver resolver, SuggestionType suggestionTy
private Stream<VariableSuggestion> variableSuggestions(String word) {
return variablesCache.stream()
.filter(v -> SearchUtils.containsWord(v.getName(), word))
.map(VariableSuggestion::new);
.map(cf -> new VariableSuggestion(cf, codeRepository));
}

private Stream<SnippetSuggestion> snippetSuggestions(ResourceResolver resolver, String word) throws AcmException {
Expand All @@ -116,7 +119,7 @@ private Stream<SnippetSuggestion> snippetSuggestions(ResourceResolver resolver,
private Stream<ClassSuggestion> classSuggestions(String word) {
return classCache.stream()
.filter(cf -> SearchUtils.containsWord(cf.getClassName(), word))
.map(ClassSuggestion::new);
.map(cf -> new ClassSuggestion(cf, codeRepository));
}

private Stream<Suggestion> resourceSuggestions(ResourceResolver resolver, String word) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
public class ClassSuggestion implements Suggestion {

private final ClassInfo classInfo;
private final CodeRepository codeRepository;

public ClassSuggestion(ClassInfo classInfo) {
public ClassSuggestion(ClassInfo classInfo, CodeRepository codeRepository) {
this.classInfo = classInfo;
this.codeRepository = codeRepository;
}

@Override
Expand All @@ -34,7 +36,7 @@ public String getInfo() {
List<String> info = new LinkedList<>();

info.add(String.format("Bundle: %s", classInfo.getBundle().getSymbolicName()));
CodeRepository.linkToClass(classInfo.getClassName()).ifPresent(link -> {
codeRepository.linkToClass(classInfo.getClassName()).ifPresent(link -> {
info.add(String.format("Source Code: [Open on GitHub](%s)", link));
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
public class VariableSuggestion implements Suggestion {

private final Variable variable;
private final CodeRepository codeRepository;

public VariableSuggestion(Variable variable) {
public VariableSuggestion(Variable variable, CodeRepository codeRepository) {
this.variable = variable;
this.codeRepository = codeRepository;
}

@Override
Expand All @@ -34,7 +36,7 @@ public String getInfo() {
List<String> info = new LinkedList<>();

info.add(String.format("Type: %s", variable.getType()));
CodeRepository.linkToClass(variable.getType()).ifPresent(link -> {
codeRepository.linkToClass(variable.getType()).ifPresent(link -> {
info.add(String.format("Source Code: [Open on GitHub](%s)", link));
});

Expand Down
41 changes: 30 additions & 11 deletions core/src/main/java/com/vml/es/aem/acm/core/code/CodeRepository.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,43 @@
import java.util.Map;
import java.util.Optional;
import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Modified;
import org.osgi.service.metatype.annotations.AttributeDefinition;
import org.osgi.service.metatype.annotations.Designate;
import org.osgi.service.metatype.annotations.ObjectClassDefinition;

@Component(immediate = true, service = CodeRepository.class)
@Designate(ocd = CodeRepository.Config.class)
public class CodeRepository {

// TODO make it configurable
private static final Map<String, String> CLASS_LINKS = new HashMap<>();

static {
CLASS_LINKS.put("com.vml.es.aem.acm.core", "https://github.com/wttech/acm/blob/main/core/src/main/java");
CLASS_LINKS.put(
"org.apache.sling.api",
"https://github.com/apache/sling-org-apache-sling-api/tree/master/src/main/java");
@ObjectClassDefinition(name = "AEM Content Manager - Code repository")
public @interface Config {
@AttributeDefinition(
name = "Class Links",
description =
"Mapping of class prefixes to their corresponding GitHub URLs in the format 'prefix=url'.")
String[] classLinks() default {
"com.vml.es.aem.acm.core=https://github.com/wttech/acm/blob/main/core/src/main/java",
"org.apache.sling.api=https://github.com/apache/sling-org-apache-sling-api/tree/master/src/main/java"
};
}

private CodeRepository() {
// intentionally empty
private final Map<String, String> CLASS_LINKS = new HashMap<>();

@Activate
@Modified
public void activate(Config config) {
for (String classLink : config.classLinks()) {
String[] parts = classLink.split("=");
if (parts.length == 2) {
CLASS_LINKS.put(parts[0].trim(), parts[1].trim());
}
}
}

public static Optional<String> linkToClass(String className) {
public Optional<String> linkToClass(String className) {
return CLASS_LINKS.entrySet().stream()
.filter(entry -> StringUtils.startsWith(className, entry.getKey()))
.findFirst()
Expand Down