org.gradle.api.tasks.diagnostics.internal.text.StyledTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
There is a newer version: 8.11.1
/*
 * Copyright 2022 the original author or authors.
 *
 * 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.gradle.api.tasks.diagnostics.internal.text;

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import org.gradle.internal.logging.text.StyledTextOutput;
import org.gradle.reporting.ReportRenderer;

import java.util.List;
import java.util.stream.IntStream;
import java.util.stream.Stream;

import static org.gradle.internal.logging.text.StyledTextOutput.Style.Header;
import static org.gradle.internal.logging.text.StyledTextOutput.Style.Normal;

/**
 * Simple utility for printing a table.
 */
public class StyledTable {
    private final String indent;
    private final List headers;
    private final List rows;

    public StyledTable(String indent, List headers, List rows) {
        for (int i = 0; i < rows.size(); i++) {
            if (rows.get(i).text.size() != headers.size()) {
                throw new IllegalArgumentException("Header and row " + i + " must have the same number of columns");
            }
        }
        this.indent = indent;
        this.headers = ImmutableList.copyOf(headers);
        this.rows = ImmutableList.copyOf(rows);
    }

    public static final class Row {
        public final List text;
        public final StyledTextOutput.Style style;

        public Row(List text, StyledTextOutput.Style style) {
            this.text = ImmutableList.copyOf(text);
            this.style = style;
        }
    }

    public static final class Renderer extends ReportRenderer {
        @Override
        public void render(StyledTable model, StyledTextOutput output) {
            int[] colWidths = new int[model.headers.size()];
            for (int i = 0; i < model.headers.size(); i++) {
                int finalI = i;
                colWidths[i] = Stream.concat(
                    Stream.of(model.headers.get(i)),
                    model.rows.stream().map(row -> row.text.get(finalI))
                ).mapToInt(String::length).max().orElse(0);
            }

            output.style(Header);
            printRow(model, output, colWidths, model.headers, ' ');
            output.style(Normal);
            output.println();
            // Print the separator row
            printRow(
                model, output, colWidths,
                IntStream.range(0, colWidths.length).mapToObj(i -> "").collect(ImmutableList.toImmutableList()),
                '-'
            );
            output.println();
            List rowList = model.rows;
            for (int i = 0; i < rowList.size(); i++) {
                Row row = rowList.get(i);
                output.style(row.style);
                printRow(model, output, colWidths, row.text, ' ');
                output.style(Normal);
                if (i < rowList.size() - 1) {
                    output.println();
                }
            }
        }

        private void printRow(StyledTable model, StyledTextOutput output, int[] colWidths, List row, char padChar) {
            output.withStyle(Normal).text(model.indent + "|" + padChar);
            for (int i = 0; i < row.size(); i++) {
                output.text(Strings.padEnd(row.get(i), colWidths[i], padChar));
                if (i < row.size() - 1) {
                    output.withStyle(Normal).text(padChar + "|" + padChar);
                }
            }
            output.withStyle(Normal).text(padChar + "|");
        }
    }
}