poi/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFDataFormat.java

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

package org.apache.poi.xssf.usermodel;

import static org.apache.poi.xssf.XSSFTestDataSamples.openSampleWorkbook;
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.io.IOException;
import java.util.Date;

import org.apache.poi.ss.formula.ConditionalFormattingEvaluator;
import org.apache.poi.ss.formula.WorkbookEvaluatorProvider;
import org.apache.poi.ss.usermodel.BaseTestDataFormat;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.DataFormatter;
import org.apache.poi.ss.usermodel.FormulaEvaluator;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.XSSFITestDataProvider;
import org.apache.poi.xssf.XSSFTestDataSamples;
import org.junit.jupiter.api.Test;

/**
 * Tests for {@link XSSFDataFormat}
 */
public final class TestXSSFDataFormat extends BaseTestDataFormat {

    public TestXSSFDataFormat() {
        super(XSSFITestDataProvider.instance);
    }

    /**
     * [Bug 58778] Built-in number formats can be overridden with XSSFDataFormat.putFormat(int id, String fmt)
     */
    @Test
    void test58778() throws IOException {
        try (XSSFWorkbook wb1 = new XSSFWorkbook()) {
            Cell cell = wb1.createSheet("bug58778").createRow(0).createCell(0);
            cell.setCellValue(5.25);
            CellStyle style = wb1.createCellStyle();

            XSSFDataFormat dataFormat = wb1.createDataFormat();

            short poundFmtIdx = 6;
            dataFormat.putFormat(poundFmtIdx, POUND_FMT);
            style.setDataFormat(poundFmtIdx);
            cell.setCellStyle(style);
            // Cell should appear as "<poundsymbol>5"

            try (XSSFWorkbook wb2 = XSSFTestDataSamples.writeOutCloseAndReadBack(wb1)) {
                cell = wb2.getSheet("bug58778").getRow(0).getCell(0);
                assertEquals(5.25, cell.getNumericCellValue(), 0);

                style = cell.getCellStyle();
                assertEquals(POUND_FMT, style.getDataFormatString());
                assertEquals(poundFmtIdx, style.getDataFormat());

                // manually check the file to make sure the cell is rendered as "<poundsymbol>5"
                // Verified with LibreOffice 4.2.8.2 on 2015-12-28
            }
        }
    }

    @Test
    void testConditionalFormattingEvaluation() throws IOException {
        try (Workbook wb = openSampleWorkbook("61060-conditional-number-formatting.xlsx")) {

            final DataFormatter formatter = new DataFormatter();
            final FormulaEvaluator evaluator = wb.getCreationHelper().createFormulaEvaluator();
            final ConditionalFormattingEvaluator cfEvaluator = new ConditionalFormattingEvaluator(wb, (WorkbookEvaluatorProvider) evaluator);

            CellReference ref = new CellReference("A1");
            Cell cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
            assertEquals("0.10", formatter.formatCellValue(cell, evaluator, cfEvaluator));
            // verify cell format without the conditional rule applied
            assertEquals("0.1", formatter.formatCellValue(cell, evaluator));

            ref = new CellReference("A3");
            cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
            assertEquals("-2.00E+03", formatter.formatCellValue(cell, evaluator, cfEvaluator));
            // verify cell format without the conditional rule applied
            assertEquals("-2000", formatter.formatCellValue(cell, evaluator));

            ref = new CellReference("A4");
            cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
            assertEquals("100", formatter.formatCellValue(cell, evaluator, cfEvaluator));

            ref = new CellReference("A5");
            cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
            assertEquals("$1,000", formatter.formatCellValue(cell, evaluator, cfEvaluator));
            // verify cell format without the conditional rule applied
            assertEquals("1000", formatter.formatCellValue(cell, evaluator));
        }
    }

    @Test
    void testSetUseCachedValuesForFormulaCells() throws Exception {
        try (XSSFWorkbook wb = openSampleWorkbook("formula-eval.xlsx")) {
            final DataFormatter formatter = new DataFormatter();
            XSSFSheet sheet = wb.getSheetAt(0);
            XSSFRow row = sheet.getRow(0);
            XSSFCell d1 = row.getCell(3);
            assertEquals("SUM(A1:C1)", formatter.formatCellValue(d1));
            formatter.setUseCachedValuesForFormulaCells(true);
            assertEquals("6.75", formatter.formatCellValue(d1));
        }
    }

    @Test
    public void testFormatCellValue() throws IOException {
        DataFormatter df = new DataFormatter();

        assertEquals("", df.formatCellValue(null));

        try (Workbook wb = new XSSFWorkbook()) {
            Cell cell = wb.createSheet("test").createRow(0).createCell(0);
            assertEquals("", df.formatCellValue(cell));

            cell.setCellValue(123);
            assertEquals("123", df.formatCellValue(cell));

            /* This is flaky, likely because of timezone
            cell.setCellValue(new Date(234092383));
            assertEquals("25571.75107", df.formatCellValue(cell));
            */

            cell.setCellValue("abcdefgh");
            assertEquals("abcdefgh", df.formatCellValue(cell));

            cell.setCellValue(true);
            assertEquals("TRUE", df.formatCellValue(cell));

            CellStyle cellStyle = wb.createCellStyle();
            cellStyle.setDataFormat((short)14);
            cell.setCellStyle(cellStyle);
            cell.setCellValue(new Date(234092383));
            assertEquals("1/3/70", df.formatCellValue(cell));

            /* This is flaky, likely because of timezone
            cellStyle.setDataFormat((short)9999);
            assertEquals("25571.751069247686", df.formatCellValue(cell));
            */
        }
    }
}