Skip to content

Configurable newline character (take 2) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
perlancar wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Configurable newline character (take 2) #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e1341b8
Configurable newline character
sharyanto Feb 8, 2012
40b83c6
Remove mention of setting $NL to other than '' and "\n" [suggested by…
sharyanto Feb 14, 2012
019477e
Add document that setting $NL to '' will cause comment to not show up…
sharyanto Feb 14, 2012
2c8e575
Use Test in test script NL.t
sharyanto Feb 29, 2012
f8cd683
Add test: comment is removed when $NL set to ''
sharyanto Feb 29, 2012
d5dc700
Remove comment in tied dump when $NL is ''
sharyanto Feb 29, 2012
0ad4395
Update documentation in regard to setting $NL dan $INDENT
sharyanto Feb 29, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 24 additions & 14 deletions lib/Data/Dump.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ $VERSION = "1.21";
$DEBUG = 0;

use overload ();
use vars qw(%seen %refcnt @dump @fixup %require $TRY_BASE64 @FILTERS $INDENT);
use vars qw(%seen %refcnt @dump @fixup %require $TRY_BASE64 $NL @FILTERS $INDENT);

$TRY_BASE64 = 50 unless defined $TRY_BASE64;
$INDENT = " " unless defined $INDENT;
$NL = "\n" unless defined $NL;

sub dump
{
Expand All @@ -40,20 +41,20 @@ sub dump
my $out = "";
if (%require) {
for (sort keys %require) {
$out .= "require $_;\n";
$out .= "require $_;$NL";
}
}
if (%refcnt) {
# output all those with refcounts first
for (@dump) {
my $name = $_->[0];
if ($refcnt{$name}) {
$out .= "my \$$name = $_->[1];\n";
$out .= "my \$$name = $_->[1];$NL";
undef $_->[1];
}
}
for (@fixup) {
$out .= "$_;\n";
$out .= "$_;$NL";
}
}

Expand All @@ -66,28 +67,28 @@ sub dump
$out .= ")" if $paren;

if (%refcnt || %require) {
$out .= ";\n";
$out .= ";$NL";
$out =~ s/^/$INDENT/gm;
$out = "do {\n$out}";
$out = "do {$NL$out}";
}

#use Data::Dumper; print Dumper(\%refcnt);
#use Data::Dumper; print Dumper(\%seen);

print STDERR "$out\n" unless defined wantarray;
print STDERR "$out$NL" unless defined wantarray;
$out;
}

*pp = \&dump;

sub dd {
print dump(@_), "\n";
print dump(@_), $NL;
}

sub ddx {
my(undef, $file, $line) = caller;
$file =~ s,.*[\\/],,;
my $out = "$file:$line: " . dump(@_) . "\n";
my $out = "$file:$line: " . dump(@_) . $NL;
$out =~ s/^/# /gm;
print $out;
}
Expand Down Expand Up @@ -330,7 +331,7 @@ sub _dump
my $klen_pad = 0;
my $tmp = "@keys @vals";
if (length($tmp) > 60 || $tmp =~ /\n/ || $tied) {
$nl = "\n";
$nl = $NL;

# Determine what padding to add
if ($kstat_max < 4) {
Expand All @@ -354,7 +355,7 @@ sub _dump
}
}
$out = "{$nl";
$out .= "$INDENT# $tied$nl" if $tied;
$out .= "$INDENT# $tied$nl" if $tied && $NL =~ /\n/;
while (@keys) {
my $key = shift @keys;
my $val = shift @vals;
Expand All @@ -381,7 +382,7 @@ sub _dump
if ($class && $ref) {
$out = "bless($out, " . quote($class) . ")";
}
if ($comment) {
if ($comment && $NL =~ /\n/) {
$comment =~ s/^/# /gm;
$comment .= "\n" unless $comment =~ /\n\z/;
$comment =~ s/^#[ \t]+\n/\n/;
Expand Down Expand Up @@ -472,8 +473,8 @@ sub format_list
if ($comment || (@_ > $indent_lim && (length($tmp) > 60 || $tmp =~ /\n/))) {
my @elem = @_;
for (@elem) { s/^/$INDENT/gm; }
return "\n" . ($comment ? "$INDENT# $comment\n" : "") .
join(",\n", @elem, "");
return $NL . ($comment && $NL =~ /\n/ ? "$INDENT# $comment\n" : "") .
join(",$NL", @elem, "");
} else {
return join(", ", @_);
}
Expand Down Expand Up @@ -676,6 +677,15 @@ be valid Perl.
How long must a binary string be before we try to use the base64 encoding
for the dump output. The default is 50. Set it to 0 to disable base64 dumps.

=item $Data::Dump::NL

Newline character. Defaults to "\n" but can be set to " " (a single space) for
single-line dumps. Removing newline from this variable will also cause comments
to not show up.

If you want to generate nicer single-line dumps, also set $Data::Dump::INDENT to
"".

=back


Expand Down
31 changes: 31 additions & 0 deletions t/NL.t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
use strict;
use Test;

BEGIN { plan tests => 4 }

use Data::Dump qw(dump);
use Data::Dump::Filtered qw(dump_filtered);

# basic

my $a = {
a => "123456789012345678901234567890",
bb => "123456789012345678901234567890",
};
ok(dump($a), qq|{\n a => "123456789012345678901234567890",\n bb => "123456789012345678901234567890",\n}|);
{
local $Data::Dump::NL = "";
ok(dump($a), qq|{ a => "123456789012345678901234567890", bb => "123456789012345678901234567890" }|);
}

# comment

my $filter = sub {
my ($ctx, $oref) = @_;
return { comment=>"comment" };
};
ok(dump_filtered($a, $filter), qq|# comment\n{\n a => # comment\n "123456789012345678901234567890",\n bb => # comment\n "123456789012345678901234567890",\n}|);
{
local $Data::Dump::NL = "";
ok(dump_filtered($a, $filter), qq|{ a => "123456789012345678901234567890", bb => "123456789012345678901234567890" }|);
}
12 changes: 11 additions & 1 deletion t/tied.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use strict;
use Test qw(plan ok);
use Data::Dump qw(dump);

plan tests => 4;
plan tests => 6;

{
package MyTie;
Expand Down Expand Up @@ -54,13 +54,23 @@ ok(nl(dump(\%hash)), <<EOT);
d => "vd",
}
EOT
{
local $Data::Dump::NL = " ";
local $Data::Dump::INDENT = "";
ok(dump(\%hash), q|{ a => "va", b => "vb", c => "vc", d => "vd", }|);
}

ok(nl(dump(\@array)), <<EOT);
[
# tied MyTie
"v0" .. "v3",
]
EOT
{
local $Data::Dump::NL = " ";
local $Data::Dump::INDENT = "";
ok(dump(\@array), q|[ "v0" .. "v3", ]|);
}

ok(nl(dump($scalar)), <<EOT);
"v"
Expand Down