scrum.server.sprint.SprintReportPdfCreator.java Source code

Introduction

Here is the source code for scrum.server.sprint.SprintReportPdfCreator.java

Source

/*
 * Copyright 2011 Witoslaw Koczewsi <wi@koczewski.de>, Artjom Kochtchi
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero
 * General Public License as published by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program 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 Affero General Public
 * License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */
package scrum.server.sprint;

import com.itextpdf.text.BaseColor;
import ilarkesto.base.TmExtend;
import ilarkesto.pdf.ACell;
import ilarkesto.pdf.AParagraph;
import ilarkesto.pdf.APdfContainerElement;
import ilarkesto.pdf.ARow;
import ilarkesto.pdf.ATable;
import ilarkesto.pdf.FieldList;
import ilarkesto.pdf.FontStyle;
import java.util.List;
import scrum.client.sprint.SprintHistoryHelper;
import scrum.client.sprint.SprintHistoryHelper.StoryInfo;
import scrum.client.sprint.SprintHistoryHelper.TaskInfo;
import scrum.server.common.APdfCreator;
import scrum.server.common.BurndownChart;
import scrum.server.common.ScrumPdfContext;
import scrum.server.common.WikiToPdfConverter;
import scrum.server.project.Requirement;

public class SprintReportPdfCreator extends APdfCreator {

    private Sprint sprint;

    public SprintReportPdfCreator(Sprint sprint) {
        super(sprint.getProject());
        this.sprint = sprint;
    }

    @Override
    protected void build(APdfContainerElement pdf) {
        reportHeader(pdf, "Sprint Report", sprint.getProject().getLabel());

        SprintReport report = sprint.getSprintReport();

        pdf.nl();
        FieldList fields = pdf.fieldList().setLabelFontStyle(fieldLabelFont);
        fields.field("Sprint").paragraph().text(sprint.getReference() + " ", referenceFont).text(sprint.getLabel());
        fields.field("Period")
                .text(TmExtend.FORMAT_SHORTWEEKDAY_SHORTMONTH_DAY.format(sprint.getBegin()) + "  -  "
                        + TmExtend.FORMAT_SHORTWEEKDAY_SHORTMONTH_DAY.format(sprint.getEnd()) + "   ("
                        + sprint.getLengthInDays() + " days)");
        fields.field("Velocity").text(sprint.getVelocity() + " StoryPoints");
        int burnedWork = report == null
                ? getBurnedWork(sprint.getIncompletedRequirementsData())
                        + getBurnedWork(sprint.getCompletedRequirementsData())
                : report.getBurnedWork();
        fields.field("Burned work").text(burnedWork + " hours");
        fields.field("Product Owner").text(sprint.getProductOwnersAsString());
        fields.field("Scrum Master").text(sprint.getScrumMastersAsString());
        fields.field("Team").text(sprint.getTeamMembersAsString());

        pdf.nl();
        pdf.image(BurndownChart.createBurndownChartAsByteArray(sprint, 1000, 500)).setScaleByWidth(150f);

        ScrumPdfContext pdfContext = new ScrumPdfContext(sprint.getProject());
        if (sprint.isGoalSet()) {
            sectionHeader(pdf, "Goal");
            WikiToPdfConverter.buildPdf(pdf, sprint.getGoal(), pdfContext);
        }

        if (report == null) {
            requirements(pdf, "Completed stories", sprint.getCompletedRequirementsData());
            requirements(pdf, "Rejected stories", sprint.getIncompletedRequirementsData());
        } else {
            requirements(pdf, "Completed stories", report.getCompletedRequirementsAsList(), report);
            requirements(pdf, "Rejected stories", report.getRejectedRequirementsAsList(), report);
        }

        if (sprint.isReviewNoteSet()) {
            sectionHeader(pdf, "Review notes");
            WikiToPdfConverter.buildPdf(pdf, sprint.getReviewNote(), pdfContext);
        }

        if (sprint.isRetrospectiveNoteSet()) {
            sectionHeader(pdf, "Retrospecitve notes");
            WikiToPdfConverter.buildPdf(pdf, sprint.getRetrospectiveNote(), pdfContext);
        }

    }

    private int getBurnedWork(String requirementsData) {
        List<StoryInfo> requirements = SprintHistoryHelper.parseRequirementsAndTasks(requirementsData);
        if (requirements.isEmpty())
            return 0;
        int sum = 0;
        for (StoryInfo req : requirements) {
            sum += req.getBurnedWork();
        }
        return sum;
    }

    private void requirements(APdfContainerElement pdf, String title, List<Requirement> requirements,
            SprintReport report) {
        if (requirements.isEmpty())
            return;
        sectionHeader(pdf, title);
        for (Requirement req : requirements) {
            requirement(pdf, req, report.getOpenTasks(req), report.getClosedTasks(req));
        }
    }

    @Deprecated
    private void requirements(APdfContainerElement pdf, String title, String requirementsData) {
        List<StoryInfo> requirements = SprintHistoryHelper.parseRequirementsAndTasks(requirementsData);
        if (requirements.isEmpty())
            return;
        sectionHeader(pdf, title);
        for (StoryInfo req : requirements) {
            requirement(pdf, req);
        }
    }

    @Deprecated
    private void requirement(APdfContainerElement pdf, StoryInfo req) {
        pdf.nl();

        ATable table = pdf.table(3, 20, 2, 2);

        ARow rowHeader = table.row().setDefaultBackgroundColor(BaseColor.LIGHT_GRAY);
        rowHeader.cell().setFontStyle(referenceFont).text(req.getReference());
        rowHeader.cell().setFontStyle(new FontStyle(defaultFont).setBold(true)).text(req.getLabel());
        rowHeader.cell().paragraph().text(req.getEstimatedWorkAsString(), referenceFont);
        rowHeader.cell().paragraph().text(req.getBurnedWorkAsString(), referenceFont);

        List<TaskInfo> tasks = req.getTasks();
        for (TaskInfo tsk : tasks) {
            ACell tasksCell = table.row().cell().setColspan(table.getColumnCount());
            AParagraph p = tasksCell.paragraph();
            p.text(tsk.getReference(), referenceFont);
            p.text(" " + tsk.getLabel() + " ", defaultFont);
            p.text(tsk.getBurnedWork() + " hrs.", referenceFont);
        }

        table.createCellBorders(BaseColor.GRAY, 0.2f);
    }

    private void sectionHeader(APdfContainerElement pdf, String label) {
        pdf.paragraph().nl().text(label, headerFonts[1]).nl();
    }

    @Override
    protected String getFilename() {
        return "report-" + sprint.getReference();
    }

}