Text::Haml - Haml Perl implementation

    use Text::Haml;

    my $haml = Text::Haml->new;

    my $html = $haml->render('%p foo'); # <p>foo</p>

    $html = $haml->render('= user', user => 'friend'); # <div>friend</div>

Text::Haml implements Haml http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html specification.

Text::Haml passes specification tests written by Norman Clarke http://github.com/norman/haml-spec and supports only cross-language Haml features. Do not expect Ruby specific things to work.

Text::Haml implements the following attributes:

Holds the string of code that is appended to the generated Perl code.

Holds the Perl code.

Holds compiled code.

    $haml->encoding('utf-8');

Default is utf-8.

Escape subroutine presented as string.

Default is

    $haml->escape(<<'EOF');
        my $s = shift;
        $s =~ s/&/&amp;/g;
        $s =~ s/</&lt;/g;
        $s =~ s/>/&gt;/g;
        $s =~ s/"/&quot;/g;
        $s =~ s/'/&apos;/g;
        return $s;
    EOF

    $haml->escape_html(0);

Switch on/off Haml output html escaping. Default is on.

Holds filters.

    $haml->format('xhtml');

Supported formats: xhtml, html, html5.

Default is xhtml.

Holds the namespace under which the Perl package is generated.

Holds the string of code that is prepended to the generated Perl code.

Holds the variables that are passed during the rendering.

When options is NOT SET (by default) passed variables are normal Perl variables and are used with $ prefix.

    $haml->render('%p $var', var => 'hello');

When this option is SET passed variables are Perl lvalue subroutines and are used without $ prefix.

    $haml->render('%p var', var => 'hello');

But if you declare Perl variable in a block, it must be used with $ prefix.

    $haml->render('<<EOF')
        - my $foo;
        %p= $foo
    EOF

    helpers => {
        foo => sub {
            my $self   = shift;
            my $string = shift;

            $string =~ s/r/z/;

            return $string;
        }
    }

Holds helpers subroutines. Helpers can be called in Haml text as normal Perl functions. See also add_helper.

    $haml->helpers_args($my_context);

First argument passed to the helper (Text::Haml instance by default).

    $haml->error;

Holds the last error.

Holds parsed haml elements.

    my $haml = Text::Haml->new;

    $haml->add_helper(current_time => sub { time });

Adds a new helper.

    $haml->add_filter(compress => sub { $_[0] =~ s/\s+/ /g; $_[0]});

Adds a new filter.

    $haml->build(@_);

Builds the Perl code.

    $haml->compile;

Compiles parsed code.

    $haml->interpret(@_);

Interprets compiled code.

    $haml->parse('%p foo');

Parses Haml string building a tree.

    my $text = $haml->render('%p foo');

    my $text = $haml->render('%p var', var => 'hello');

Renders Haml string. Returns undef on error. See error attribute.

    my $text = $haml->render_file('foo.haml');

A helper method that loads a file and passes it to the render method.

Despite of existing string interpolation in Perl, Ruby interpolation is also supported.

$haml->render('%p Hello #{user}', user => 'foo')

When declaring tag attributes : symbol can be used.

$haml->render("%a{:href => 'bar'}");

Perl-style is supported but not recommented, since your Haml template won't work with Ruby Haml implementation parser.

$haml->render("%a{href => 'bar'}");

    http://github.com/vti/text-haml

Viacheslav Tykhanovskyi, vti@cpan.org.

In alphabetical order:

Nick Ragouzis

Norman Clarke

Copyright (C) 2009-2010, Viacheslav Tykhanovskyi.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.