File Coverage

blib/lib/Pod/Confluence.pm

Criterion	Covered	Total	%
statement	134	148	90.5
branch	28	32	87.5
condition	6	7	85.7
subroutine	38	42	90.4
pod	1	31	3.2
total	207	260	79.6

use strict;
use warnings;

package Pod::Confluence;
$Pod::Confluence::VERSION = '1.01';
# ABSTRACT: Converts pod to confluence flavored markdown
# PODNAME: Pod::Confluence

use parent qw(Pod::Simple::Methody);

use HTML::Entities;
use Log::Any;

my $logger = Log::Any->get_logger();

sub new {
    return shift->Pod::Simple::Methody::new()->_init(@_);
}

sub _confluence_macro_end {
    my ( $self, %options ) = @_;

    my @optional_elements = ( ( $options{has_text} ? ']]>' : () ), );

    return join( '', @optional_elements, '' );
}

sub _confluence_macro_start {
    my ( $self, $name, %options ) = @_;
    my $parameters = $options{parameters} || {};

    my @optional_elements = (
        (   map {"$parameters->{$_}"}
                keys(%$parameters)
        ),
        ( $options{has_text} ? '
    );

    return join( '',
        "
        ( $options{self_close} ? ' /' : '' ), ">", @optional_elements );
}

sub end_B {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub end_C {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub end_F {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub end_head1 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    pop( @{ $self->{element_stack} } );
}

sub end_head2 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    pop( @{ $self->{element_stack} } );
}

sub end_head3 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    pop( @{ $self->{element_stack} } );
}

sub end_head4 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    pop( @{ $self->{element_stack} } );
}

sub end_I {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub end_item_text {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    $self->end_Para();
}

sub end_L {
    my ( $self, $attribute_hash ) = @_;
    if ( $self->{link_type} eq 'pod' ) {
        $self->{in_cdata} = 0;
        $self->_print( ']]>' . '' );
    }
    elsif ( $self->{link_type} eq 'url' ) {
        $self->_print('');
    }
    delete( $self->{link_type} );
}

sub end_over_text {
    my ( $self, $attribute_hash ) = @_;
    $self->{indent} -= 2;
}

sub end_Para {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    pop( @{ $self->{element_stack} } );
}

sub end_S {
    my ( $self, $attribute_hash ) = @_;
    $self->{in_non_breaking} = 0;
}

sub end_Verbatim {
    my ( $self, $attribute_hash ) = @_;
    $self->{in_cdata} = 0;
    $self->_print( $self->_confluence_macro_end( has_text => 1 ) );
    pop( @{ $self->{element_stack} } );
}

sub _handle_element_end {
    $logger->tracef( '_handle_element_end(%s,%s)', $_[1], $_[2] );
    Pod::Simple::Methody::_handle_element_end(@_);
}

sub _handle_element_start {
    $logger->tracef( '_handle_element_start(%s,%s)', $_[1], $_[2] );
    Pod::Simple::Methody::_handle_element_start(@_);
}

sub handle_text {
    my ( $self, $text ) = @_;

    $text = encode_entities($text) unless ( $self->{in_cdata} );
    $text =~ s/[ \t]/ /g if ( $self->{in_non_breaking} );

    $logger->tracef( 'handle_text(%s)', $text );
    $self->_print($text);
}

sub _init {
    my ( $self, %options ) = @_;

    $self->{space_key} = $options{space_key};
    $self->{packages_in_space} =
        { map { $_ => 1 } @{ $options{packages_in_space} } };
    $self->{confluence_schema_version} = $options{confluence_schema_version} || 1;

    $self->{element_stack} = [];
    $self->{indent}        = 0;

    return $self;
}

sub _print {
    my ( $self, $text ) = @_;
    print( { $self->{output_fh} } $text );
}

sub start_B {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub start_C {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub start_F {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub start_Document {
    my ( $self, $attribute_hash ) = @_;
    $self->_print( '' . $self->_confluence_macro_start( 'toc', self_close => 1 ) . '' );
}

sub start_head1 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    $self->{indent} = 0;
}

sub start_head2 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    $self->{indent} = 0;
}

sub start_head3 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    $self->{indent} = 0;
}

sub start_head4 {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
    $self->{indent} = 0;
}

sub start_I {
    my ( $self, $attribute_hash ) = @_;
    $self->_print('');
}

sub start_item_text {
    my ( $self, $attribute_hash ) = @_;
    $self->{indent} -= 1;
    $self->start_Para();
    $self->{indent} += 1;
    $self->_print('');
}

sub start_L {
    my ( $self, $attribute_hash ) = @_;
    $self->{link_type} = $attribute_hash->{type};
    if ( $attribute_hash->{type} eq 'pod' ) {
        my $to = $attribute_hash->{to};
        if ( !$to || $self->{packages_in_space}{"$to"} ) {
            $self->{link_type} = 'pod';
            $self->_print(
                (   $attribute_hash->{section}
                    ? ""
                    : ''
                )
                . ( $to ? ""
                    : ''
                    )
                    . '
            );
            $self->{in_cdata} = 1;
        }
        else {
            my $url = $to ? "https://metacpan.org/pod/$to" : '';
            my $section = $attribute_hash->{section};
            if ($section) {
                $section =~ s/[^a-zA-Z0-9]+/-/g;
                $section =~ s/-$//g;
                $url .= "#$section";
            }
            $self->{link_type} = 'url';
            $self->_print("");
        }
    }
    elsif ( $attribute_hash->{type} eq 'url' ) {
        $self->{link_type} = 'url';
        $self->_print("");
    }
}

sub start_over_text {
    my ( $self, $attribute_hash ) = @_;
    $self->{indent} += 2;
}

sub start_Para {
    my ( $self, $attribute_hash ) = @_;
    my $style;
    if ( $self->{indent} ) {
        $style = 'style="margin-left: ' . ( $self->{indent} * 30 ) . 'px;"';
    }
    $self->_print( $style ? "" : '' );
}

sub start_S {
    my ( $self, $attribute_hash ) = @_;
    $self->{in_non_breaking} = 1;
}

sub start_Verbatim {
    my ( $self, $attribute_hash ) = @_;
    $self->_print(
        $self->_confluence_macro_start(
            'code',
            has_text   => 1,
            parameters => { language => 'perl' }
        )
    );
    $self->{in_cdata} = 1;
}

1;

__END__