File Coverage

lib/Templer/Plugin/Textile.pm

Criterion	Covered	Total	%
statement	23	25	92.0
branch	2	4	50.0
condition	1	3	33.3
subroutine	7	7	100.0
pod	3	3	100.0
total	36	42	85.7

=head1 NAME

Templer::Plugin::Textile - A simple textile-formatting plugin.

=cut

=head1 DESCRIPTION

This class implements a formatter plugin for C<templer> which allows
pages to be written using textile.

This allows input such as this to be executed:

=for example begin

    Title: This is my page
    format: textile
    ----
    **Bold**
    _italic_
    Content!

=for example end

=cut

=head1 LICENSE

This module is free software; you can redistribute it and/or modify it
under the terms of either:

a) the GNU General Public License as published by the Free Software
Foundation; either version 2, or (at your option) any later version,
or

b) the Perl "Artistic License".

=cut

=head1 AUTHOR

Steve Kemp <[e-mail]>

=cut

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2012-2015 Steve Kemp <[e-mail]>.

This library is free software. You can modify and or distribute it under
the same terms as Perl itself.

=cut

=head1 METHODS

=cut


use strict;
use warnings;


package Templer::Plugin::Textile;


=head2 new

Constructor.  No arguments are supported/expected.

=cut


sub new
{
    my ( $proto, %supplied ) = (@_);
    my $class = ref($proto) || $proto;

    my $self = {};
    bless( $self, $class );
    return $self;
}


=head2 available

This plugin is available if we've got the L<Text::Textile> module.

=cut

sub available
{
    my $str = "use Text::Textile;";

    ## no critic (Eval)
    eval($str);
    ## use critic

    return ( $@ ? undef : 1 );
}


=head2 format

Format the given text.

=cut

sub format
{
    my ( $self, $str, $data ) = (@_);

    if ( $self->available() )
    {
        Text::Textile::textile($str);
    }
    else
    {
        warn
          "Textile formatting disabled as the Text::Textile module isn't present.\n";

        $str;
    }
}

Templer::Plugin::Factory->new()
  ->register_formatter( "textile", "Templer::Plugin::Textile" );