package Catalyst::Plugin::Sitemap;
+BEGIN {
+ $Catalyst::Plugin::Sitemap::VERSION = '1.0.0';
+}
+
# ABSTRACT: Sitemap support for Catalyst.
+
+use strict;
+use warnings;
+
+use Moose::Role;
+
+no warnings qw/uninitialized/;
+
+use WWW::Sitemap::XML;
+use List::Util qw/ first /;
+
+has sitemap => (
+ is => 'ro',
+ builder => '_build_sitemap',
+ lazy => 1,
+);
+
+sub sitemap_as_xml {
+ my $self = shift;
+ return $self->sitemap->as_xml->toString;
+}
+
+sub _build_sitemap {
+ my $self = shift;
+
+ my $sitemap = WWW::Sitemap::XML->new;
+
+ if ( $self->can('uri_disposition') ) {
+ $self->uri_disposition('absolute');
+ }
+
+ for my $controller ( map { $self->controller($_) } $self->controllers ) {
+ ACTION:
+ for my $a ( $controller->get_action_methods ) {
+
+ my $action = $controller->action_for( $a->name );
+
+ my $attr = $action->attributes->{Sitemap} or next ACTION;
+
+ die "more than one attribute 'Sitemap' for sub ",
+ $a->fully_qualified_name
+ if @$attr > 1;
+
+ my @attr = split /\s*(?:,|=>)\s*/, $attr->[0];
+
+ my %uri_params;
+
+ if ( @attr == 1 ) {
+ if ( $attr[0] eq '*' ) {
+ my $sitemap_method = $action->name . "_sitemap";
+
+ if ( $controller->can($sitemap_method) ) {
+ $controller->$sitemap_method( $self, $sitemap );
+ next ACTION;
+ }
+ }
+
+ if ( $attr[0] + 0 > 0 ) {
+
+ # it's a number
+ $uri_params{priority} = $attr[0];
+ }
+
+ }
+ elsif ( @attr > 0 ) {
+ %uri_params = @attr;
+ }
+
+ $uri_params{loc} = ''.$self->uri_for_action( $action->private_path );
+
+ $sitemap->add(%uri_params);
+ }
+
+ }
+
+ return $sitemap;
+}
+
+1;
+
+
+
+=pod
+
+=head1 NAME
+
+Catalyst::Plugin::Sitemap - Sitemap support for Catalyst.
+
+=head1 VERSION
+
+version 1.0.0
+
=head1 SYNOPSIS
# in MyApp.pm
sub sitemap : Path('/sitemap') {
my ( $self, $c ) = @_;
- $c->res->body( $c->sitemap->as_xml->sprint );
+ $c->res->body( $c->sitemap_as_xml );
}
=head1 DESCRIPTION
=head2 sitemap()
-Returns a L<WWW::Search::XML> object. The sitemap object is populated by
+Returns a L<WWW::Sitemap::XML> object. The sitemap object is populated by
inspecting the controllers of the application for actions with the
sub attribute C<:Sitemap>.
+=head2 sitemap_as_xml()
+
+Returns the sitemap as a string containing its XML representation.
+
=head1 C<:Sitemap> Subroutine Attribute
The sitemap is populated by actions ear-marked with the <:Sitemap> sub
=item C<:Sitemap($priority)>
-
sub with_priority :Local :Sitemap(0.9) {
...
}
}
Adds the url with the given entry attributes (as defined by
-L<WWW::Search::XML::URL>).
+L<WWW::Sitemap::XML::URL>).
If the action does not
resolves in a single url, this will results in an error.
=back
-
-=head1 BUGS AND LIMITATIONS
-
-Currently, each invocation of the method C<sitemap()> will
-re-generate the C<WWW::Sitemap::XML> object. A future version
-of this module might offer a way to only compute the sitemap
-once.
-
-
=head1 SEE ALSO
-=over
+=over
=item L<WWW::Sitemap::XML>
-=item http://babyl.dyndns.org/techblog/entry/catalyst-plugin-sitemap
+Module that C<Catalyst::Plugin::Sitemap> currently uses under the hood.
-=back
+=item L<Search::Sitemap>
-=cut
+Original module that this plugin was using under the hood.
-use strict;
-use warnings;
-
-use Moose::Role;
-
-no warnings qw/uninitialized/;
-
-use WWW::Sitemap::XML;
-use List::Util qw/ first /;
+=item L<Dancer::Plugin::SiteMap>
-sub sitemap {
- my $self = shift;
-
- my $sitemap = WWW::Sitemap::XML->new;
-
- for my $controller ( $self->controller(qr//) ) {
- ACTION:
- for my $a ( $controller->get_action_methods ) {
-
- my $action = $controller->action_for( $a->name );
+Similar plugin for the L<Dancer> framework, which inspired
+C<Catalyst::Plugin::Sitemap>.
- my $attr = $action->attributes->{Sitemap} or next ACTION;
-
- die "more than one attribute 'Sitemap' for sub ",
- $a->fully_qualified_name
- if @$attr > 1;
-
- my @attr = split /\s*(?:,|=>)\s*/, $attr->[0];
-
- my %uri_params;
-
- if ( @attr == 1 ) {
- if ( $attr[0] eq '*' ) {
- my $sitemap_method = $action->name . "_sitemap";
+=item http://babyl.dyndns.org/techblog/entry/catalyst-plugin-sitemap
- if ( $controller->can($sitemap_method) ) {
- $controller->$sitemap_method( $self, $sitemap );
- next ACTION;
- }
- }
+Blog article introducing C<Catalyst::Plugin::Sitemap>.
- if ( $attr[0] + 0 > 0 ) {
- # it's a number
- $uri_params{priority} = $attr[0];
- }
+=back
- }
- elsif ( @attr > 0 ) {
- %uri_params = @attr;
- }
+=head1 AUTHOR
- $uri_params{loc} = $self->uri_for_action( $action->private_path );
+Yanick Champoux <yanick@babyl.dyndns.org>
- $sitemap->add( \%uri_params );
+=head1 COPYRIGHT AND LICENSE
- next ACTION;
- }
+This software is copyright (c) 2010 by Yanick Champoux.
- }
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
- return $sitemap;
-}
+=cut
-1;
__END__
projects / chaz / p5-Catalyst-Plugin-Sitemap / blobdiff