/* * Copyright 2013 - 2014 Felix Müller * * This file is part of CodeQ Invest. * * CodeQ Invest is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * CodeQ Invest is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with CodeQ Invest. If not, see <http://www.gnu.org/licenses/>. */ package org.codeqinvest.codechanges; import lombok.extern.slf4j.Slf4j; import org.codeqinvest.codechanges.scm.CodeChurnCalculationException; import org.codeqinvest.codechanges.scm.CodeChurnCalculator; import org.codeqinvest.codechanges.scm.DailyCodeChurn; import org.codeqinvest.codechanges.scm.ScmConnectionEncodingException; import org.codeqinvest.codechanges.scm.ScmConnectionSettings; import org.codeqinvest.codechanges.scm.factory.CodeChurnCalculatorFactory; import org.joda.time.LocalDate; import java.util.Collection; /** * Helper base class for {@code CodeChangeProbabilityCalculator} implementations * that uses historical data from the scm system. * * @author fmueller */ @Slf4j abstract class AbstractCodeChangeProbabilityCalculator implements CodeChangeProbabilityCalculator { private final CodeChurnCalculatorFactory codeChurnCalculatorFactory; private final LocalDate startDay; private final int days; protected AbstractCodeChangeProbabilityCalculator(CodeChurnCalculatorFactory codeChurnCalculatorFactory, LocalDate startDay, int days) { this.codeChurnCalculatorFactory = codeChurnCalculatorFactory; this.startDay = startDay; this.days = days; } public final int getDays() { return days; } /** * {@inheritDoc} */ @Override public final double calculateCodeChangeProbability(ScmConnectionSettings connectionSettings, String file) throws CodeChurnCalculationException, ScmConnectionEncodingException { log.info("Calculate code change probability for file {}", file); final CodeChurnCalculator codeChurnCalculator = codeChurnCalculatorFactory.create(connectionSettings); final double computedChangeProbability = computeChangeProbability(days, codeChurnCalculator.calculateCodeChurn(connectionSettings, file, startDay, days)); return Math.min(1.0, computedChangeProbability); } protected abstract double computeChangeProbability(int days, Collection<DailyCodeChurn> codeChurns); }