File Coverage

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

Criterion	Covered	Total	%
statement	51	51	100.0
branch	13	14	92.8
condition			n/a
subroutine	10	10	100.0
pod	1	1	100.0
total	75	76	98.6

package Pod::Simple::Wiki::Markdown;

###############################################################################
#
# Pod::Simple::Wiki::Markdown - A class for creating Pod to Markdown filters.
#
#
# Copyright 2003-2014, John McNamara, [e-mail], Daniel T. Staal,
# [e-mail]
#
# Documentation after __END__
#

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

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


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

###############################################################################
#
# 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         = shift;
    my $item_type    = $_[0];
    my $item_param   = $_[1];
    my $indent_level = $self->{_item_indent} - 1;

    if ( $item_type eq 'bullet' ) {
        $self->_append( '    ' x $indent_level . '* ' );
    }
    elsif ( $item_type eq 'number' ) {
        $self->_append( '    ' x $indent_level . '1 ' );
    }

# In theory Markdown supports nested definition lists - but *everything* has to be indented.
    elsif ( $item_type eq 'text' ) {
        $self->_append( '    ' x $indent_level . '' );
    }
}

###############################################################################
#
# _start_L()
#
# Handle the start of a link element.
#
sub _start_L {

    my $self       = shift;
    my $link_attrs = shift;

    $self->{_link_attrs} = $link_attrs;

    # Ouput start of Confluence link and flush the _wiki_text buffer.
    $self->_output( '[' );
}


###############################################################################
#
# _end_L()
#
# Handle the end of a link element.
#
sub _end_L {

    my $self         = shift;
    my $link_attrs   = $self->{_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)" );
}

###############################################################################
#
# _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;

    # Escape any tokens here, if necessary.
    # The following characters are escaped by prepending a backslash: \`*_
    # (Markdown has other escapes as well, but these cover most cases, and the others
    # are usually optional.)
    @tokens = map { s/([\\`\*\_])/\\$1/g; $_ } @tokens;

    # 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( "\n" . '    ' x $indent_level . ':   ' );
}


###############################################################################
#
# _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( '    ' x $indent_level . '' );
    }
}


1;


__END__