File Coverage

blib/lib/IOC/Container.pm

Criterion	Covered	Total	%
statement	148	148	100.0
branch	58	60	96.6
condition	21	23	91.3
subroutine	34	34	100.0
pod	22	22	100.0
total	283	287	98.6

package IOC::Container;

use strict;
use warnings;

our $VERSION = '0.14';

use Scalar::Util qw(blessed);

use IOC::Interfaces;
use IOC::Exceptions;

use IOC::Visitor::ServiceLocator;

use base 'IOC::Visitable';

sub new {
    my ($_class, $name) = @_;
    my $class = ref($_class) || $_class;
    my $container = {};
    bless($container, $class);
    $container->_init($name);
    return $container;
}

sub _init {
    my ($self, $name) = @_;
    $self->{services} = {};
    $self->{service_locks} = {};
    $self->{proxies} = {};
    $self->{sub_containers} = {};
    $self->{parent_container} = undef;
    $self->{name} = $name || 'default';
}

sub name {
    my ($self) = @_;
    return $self->{name};
}

# parent containers

sub setParentContainer {
    my ($self, $parent_container) = @_;
    (blessed($parent_container) && $parent_container->isa('IOC::Container'))
        || throw IOC::InsufficientArguments "You must provide an IOC::Container object as a parent container";
    $self->{parent_container} = $parent_container;
}

sub getParentContainer {
    my ($self) = @_;
    return $self->{parent_container};
}

sub isRootContainer {
    my ($self) = @_;
    return defined($self->{parent_container}) ? 0 : 1;
}

sub findRootContainer {
    my ($self) = @_;
    return $self if $self->isRootContainer();
    my $current = $self;
    $current = $current->getParentContainer() until $current->isRootContainer();
    return $current;
}

# sub containers

sub addSubContainer {
    my ($self, $container) = @_;
    (blessed($container) && $container->isa('IOC::Container'))
        || throw IOC::InsufficientArguments "You must provide an IOC::Container object as a sub-container";
    my $name = $container->name();
    (!exists ${$self->{sub_containers}}{$name})
        || throw IOC::ContainerAlreadyExists "Duplicate Sub-Container Name '${name}' in container '" . $self->{name} . "'";
    $self->{sub_containers}->{$name} = $container;
    $container->setParentContainer($self);
    $self;
}

sub addSubContainers {
    my ($self, @containers) = @_;
    (@containers) || throw IOC::InsufficientArguments "You must provide at least one IOC::Container to add";
    $self->addSubContainer($_) foreach @containers;
    $self;
}

sub hasSubContainer {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must supply a name of a sub-container";
    return (exists ${$self->{sub_containers}}{$name}) ? 1 : 0;
}

sub hasSubContainers {
    my ($self) = @_;
    return scalar(keys(%{$self->{sub_containers}})) ? 1 : 0;
}

sub getSubContainerList {
    my ($self) = @_;
    return keys %{$self->{sub_containers}};
}

sub getSubContainer {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must supply a name of a sub-container";
    (exists ${$self->{sub_containers}}{$name})
        || throw IOC::ContainerNotFound "There is no subcontainer by the name '${name}' in container '" . $self->{name} . "'";
    return $self->{sub_containers}->{$name};
}

sub getAllSubContainers {
    my ($self) = @_;
    return values %{$self->{sub_containers}};
}

sub accept {
    my ($self, $visitor) = @_;
    (blessed($visitor) && $visitor->isa('IOC::Visitor'))
        || throw IOC::InsufficientArguments "You must pass an IOC::Visitor object to the visit method";
    return $visitor->visit($self);
}

# services

sub register {
    my ($self, $service) = @_;
    (blessed($service) && $service->isa('IOC::Service'))
        || throw IOC::InsufficientArguments "You must provide a valid IOC::Service object to register";
    my $name = $service->name();
    (!exists ${$self->{services}}{$name})
        || throw IOC::ServiceAlreadyExists "Duplicate Service Name '${name}'";
    $service->setContainer($self);
    $self->{services}->{$name} = $service;
    $self;
}

sub unregister {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must provide a service name to unregister";
    (exists ${$self->{services}}{$name})
        || throw IOC::ServiceNotFound "Unknown Service '${name}'";
    my $service = $self->{services}->{$name};
    $service->removeContainer();
    delete $self->{services}->{$name};
    return $service;
}

sub registerWithProxy {
    my ($self, $service, $proxy) = @_;
    $self->register($service);
    $self->addProxy($service->name(), $proxy);
    $self;
}

sub addProxy {
    my ($self, $name, $proxy) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must provide a valid service name";
    (blessed($proxy) && $proxy->isa('IOC::Proxy'))
        || throw IOC::InsufficientArguments "You must provide a valid IOC::Proxy object to register";
    (exists ${$self->{services}}{$name})
        || throw IOC::ServiceNotFound "Unknown Service '${name}'";
    $self->{proxies}->{$name} = $proxy;
    $self;
}

sub get {
    my ($self, $name, %params) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must provide a name of the service";
    (exists ${$self->{services}}{$name})
        || throw IOC::ServiceNotFound "Unknown Service '${name}'";
    # a literal object can have no dependencies,
    # and therefore can have no circular refs, so
    # we can optimize their usage there as well
    return $self->{services}->{$name}->instance()
        if $self->{services}->{$name}->isa('IOC::Service::Literal');
    if ($self->_isServiceLocked($name)) {
        # NOTE:
        # if the service is parameterized
        # then we cannot defer it - SL
        ($self->{services}->{$name}->isa('IOC::Service::Parameterized'))
            && throw IOC::IllegalOperation "The service '$name' is locked, cannot defer a parameterized instance";
        # otherwise ...
        return $self->{services}->{$name}->deferred();
    }
    $self->_lockService($name);
    my $instance = $self->{services}->{$name}->instance(%params);
    $self->_unlockService($name);
    if (blessed($instance) && ref($instance) !~ /\:\:\_\:\:Proxy$/) {
        return $self->{proxies}->{$name}->wrap($instance) if exists ${$self->{proxies}}{$name};
    }
    return $instance;
}

sub find {
    my ($self, $path, $extra_args) = @_;
    (defined($path))
        || throw IOC::InsufficientArguments "You must provide a path of find a service";
    return $self->accept(IOC::Visitor::ServiceLocator->new($path, $extra_args));
}

sub hasService {
    my ($self, $name) = @_;
    (defined($name)) || throw IOC::InsufficientArguments "You must provide a name of the service";
    return (exists ${$self->{services}}{$name}) ? 1 : 0;
}

sub getServiceList {
    my ($self) = @_;
    return keys %{$self->{services}};
}

sub DESTROY {
    my ($self) = @_;
    # this will not DESTROY all the
    # sub-containers it holds, since
    # a sub-container might be still
    # refered to elsewhere.
    $self->{sub_containers} = undef;
    # and the same with the parent
    $self->{parent_container} = undef;
    # this will DESTROY all the
    # services it holds, since
    # a service can only have one
    # container, then this is okay
    # to do that, otherwise we would
    # need to deal with that.
    foreach my $service (values %{$self->{services}}) {
        defined $service && $service->DESTROY;
    }
}

# private methods

sub _lockService {
    my ($self, $name) = @_;
    $self->{lock_level}++;
    $self->{service_locks}->{$name} = $self->{lock_level};
#     use Data::Dumper;
#     print "locking '$name' -> our locks are: " . Dumper($self->{service_locks});
}

sub _unlockService {
    my ($self, $name) = @_;
    $self->{lock_level}--;
    delete $self->{service_locks}->{$name};
}

sub _isServiceLocked {
    my ($self, $name) = @_;
    return (exists ${$self->{service_locks}}{$name});
}

1;

__END__