org.jboss.maven.plugins.qstools.checkers.ReadmeChecker Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the 
 * distribution for a full listing of individual contributors.
 *
 * 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
 * http://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 org.jboss.maven.plugins.qstools.checkers;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.jboss.maven.plugins.qstools.QSChecker;
import org.jboss.maven.plugins.qstools.Violation;
import org.w3c.dom.Document;

/**
 * @author Rafael Benevides
 * 
 */
@Component(role = QSChecker.class, hint = "readmeChecker")
public class ReadmeChecker extends AbstractProjectChecker {

    private static final String[] README_METADATA = new String[] { "Author:", "Level:", "Technologies:", "Summary:", "Target Product:", "Source:" };

    private String regexPattern;
    
    private String folderName;

    /*
     * (non-Javadoc)
     * 
     * @see org.jboss.maven.plugins.qstools.QSChecker#getCheckerDescription()
     */
    @Override
    public String getCheckerDescription() {
        return "Checks if README.md metadata is defined and if the title matches the folder name";
    }

    /*
     * (non-Javadoc)
     * 
     * @see
     * org.jboss.maven.plugins.qstools.checkers.AbstractProjectChecker#processProject(org.apache.maven.project.MavenProject,
     * org.w3c.dom.Document, java.util.Map)
     */
    @Override
    public void processProject(MavenProject project, Document doc, Map> results) throws Exception {
        folderName = project.getBasedir().getName() + ":";
        setupRegexPattern();
        File readme = new File(project.getBasedir(), "README.md");
        if (readme.exists()) {
           checkReadmeFile(readme, results);
        }
    }

    /**
     * Create a regex pattern using all metadata clauses
     * 
     * Format: metadata1:|metadata2:|metadata3:
     * 
     * @param string
     */
    private void setupRegexPattern() {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < README_METADATA.length; i++) {
            String metadata = README_METADATA[i];
            sb.append(metadata + "|");
        }
        sb.append(folderName);
        regexPattern = sb.toString();
    }

    /**
     * Check if the file contains all defined metadata
     */
    private void checkReadmeFile(File readme, Map> results) throws IOException {
        BufferedReader br = new BufferedReader(new FileReader(readme));
        try {
            Pattern p = Pattern.compile(regexPattern);
            List usedPatterns = new ArrayList();
            while (br.ready()) {
                String line = br.readLine();
                Matcher m = p.matcher(line);
                if (m.find()) {
                    usedPatterns.add(m.group());
                }
            }
            for (String metadata: README_METADATA){
                if (!usedPatterns.contains(metadata)){
                    String msg = "File doesn't containt [%s] metadata";
                    addViolation(readme, results, 3, String.format(msg, metadata));
                }
            }
            if (!usedPatterns.contains(folderName)){
                String msg = "Readme title doesn't match the folder name: "  + folderName;
                addViolation(readme, results, 1, msg);
            }
        } finally {
            if (br != null) {
                br.close();
            }
        }

    }

}