summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMason James <mtj@kohaaloha.com>2023-02-04 23:58:46 +1300
committerMason James <mtj@kohaaloha.com>2023-02-04 23:58:46 +1300
commit82285a4b2afbfe4481d86d07047195fc95fd2e8e (patch)
treeb51a2f28414914a0f259425bf3b555de27e54b78
Import original source of Text-MarkdownTable 0.3.1
-rw-r--r--Build.PL4
-rw-r--r--Changes23
-rw-r--r--LICENSE379
-rw-r--r--MANIFEST15
-rw-r--r--META.json65
-rw-r--r--META.yml35
-rw-r--r--README102
-rw-r--r--cpanfile3
-rw-r--r--dist.ini1
-rw-r--r--lib/Text/MarkdownTable.pm337
-rw-r--r--t/file.t18
-rw-r--r--t/release-pod-syntax.t14
-rw-r--r--t/simple.t102
-rw-r--r--t/synopsis.t31
14 files changed, 1129 insertions, 0 deletions
diff --git a/Build.PL b/Build.PL
new file mode 100644
index 0000000..c5e706a
--- /dev/null
+++ b/Build.PL
@@ -0,0 +1,4 @@
+# This Build.PL for Text-MarkdownTable was generated by Dist::Zilla::Plugin::ModuleBuildTiny 0.006.
+use v5.10.0;
+use Module::Build::Tiny 0.039;
+Build_PL();
diff --git a/Changes b/Changes
new file mode 100644
index 0000000..ff290df
--- /dev/null
+++ b/Changes
@@ -0,0 +1,23 @@
+0.3.1 2015-07-08 12:12:59 CEST
+ - fix minimal dependency on Moo
+ - additional option 'edges' to disable first and last border
+ - public method 'streaming'
+
+0.3.0 2015-07-01 12:02:42 CEST
+ - additional option 'header'
+
+0.2.4 2014-10-23 00:17:08 CEST
+ - fixed undefined $_ in simple.t test (Patrick Hochstenbach)
+
+0.2.3 2014-07-16 09:45:11 CEST
+ - improved performance by using printf
+ - support undefined column names
+
+0.2.2 2014-07-15 15:02:56 CEST
+ - simplify option 'fh' with IO::Handle::Util
+
+0.2.1 2014-07-11 10:14:33 CEST
+ - implemented condense and unbuffered writing
+
+0.2.0 2014-07-10
+ - inital release, based on Catmandu::Exporter::Table 0.1.2
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d7364a5
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,379 @@
+This software is copyright (c) 2014- by Jakob Voß <jakob.voss@gbv.de>.
+
+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) 2014- by Jakob Voß <jakob.voss@gbv.de>.
+
+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) 2014- by Jakob Voß <jakob.voss@gbv.de>.
+
+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..f7fc562
--- /dev/null
+++ b/MANIFEST
@@ -0,0 +1,15 @@
+# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.035.
+Build.PL
+Changes
+LICENSE
+MANIFEST
+META.json
+META.yml
+README
+cpanfile
+dist.ini
+lib/Text/MarkdownTable.pm
+t/file.t
+t/release-pod-syntax.t
+t/simple.t
+t/synopsis.t
diff --git a/META.json b/META.json
new file mode 100644
index 0000000..d37013f
--- /dev/null
+++ b/META.json
@@ -0,0 +1,65 @@
+{
+ "abstract" : "Write Markdown syntax tables from data",
+ "author" : [
+ "Jakob Voß <jakob.voss@gbv.de>"
+ ],
+ "dynamic_config" : 0,
+ "generated_by" : "Dist::Zilla version 5.035, Dist::Milla version v1.0.8, CPAN::Meta::Converter version 2.150001",
+ "license" : [
+ "perl_5"
+ ],
+ "meta-spec" : {
+ "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
+ "version" : "2"
+ },
+ "name" : "Text-MarkdownTable",
+ "no_index" : {
+ "directory" : [
+ "t",
+ "xt",
+ "inc",
+ "share",
+ "eg",
+ "examples"
+ ]
+ },
+ "prereqs" : {
+ "configure" : {
+ "requires" : {
+ "Module::Build::Tiny" : "0.039"
+ }
+ },
+ "develop" : {
+ "requires" : {
+ "Dist::Milla" : "v1.0.8",
+ "Test::Pod" : "1.41"
+ }
+ },
+ "runtime" : {
+ "requires" : {
+ "IO::Handle::Util" : "0.01",
+ "Moo" : "1.000008",
+ "perl" : "v5.10.0"
+ }
+ }
+ },
+ "release_status" : "stable",
+ "resources" : {
+ "bugtracker" : {
+ "web" : "https://github.com/nichtich/Text-MarkdownTable/issues"
+ },
+ "homepage" : "https://github.com/nichtich/Text-MarkdownTable",
+ "repository" : {
+ "type" : "git",
+ "url" : "https://github.com/nichtich/Text-MarkdownTable.git",
+ "web" : "https://github.com/nichtich/Text-MarkdownTable"
+ }
+ },
+ "version" : "0.3.1",
+ "x_contributors" : [
+ "Jakob Voss <jakob@nichtich.de>",
+ "Jakob Voss <voss@gbv.de>",
+ "Patrick Hochstenbach <patrick.hochstenbach@ugent.be>"
+ ]
+}
+
diff --git a/META.yml b/META.yml
new file mode 100644
index 0000000..d2e288c
--- /dev/null
+++ b/META.yml
@@ -0,0 +1,35 @@
+---
+abstract: 'Write Markdown syntax tables from data'
+author:
+ - 'Jakob Voß <jakob.voss@gbv.de>'
+build_requires: {}
+configure_requires:
+ Module::Build::Tiny: '0.039'
+dynamic_config: 0
+generated_by: 'Dist::Zilla version 5.035, Dist::Milla version v1.0.8, CPAN::Meta::Converter version 2.150001'
+license: perl
+meta-spec:
+ url: http://module-build.sourceforge.net/META-spec-v1.4.html
+ version: '1.4'
+name: Text-MarkdownTable
+no_index:
+ directory:
+ - t
+ - xt
+ - inc
+ - share
+ - eg
+ - examples
+requires:
+ IO::Handle::Util: '0.01'
+ Moo: '1.000008'
+ perl: v5.10.0
+resources:
+ bugtracker: https://github.com/nichtich/Text-MarkdownTable/issues
+ homepage: https://github.com/nichtich/Text-MarkdownTable
+ repository: https://github.com/nichtich/Text-MarkdownTable.git
+version: 0.3.1
+x_contributors:
+ - 'Jakob Voss <jakob@nichtich.de>'
+ - 'Jakob Voss <voss@gbv.de>'
+ - 'Patrick Hochstenbach <patrick.hochstenbach@ugent.be>'
diff --git a/README b/README
new file mode 100644
index 0000000..561e349
--- /dev/null
+++ b/README
@@ -0,0 +1,102 @@
+NAME
+ Text::MarkdownTable - Write Markdown syntax tables from data
+
+SYNOPSIS
+ my $table = Text::MarkdownTable->new;
+ $table->add({one=>"a",two=>"table"});
+ $table->add({one=>"is",two=>"nice"});
+ $table->done;
+
+ | one | two |
+ |-----|-------|
+ | a | table |
+ | is | nice |
+
+ Text::MarkdownTable->new( columns => ['X','Y','Z'], edges => 0 )
+ ->add({a=>1,b=>2,c=>3})->done;
+
+ X | Y | Z
+ --|---|--
+ 1 | 2 | 3
+
+DESCRIPTION
+ This module can be used to write data in tabular form, formatted in
+ MultiMarkdown syntax. The resulting format can be used for instance to
+ display CSV data or to include data tables in Markdown files. Newlines
+ and vertical bars in table cells are replaced by a space character and
+ cell values can be truncated.
+
+CONFIGURATION
+ file
+ Filename, GLOB, scalar reference or IO::Handle to write to (default
+ STDOUT).
+
+ fields
+ Array, hash reference, or comma-separated list of fields/columns.
+
+ columns
+ Column names. By default field names are used.
+
+ widths
+ Column widths. By default column widths are calculated automatically
+ to the width of the widest value. With given widths, the table is
+ directly be written without buffering and large table cell values
+ are truncated.
+
+ header
+ Include header lines. Enabled by default.
+
+ edges
+ Include border before first column and after last column. Enabled by
+ default. Note that single-column tables don't not look like tables
+ if edges are disabled.
+
+ condense
+ Write table unbuffered in condense format:
+
+ one|two
+ ---|---
+ a|table
+ is|nice
+
+ Note that single-column tables are don't look like tables on
+ condense format.
+
+METHODS
+ add( $row )
+ Add a row as hash reference. Returns the table instance.
+
+ streaming
+ Returns whether rows are directly written or buffered until "done"
+ is called.
+
+ done
+ Finish and write the table unless it has already been written in
+ "streaming" mode.
+
+SEE ALSO
+ See Catmandu::Exporter::Table for an application of this module that can
+ be used to easily convert data to Markdown tables.
+
+ Similar table-generating modules include:
+
+ Text::Table::Tiny
+ Text::TabularDisplay
+ Text::SimpleTable
+ Text::Table
+ Text::ANSITable
+ Text::ASCIITable
+ Text::UnicodeBox::Table
+ Table::Simple
+ Text::SimpleTable
+ Text::SimpleTable::AutoWidth
+
+AUTHOR
+ Jakob Voß <jakob.voss@gbv.de>
+
+COPYRIGHT AND LICENSE
+ Copyright 2014- Jakob Voß
+
+ This library is free software; you can redistribute it and/or modify it
+ under the same terms as Perl itself.
+
diff --git a/cpanfile b/cpanfile
new file mode 100644
index 0000000..e730886
--- /dev/null
+++ b/cpanfile
@@ -0,0 +1,3 @@
+requires perl => '5.10.0';
+requires Moo => '1.000008';
+requires 'IO::Handle::Util' => '0.01';
diff --git a/dist.ini b/dist.ini
new file mode 100644
index 0000000..a4dbffa
--- /dev/null
+++ b/dist.ini
@@ -0,0 +1 @@
+[@Milla]
diff --git a/lib/Text/MarkdownTable.pm b/lib/Text/MarkdownTable.pm
new file mode 100644
index 0000000..821ff6e
--- /dev/null
+++ b/lib/Text/MarkdownTable.pm
@@ -0,0 +1,337 @@
+package Text::MarkdownTable;
+use strict;
+use warnings;
+use 5.010;
+
+our $VERSION = '0.3.1';
+
+use Moo;
+use IO::File;
+use IO::Handle::Util ();
+
+has file => (
+ is => 'ro',
+ lazy => 1,
+ default => sub { \*STDOUT },
+);
+
+has fh => (
+ is => 'ro',
+ lazy => 1,
+ default => sub {
+ my $fh = $_[0]->file;
+ $fh = ref $fh
+ ? IO::Handle::Util::io_from_ref($fh) : IO::File->new($fh,"w");
+ die "invalid option file" if !$fh;
+ binmode $fh, $_[0]->encoding;
+ $fh;
+ }
+);
+
+has encoding => (
+ is => 'ro',
+ default => sub { ':utf8' }
+);
+
+has fields => (
+ is => 'rw',
+ trigger => 1,
+);
+
+# TODO: ensure that number of columns is number of fields
+has columns => (
+ is => 'lazy',
+ coerce => \&_coerce_list,
+ builder => sub { $_[0]->fields }
+);
+
+has widths => (
+ is => 'lazy',
+ coerce => \&_coerce_list,
+ builder => sub {
+ $_[0]->_fixed_width(0);
+ return [map { defined($_) ? length $_ : 0 } @{$_[0]->columns}]
+ },
+);
+
+has header => (
+ is => 'rw',
+ default => sub { 1 }
+);
+
+has edges => (
+ is => 'rw',
+ default => sub { 1 },
+);
+
+has condense => (
+ is => 'rw',
+);
+
+has streaming => (is => 'rwp');
+
+has _fixed_width => (is => 'rw', default => sub { 1 });
+
+# TODO: duplicated in Catmandu::Exporter::CSV fields-coerce
+sub _coerce_list {
+ if (ref $_[0]) {
+ return $_[0] if ref $_[0] eq 'ARRAY';
+ return [sort keys %{$_[0]}] if ref $_[0] eq 'HASH';
+ }
+ return [split ',', $_[0]];
+}
+
+sub _trigger_fields {
+ my ($self, $fields) = @_;
+ $self->{fields} = _coerce_list($fields);
+ if (ref $fields and ref $fields eq 'HASH') {
+ $self->{columns} = [ map { $fields->{$_} // $_ } @{$self->{fields}} ];
+ }
+}
+
+sub add {
+ my ($self, $data) = @_;
+ unless ($self->fields) {
+ $self->{fields} = [ sort keys %$data ]
+ }
+ my $fields = $self->fields;
+ my $widths = $self->widths; # may set
+ my $row = [ ];
+
+ if (!$self->streaming and ($self->condense or $self->_fixed_width)) {
+ $self->_set_streaming(1);
+ $self->_print_header if $self->header;
+ }
+
+ foreach my $col (0..(@$fields-1)) {
+ my $field = $fields->[$col];
+ my $width = $widths->[$col];
+
+ my $value = $data->{$field} // "";
+ $value =~ s/[\n|]/ /g;
+
+ my $w = length $value;
+ if ($self->_fixed_width) {
+ if (!$width or $w > $width) {
+ if ($width > 5) {
+ $value = substr($value, 0, $width-3) . '...';
+ } else {
+ $value = substr($value, 0, $width);
+ }
+ }
+ } else {
+ $widths->[$col] = $w if !$width or $w > $width;
+ }
+ push @$row, $value;
+ }
+
+ $self->_add_row($row);
+ $self;
+}
+
+sub _add_row {
+ my ($self, $row) = @_;
+
+ if ($self->streaming) {
+ $self->_print_row($row);
+ } else {
+ push @{$self->{_rows}}, $row;
+ }
+}
+
+sub done {
+ my ($self) = @_;
+
+ if ($self->{_rows}) {
+ $self->_print_header if $self->header;
+ $self->_print_row($_) for @{$self->{_rows}};
+ }
+}
+
+sub _print_header {
+ my ($self) = @_;
+ my $fh = $self->fh;
+
+ $self->_print_row($self->columns);
+ if ($self->condense) {
+ $self->_print_row([ map { '-' x length $_ } @{$self->columns} ]);
+ } elsif ($self->edges) {
+ print $fh '|'.('-' x ($_+2)) for @{$self->widths};
+ print $fh "|\n";
+ } else {
+ print $fh substr(join('|',map { '-' x ($_+2) } @{$self->widths}),1,-1);
+ print $fh "\n";
+ }
+}
+
+has _row_format => (
+ is => 'lazy',
+ builder => sub {
+ if ( $_[0]->condense ) {
+ join("|",map {"%s"} @{$_[0]->fields})."\n"
+ } elsif ( $_[0]->edges ) {
+ join("",map {"| %-".$_."s "} @{$_[0]->widths})."|\n";
+ } else {
+ join(" | ",map {"%-".$_."s"} @{$_[0]->widths})."\n";
+ }
+ }
+);
+
+sub _print_row {
+ my ($self, $row) = @_;
+ printf {$self->fh} $self->_row_format, @{$row};
+}
+
+1;
+__END__
+
+=head1 NAME
+
+Text::MarkdownTable - Write Markdown syntax tables from data
+
+=begin markdown
+
+# STATUS
+
+[![Build Status](https://travis-ci.org/nichtich/Text-MarkdownTable.png)](https://travis-ci.org/nichtich/Text-MarkdownTable)
+[![Coverage Status](https://coveralls.io/repos/nichtich/Text-MarkdownTable/badge.png)](https://coveralls.io/r/nichtich/Text-MarkdownTable)
+[![Kwalitee Score](http://cpants.cpanauthors.org/dist/Text-MarkdownTable.png)](http://cpants.cpanauthors.org/dist/Text-MarkdownTable)
+
+=end markdown
+
+=head1 SYNOPSIS
+
+ my $table = Text::MarkdownTable->new;
+ $table->add({one=>"a",two=>"table"});
+ $table->add({one=>"is",two=>"nice"});
+ $table->done;
+
+ | one | two |
+ |-----|-------|
+ | a | table |
+ | is | nice |
+
+ Text::MarkdownTable->new( columns => ['X','Y','Z'], edges => 0 )
+ ->add({a=>1,b=>2,c=>3})->done;
+
+ X | Y | Z
+ --|---|--
+ 1 | 2 | 3
+
+=head1 DESCRIPTION
+
+This module can be used to write data in tabular form, formatted in
+MultiMarkdown syntax. The resulting format can be used for instance to display
+CSV data or to include data tables in Markdown files. Newlines and vertical
+bars in table cells are replaced by a space character and cell values can be
+truncated.
+
+=head1 CONFIGURATION
+
+=over
+
+=item file
+
+Filename, GLOB, scalar reference or L<IO::Handle> to write to (default STDOUT).
+
+=item fields
+
+Array, hash reference, or comma-separated list of fields/columns.
+
+=item columns
+
+Column names. By default field names are used.
+
+=item widths
+
+Column widths. By default column widths are calculated automatically to the
+width of the widest value. With given widths, the table is directly be written
+without buffering and large table cell values are truncated.
+
+=item header
+
+Include header lines. Enabled by default.
+
+=item edges
+
+Include border before first column and after last column. Enabled by default.
+Note that single-column tables don't not look like tables if edges are
+disabled.
+
+=item condense
+
+Write table unbuffered in condense format:
+
+ one|two
+ ---|---
+ a|table
+ is|nice
+
+Note that single-column tables are don't look like tables on condense format.
+
+=back
+
+=head1 METHODS
+
+=over
+
+=item add( $row )
+
+Add a row as hash reference. Returns the table instance.
+
+=item streaming
+
+Returns whether rows are directly written or buffered until C<done> is called.
+
+=item done
+
+Finish and write the table unless it has already been written in C<streaming>
+mode.
+
+=back
+
+=head1 SEE ALSO
+
+See L<Catmandu::Exporter::Table> for an application of this module that can be
+used to easily convert data to Markdown tables.
+
+Similar table-generating modules include:
+
+=over
+
+=item L<Text::Table::Tiny>
+
+=item L<Text::TabularDisplay>
+
+=item L<Text::SimpleTable>
+
+=item L<Text::Table>
+
+=item L<Text::ANSITable>
+
+=item L<Text::ASCIITable>
+
+=item L<Text::UnicodeBox::Table>
+
+=item L<Table::Simple>
+
+=item L<Text::SimpleTable>
+
+=item L<Text::SimpleTable::AutoWidth>
+
+=back
+
+=encoding utf8
+
+=head1 AUTHOR
+
+Jakob Voß E<lt>jakob.voss@gbv.deE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2014- Jakob Voß
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself.
+
+=cut
diff --git a/t/file.t b/t/file.t
new file mode 100644
index 0000000..236670c
--- /dev/null
+++ b/t/file.t
@@ -0,0 +1,18 @@
+use strict;
+use warnings;
+use Test::More;
+use Text::MarkdownTable;
+use IO::Handle;
+use File::Temp;
+
+my (undef, $file) = File::Temp::tempfile( OPEN => 0 );
+Text::MarkdownTable->new( file => $file, condense => 1 )->add({x=>1})->done;
+is do { local (@ARGV, $/) = ($file); <> }, "x\n-\n1\n", "write to file";
+
+my $tempdir = File::Temp::tempdir;
+foreach ('', '/', undef, Text::MarkdownTable->new, $tempdir) {
+ eval { Text::MarkdownTable->new( file => $_ )->add({x=>1})->done; };
+ ok $@, 'invalid file';
+}
+
+done_testing;
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();
diff --git a/t/simple.t b/t/simple.t
new file mode 100644
index 0000000..2eb36a5
--- /dev/null
+++ b/t/simple.t
@@ -0,0 +1,102 @@
+use strict;
+use warnings;
+use Test::More;
+
+BEGIN { use_ok 'Text::MarkdownTable'; }
+require_ok 'Text::MarkdownTable';
+
+sub is_table(@) {
+ my ($message, $expect,$data) = (pop,pop,shift);
+ my $out = "";
+ my $table = Text::MarkdownTable->new(@_, file => \$out);
+ $table->add($_) for @$data;
+ $table->done;
+ is $out, $expect, $message;
+}
+
+is_table [ ], columns => "foo,bar", '', "empty table";
+
+is_table [{a => 'moose', b => '1'},
+ {a => "p\nony", b => '2'},
+ {a => 'shr|mp', b => '3'}],
+<<TABLE, "MultiMarkdown format ok";
+| a | b |
+|--------|---|
+| moose | 1 |
+| p ony | 2 |
+| shr mp | 3 |
+TABLE
+
+is_table [{ a => 'Hello', b => 'World' }],
+ fields => { a => 'Longname', x => 'X', y => undef },
+<<TABLE, "custom column names as HASH";
+| Longname | X | y |
+|----------|---|---|
+| Hello | | |
+TABLE
+
+is_table [{ a => 'Hello', b => 'happy', c => 'World', d => '!' }],
+ columns => ['greet',undef,'greet',''],
+<<TABLE, "custom column names as ARRAY";
+| greet | | greet | |
+|-------|-------|-------|---|
+| Hello | happy | World | ! |
+TABLE
+
+is_table [{ aa => 'Hi', b => 'World', c => 'long value' }],
+ widths => '5,3,6',
+<<TABLE, "custom column width / truncation";
+| aa | b | c |
+|-------|-----|--------|
+| Hi | Wor | lon... |
+TABLE
+
+is_table [{ aa => 'Hi', b => 'World', c => 'long value' }],
+ widths => '5,3,6', condense => 1,
+<<TABLE, "condense with truncation";
+aa|b|c
+--|-|-
+Hi|Wor|lon...
+TABLE
+
+ok !Text::MarkdownTable->new->streaming, "no streaming by default";
+
+my $out = "";
+my $table = Text::MarkdownTable->new( condense => 1, file => \$out );
+$table->add({ foo => 1, bar => 1024 });
+ok $table->streaming, "streaming mode";
+is $out, <<TABLE, "streaming mode";
+bar|foo
+---|---
+1024|1
+TABLE
+
+$table->add({ doz => 7, bar => 0, doz => 'ignored' });
+is $out, <<TABLE, "streaming mode";
+bar|foo
+---|---
+1024|1
+0|
+TABLE
+
+is_table [{a => 7},{a => 8}],
+ header => 0,
+ "| 7 |\n| 8 |\n", "disable header";
+
+is_table [{a => 7, b=> 1},{a => 8}],
+ header => 0, condense => 1,
+ "7|1\n8|\n", "vbar delimited values";
+
+is_table([{foo => 1, bar => 2}], edges => 0, <<TABLE, "edges disabled");
+bar | foo
+----|----
+2 | 1
+TABLE
+
+is_table([{a => 1, b => 2, c => 3}], edges => 0, <<TABLE, "edges disabled");
+a | b | c
+--|---|--
+1 | 2 | 3
+TABLE
+
+done_testing;
diff --git a/t/synopsis.t b/t/synopsis.t
new file mode 100644
index 0000000..cc05889
--- /dev/null
+++ b/t/synopsis.t
@@ -0,0 +1,31 @@
+use strict;
+use warnings;
+use Test::More;
+use Text::MarkdownTable;
+
+my $out = '';
+my $table = Text::MarkdownTable->new( file => \$out );
+$table->add({one=>"a",two=>"table"});
+$table->add({one=>"is",two=>"nice"});
+$table->done;
+is $out, <<TABLE;
+| one | two |
+|-----|-------|
+| a | table |
+| is | nice |
+TABLE
+
+$out = '';
+Text::MarkdownTable->new(
+ columns => ['X','Y','Z'],
+ edges => 0,
+ file => \$out,
+)->add({a=>1,b=>2,c=>3})->done;
+
+is $out, <<TABLE;
+X | Y | Z
+--|---|--
+1 | 2 | 3
+TABLE
+
+done_testing;