File Coverage

blib/lib/Template/LiquidX/Tidy.pm

Criterion	Covered	Total	%
statement	64	125	51.2
branch	2	38	5.2
condition	0	5	0.0
subroutine	18	22	81.8
pod	1	4	25.0
total	85	194	43.8

package Template::LiquidX::Tidy;

use strict;
use warnings;
use experimental 'signatures';

our $VERSION = '0.01';

use Template::LiquidX::Tidy::Liquid::Utility;
use Template::Liquid;
use Template::Liquid::Document;
use Template::Liquid::Tag::If;
use Template::Liquid::Tag::Case;

use Exporter 'import';
our @EXPORT_OK = qw(transform_back);

our %defaults = (
    indent	  => 4,
    force_nl	  => 0,
    force_nl_tags => 'for endfor '
    .'comment endcomment '
    .'if unless elsif else endif endunless '
#    .'capture '
    .'case when endcase',
    short_if      => 8,
    html	  => 1,
   );

our $_patched;
sub _patch_liquid_store_block_markup {
    return if $_patched++;
    no warnings 'redefine';

    my $_if_push_block = \&Template::Liquid::Tag::If::push_block;
    *Template::Liquid::Tag::If::push_block = sub {
	my $self = shift;
	my ($vars) = @_;
	my $block = $_if_push_block->($self, $vars);
	$block->{markup} = $vars->{markup};
	$block
    };

    my $_case_push_block = \&Template::Liquid::Tag::Case::push_block;
    *Template::Liquid::Tag::Case::push_block = sub {
	my $self = shift;
	my ($vars) = @_;
	my $block = $_case_push_block->($self, $vars);
	$block->{markup} = $vars->{markup};
	$block
    };

    return;
}

BEGIN {
    _patch_liquid_store_block_markup();
}

package Template::Liquid::Document {
    use strict;
    use warnings;
    use experimental 'signatures';

    use Template::LiquidX::Tidy::impl qw(_tidy_list _tidy_make_string);

    sub dump ($self) {
	my $return = '';
	$return .= $self->{markup} if defined $self->{markup};
	for my $node (@{$self->{nodelist}},
		      @{$self->{blocks}}) {
	    my $rendering = ref $node ? $node->dump() : $node;
	    $return .= $rendering if defined $rendering;
	}
	$return .= $self->{markup_2} if defined $self->{markup_2};
	$return
    }

    sub tidy ($self, $args = {}, $level = 0, $clevel = 0, $list = undef) {
	my @list = _tidy_list($self, $args, $level, $clevel);
	if ($list) {
	    @list
	} else {
	    _tidy_make_string($self, $args, @list)
	}
    }

    sub transform ($self, $args = {}, $trans_map = {}, $is_block = undef) {
	my $return = '';
	$trans_map->{__i} ||= 1;
	my $i = $trans_map->{__i}++;
	$trans_map->{ $i } = $self;

	if (defined $self->{markup}) {
	    my $ent = '&#' . (1_040_000 + $i) . ';';
	    if ($self->{markup} =~ /^\s*\{\{/) {
		$return .= $ent;
	    }
	    elsif ($self->{blocks}) {
		$return .= '';
	    }
	    else {
		$return .= '';
	    }
	}

	if ($self->{nodelist}) {
	    for my $node ($self->{nodelist}->@*) {
		my $rendering;
		if (ref $node) {
		    ($rendering) = $node->transform($args, $trans_map);
		}
		else {
		    $rendering = $node;
		}

		$return .= $rendering if defined $rendering;
	    }
	}

	if ($self->{blocks}) {
	    for my $block ($self->{blocks}->@*) {
		my $rendering;
		if (ref $block) {
		    ($rendering) = $block->transform($args, $trans_map, 1);
		}
		else {
		    $rendering = $block;
		}

		$return .= $rendering if defined $rendering;
	    }
	}

	if (defined $self->{markup_2}) {
	    my $ent = '&#' . (1_041_000 + $i) . ';';
	    if ($self->{markup} =~ /^\s*\{\{/) {
		$return .= $ent;
	    }
	    elsif (defined $self->{markup} && $self->{blocks}) {
		$return .= '';
	    }
	    else {
		$return .= '';
	    }
	}

	($return, $trans_map)
    }
};


sub transform_back ($trans, $map) {
    $trans =~ s{
		   (?: (?  [01])(? [0-9]{3});"> )
		     | (?  0)(? [0-9]{3});">)
		     | (?  )
		     | (? &\#104(? [01])(? [0-9]{3}); )
		   )
	   }{
	       $map->{ $+{id} + 0 }{ $+{content_part} ? 'markup_2' : 'markup' }
	   }grex;
}

1;

=head1 NAME

Template::LiquidX::Tidy - Indentation for Liquid template documents

=head1 SYNOPSIS

    use Template::LiquidX::Tidy;
    use Template::Liquid;
    use Template::LiquidX::Tag::...; # any additional tag modules you need

    my $parsed      = Template::Liquid->parse($template_string);
    my $tidy_string = $parsed->{document}->tidy(\%options);

=head1 DESCRIPTION

The LiquidX::Tidy module enhances a parsed Template::Liquid::Document
with a method to indent the document source code according to some
options.

You can also use the command line client L to indent your
template source codes.

=head1 METHODS

=head2 Template::Liquid::Document::tidy(%options)

This method is to be called on a L, i.e. some
node in the document created by Cparse>.

It returns a string of the formatted and indented document node.

Th following options are possible:

=over 4

=item B =E boolean

Indent HTML code. Defaults to on.

=item B =E number

The number of spaces for each indentation level. Default 4.

=item B =E boolean

Whether to forcibly add line breaks into tags listed as
force_nl_tags.

Default no for the module, yes for the command line client.

=item B =E number

The length of a text inbetween C<{% if %}> that should be exempt from force_nl

=item B =E 'for endfor ...'

A space separated list of tags where C will add line breaks.

Default tags: for endfor comment endcomment if unless elsif else endif
endunless case when endcase

=back

=head2 Template::Liquid::Document::dump()

This method is to be called on a L, i.e. some
node in the document created by Cparse>.

It returns a copy of the source document.

=head2 Template::Liquid::Document::transform()

    my ($transformed_document, $replacement_map) = $document->transform();
    my $new_document = Template::LiquidX::Tidy::transform_back(
        $transformed_document, $replacement_map);

This method is to be called on a L, i.e. some
node in the document created by Cparse>.

It returns a tuple with the source document where all Liquid tags have
been replaced by HTML entities and blank CdivE> and
CiE> tags. This HTML document can the be further processed
before using the C method to put back the Liquid tags.

=head2 Template::LiquidX::Tidy::transform_back($transformed_document, $replacement_map)

This method returns a new template string undoing a transform
operation.

=cut