DependencyUpdatesXmlReportRenderer.java

package org.codehaus.mojo.versions.xml;

/*
 * 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
 *
 *     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.
 */

import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.model.Dependency;
import org.codehaus.mojo.versions.api.AbstractVersionDetails;
import org.codehaus.mojo.versions.api.ArtifactVersions;
import org.codehaus.mojo.versions.api.ArtifactVersionsCache;
import org.codehaus.mojo.versions.api.ReportRenderer;
import org.codehaus.mojo.versions.reporting.OverviewStats;
import org.codehaus.mojo.versions.reporting.model.DependencyInfo;
import org.codehaus.mojo.versions.reporting.model.DependencyReportSummary;
import org.codehaus.mojo.versions.reporting.model.DependencyUpdatesModel;
import org.codehaus.mojo.versions.reporting.model.DependencyUpdatesReport;
import org.codehaus.mojo.versions.reporting.model.io.xpp3.DependencyUpdatesReportXpp3Writer;

import static java.util.Optional.empty;
import static java.util.Optional.ofNullable;
import static org.codehaus.mojo.versions.api.Segment.INCREMENTAL;
import static org.codehaus.mojo.versions.api.Segment.MAJOR;
import static org.codehaus.mojo.versions.api.Segment.MINOR;
import static org.codehaus.mojo.versions.xml.CommonXmlReportRendererUtils.setSection;
import static org.codehaus.mojo.versions.xml.CommonXmlReportRendererUtils.statusFor;

/**
 * XML renderer for DependencyUpdatesReport creates an xml file in target directory and writes report about available
 * dependency/dependency management updates.
 *
 * @author Illia Dubinin
 * @since 2.4
 */
public class DependencyUpdatesXmlReportRenderer implements ReportRenderer
{
    private final DependencyUpdatesModel model;
    private final Path outputFile;
    private final ArtifactVersionsCache newestUpdateCache
            = new ArtifactVersionsCache( AbstractVersionDetails::getNewestUpdate );
    /**
     * Creates a new instance
     * @param model object containing the updates model
     * @param outputFile output file for the report
     */
    public DependencyUpdatesXmlReportRenderer( DependencyUpdatesModel model, Path outputFile )
    {
        this.model = model;
        this.outputFile = outputFile;
    }

    /**
     * Creates an XML report
     */
    @Override
    public void render()
    {
        try ( BufferedWriter writer = Files.newBufferedWriter( outputFile,
                StandardCharsets.UTF_8 ) )
        {
            new DependencyUpdatesReportXpp3Writer().write( writer, new DependencyUpdatesReport()
            {{
                setSummary( new DependencyReportSummary()
                {{
                    OverviewStats overviewStats = OverviewStats.fromUpdates( model.getAllUpdates().values(),
                            newestUpdateCache );
                    setUsingLastVersion( String.valueOf( overviewStats.getUpToDate() ) );
                    setNextVersionAvailable( String.valueOf( overviewStats.getAny() ) );
                    setNextIncrementalAvailable( String.valueOf( overviewStats.getIncremental() ) );
                    setNextMinorAvailable( String.valueOf( overviewStats.getMinor() ) );
                    setNextMajorAvailable( String.valueOf( overviewStats.getMajor() ) );
                }} );
                setDependencyManagements( createDependencyInfo( model.getArtifactManagementUpdates() ) );
                setDependencies( createDependencyInfo( model.getArtifactUpdates() ) );
            }} );
        }
        catch ( IOException e )
        {
            throw new RuntimeException( e );
        }
    }

    private static List<DependencyInfo> createDependencyInfo( Map<Dependency, ArtifactVersions> versions )
    {
        return versions.entrySet().stream().map( e ->
                new DependencyInfo()
        {{
            setGroupId( e.getKey().getGroupId() );
            setArtifactId( e.getKey().getArtifactId() );
            setCurrentVersion( e.getKey().getVersion() );
            setScope( e.getKey().getScope() );
            setType( e.getKey().getType() );
            setClassifier( e.getKey().getClassifier() );

            ofNullable( e.getValue().getNewestUpdate( empty() ) )
                    .map( ArtifactVersion::toString ).ifPresent( this::setLastVersion );

            setSection( e.getValue(), INCREMENTAL, this::setIncrementals );
            setSection( e.getValue(), MINOR, this::setMinors );
            setSection( e.getValue(), MAJOR, this::setMajors );

            setStatus( statusFor( getLastVersion(), getIncrementals(), getMinors() ) );
        }} ).collect( Collectors.toList() );
    }
}