package Local::WriteExcel; #============================================================================== # creates xls or xlsx file, provides Spreadsheet::WriteExcel::Simple methods # write_row(), write_bold_row(), data() & save() # returns data for use in email attachments and/or saves file to disk # limited to single worksheet for xlsx file TODO: support multiple worksheets #============================================================================== use Spreadsheet::WriteExcel::Simple; # for xls files use Excel::Writer::XLSX; # for xlsx files use Data::Printer; use IO::Scalar; use IO::All; use Moo; use feature 'say'; # supported file types: my @exts = qw(xls xlsx); # for Excel::Writer::XLSX: my $xlsx_data; # filename, optionally passed in (if not then need filetype): has filename => ( is => 'ro' ); # filetype (xls or xlsx); passed in at object creation or captured in builder # from filename extension (.xls[x]): has filetype => ( # use builder to trigger on ->new rather than on usage is => 'ro', isa => sub { my $ft = shift; # say $ft; die "unsupported filetype $ft" unless grep { $ft eq $_ } @exts; }, builder => 1, ); sub _build_filetype { # say "Building filetype"; $_[0]->filename =~ m!\.(?[^\.]+)$!; # return extension (xls or xlsx): return $+{ext}; } # xl_object: Spreadsheet::WriteExcel::Simple or Excel::Writer::XLSX object has xl_object => ( is => 'rwp' ); # set in BUILD block # set Excel::Writer::XLSX worksheet name: has worksheet_name => ( is => 'rw', default => 'sheet1', trigger => 1 ); sub _trigger_worksheet_name { die "filetype must be xlsx to use worksheet_name" unless $_[0]->filetype eq 'xlsx'; } # new Excel::Writer::XLSX worksheet: has worksheet => ( is => 'lazy' ); sub _build_worksheet { $_[0]->xl_object->add_worksheet($_[0]->worksheet_name) } # for Excel::Writer::XLSX write_row(): has row_counter => ( is => 'rw', default => 'A1' ); # 1st data row sub BUILD { my ($self, $args) = @_; # p $self; p $args; # either filetype or filename must be supplied in args to object: die "require either filename or filetype in args to object" if ! grep $args->{$_}, qw(filename filetype); # xl_object is Excel::Writer::XLSX or Spreadsheet::WriteExcel::Simple: my $xl_object = ( $self->filetype eq 'xlsx' ) ? Excel::Writer::XLSX->new( IO::Scalar->new(\$xlsx_data) ) : Spreadsheet::WriteExcel::Simple->new(); $self->_set_xl_object($xl_object); } #=============================================================================== sub write_bold_row { my $self = shift; my $ref = shift; # aref my $xl = $self->xl_object; if ( $self->filetype eq 'xls' ) { $xl->write_bold_row($ref); } else { my $hdr_format = $xl->add_format(bold => 1); $self->_write_xlsx_row($ref, $hdr_format); } } #------------------------------------------------------------------------------- sub write_row { my $self = shift; my $ref = shift; # aref if ( $self->filetype eq 'xls' ) { $self->xl_object->write_row($ref); } else { $self->_write_xlsx_row($ref); } } #------------------------------------------------------------------------------- # return data in format eg for email attachment: sub data { my $self = shift; # p $self; if ( $self->filetype eq 'xls' ) { return $self->xl_object->data; } else { $self->xl_object->close; return $xlsx_data; } } #------------------------------------------------------------------------------- sub save { my ($self, $filename) = @_; # filename optional, may already have been provided in object creation # could also be overridden by passing in a new value: $filename ||= $self->filename or die 'cannot call save() without a ' . 'filename arg unless already provided at object construction'; if ( $self->filetype eq 'xls' ) { $self->xl_object->save($self->filename); } else { $self->xl_object->close; # is OK to call this twice (ie if data() visited) io($filename)->print($xlsx_data); } } #------------------------------------------------------------------------------- sub _write_xlsx_row { my ($self, $ref, $format) = @_; # format optional my $row = $self->row_counter; # p $row; $self->worksheet->write_row($row, $ref, $format); # A1, A2, A3, A4, etc # auto-increment & set new row counter: $self->row_counter(++$row); } 1;