File Coverage

blib/lib/Starch/Factory.pm

Criterion	Covered	Total	%
statement	60	60	100.0
branch	7	8	87.5
condition			n/a
subroutine	17	17	100.0
pod	3	4	75.0
total	87	89	97.7

package Starch::Factory;
our $VERSION = '0.14';

=encoding utf8

=head1 NAME

Starch::Factory - Role applicator and class creator.

=head1 DESCRIPTION

This class consumes the L role and
is used by L to apply specified plugins to manager,
state, and store classes.

Normally there is no need to interact with this class directly.

=cut

use Module::Runtime qw( require_module );
use Moo::Object qw();
use Moo::Role qw();
use Starch::Manager;
use Starch::State;
use Starch::Util qw( load_prefixed_module croak );
use Types::Common::String -types;
use Types::Standard -types;

use Moo;
use strictures 2;
use namespace::clean;

with 'Starch::Plugin::Bundle';

=head1 OPTIONAL ARGUMENTS

=head2 plugins

This is the L attribute, but altered
to be an argument.

=cut

has '+plugins' => (
    init_arg => 'plugins',
);
sub bundled_plugins {
    return [];
}

=head2 base_manager_class

The base class of the Starch manager object.  Default to C.

=cut

has base_manager_class => (
    is      => 'lazy',
    isa     => NonEmptySimpleStr,
    default => 'Starch::Manager',
);

=head2 base_state_class

The base class of Starch state objects.  Default to C.

=cut

has base_state_class => (
    is      => 'lazy',
    isa     => NonEmptySimpleStr,
    default => 'Starch::State',
);

=head1 ATTRIBUTES

=head2 manager_class

The anonymous class which extends L and has
L applied to it.

=cut

has manager_class => (
    is       => 'lazy',
    isa      => ClassName,
    init_arg => undef,
);
sub _build_manager_class {
    my ($self) = @_;

    my $roles = $self->manager_roles();
    my $class = $self->base_manager_class();
    require_module( $class );

    return $class if !@$roles;

    return Moo::Role->create_class_with_roles( $class, @$roles );
}

=head2 state_class

The anonymous class which extends L and has
L applied to it.

=cut

has state_class => (
    is       => 'lazy',
    isa      => ClassName,
    init_arg => undef,
);
sub _build_state_class {
    my ($self) = @_;

    my $roles = $self->state_roles();
    my $class = $self->base_state_class();
    require_module( $class );

    return $class if !@$roles;

    return Moo::Role->create_class_with_roles( $class, @$roles );
}

=head1 METHODS

=head2 base_store_class

    my $class = $factory->base_store_class( '::Memory' );
    # Starch::Store::Memory

    my $class = $factory->base_store_class( 'Starch::Store::Memory' );
    # Starch::Store::Memory

Given an absolute or relative store class name this will
return the resolved class name.

=cut

sub base_store_class {
    my ($self, $suffix) = @_;

    return load_prefixed_module(
        'Starch::Store',
        $suffix,
    );
}

=head2 store_class

    my $class = $factory->store_class( '::Memory' );

Given an absolute or relative store class name this will
return an anonymous class which extends the store class
and has L applied to it.

=cut

sub store_class {
    my ($self, $suffix) = @_;

    my $roles = $self->store_roles();
    my $class = $self->base_store_class( $suffix );

    return $class if !@$roles;

    return Moo::Role->create_class_with_roles( $class, @$roles );
}

=head2 new_store

    my $store = $factory->new_store( class=>'::Memory', %args );

Creates and returns a new L object with the
factory argument set.

Note that since the L argument is
required you must specify it.

=cut

sub new_store {
    my $self = shift;

    my $args = Moo::Object->BUILDARGS( @_ );
    $args = { %$args };
    my $suffix = delete $args->{class};
    croak "No class key was declared in the Starch store hash ref"
        if !defined $suffix;

    my $class = $self->store_class( $suffix );
    return $class->new(
        %$args,
    );
}

1;
__END__