com.github.cameltooling.lsp.internal.codeactions.AbstractQuickfix Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-lsp-server Show documentation
Server Implementation of the Language Server Protocol for Apache Camel
There is a newer version: 1.27.0
/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      https://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.github.cameltooling.lsp.internal.codeactions;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Collectors;

import org.apache.camel.catalog.CamelCatalog;
import org.apache.commons.text.similarity.LevenshteinDistance;
import org.eclipse.lsp4j.CodeAction;
import org.eclipse.lsp4j.CodeActionKind;
import org.eclipse.lsp4j.CodeActionParams;
import org.eclipse.lsp4j.Command;
import org.eclipse.lsp4j.Diagnostic;
import org.eclipse.lsp4j.Position;
import org.eclipse.lsp4j.Range;
import org.eclipse.lsp4j.TextDocumentItem;
import org.eclipse.lsp4j.TextEdit;
import org.eclipse.lsp4j.WorkspaceEdit;
import org.eclipse.lsp4j.jsonrpc.messages.Either;

import com.github.cameltooling.lsp.internal.CamelTextDocumentService;
import com.github.cameltooling.lsp.internal.catalog.util.KameletsCatalogManager;
import com.github.cameltooling.lsp.internal.parser.ParserFileHelperUtil;
import com.github.cameltooling.lsp.internal.settings.SettingsManager;

public abstract class AbstractQuickfix {
	
	protected CamelTextDocumentService camelTextDocumentService;
	
	protected AbstractQuickfix(CamelTextDocumentService camelTextDocumentService) {
		this.camelTextDocumentService = camelTextDocumentService;
	}
	
	public List> apply(CodeActionParams params) {
		TextDocumentItem openedDocument = camelTextDocumentService.getOpenedDocument(params.getTextDocument().getUri());
		List diagnostics = params.getContext().getDiagnostics();
		List> res = new ArrayList<>();
		for(Diagnostic diagnostic : diagnostics) {
			if(diagnostic.getCode()!= null && getDiagnosticId().equals(diagnostic.getCode().getLeft())) {
				CharSequence currentValueInError = retrieveCurrentErrorValue(openedDocument, diagnostic);
				if(currentValueInError != null) {
					List possibleProperties = retrievePossibleValues(openedDocument, camelTextDocumentService.getCamelCatalog(), diagnostic.getRange().getStart(), camelTextDocumentService.getSettingsManager(), camelTextDocumentService.getKameletsCatalogManager());
					int distanceThreshold = Math.round(currentValueInError.length() * 0.4f);
					LevenshteinDistance levenshteinDistance = new LevenshteinDistance(distanceThreshold);
					List mostProbableProperties = possibleProperties.stream()
							.filter(possibleProperty -> levenshteinDistance.apply(possibleProperty, currentValueInError) != -1)
							.collect(Collectors.toList());
					for (String mostProbableProperty : mostProbableProperties) {
						res.add(Either.forRight(createCodeAction(params, diagnostic, mostProbableProperty)));
					}
				}
			}
		}
		return res;
	}

	protected String retrieveCurrentErrorValue(TextDocumentItem openedDocument, Diagnostic diagnostic) {
		Range diagnosticRange = diagnostic.getRange();
		String line = new ParserFileHelperUtil().getLine(openedDocument, diagnosticRange.getStart().getLine());
		int endCharacter = diagnosticRange.getEnd().getCharacter();
		if (line.length() > endCharacter) {
			return line.substring(diagnosticRange.getStart().getCharacter(), endCharacter);
		} else {
			return null;
		}
	}
	
	protected CodeAction createCodeAction(CodeActionParams params, Diagnostic diagnostic, String possibleProperty) {
		CodeAction codeAction = new CodeAction("Did you mean "+possibleProperty + "?");
		codeAction.setDiagnostics(Collections.singletonList(diagnostic));
		codeAction.setKind(CodeActionKind.QuickFix);
		Map> changes = new HashMap<>();
		TextEdit textEdit = new TextEdit(diagnostic.getRange(), possibleProperty);
		changes.put(params.getTextDocument().getUri(), Arrays.asList(textEdit));
		codeAction.setEdit(new WorkspaceEdit(changes));
		return codeAction;
	}
	
	protected abstract List retrievePossibleValues(TextDocumentItem textDocumentItem, CompletableFuture camelCatalog, Position position, SettingsManager settingsManager, KameletsCatalogManager kameletsCatalogManager);
	protected abstract String getDiagnosticId();
	
}