Skip to content

Commit

Permalink
table: fix escaping of future functions
Browse files Browse the repository at this point in the history
  • Loading branch information
jmcnamara committed Oct 9, 2023
1 parent f19662d commit 48ce5d3
Show file tree
Hide file tree
Showing 5 changed files with 191 additions and 3 deletions.
9 changes: 6 additions & 3 deletions lib/Excel/Writer/XLSX/Worksheet.pm
Original file line number Diff line number Diff line change
Expand Up @@ -2827,6 +2827,7 @@ sub _prepare_formula {

my $self = shift;
my $formula = shift;
my $expand_future_functions = shift;

# Ignore empty/null formulas.
return $formula if !$formula;
Expand Down Expand Up @@ -2869,7 +2870,7 @@ sub _prepare_formula {
$formula =~ s/\b(WRAPROWS\()/_xlfn.$1/g;
$formula =~ s/\b(XLOOKUP\()/_xlfn.$1/g;

if ( !$self->{_use_future_functions} ) {
if ( !$self->{_use_future_functions} && !$expand_future_functions ) {
return $formula;
}

Expand Down Expand Up @@ -5073,6 +5074,9 @@ sub add_table {
# Covert Excel 2010 "@" ref to 2007 "#This Row".
$formula =~ s/@/[#This Row],/g;

# Escape any future functions.
$formula = $self->_prepare_formula($formula, 1);

$col_data->{_formula} = $formula;
# We write the formulas below after the table data.
}
Expand Down Expand Up @@ -5103,8 +5107,7 @@ sub add_table {

}
else {
$formula = $function;
$formula =~ s/^=//;
$formula = $self->_prepare_formula($function, 1);
$col_data->{_custom_total} = $formula;
$function = 'custom';
}
Expand Down
94 changes: 94 additions & 0 deletions t/regression/table35.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
###############################################################################
#
# Tests the output of Excel::Writer::XLSX against Excel generated files.
#
# Copyright 2000-2023, John McNamara, [email protected]
#
# SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
#

use lib 't/lib';
use TestFunctions qw(_compare_xlsx_files _is_deep_diff);
use strict;
use warnings;

use Test::More tests => 1;

###############################################################################
#
# Tests setup.
#
my $filename = 'table35.xlsx';
my $dir = 't/regression/';
my $got_filename = $dir . "ewx_$filename";
my $exp_filename = $dir . 'xlsx_files/' . $filename;


my $ignore_members = [ 'xl/calcChain.xml', '\[Content_Types\].xml', 'xl/_rels/workbook.xml.rels' ];
my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };

###############################################################################
#
# Test the creation of a simple Excel::Writer::XLSX file with tables.
#
use Excel::Writer::XLSX;

my $workbook = Excel::Writer::XLSX->new( $got_filename );
my $worksheet = $workbook->add_worksheet();

my $format1 = $workbook->add_format( num_format => "0.0000" );

my $data = [
[ 'Foo', 1234, 0, 4321 ],
[ 'Bar', 1256, 0, 4320 ],
[ 'Baz', 2234, 0, 4332 ],
[ 'Bop', 1324, 0, 4333 ],
];


# Set the column width to match the target worksheet.
$worksheet->set_column('C:F', 10.288);

# Add the table.
$worksheet->add_table(
'C2:F6',
{
data => $data,
columns => [
{},
{},
{},
{ formula => 'BASE(0,2)', format => $format1 }
],
}
);

$workbook->close();


###############################################################################
#
# Compare the generated and existing Excel files.
#

my ( $got, $expected, $caption ) = _compare_xlsx_files(

$got_filename,
$exp_filename,
$ignore_members,
$ignore_elements,
);

_is_deep_diff( $got, $expected, $caption );


###############################################################################
#
# Cleanup.
#
unlink $got_filename;

__END__
91 changes: 91 additions & 0 deletions t/regression/table36.t
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
###############################################################################
#
# Tests the output of Excel::Writer::XLSX against Excel generated files.
#
# Copyright 2000-2023, John McNamara, [email protected]
#
# SPDX-License-Identifier: Artistic-1.0-Perl OR GPL-1.0-or-later
#

use lib 't/lib';
use TestFunctions qw(_compare_xlsx_files _is_deep_diff);
use strict;
use warnings;

use Test::More tests => 1;

###############################################################################
#
# Tests setup.
#
my $filename = 'table36.xlsx';
my $dir = 't/regression/';
my $got_filename = $dir . "ewx_$filename";
my $exp_filename = $dir . 'xlsx_files/' . $filename;

my $ignore_members = [ 'xl/calcChain.xml', '\[Content_Types\].xml', 'xl/_rels/workbook.xml.rels' ];
my $ignore_elements = { 'xl/workbook.xml' => ['<workbookView'] };


###############################################################################
#
# Test the creation of a simple Excel::Writer::XLSX file with tables.
#
use Excel::Writer::XLSX;

my $workbook = Excel::Writer::XLSX->new( $got_filename );
my $worksheet = $workbook->add_worksheet();

# Set the column width to match the target worksheet.
$worksheet->set_column('C:F', 10.288);

# Write some strings to order the string table.
$worksheet->write_string('A1', 'Column1');
$worksheet->write_string('B1', 'Column2');
$worksheet->write_string('C1', 'Column3');
$worksheet->write_string('D1', 'Column4');
$worksheet->write_string('E1', 'Total');

# Add the table.
$worksheet->add_table(
'C3:F14',
{
total_row => 1,
columns => [
{ total_string => 'Total' },
{ total_function => 'BASE(0,2)' },
{ total_function => '=SUM([Column3])' },
{ total_function => 'count' },
],

}
);



$workbook->close();


###############################################################################
#
# Compare the generated and existing Excel files.
#

my ( $got, $expected, $caption ) = _compare_xlsx_files(

$got_filename,
$exp_filename,
$ignore_members,
$ignore_elements,
);

_is_deep_diff( $got, $expected, $caption );


###############################################################################
#
# Cleanup.
#
unlink $got_filename;

__END__
Binary file added t/regression/xlsx_files/table35.xlsx
Binary file not shown.
Binary file added t/regression/xlsx_files/table36.xlsx
Binary file not shown.

0 comments on commit 48ce5d3

Please sign in to comment.