xlnt/source/workbook/tests/test_write.hpp

#pragma once

#include <iostream>
#include <cxxtest/TestSuite.h>

#include <detail/relationship_serializer.hpp>
#include <detail/shared_strings_serializer.hpp>
#include <detail/workbook_serializer.hpp>
#include <detail/worksheet_serializer.hpp>
#include <helpers/temporary_file.hpp>
#include <helpers/path_helper.hpp>
#include <helpers/xml_helper.hpp>
#include <xlnt/workbook/workbook.hpp>

class test_write : public CxxTest::TestSuite
{
public:
    void test_write_empty_workbook()
    {
        xlnt::workbook wbk;
        wbk.get_active_sheet().get_cell("A2").set_value("xlnt");
        wbk.get_active_sheet().get_cell("B5").set_value(88);
        wbk.get_active_sheet().get_cell("B5").set_number_format(xlnt::number_format::percentage_00());
        wbk.save(temp_file.get_path());
        
        if(temp_file.get_path().exists())
        {
            path_helper::delete_file(temp_file.get_path());
        }

        TS_ASSERT(!temp_file.get_path().exists());
        wb_.save(temp_file.get_path());
        TS_ASSERT(temp_file.get_path().exists());
    }

    void test_write_virtual_workbook()
    {
        xlnt::workbook old_wb;
        std::vector<unsigned char> saved_wb;
        TS_ASSERT(old_wb.save(saved_wb));
        xlnt::workbook new_wb;
        TS_ASSERT(new_wb.load(saved_wb));
    }

    void test_write_workbook_rels()
    {
        xlnt::workbook wb;
        wb.add_shared_string(xlnt::text());
        xlnt::zip_file archive;
        xlnt::relationship_serializer serializer(archive);
        serializer.write_relationships(wb.get_relationships(), "xl/workbook.xml");
        pugi::xml_document xml;
        xml.load(archive.read(xlnt::path("xl/_rels/workbook.xml.rels")).c_str());

        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/workbook.xml.rels"), xml));
    }

    void test_write_workbook()
    {
        xlnt::workbook wb;
        xlnt::workbook_serializer serializer(wb);
        pugi::xml_document xml;
        serializer.write_workbook(xml);

        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/workbook.xml"), xml));
    }

    void test_write_string_table()
    {
        xlnt::workbook wb;
        auto ws = wb.get_active_sheet();
        
        ws.get_cell("A1").set_value("hello");
        ws.get_cell("A2").set_value("world");
        ws.get_cell("A3").set_value("nice");
        
        pugi::xml_document xml;
        xlnt::shared_strings_serializer::write_shared_strings(wb.get_shared_strings(), xml);

        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sharedStrings.xml"), xml));
    }

    void test_write_worksheet()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("F42").set_value("hello");
        
        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
    
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1.xml"), xml));
    }

    void test_write_hidden_worksheet()
    {
		auto ws = wb_.create_sheet();
        ws.get_page_setup().set_sheet_state(xlnt::sheet_state::hidden);
        ws.get_cell("F42").set_value("hello");

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1.xml"), xml));
    }

    void test_write_bool()
    {
        auto ws = wb_.create_sheet();
        ws.get_cell("F42").set_value(false);
        ws.get_cell("F43").set_value(true);

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_bool.xml"), xml));
    }

    void test_write_formula()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("F1").set_value(10);
        ws.get_cell("F2").set_value(32);
        ws.get_cell("F3").set_formula("F1+F2");

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_formula.xml"), xml));
    }

    void test_write_height()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("F1").set_value(10);
        ws.get_row_properties(ws.get_cell("F1").get_row()).height = 30;

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_height.xml"), xml));
    }

    void test_write_hyperlink()
    {
        xlnt::workbook clean_wb;
        auto ws = clean_wb.get_active_sheet();
        
        ws.get_cell("A1").set_value("test");
        ws.get_cell("A1").set_hyperlink("http://test.com");

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_hyperlink.xml"), xml));
    }

    void test_write_hyperlink_rels()
    {
		auto ws = wb_.create_sheet();
        TS_ASSERT_EQUALS(0, ws.get_relationships().size());
        ws.get_cell("A1").set_value("test");
        ws.get_cell("A1").set_hyperlink("http://test.com/");
        TS_ASSERT_EQUALS(1, ws.get_relationships().size());
        ws.get_cell("A2").set_value("test");
        ws.get_cell("A2").set_hyperlink("http://test2.com/");
        TS_ASSERT_EQUALS(2, ws.get_relationships().size());
        
        xlnt::zip_file archive;
        xlnt::relationship_serializer serializer(archive);
        serializer.write_relationships(ws.get_relationships(), "xl/worksheets/sheet1.xml");
        pugi::xml_document xml;
        xml.load(archive.read(xlnt::path("xl/worksheets/_rels/sheet1.xml.rels")).c_str());
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_hyperlink.xml.rels"), xml));
    }
    
    void _test_write_hyperlink_image_rels()
    {
        TS_SKIP("not implemented");
    }

    void test_hyperlink_value()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("A1").set_hyperlink("http://test.com");
        TS_ASSERT_EQUALS("http://test.com", ws.get_cell("A1").get_value<std::string>());
        ws.get_cell("A1").set_value("test");
        TS_ASSERT_EQUALS("test", ws.get_cell("A1").get_value<std::string>());
    }

    void test_write_auto_filter()
    {
        xlnt::workbook wb;
        auto ws = wb.get_sheet_by_index(0);
        ws.get_cell("F42").set_value("hello");
        ws.auto_filter("A1:F1");

        xlnt::worksheet_serializer ws_serializer(ws);
        pugi::xml_document xml;
        ws_serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_auto_filter.xml"), xml));

        xlnt::workbook_serializer wb_serializer(wb);
        pugi::xml_document xml2;
        wb_serializer.write_workbook(xml2);

        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/workbook_auto_filter.xml"), xml2));
    }
    
    void test_write_auto_filter_filter_column()
    {
        
    }
    
    void test_write_auto_filter_sort_condition()
    {
        
    }

    void test_freeze_panes_horiz()
    {
        auto ws = wb_.create_sheet();
        ws.get_cell("F42").set_value("hello");
        ws.freeze_panes("A4");

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);

        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_freeze_panes_horiz.xml"), xml));
    }

    void test_freeze_panes_vert()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("F42").set_value("hello");
        ws.freeze_panes("D1");

        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_freeze_panes_vert.xml"), xml));
    }

    void test_freeze_panes_both()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("F42").set_value("hello");
        ws.freeze_panes("D4");
        
        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/sheet1_freeze_panes_both.xml"), xml));
    }

    void test_long_number()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("A1").set_value(9781231231230LL);
   
        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/long_number.xml"), xml));
    }

    void test_short_number()
    {
		auto ws = wb_.create_sheet();
        ws.get_cell("A1").set_value(1234567890);
        
        xlnt::worksheet_serializer serializer(ws);
        pugi::xml_document xml;
        serializer.write_worksheet(xml);
        
        TS_ASSERT(xml_helper::file_matches_document(path_helper::get_data_directory("writer/expected/short_number.xml"), xml));
    }

    void test_write_page_setup()
    {
        xlnt::workbook wb;
        auto ws = wb.get_active_sheet();

        auto &page_setup = ws.get_page_setup();
        TS_ASSERT(page_setup.is_default());

        page_setup.set_break(xlnt::page_break::column);
        page_setup.set_fit_to_height(true);
        page_setup.set_fit_to_page(true);
        page_setup.set_fit_to_width(true);
        page_setup.set_horizontal_centered(true);
        page_setup.set_orientation(xlnt::orientation::landscape);
        page_setup.set_paper_size(xlnt::paper_size::a5);
        page_setup.set_scale(4.0);
        page_setup.set_sheet_state(xlnt::sheet_state::visible);
        page_setup.set_vertical_centered(true);

        TS_ASSERT(!page_setup.is_default());

        std::vector<std::uint8_t> bytes;
        wb.save(bytes);

        xlnt::zip_file archive;
        archive.load(bytes);
        auto worksheet_xml_string = archive.read(xlnt::path("xl/worksheets/sheet1.xml"));

        pugi::xml_document worksheet_xml;
        worksheet_xml.load(worksheet_xml_string.c_str());

        std::string expected =
        "<worksheet xmlns=\"http://schemas.openxmlformats.org/spreadsheetml/2006/main\" xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\">"
        "	<sheetPr>"
        "		<outlinePr summaryBelow=\"1\" summaryRight=\"1\" />"
        "       <pageSetUpPr fitToPage=\"1\" />"
        "	</sheetPr>"
        "	<dimension ref=\"A1:A1\" />"
        "	<sheetViews>"
        "		<sheetView workbookViewId=\"0\">"
        "			<selection activeCell=\"A1\" sqref=\"A1\" />"
        "		</sheetView>"
        "	</sheetViews>"
        "	<sheetFormatPr baseColWidth=\"10\" defaultRowHeight=\"15\" />"
        "	<sheetData />"
        "   <printOptions horizontalCentered=\"1\" verticalCentered=\"1\" />"
        "	<pageMargins left=\"0.75\" right=\"0.75\" top=\"1\" bottom=\"1\" header=\"0.5\" footer=\"0.5\" />"
        "   <pageSetup orientation=\"landscape\" paperSize=\"11\" fitToHeight=\"1\" fitToWidth=\"1\" />"
        "</worksheet>";

        TS_ASSERT(xml_helper::string_matches_document(expected, worksheet_xml));
    }

 private:
    temporary_file temp_file;
    xlnt::workbook wb_;
};