org.eluder.coveralls.maven.plugin.domain.Source Maven / Gradle / Ivy

Go to download
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2013 - 2023, Tapio Rautonen
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.eluder.coveralls.maven.plugin.domain;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.ListIterator;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public final class Source implements JsonObject {

    private static final long serialVersionUID = 1L;

    private static final Pattern NEWLINE = Pattern.compile("\r\n|\r|\n");
    // private static final String CLASSIFIER_SEPARATOR = "#";

    String name;
    String digest;
    Integer[] coverage;
    List branches;
    String classifier;

    public Source(final String name, final String source, final String digest) {
        this(name, getLines(source), digest, null);
    }

    public Source(final String name, final int lines, final String digest, final String classifier) {
        this.name = name;
        this.digest = digest;
        this.coverage = new Integer[lines];
        this.classifier = classifier;
        this.branches = new ArrayList<>();
    }

    @JsonIgnore
    public String getName() {
        return name;
    }

    @JsonProperty("name")
    public String getFullName() {
        return name;

        // #45: cannot use identifier due to unfetchable source files
        // return (classifier == null ? name : name + CLASSIFIER_SEPARATOR + classifier);
    }

    @JsonProperty("source_digest")
    public String getDigest() {
        return digest;
    }

    @JsonProperty("coverage")
    public Integer[] getCoverage() {
        return coverage;
    }

    @JsonProperty("branches")
    public Integer[] getBranches() {
        final List branchesRaw = new ArrayList<>(branches.size() * 4);
        for (final Branch b : branches) {
            branchesRaw.add(b.getLineNumber());
            branchesRaw.add(b.getBlockNumber());
            branchesRaw.add(b.getBranchNumber());
            branchesRaw.add(b.getHits());
        }
        return branchesRaw.toArray(new Integer[branchesRaw.size()]);
    }

    public List getBranchesList() {
        return Collections.unmodifiableList(branches);
    }

    @JsonIgnore
    public String getClassifier() {
        return classifier;
    }

    public void setClassifier(final String classifier) {
        this.classifier = classifier;
    }

    private void checkLineRange(final int lineNumber) {
        int index = lineNumber - 1;
        if (index >= this.coverage.length) {
            throw new IllegalArgumentException(
                    "Line number " + lineNumber + " is greater than the source file " + name + " size");
        }
    }

    public void addCoverage(final int lineNumber, final Integer coverage) {
        checkLineRange(lineNumber);
        this.coverage[lineNumber - 1] = coverage;
    }

    public void addBranchCoverage(final int lineNumber, final int blockNumber, final int branchNumber, final int hits) {
        addBranchCoverage(false, lineNumber, blockNumber, branchNumber, hits);
    }

    private void addBranchCoverage(final boolean merge, final int lineNumber, final int blockNumber,
            final int branchNumber, final int hits) {
        checkLineRange(lineNumber);
        int hitSum = hits;
        final ListIterator it = this.branches.listIterator();
        while (it.hasNext()) {
            final Branch b = it.next();
            if (b.getLineNumber() == lineNumber && b.getBlockNumber() == blockNumber
                    && b.getBranchNumber() == branchNumber) {
                it.remove();
                if (merge) {
                    hitSum += b.getHits();
                }
            }
        }
        this.branches.add(new Branch(lineNumber, blockNumber, branchNumber, hitSum));
    }

    public Source merge(final Source source) {
        Source copy = new Source(this.name, this.coverage.length, this.digest, this.classifier);
        System.arraycopy(this.coverage, 0, copy.coverage, 0, this.coverage.length);
        copy.branches.addAll(this.branches);
        if (copy.equals(source)) {
            for (int i = 0; i < copy.coverage.length; i++) {
                if (source.coverage[i] != null) {
                    int base = copy.coverage[i] != null ? copy.coverage[i] : 0;
                    copy.coverage[i] = base + source.coverage[i];
                }
            }
            for (final Branch b : source.branches) {
                copy.addBranchCoverage(true, b.getLineNumber(), b.getBlockNumber(), b.getBranchNumber(), b.getHits());
            }
        }
        return copy;
    }

    @Override
    public boolean equals(final Object obj) {
        if (!(obj instanceof Source)) {
            return false;
        }
        Source other = (Source) obj;
        return Objects.equals(this.name, other.name) && Objects.equals(this.digest, other.digest)
                && this.coverage.length == other.coverage.length;
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.name, this.digest, this.coverage.length);
    }

    private static int getLines(final String source) {
        int lines = 1;
        Matcher matcher = NEWLINE.matcher(source);
        while (matcher.find()) {
            lines++;
        }
        return lines;
    }
}