ResInsight/ApplicationLibCode/UnitTests/RifTextDataTableFormatter-Test.cpp

#include "gtest/gtest.h"

#include "RiaTextStringTools.h"

#include "RifTextDataTableFormatter.h"

#include <QString>
#include <QStringList>

TEST( RifTextDataTableFormatter, BasicUsage )
{
    QString                   tableText;
    QTextStream               stream( &tableText );
    RifTextDataTableFormatter formatter( stream );

    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "Well" ),
        RifTextDataTableColumn( "Integer Number" ),
        RifTextDataTableColumn( "IntNumer 2" ),
        RifTextDataTableColumn( "IntNumer 3" ),
    };

    formatter.header( header );

    formatter.add( "well a" );
    formatter.add( 1 );
    formatter.add( 2 );
    formatter.add( 3 );
    formatter.rowCompleted();

    formatter.add( "well B" );
    formatter.add( 12 );
    formatter.add( 23 );
    formatter.add( 233 );
    formatter.rowCompleted();

    formatter.tableCompleted();

    std::cout << tableText.toStdString();
}

TEST( RifTextDataTableFormatter, NoPrefix )
{
    QString                   tableText;
    QTextStream               stream( &tableText );
    RifTextDataTableFormatter formatter( stream );

    formatter.setTableRowPrependText( "   " );
    formatter.setTableRowLineAppendText( "" );

    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "Well" ),
        RifTextDataTableColumn( "Integer Number", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "IntNumer 2", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "IntNumer 3", RifTextDataTableDoubleFormatting(), RIGHT ),
    };

    formatter.header( header );

    formatter.add( "well a" );
    formatter.add( 1 );
    formatter.add( 2 );
    formatter.add( 3 );
    formatter.rowCompleted();

    formatter.add( "well B" );
    formatter.add( 12 );
    formatter.add( 231 );
    formatter.add( 23123 );
    formatter.rowCompleted();

    formatter.tableCompleted();

    std::cout << tableText.toStdString();
}

TEST( RifTextDataTableFormatter, LongLine )
{
    QString                   tableText;
    QTextStream               stream( &tableText );
    RifTextDataTableFormatter formatter( stream );

    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "50 Character Well Name" ),
        RifTextDataTableColumn( "10 Int #1", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #2", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #3", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #4", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #5", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #6", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #7", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #8", RifTextDataTableDoubleFormatting(), RIGHT ),
    };

    formatter.header( header );
    QString fiftyCharacterWellName = "01234567890123456789012345678901234567890123456789";
    formatter.add( fiftyCharacterWellName );
    for ( int i = 0; i < 8; ++i )
    {
        formatter.add( std::numeric_limits<int>::max() ); // 10 characters
    }
    int fullLineLength = formatter.tableRowPrependText().length() + 9 * formatter.columnSpacing() + 50 + 8 * 10 +
                         formatter.tableRowAppendText().length();
    int tableWidth = formatter.tableWidth();
    EXPECT_EQ( tableWidth, fullLineLength );
    EXPECT_GT( tableWidth, formatter.maxDataRowWidth() );

    formatter.rowCompleted();
    formatter.tableCompleted();

    QStringList tableLines = RiaTextStringTools::splitSkipEmptyParts( tableText, QRegularExpression( "[\r\n]" ) );
    for ( QString line : tableLines )
    {
        std::cout << QString( "Line: \"%1\"" ).arg( line ).toStdString() << std::endl;
        if ( !line.startsWith( formatter.commentPrefix() ) )
        {
            EXPECT_LE( line.length(), formatter.maxDataRowWidth() );
        }
    }
}

TEST( RifTextDataTableFormatter, LongLine132 )
{
    QString                   tableText;
    QTextStream               stream( &tableText );
    RifTextDataTableFormatter formatter( stream );

    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "10 Char" ),
        RifTextDataTableColumn( "10 Int #1", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #2", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #3", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #4", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #5", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #6", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #7", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "I", RifTextDataTableDoubleFormatting(), RIGHT ),
    };

    formatter.header( header );
    QString tenCharacterWellName = "0123456789";
    formatter.add( tenCharacterWellName );
    for ( int i = 0; i < 7; ++i )
    {
        formatter.add( std::numeric_limits<int>::max() ); // 10 characters
    }
    formatter.add( 11 );

    int fullLineLength = formatter.tableRowPrependText().length() + 9 * formatter.columnSpacing() + 10 + 7 * 10 + 2 +
                         formatter.tableRowAppendText().length();
    int tableWidth = formatter.tableWidth();
    EXPECT_GE( tableWidth, fullLineLength );
    EXPECT_EQ( formatter.maxDataRowWidth(), fullLineLength );

    formatter.rowCompleted();
    formatter.tableCompleted();

    QStringList tableLines = RiaTextStringTools::splitSkipEmptyParts( tableText, QRegularExpression( "[\r\n]" ) );
    for ( QString line : tableLines )
    {
        std::cout << QString( "Line: \"%1\"" ).arg( line ).toStdString() << std::endl;
        if ( line.startsWith( "0" ) )
        {
            EXPECT_EQ( line.length(), formatter.maxDataRowWidth() );
        }
    }
}

TEST( RifTextDataTableFormatter, LongLine133 )
{
    QString                   tableText;
    QTextStream               stream( &tableText );
    RifTextDataTableFormatter formatter( stream );

    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "10 Char" ),
        RifTextDataTableColumn( "10 Int #1", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #2", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #3", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #4", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #5", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #6", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "10 Int #7", RifTextDataTableDoubleFormatting(), RIGHT ),
        RifTextDataTableColumn( "I", RifTextDataTableDoubleFormatting(), RIGHT ),
    };

    formatter.header( header );
    QString fiftyCharacterWellName = "0123456789";
    formatter.add( fiftyCharacterWellName );
    for ( int i = 0; i < 7; ++i )
    {
        formatter.add( std::numeric_limits<int>::max() ); // 10 characters
    }
    formatter.add( 111 );

    int fullLineLength = formatter.tableRowPrependText().length() + 9 * formatter.columnSpacing() + 10 + 7 * 10 + 3 +
                         formatter.tableRowAppendText().length();
    int tableWidth = formatter.tableWidth();
    EXPECT_GE( tableWidth, fullLineLength );
    EXPECT_LT( formatter.maxDataRowWidth(), fullLineLength );

    formatter.rowCompleted();
    formatter.tableCompleted();

    QStringList tableLines = RiaTextStringTools::splitSkipEmptyParts( tableText, QRegularExpression( "[\r\n]" ) );
    for ( QString line : tableLines )
    {
        std::cout << QString( "Line: \"%1\"" ).arg( line ).toStdString() << std::endl;
        if ( line.startsWith( "0" ) )
        {
            EXPECT_LE( line.length(), formatter.maxDataRowWidth() );
        }
    }
}

TEST( RifTextDataTableFormatter, TwoHeaderRowsWithDifferentColSpan )
{
    std::vector<RifTextDataTableColumn> header = {
        RifTextDataTableColumn( "WELL", "NAME" ), // well
        RifTextDataTableColumn( "GROUP", "NAME" ), // group
        RifTextDataTableColumn( "", "I" ), // I
        RifTextDataTableColumn( "", "J" ), // J
        RifTextDataTableColumn( "BHP", "DEPTH" ), // RefDepth
        RifTextDataTableColumn( "PHASE", "FLUID" ), // Type
        RifTextDataTableColumn( "DRAIN", "AREA", "[cm2]" ), // DrainRad
        RifTextDataTableColumn( "INFLOW", "EQUANS" ), // GasInEq
        RifTextDataTableColumn( "OPEN", "SHUT" ), // AutoShut
        RifTextDataTableColumn( "CROSS", "FLOW" ), // XFlow
        RifTextDataTableColumn( "PVT", "TABLE" ), // FluidPVT
        RifTextDataTableColumn( "HYDS", "DENS" ), // HydrDens
        RifTextDataTableColumn( "FIP", "REGN" ) // FluidInPla) };
    };

    {
        QString     tableText;
        QTextStream stream( &tableText );

        RifTextDataTableFormatter formatter( stream );
        formatter.setColumnSpacing( 2 );

        formatter.header( header );
        // Test with keyword after header
        formatter.keyword( "WELSPECS" );

        formatter.add( "OP-01" );
        formatter.add( "PLATFORM" );
        formatter.add( "45" );
        formatter.add( "99" );
        formatter.add( "1*" );
        formatter.add( "OIL" );
        formatter.add( "0.0" );
        formatter.add( "STD" );
        formatter.add( "STOP" );
        formatter.add( "YES" );
        formatter.add( "0" );
        formatter.add( "SEG" );
        formatter.add( "0" );
        formatter.rowCompleted();

        formatter.add( "OP-02ST" );
        formatter.add( "PLATFORM" );
        formatter.add( "60" );
        formatter.add( "91" );
        formatter.add( "1*" );
        formatter.add( "OIL" );
        formatter.add( "0.0" );
        formatter.add( "STD" );
        formatter.add( "STOP" );
        formatter.add( "YES" );
        formatter.add( "0" );
        formatter.add( "SEG" );
        formatter.add( "0" );
        formatter.rowCompleted();

        formatter.tableCompleted();

        const QString textForCompare =
            R"(-- WELL     GROUP             BHP    PHASE  DRAIN  INFLOW  OPEN  CROSS  PVT    HYDS  FIP 
-- NAME     NAME      I   J   DEPTH  FLUID  AREA   EQUANS  SHUT  FLOW   TABLE  DENS  REGN
--                                          [cm2]                                        
WELSPECS
   OP-01    PLATFORM  45  99  1*     OIL    0.0    STD     STOP  YES    0      SEG   0    /
   OP-02ST  PLATFORM  60  91  1*     OIL    0.0    STD     STOP  YES    0      SEG   0    /
/
)";

        EXPECT_STREQ( textForCompare.toStdString().data(), tableText.toStdString().data() );
    }

    {
        QString     tableText;
        QTextStream stream( &tableText );

        RifTextDataTableFormatter formatter( stream );
        formatter.setColumnSpacing( 2 );

        // Test with keyword before header
        formatter.keyword( "WELSPECS" );
        formatter.header( header );

        formatter.add( "OP-01" );
        formatter.add( "PLATFORM" );
        formatter.add( "45" );
        formatter.add( "99" );
        formatter.add( "1*" );
        formatter.add( "OIL" );
        formatter.add( "0.0" );
        formatter.add( "STD" );
        formatter.add( "STOP" );
        formatter.add( "YES" );
        formatter.add( "0" );
        formatter.add( "SEG" );
        formatter.add( "0" );
        formatter.rowCompleted();

        formatter.add( "OP-02ST" );
        formatter.add( "PLATFORM" );
        formatter.add( "60" );
        formatter.add( "91" );
        formatter.add( "1*" );
        formatter.add( "OIL" );
        formatter.add( "0.0" );
        formatter.add( "STD" );
        formatter.add( "STOP" );
        formatter.add( "YES" );
        formatter.add( "0" );
        formatter.add( "SEG" );
        formatter.add( "0" );
        formatter.rowCompleted();

        formatter.tableCompleted();

        const QString textForCompare = R"(WELSPECS
-- WELL     GROUP             BHP    PHASE  DRAIN  INFLOW  OPEN  CROSS  PVT    HYDS  FIP 
-- NAME     NAME      I   J   DEPTH  FLUID  AREA   EQUANS  SHUT  FLOW   TABLE  DENS  REGN
--                                          [cm2]                                        
   OP-01    PLATFORM  45  99  1*     OIL    0.0    STD     STOP  YES    0      SEG   0    /
   OP-02ST  PLATFORM  60  91  1*     OIL    0.0    STD     STOP  YES    0      SEG   0    /
/
)";

        EXPECT_STREQ( textForCompare.toStdString().data(), tableText.toStdString().data() );
    }
}

TEST( RifTextDataTableFormatter, ReplaceTokensInString )
{
    {
        std::map<QString, QString> keyValues = {
            { "$KEY1", "VALUE1" },
            { "$KEY1_WITH_MORE_TEXT", "VALUE2" },
        };

        auto templateText = QString( "$KEY1, $KEY1_WITH_MORE_TEXT" );
        auto resolvedText = RiaTextStringTools::replaceTemplateTextWithValues( templateText, keyValues );

        EXPECT_STREQ( resolvedText.toStdString().data(), "VALUE1, VALUE2" );
    }

    {
        std::map<QString, QString> keyValues = {
            { "$KEY1", "VALUE1" },
        };

        auto templateText = QString( "$KEY1, $KEY1_WITH_MORE_2" );
        auto resolvedText = RiaTextStringTools::replaceTemplateTextWithValues( templateText, keyValues );

        EXPECT_STREQ( resolvedText.toStdString().data(), "VALUE1, $KEY1_WITH_MORE_2" );
    }
}