File Coverage

lib/Mojolicious/Plugin/Sprite.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

package Mojolicious::Plugin::Sprite;

use warnings;
use strict;
use Mojo::Base 'Mojolicious::Plugin';
use XML::LibXML;

use constant DEFAULT_CONFIG_FILE => 'sprite.xml';
use constant DEFAULT_CSS_URL     => '/css/sprite.css';

our $VERSION = '0.01';

our $parser  = XML::LibXML->new();

sub register {
    my ( $self, $app, $conf ) = @_;
    $conf ||= {};

    my $config  = $conf->{config}  || DEFAULT_CONFIG_FILE;
    my $css_url = $conf->{css_url} || DEFAULT_CSS_URL;

    my $sprite_images = ref($config) eq 'HASH'
        ? $config
        : $self->_parse_xml_config($app, $config)
    ;

    unless (scalar %$sprite_images) {
        $app->log->warn( __PACKAGE__ .": Plugin not activated.");
    }

    $app->hook(after_dispatch => sub {
        my ($c) = @_;
        my $res = $c->res;

        # Only successful response
        return if $res->code !~ m/^2/;

        # Only html response
        return unless $res->headers->content_type;
        return if $res->headers->content_type !~ /html/;
        return if $res->body !~ /^\s*

        # Skip if "?no_sprites=1" and mode is 'develompent'
        return if $app->mode eq 'development' && $c->param('no_sprites');

        my $dom = $parser->parse_html_string($res->body);

        # Replace "img" tags
        foreach my $img ( $dom->findnodes('//img') ) {
            # Skip if "src" is empty
            my $src = $img->getAttribute('src') or last;

            # Remove first "/"
            $src =~ s/^\///;

            # Skip if not found
            my $selector = $sprite_images->{$src} or last;

            # Change node name
            $img->setNodeName('span');

            # Add single space
            $img->appendText(' ');

            # Add 'class' and 'id' attribute
            my @class = grep { $_ } ($img->getAttribute('class'), 'spr');
            if ( substr($selector, 0, 1) eq '.' ) {
                push @class, substr($selector, 1);
            }
            else {
                $img->setAttribute( 'id', substr($selector, 1) );
            }
            $img->setAttribute( 'class', join(' ', @class) );

            # Remove unneeded attributes
            $img->removeAttribute($_) for qw(src width height alt);
        }

        # Add 'sprite.css'
        foreach my $head ( $dom->findnodes('/html/head') ) {
            my $style = $head->addNewChild(undef, 'link');
            $style->setAttribute('rel', 'stylesheet');
            $style->setAttribute('href', $css_url);
        }

        $res->body( $dom->toStringHTML() );
    });
}

sub _parse_xml_config {
    my ($self, $app, $config) = @_;

    unless (-e $config) {
        $app->log->warn( __PACKAGE__ .": Config file '$config' does not exists.");
        return {};
    }

    my $parser = XML::LibXML->new();
    my $dom    = $parser->parse_file($config);

    my %sprite_images = map {
        $_->getAttribute('image') => $_->getAttribute('selector')
    } $dom->findnodes('/root/sprite/image');

    return \%sprite_images;
}

1;
__END__