001/**
002 * Copyright (C) 2006-2024 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.tools.validator;
017
018import java.lang.reflect.Field;
019import java.util.List;
020import java.util.regex.Pattern;
021import java.util.stream.Stream;
022
023import org.apache.xbean.finder.AnnotationFinder;
024import org.talend.sdk.component.api.configuration.Option;
025import org.talend.sdk.component.api.meta.Documentation;
026
027public class DocumentationWordingValidator implements Validator {
028
029    private final Pattern correctWordingPattern = Pattern.compile("^[A-Z0-9]+.*\\.$");
030
031    @Override
032    public Stream<String> validate(final AnnotationFinder finder, final List<Class<?>> components) {
033
034        final String error = "@Documentation on '%s' is empty or is not capitalized or ends not by a dot.";
035        final Stream<String> componentWording = components
036                .stream() //
037                .filter(c -> c.isAnnotationPresent(Documentation.class)) //
038                .filter(c -> isIncorrect(c.getAnnotation(Documentation.class))) //
039                .map(c -> String.format(error, c.getName())) //
040                .sorted();
041
042        final Stream<String> fieldWording = finder
043                .findAnnotatedFields(Option.class)
044                .stream() //
045                .filter(field -> field.isAnnotationPresent(Documentation.class))
046                .filter((Field field) -> this.isIncorrect(field.getAnnotation(Documentation.class)))
047                .map(c -> String.format(error, c.getName()))
048                .sorted();
049        return Stream.concat(componentWording, fieldWording);
050    }
051
052    private boolean isIncorrect(final Documentation annotation) {
053        final String value = annotation.value();
054        return !this.correctWordingPattern.matcher(value).matches();
055    }
056
057}