diff options
author | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:33:33 +0100 |
---|---|---|
committer | Andrew Shadura <andrewsh@debian.org> | 2017-09-08 15:33:33 +0100 |
commit | 9e3dc7af5fcc4f59f204b319d85844340ee1a8a5 (patch) | |
tree | 8e971bf5c10833129e908391157a583912aa51e6 |
Import original source of Text-SimpleTable-AutoWidth 0.09
-rw-r--r-- | LICENSE | 379 | ||||
-rw-r--r-- | MANIFEST | 16 | ||||
-rw-r--r-- | MANIFEST.SKIP | 9 | ||||
-rw-r--r-- | META.yml | 22 | ||||
-rw-r--r-- | Makefile.PL | 62 | ||||
-rw-r--r-- | README | 15 | ||||
-rw-r--r-- | dist.ini | 20 | ||||
-rw-r--r-- | lib/Text/SimpleTable/AutoWidth.pm | 276 | ||||
-rw-r--r-- | t/01use.t | 3 | ||||
-rw-r--r-- | t/02pod.t | 7 | ||||
-rw-r--r-- | t/03podcoverage.t | 7 | ||||
-rw-r--r-- | t/04tables.t | 46 | ||||
-rw-r--r-- | t/author-critic.t | 20 | ||||
-rw-r--r-- | t/release-pod-coverage.t | 15 | ||||
-rw-r--r-- | t/release-pod-syntax.t | 14 |
15 files changed, 911 insertions, 0 deletions
@@ -0,0 +1,379 @@ +This software is copyright (c) 2015 by Oleg Kostyuk. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2015 by Oleg Kostyuk. + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2015 by Oleg Kostyuk. + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End + diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..e558908 --- /dev/null +++ b/MANIFEST @@ -0,0 +1,16 @@ +# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.031. +LICENSE +MANIFEST +MANIFEST.SKIP +META.yml +Makefile.PL +README +dist.ini +lib/Text/SimpleTable/AutoWidth.pm +t/01use.t +t/02pod.t +t/03podcoverage.t +t/04tables.t +t/author-critic.t +t/release-pod-coverage.t +t/release-pod-syntax.t diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP new file mode 100644 index 0000000..570c0db --- /dev/null +++ b/MANIFEST.SKIP @@ -0,0 +1,9 @@ +\.git +blib/ +\.DS_Store$ +pm_to_blib$ +Makefile$ +MANIFEST\.skip$ +MANIFEST\.bak$ +Makefile\.old$ +\.shipit$ diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..604f083 --- /dev/null +++ b/META.yml @@ -0,0 +1,22 @@ +--- +abstract: 'Text::SimpleTable::AutoWidth - Simple eyecandy ASCII tables with auto-width selection' +author: + - 'Oleg Kostyuk <cub.uanic@gmail.com>' +build_requires: + Test::More: 0 +configure_requires: + ExtUtils::MakeMaker: 0 +dynamic_config: 0 +generated_by: 'Dist::Zilla version 5.031, CPAN::Meta::Converter version 2.143240' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: 1.4 +name: Text-SimpleTable-AutoWidth +requires: + List::Util: 0 + Moo: 0 + Text::SimpleTable: 0 + strict: 0 + warnings: 0 +version: 0.09 diff --git a/Makefile.PL b/Makefile.PL new file mode 100644 index 0000000..33adb29 --- /dev/null +++ b/Makefile.PL @@ -0,0 +1,62 @@ + +# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.031. +use strict; +use warnings; + + + +use ExtUtils::MakeMaker; + + + +my %WriteMakefileArgs = ( + "ABSTRACT" => "Text::SimpleTable::AutoWidth - Simple eyecandy ASCII tables with auto-width selection", + "AUTHOR" => "Oleg Kostyuk <cub.uanic\@gmail.com>", + "CONFIGURE_REQUIRES" => { + "ExtUtils::MakeMaker" => 0 + }, + "DISTNAME" => "Text-SimpleTable-AutoWidth", + "EXE_FILES" => [], + "LICENSE" => "perl", + "NAME" => "Text::SimpleTable::AutoWidth", + "PREREQ_PM" => { + "List::Util" => 0, + "Moo" => 0, + "Text::SimpleTable" => 0, + "strict" => 0, + "warnings" => 0 + }, + "TEST_REQUIRES" => { + "Test::More" => 0 + }, + "VERSION" => "0.09", + "test" => { + "TESTS" => "t/*.t" + } +); + + +my %FallbackPrereqs = ( + "ExtUtils::MakeMaker" => 0, + "List::Util" => 0, + "Moo" => 0, + "Test::More" => 0, + "Text::SimpleTable" => 0, + "strict" => 0, + "warnings" => 0 +); + + +unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { + delete $WriteMakefileArgs{TEST_REQUIRES}; + delete $WriteMakefileArgs{BUILD_REQUIRES}; + $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; +} + +delete $WriteMakefileArgs{CONFIGURE_REQUIRES} + unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; + +WriteMakefile(%WriteMakefileArgs); + + + @@ -0,0 +1,15 @@ + + +This archive contains the distribution Text-SimpleTable-AutoWidth, +version 0.09: + + Text::SimpleTable::AutoWidth - Simple eyecandy ASCII tables with auto-width selection + +This software is copyright (c) 2015 by Oleg Kostyuk. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + + +This README file was generated by Dist::Zilla::Plugin::Readme v5.031. + diff --git a/dist.ini b/dist.ini new file mode 100644 index 0000000..bff102d --- /dev/null +++ b/dist.ini @@ -0,0 +1,20 @@ +name = Text-SimpleTable-AutoWidth +version = 0.09 +author = Oleg Kostyuk <cub.uanic@gmail.com> +license = Perl_5 +copyright_holder = Oleg Kostyuk + +[@Basic] + +[PkgVersion] +[PodWeaver] +[PodSyntaxTests] +[PodCoverageTests] +[Test::Perl::Critic] +[TestRelease] +[ConfirmRelease] +[UploadToCPAN] +[AutoPrereqs] +[ReadmeAnyFromPod/MarkdownInRoot] +filename = README.md + diff --git a/lib/Text/SimpleTable/AutoWidth.pm b/lib/Text/SimpleTable/AutoWidth.pm new file mode 100644 index 0000000..3287f04 --- /dev/null +++ b/lib/Text/SimpleTable/AutoWidth.pm @@ -0,0 +1,276 @@ +use strict; +use warnings; + +package Text::SimpleTable::AutoWidth; +$Text::SimpleTable::AutoWidth::VERSION = '0.09'; +use Moo; + +# ABSTRACT: Text::SimpleTable::AutoWidth - Simple eyecandy ASCII tables with auto-width selection + + +has 'fixed_width' => ( is => 'rw', default => 0 ); # isa => 'Int' +has 'max_width' => ( is => 'rw', default => 0 ); # isa => 'Int' + +has 'captions' => ( is => 'rw' ); # isa => 'ArrayRef[Str]' +has 'rows' => ( is => 'rw' ); # isa => 'ArrayRef[ArrayRef[Str]]' + +our $WIDTH_LIMIT = 200; # default maximum width + + +sub row { + my ( $self, @texts ) = @_; + + if ( $self->rows ) { + push( @{ $self->rows }, [@texts] ); + } + else { + $self->rows( [ [@texts] ] ); + } + + return $self; +} + + +use List::Util; +use Text::SimpleTable; + +sub draw { + my $self = shift; + + # count of columns will be same as count of captions, or same + # as count of columns in first row, if there is no captions + my $columns = + ( $self->captions && @{ $self->captions } ) + || ( $self->rows && @{ $self->rows->[0] } ) + || 0; + + return unless $columns; + + # table will not be wider than limits + my $limit = + $self->max_width ? $self->max_width + : $self->fixed_width ? $self->fixed_width + : $WIDTH_LIMIT; + + # by default, each column should have at least 2 symbols: + # one informative and one for '-' (if we'll need to wrap) + my @max_width = (2) x $columns; + + # calculate max width of each column + for my $row ( ( $self->captions ? $self->captions : () ), @{ $self->rows } ) { + my @row_width = map { length } @$row; + $#row_width = $columns - 1 if $#row_width >= $columns; + + # find new width + # we will do this in two passes + my @new_width = @max_width; + + # first pass: + # find new width for all columns, that we can + # make wider without need to wrap anything + for my $idx ( 0 .. $#row_width ) { + if ( $max_width[$idx] < $row_width[$idx] ) { + $new_width[$idx] = $row_width[$idx]; + + # check for limits + my $total = $columns + 1 # for each '|' + + $columns * 2 # for spaces around each value + + List::Util::reduce { $a + $b } @new_width; + + # restore old value, if new value will lead to wrap + $new_width[$idx] = $max_width[$idx] + if $total > $limit; + } + } + + # second pass: + # find new width for all columns, that we can + # make wider and need to wrap something + for my $idx ( 0 .. $#row_width ) { + if ( $new_width[$idx] < $row_width[$idx] ) { + my $total = $columns + 1 # for each '|' + + $columns * 2 # for spaces around each value + + List::Util::reduce { $a + $b } @new_width; + + $new_width[$idx] += $limit - $total; + last; + } + } + + # save new result + @max_width = @new_width; + + # check for limits + my $total = $columns + 1 # for each '|' + + $columns * 2 # for spaces around each value + + List::Util::reduce { $a + $b } @max_width; + + last if $total >= $limit; + } + + # check for fixed_width + if ( $self->fixed_width ) { + my $total = $columns + 1 # for each '|' + + $columns * 2 # for spaces around each value + + List::Util::reduce { $a + $b } @max_width; + + $max_width[-1] += $self->fixed_width - $total + unless $total == $self->fixed_width; + } + + # prepare drawer + my @params = @max_width; + + if ( $self->captions ) { + my $idx = 0; + for (@params) { + $_ = [ $_, $self->captions->[ $idx++ ] ]; + } + } + my $tab = Text::SimpleTable->new(@params); + + # put rows into drawer + $tab->row(@$_) for @{ $self->rows }; + + return $tab->draw(); +} + +__PACKAGE__->meta->make_immutable(); + + +1; # End of Text::SimpleTable::AutoWidth + +__END__ + +=pod + +=encoding UTF-8 + +=head1 NAME + +Text::SimpleTable::AutoWidth - Text::SimpleTable::AutoWidth - Simple eyecandy ASCII tables with auto-width selection + +=head1 VERSION + +version 0.09 + +=head1 SYNOPSIS + + use Text::SimpleTable::AutoWidth; + + my $t1 = Text::SimpleTable::AutoWidth->new(); + $t1->row( 'foobarbaz', 'yadayadayada' ); + print $t1->draw; + + .-----------+--------------. + | foobarbaz | yadayadayada | + '-----------+--------------' + + + my $t2 = Text::SimpleTable::AutoWidth->new(); + $t2->captions( 'Foo', 'Bar' ); + $t2->row( 'foobarbaz', 'yadayadayada' ); + $t2->row( 'barbarbarbarbar', 'yada' ); + print $t2->draw; + + .-----------------+--------------. + | Foo | Bar | + +-----------------+--------------+ + | foobarbaz | yadayadayada | + | barbarbarbarbar | yada | + '-----------------+--------------' + +=head1 DESCRIPTION + +Simple eyecandy ASCII tables with auto-selection columns width, +as seen in L<Catalyst>. + +=head1 METHODS + +=head2 new(@attrs) + +Inherited constructor from Moo. +You can set following attributes: + +=head3 fixed_width + +Set fixed width for resulting table. By default it's 0, +that's mean "don't fix width", so width of result table +will depend on input data. + +Be warned, that fixed_width will include not only width of your data, +but also all surronding characters, like spaces across values, +table drawings (like '|') and hypen (if wrapping is needed). + +=head3 max_width + +Set maximum width for resulting table. By default it's 0, +that's mean "use default value". Default value is stored in +$Text::SimpleTable::AutoWidth::WIDTH_LIMIT, and can be changed +at any moment. Default value for WIDTH_LIMIT is 200. + +Be warned, that max_width will include not only width of your data, +but also all surronding characters, like spaces across values, +table drawings (like '|') and hypen (if wrapping is needed). + +NB: if you set fixed_width and max_width at same time, then you'll +get table with fixed width, but not wider than max_width characters. + +=head3 captions + +ArrayRef[Str] for captions in resulting table. + +=head3 rows + +ArrayRef[ArrayRef[Str]] for values in each row. +You can use next method to add individual rows into table. + +=head2 row(@texts) + +Add new row to table. Return $self, so you can write something like this: + + print Text::SimpleTable::AutoWidth + ->new( max_width => 55, captions => [qw/ Name Age /] ) + ->row( 'Mother', 59 ) + ->row( 'Dad', 58 ) + ->row( 'me', 32 ) + ->draw(); + +=head2 draw() + +Draw table. Really, just calculate column width, and then call Text::SimpleTable->draw(). + +=head1 GIT REPOSITORY + +git clone git://github.com/cub-uanic/Text-SimpleTable-AutoWidth.git + +=head1 SEE ALSO + +L<Text::SimpleTable>, L<Moo>, L<Catalyst> + +=head1 AUTHOR + +Oleg Kostyuk, C<< <cub#cpan.org> >> + +=head1 COPYRIGHT & LICENSE + +Copyright by Oleg Kostyuk. + +This program is free software; you can redistribute it and/or modify it +under the terms of either: the GNU General Public License as published +by the Free Software Foundation; or the Artistic License. + +See http://dev.perl.org/licenses/ for more information. + +=head1 AUTHOR + +Oleg Kostyuk <cub.uanic@gmail.com> + +=head1 COPYRIGHT AND LICENSE + +This software is copyright (c) 2015 by Oleg Kostyuk. + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +=cut diff --git a/t/01use.t b/t/01use.t new file mode 100644 index 0000000..7515194 --- /dev/null +++ b/t/01use.t @@ -0,0 +1,3 @@ +use Test::More tests => 1; + +use_ok('Text::SimpleTable::AutoWidth'); diff --git a/t/02pod.t b/t/02pod.t new file mode 100644 index 0000000..1647794 --- /dev/null +++ b/t/02pod.t @@ -0,0 +1,7 @@ +use Test::More; + +eval "use Test::Pod 1.14"; +plan skip_all => 'Test::Pod 1.14 required' if $@; +plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD}; + +all_pod_files_ok(); diff --git a/t/03podcoverage.t b/t/03podcoverage.t new file mode 100644 index 0000000..d91be5e --- /dev/null +++ b/t/03podcoverage.t @@ -0,0 +1,7 @@ +use Test::More; + +eval "use Test::Pod::Coverage 1.04"; +plan skip_all => 'Test::Pod::Coverage 1.04 required' if $@; +plan skip_all => 'set TEST_POD to enable this test' unless $ENV{TEST_POD}; + +all_pod_coverage_ok(); diff --git a/t/04tables.t b/t/04tables.t new file mode 100644 index 0000000..5215be8 --- /dev/null +++ b/t/04tables.t @@ -0,0 +1,46 @@ +use Test::More tests => 5; + +use_ok('Text::SimpleTable::AutoWidth'); + +my $t1 = Text::SimpleTable::AutoWidth->new(); +$t1->row( 'Catalyst', 'rockz!' ); +$t1->row( 'DBIx::Class', 'rockz!' ); +$t1->row( 'Template::Toolkit', 'rockz!' ); +is( $t1->draw, <<"EOF"); +.-------------------+--------. +| Catalyst | rockz! | +| DBIx::Class | rockz! | +| Template::Toolkit | rockz! | +'-------------------+--------' +EOF + +my $t2 = Text::SimpleTable::AutoWidth->new(); +$t2->captions( [ 'ROCKZ!', 'Rockz!', 'rockz!' ] ); +$t2->row( 'Catalyst', 'DBIx::Class', 'Template::Toolkit', 'HTML::Mason' ); +is( $t2->draw, <<"EOF"); +.----------+-------------+-------------------. +| ROCKZ! | Rockz! | rockz! | ++----------+-------------+-------------------+ +| Catalyst | DBIx::Class | Template::Toolkit | +'----------+-------------+-------------------' +EOF + +my $t3 = Text::SimpleTable::AutoWidth->new( max_width => 9 ); +$t3->row('Everything works!'); +is( $t3->draw, <<"EOF"); +.-------. +| Ever- | +| ythi- | +| ng w- | +| orks! | +'-------' +EOF + +my $t4 = Text::SimpleTable::AutoWidth->new( fixed_width => 29 ); +$t4->row('Everything works!'); +is( $t4->draw, <<"EOF"); +.---------------------------. +| Everything works! | +'---------------------------' +EOF + diff --git a/t/author-critic.t b/t/author-critic.t new file mode 100644 index 0000000..af7f7ea --- /dev/null +++ b/t/author-critic.t @@ -0,0 +1,20 @@ +#!perl + +BEGIN { + unless ($ENV{AUTHOR_TESTING}) { + require Test::More; + Test::More::plan(skip_all => 'these tests are for testing by the author'); + } +} + + +use strict; +use warnings; + +use Test::More; +use English qw(-no_match_vars); + +eval "use Test::Perl::Critic"; +plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; +Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; +all_critic_ok(); diff --git a/t/release-pod-coverage.t b/t/release-pod-coverage.t new file mode 100644 index 0000000..18a8274 --- /dev/null +++ b/t/release-pod-coverage.t @@ -0,0 +1,15 @@ +#!perl + +BEGIN { + unless ($ENV{RELEASE_TESTING}) { + require Test::More; + Test::More::plan(skip_all => 'these tests are for release candidate testing'); + } +} + +# This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. + +use Test::Pod::Coverage 1.08; +use Pod::Coverage::TrustPod; + +all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); diff --git a/t/release-pod-syntax.t b/t/release-pod-syntax.t new file mode 100644 index 0000000..cdd6a6c --- /dev/null +++ b/t/release-pod-syntax.t @@ -0,0 +1,14 @@ +#!perl + +BEGIN { + unless ($ENV{RELEASE_TESTING}) { + require Test::More; + Test::More::plan(skip_all => 'these tests are for release candidate testing'); + } +} + +# This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. +use Test::More; +use Test::Pod 1.41; + +all_pod_files_ok(); |