File Coverage

blib/lib/Articulate/Role/Routes.pm

Criterion	Covered	Total	%
statement	12	19	63.1
branch			n/a
condition	0	2	0.0
subroutine	4	5	80.0
pod	1	1	100.0
total	17	27	62.9

package Articulate::Role::Routes;
use strict;
use warnings;
use Moo::Role;

=head1 NAME

Articulate::Role::Routes - allow routes to be enabled

=cut

=head1 DESCRIPTION

This is a helper role for route classes which works in tandem with L (which allows a declarative style of routing).

Note that it is not mandatory to use either of these, you can use your frameworks's own routing capabiity and merely use Articulate for the service. If you do this, you will need to handle serialisation of L objects yourself.

=head1 ATTRIBUTE

=head3 enabled

Do not set this directly, use C.

=cut

=head1 METHOD

=head3 enable

Finds all that were declared in that package. Note that this does B respect inheritance by searching parent classes, roles, etc. for routes declared there: B routes defined in the package to which this role is applied will be enabled.

=cut

sub enable { #ideally we want this to be able to switch on and off the routes.
  my $self   = shift;
  my $class  = ref $self;
  my $routes = "${class}::__routes";
  {
    no strict 'refs';
    $$routes //= [];
    $_->($self) for @$$routes;
  }
  $self->enabled(1);
}

has enabled => (
  is      => 'rw',
  default => sub { 0 },
);

with 'Articulate::Role::Component';

1;