File Coverage

blib/lib/Rubric/Renderer.pm

Criterion	Covered	Total	%
statement	43	43	100.0
branch	7	8	87.5
condition	1	2	50.0
subroutine	12	12	100.0
pod	2	2	100.0
total	65	67	97.0

use strict;
use warnings;
package Rubric::Renderer;
# ABSTRACT: the rendering interface for Rubric
$Rubric::Renderer::VERSION = '0.156';
#pod =head1 DESCRIPTION
#pod
#pod Rubric::Renderer provides a simple interface for rendering entries, entry sets,
#pod and other things collected by Rubric::WebApp.
#pod
#pod =cut

use Carp;
use File::ShareDir;
use File::Spec;
use HTML::Widget::Factory 0.03;
use Rubric;
use Rubric::Config;
use Template 2.00;
use Template::Filters;

#pod =head1 METHODS
#pod
#pod =head2 register_type($type => \%arg)
#pod
#pod This method registers a format type by providing a little data needed to render
#pod to it.  The hashref of arguments must include C, used to set the
#pod MIME type of the returned ouput; and C, used to find the primary
#pod template.
#pod
#pod This method returns a Template object, which is registered as the renderer for
#pod this type.  This return value may change in the future.
#pod
#pod =cut

my %renderer;

sub register_type {
  my ($class, $type, $arg) = @_;
  $renderer{$type} = $arg;
  $renderer{$type}{renderer} = Template->new({
    PROCESS      => ("template.$arg->{extension}"),
    INCLUDE_PATH => [
      Rubric::Config->template_path,
      File::Spec->catdir(File::ShareDir::dist_dir('Rubric'), 'templates'),
    ],
  });
}

__PACKAGE__->register_type(@$_) for (
  [ html => { content_type => 'text/html; charset="utf-8"', extension => 'html' } ],
  [ rss  => { content_type => 'application/rss+xml', extension => 'rss'  } ],
  [ txt  => { content_type => 'text/plain',          extension => 'txt'  } ],
  [ api  => { content_type => 'text/xml',            extension => 'api'  } ],
);

#pod =head2 process($template, $type, \%stash)
#pod
#pod This method renders the named template using the registered renderer for the
#pod given type, using the passed stash variables.
#pod
#pod The type must be rendered with Rubric::Renderer before this method is called.
#pod
#pod In list context, this method returns the content type and output document as a
#pod two-element list.  In scalar context, it returns the output document.
#pod
#pod =cut

my $xml_escape = sub {
  for (shift) {
    s/&/&/g;
    s/
    s/>/>/g;
    s/"/"/g;
    s/'/'/g;
    return $_;
  }
};

sub process {
  my ($class, $template, $type, $stash) = @_;
  return unless $renderer{$type};

  $stash->{xml_escape} = $xml_escape;
  $stash->{version}    = Rubric->VERSION || 0;
  $stash->{widget}     = HTML::Widget::Factory->new;
  $stash->{basename}   = Rubric::Config->basename;
  # 2007-05-07
  # XXX: we only should create one factory per request, tops -- rjbs,

  $template .= '.' . $renderer{$type}{extension};
  $renderer{$type}{renderer}->process($template, $stash, \(my $output))
    or die "Couldn't render template: " . $renderer{$type}{renderer}->error;

  die "template produced no content" unless $output;

  return wantarray
    ? ($renderer{$type}{content_type}, $output)
    :  $output;
}

1;

__END__