NAME

MojoX::CustomTemplateFileParser - Parses a custom Mojo template file format

 

SYNOPSIS

  use MojoX::CustomTemplateFileParser;

  my $content = MojoX::CustomTemplateFileParser->new(path => '/path/to/file.mojo')->parse->flatten;

  print $content;

STATUS

Unstable.

DESCRIPTION

MojoX::CustomTemplateFileParser parses files containing Mojo::Templates mixed with the expected rendering.

The parsing creates a data structure that also can be dumped into a string ready to be put in a Test::More file.

Its purpose is to facilitate development of tag helpers.

Options

path

The only argument given to the constructor is the path to the file that should be parsed.

Methods

$self->parse

Parses the file given in path. After parsing the structure is available in $self->structure.

$self->flatten

Returns a string that is suitable to put in a Test::More test file.

Example

Given a file (metacpan-1.mojo) that looks like this:

    # Code here

    ==test==
    --t--
        %= link_to 'MetaCPAN', 'http://www.metacpan.org/'
    --t--
    --e--
        <a href="http://www.metacpan.org/">MetaCPAN</a>
    --e--

    ==test loop(first name)==
    --t--
        %= text_field username => placeholder => '[var]'
    --t--
    --e--
        <input name="username" placeholder="[var]" type="text" />
    --e--

    ==no test==
    --t--
        %= text_field username => placeholder => 'Not tested'
    --t--
    --e--
        <input name="username" placeholder="Not tested" type="text" />
    --e--

    ==test==
    --t--

    --t--

    --e--

    --e--

loop(first name) on the second test means there is one test generated where [var] is replaced with first and one where it is replaced with name.

no test on the third test means it is skipped.

$self->parse

No arguments.

Running $self->parse will fill $self->structure with:

    {
        head_lines => ['', '# Code here', '', '' ],
        tests => [
            {
                is_example => 1,
                lines_after => ['', ''],
                lines_before => [''],
                lines_between => [''],
                lines_expected => [ '    <a href="http://www.metacpan.org/">MetaCPAN</a>' ],
                lines_template => [ "    %= link_to 'MetaCPAN', 'http://www.metacpan.org/'" ],
                loop => [],
                loop_variable => undef,
                test_name => 'test_1_1',
                test_number => 1,
                test_start_line => 4,
            },
            {
                is_example => 0,
                lines_after => ['', ''],
                lines_before => [''],
                lines_between => [''],
                lines_expected => [ '    <input name="username" placeholder="first" type="text" />' ],
                lines_template => [ "    %= text_field username => placeholder => 'first'" ],
                loop => [ 'first', 'name' ],
                loop_variable => 'first',
                test_name => 'test_1_2_first',
                test_number => 2,
                test_start_line => 12,
            },
            {
                is_example => 0,
                lines_after => ['', ''],
                lines_before => [''],
                lines_between => [''],
                lines_expected => [ '    <input name="username" placeholder="name" type="text" />' ],
                lines_template => [ "    %= text_field username => placeholder => 'name'" ],
                loop => [ 'first', 'name' ],
                loop_variable => 'name',
                test_name => 'test_1_2_name',
                test_number => 2,
                test_start_line => 12,
            }
        ]
    }

$self->flatten()

No arguments.

And $self->flatten returns:

    # Code here

    #** test from test-1.mojo, line 4

    my $expected_test_1_1 = qq{     <a href="http://www.metacpan.org/">MetaCPAN</a> };

    get '/test_1_1' => 'test_1_1';

    $test->get_ok('/test_1_1')->status_is(200)->trimmed_content_is($expected_test_1_1, 'Matched trimmed content in test-1.mojo, line 4');

    #** test from test-1.mojo, line 12, loop: first

    my $expected_test_1_2 = qq{     <input name="username" placeholder="first" type="text" /> };

    get '/test_1_2' => 'test_1_2';

    $test->get_ok('/test_1_2')->status_is(200)->trimmed_content_is($expected_test_1_2, 'Matched trimmed content in test-1.mojo, line 12, loop: first');

    #** test from test-1.mojo, line 12, loop: name

    my $expected_test_1_2 = qq{     <input name="username" placeholder="name" type="text" /> };

    get '/test_1_2' => 'test_1_2';

    $test->get_ok('/test_1_2')->status_is(200)->trimmed_content_is($expected_test_1_2, 'Matched trimmed content in test-1.mojo, line 12, loop: name');

    done_testing();

    __DATA__

    @@ test_1_1.html.ep

        %= link_to 'MetaCPAN', 'http://www.metacpan.org/'

    @@ test_1_2.html.ep

        %= text_field username => placeholder => 'first'

    @@ test_1_2.html.ep

        %= text_field username => placeholder => 'name'

The easiest way to put this to use is with Dist::Zilla::Plugin::Test::CreateFromMojoTemplates.

$self->exemplify($testnumber, $only_if_example)

$self->exemplify(1) returns:

    %= link_to 'MetaCPAN', 'http://www.metacpan.org/'

    <a href="http://www.metacpan.org/">MetaCPAN</a>

The second argument is a boolean that only exemplify the test if it is marked as an example in the source file, by using ==test example==.

The easiest way to put exemplify to use is with Dist::Zilla::Plugin::InsertExample::FromMojoTemplates.

$self->htmlify()

This method returns all tests in the source file in a string ready to be put into an html file that can be used as an example file. It is currently hardcoded to use a Bootstrap format.

AUTHOR

Erik Carlsson <info@code301.com>

COPYRIGHT

Copyright 2014- Erik Carlsson

LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

cpanm MojoX::CustomTemplateFileParser

perl -MCPAN -e shell
install MojoX::CustomTemplateFileParser