/ 
Spreadsheet-HTML-0.14
River stage one • 1 direct dependent • 1 total dependent
/ Spreadsheet::HTML

NAME

Spreadsheet::HTML - Render HTML5 tables with ease.

SYNOPSIS

use Spreadsheet::HTML;

$data = [ [qw(a1 a2 a3)], [qw(b1 b2 b3)], [qw(c1 c2 c3)] ];

$table = Spreadsheet::HTML->new( data => $data, indent => "\t" );
print $table->portrait;
print $table->landscape;

# non OO
print Spreadsheet::HTML::portrait( $data );
print Spreadsheet::HTML::landscape( $data );

# load from files (first table found)
$table = Spreadsheet::HTML->new( file => 'data.xls', cache => 1 );

DESCRIPTION

THIS MODULE IS AN ALPHA RELEASE!

Renders HTML5 tables with ease. Provides a handful of distinctly named methods to control overall table orientation. These methods in turn accept a number of distinctly named attributes for directing what tags and attributes to use.

METHODS

  • new( %args )

    my $table = Spreadsheet::HTML->new( data => $data );

    Constructs object. Accepts named arguments (see ATTRIBUTES). Unless you give it an array of array refs. Or an array ref of array refs. Otherwise it expects named arguments. The most favorite being 'data' which is exactly an array ref of array refs. The first row will be treated as the headings unless you specify otherwise (see ATTRIBUTES).

  • generate( %args )

    $html = $table->generate( table => {border => 1}, encode => '<>' );
print Spreadsheet::HTML::generate( data => $data, indent => "\t" );

    Returns a string that contains the rendered HTML table.

  • portrait( %args )

    Alias for generate()

  • transpose( %args )

    Uses Math::Matrix to rotate the headings and data 90 degrees counter-clockwise.

  • landscape( %args )

    Alias for transpose()

  • flip( %args )

    Flips the headings and data upside down.

  • mirror( %args )

    Columns are rendered right to left.

  • reverse( %args )

    Combines flip and mirror: flips the headings and data upside down and render columns right to left.

  • process( %args )

    Returns processed data.

ATTRIBUTES

All methods/procedures accept named arguments. If named arguments are detected: the data has to be an array ref assigned to the key 'data'. If no named args are detected then the parameter list is treated as the data itself, either an array containing array references or an array reference containing array references.

  • data: [ [], [], [], ... ]

    The data to be rendered into table cells.

  • file: $str

    The name of the data file to read. Supported formats are XLS, CSV, JSON, YAML and HTML (first table found).

  • indent: $str

    Render the table with whitespace indention. Defaults to undefined which produces no trailing whitespace to tags. Useful values are some number of spaces or tabs. (see HTML::Element::as_HTML).

  • encode: $str

    HTML Encode contents of td tags. Defaults to empty string which performs no encoding of entities. Pass a string like '<>&=' to perform encoding on any characters found. If the value is 'undef' then all unsafe characters will be encoded as HTML entites (see HTML::Element::as_HTML).

  • empty: $str

    Replace empty cells with this value. Defaults to &nbsp; Set value to undef to avoid any substitutions.

  • cache: 0 or 1

    Preserve data after it has been processed (and loaded).

  • matrix: 0 or 1

    Render the table with only td tags, no th tags, if true.

  • layout: 0 or 1

    Add W3C recommended table attributes, emit only <td> tags, no row padding or pruning, and force no HTML entity encoding in table cells.

  • headless: 0 or 1

    Render the table with without headings, if true.

  • headings: sub { return function( shift ) }

    Apply this anonymous subroutine to headers.

  • tgroups: 0 or 1

    Group table rows into <thead> <tfoot> and <tbody> sections. The <tfoot> section is always found before the <tbody> section. Only available for generate(), portrait() and mirror().

  • table: \%args

  • caption: $str

  • thead: \%args

  • tfoot: \%args

  • tbody: \%args

  • tr: \%args

  • th: \%args

  • td: \%args

    Supply attributes to the HTML tags that compose the table. There is currently no support for col and colgroup.

REQUIRES

  • HTML::AutoTag

    Used to generate HTML. Handles indentation and HTML entity encoding. Uses Tie::Hash::Attribute to handle rotation of class attributes.

  • Math::Matrix

    Used for transposing data from portrait to landscape.

  • Clone

    Useful for preventing data from being clobbered.

OPTIONAL

Used to load data from various different file formats.

SEE ALSO

BUGS AND LIMITATIONS

Currently missing <col> and <colgroup> tags, row grouping and fine grained cell attribute and content control.

Benchmarks have improved since switching from HTML::Element to HTML::AutoTag but we are still a C- student at best. The following benchmark was performed by rendering a 500x500 cell table 20 times:

Before switch to HTML::AutoTag

                   s/iter  S::H  H::E H::AT  H::T D::XT
Spreadsheet::HTML    8.58    --  -13%  -53%  -66%  -78%
HTML::Element        7.50   14%    --  -47%  -62%  -74%
HTML::AutoTag        4.01  114%   87%    --  -28%  -52%
HTML::Tiny           2.87  198%  161%   39%    --  -33%
DBIx::XHTML_Table    1.92  347%  291%  109%   50%    --

After switch to HTML::AutoTag

                  s/iter  H::E  S::H H::AT  H::T D::XT
HTML::Element       7.56    --  -34%  -46%  -60%  -74%
Spreadsheet::HTML   4.96   53%    --  -17%  -39%  -60%
HTML::AutoTag       4.12   84%   21%    --  -26%  -52%
HTML::Tiny          3.05  148%   63%   35%    --  -35%
DBIx::XHTML_Table   1.99  281%  150%  107%   53%    --

Switching to HTML::Tiny would improve speed but this would complicate rotating attributes. The suggestion from these benchmarks is to do it the way DBIx::XHTML_Table does it: by complete brute force. This does not interest me ... if 1 second can be shaved off of HTML::AutoTag's time this would suffice.

Please report any bugs or feature requests to either

I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

In terms of limitations this implementation is not as fast as it should be. From the results a few performance tests, i believe this to be blamed on HTML::Tree. v0.02 could process a 500x500 data matrix in 1/5 of a second. This version timed at around 8.5 seconds. Not awesome. DBIx::XHTML_Table timed at 2.2 seconds. The several lines of code that HTML::Element save me are not worth the time trade off, so i will be working to develop my own solution, unless another CPAN module will suffice. Don't get me wrong, HTML::Tree is awesome and powerful. But i needs speed. And i could be wrong ... ;)

This implementation is currently missing the following features:

  • build index map for columns

  • build auto col_XX and row_XX for item 1 (maybe ...)

  • emit col and colgroup tags

  • map client attrs and functions to cells by columns/rows

You are encouraged to use DBIx::XHTML_Table during the development of this module.

GITHUB

The Github project is https://github.com/jeffa/Spreadsheet-HTML

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Spreadsheet::HTML

You can also look for information at:

ACKNOWLEDGEMENTS

Thank you very much! :)

  • Neil Bowers

    Helped with Makefile.PL suggestions and corrections.

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Jeff Anderson.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.