File Coverage

blib/lib/Pod/Simple/Wiki/Muse.pm

Criterion	Covered	Total	%
statement	48	48	100.0
branch	13	14	92.8
condition			n/a
subroutine	11	11	100.0
pod	1	1	100.0
total	73	74	98.6

package Pod::Simple::Wiki::Muse;

###############################################################################
#
# Pod::Simple::Wiki::Muse - A class for creating Pod to Muse filters.
#
#
# Copyright 2015, Marco Pessotto [e-mail]
#
# Documentation after __END__
#

# perltidy with the following options: -mbl=2 -pt=0 -nola

use Pod::Simple::Wiki;
use strict;
use warnings;
use vars qw(@ISA $VERSION);


@ISA     = qw(Pod::Simple::Wiki);
$VERSION = '0.20';

###############################################################################
#
# The tag to wiki mappings.
#
my $tags = {
    ''    => '**',
    ''   => '**',
    ''    => '*',
    ''   => '*',
    ''   => '',
    ''  => '',
    ''  => "\n\n",
    '' => "\n\n",

    ''  => "** ",
    '' => "\n\n",
    ''  => "*** ",
    '' => "\n\n",
    ''  => "**** ",
    '' => "\n\n",
    ''  => "***** ",
    '' => "\n\n",
};

###############################################################################
#
# new()
#
# Simple constructor inheriting from Pod::Simple::Wiki.
#
sub new {

    my $class = shift;
    my $self = Pod::Simple::Wiki->new( 'wiki', @_ );
    $self->{_tags} = $tags;

    bless $self, $class;
    return $self;
}

###############################################################################
#
# _indent_item()
#
# Indents an "over-item" to the correct level.
#
sub _indent_item {
    my ($self, $item_type, $param) = @_;
    # print "Indent level is $self->{_item_indent}\n";
    my $indent_level = $self->{_item_indent} - 1;
    if ( $item_type eq 'bullet' ) {
        $self->_append( "\n" . '  ' x $indent_level . ' - ' );
    }
    elsif ( $item_type eq 'number' ) {
        $self->_append( "\n" . '  ' x $indent_level . ' 1. ' );
    }
    elsif ( $item_type eq 'text' ) {
        $self->_append( "\n" . '  ' x $indent_level . '  ' );
    }
}


###############################################################################
#
# _handle_text()
#
# Perform any necessary transforms on the text. This is mainly used to escape
# inadvertent CamelCase words.
#
sub _handle_text {

    my $self = shift;
    my $text = $_[0];

    # Only escape words in paragraphs
    if ( not $self->{_in_Para} ) {
        $self->{_wiki_text} .= $text;
        return;
    }

    # Split the text into tokens but maintain the whitespace
    my @tokens = split /(\s+)/, $text;

    # Portme:
    # Escape any tokens here, if necessary.

    # Rejoin the tokens and whitespace.
    $self->{_wiki_text} .= join '', @tokens;
}


###############################################################################
#
# Functions to deal with =over ... =back regions for
#
# Bulleted lists
# Numbered lists
# Text     lists
# Block    lists
#
sub _end_item_text {
    my $self         = shift;
    my $indent_level = $self->{_item_indent} - 1;
    $self->_output( " :: ");
}



###############################################################################
#
# _start_Para()
#
# Special handling for paragraphs that are part of an "over" block.
#
sub _start_Para {

    my $self         = shift;
    my $indent_level = $self->{_item_indent} - 1;
    if ( $self->{_in_over_block} ) {
        $self->_append( "\n" . '  ' x $indent_level . '  ' );
    }
}

sub _start_L {
    my ($self, $link_attrs) = @_;
    # print Dumper($link_attrs);
    # reset the buffer
    $self->_output('');
    $self->{_link_attr} = $link_attrs;
    my $link_target  = $link_attrs->{to};
    my $link_section = $link_attrs->{section};
    $link_target = '' if( !defined($link_target));

    # Handle links that are parsed as Pod links.
    if ( defined $link_section ) {
        $link_target = "$link_target#$link_section";
    }
    $self->_append( "[[$link_target][" );
}

sub _end_L {
    my $self         = shift;
    $self->_output(']]');
}

1;


__END__