File Coverage

blib/lib/Class/Pluggable.pm

Criterion	Covered	Total	%
statement	57	79	72.1
branch	8	10	80.0
condition			n/a
subroutine	14	23	60.8
pod	6	14	42.8
total	85	126	67.4

package Class::Pluggable;

use 5.008006;
use strict;
use warnings;
use vars qw($AUTOLOAD);
use Carp;

our $VERSION = '0.022';

sub add_plugin {
	my ($self, $plugin) = @_;

	push @{$self->_get_plugins()}, $plugin;

	{
	  no strict 'refs';
	  s/^&//, *{"$_"} = \&{"${plugin}::$_"}
		foreach @{"${plugin}::EXPORT_AS_PLUGIN"};
	}
}


sub _get_plugins {
  my $self = shift;

  if (not ref $self) {
    printf "  !! ref = %s\n", $self;
    croak("Cannot handle the plugins as Class method.");
  }

  $self->{_PLUGINS} = [] if not $self->{_PLUGINS};
  return $self->{_PLUGINS};
}


sub get_plugins {
  return @{$_[0]->_get_plugins()};
}


sub add_hook {
  my ($self, $hook, $method) = @_;

  if (defined ${$self->{_HOOK}}{$hook}) {
	carp("The hook ($hook) already in used. It will overwrite with new method.");
  }

  ${$self->{_HOOK}}{$hook} = $method;
}


sub run_hook {
  my ($self, $hook) = @_;
  my $method = ${$self->{_HOOK}}{$hook};

  if (not defined $method) {
	my $caller = caller(0);
	croak("The hook ($hook) $caller called doesn't exists.");
  }

  $self->execute_all_plugins_method($method);
}



sub remove_hook {
  my ($self, $hook) = @_;
  delete ${$self->{_HOOK}}{$hook};
}


sub execute_plugin_method {
	my ($self, $plugin, $method, @args) = @_;
	my $result;

	if (defined &{"${plugin}::$method"}) {
	  # Give $self to make the plugin method looks like object method.
	  {
		no strict 'refs';
		$result = &{"${plugin}::$method"}($self, @args);
	  }
	}
	return $result;
}

sub execute_all_plugins_method {
  my ($self, $method, @args) = @_;

  $self->execute_plugin_method($_, $method, @args)
	foreach $self->get_plugins();
}



## Deprecated Methods.
sub addPlugin { carp("deprecated method."); (shift)->add_plugin(@_) }
sub _getPlugins { carp("deprecated method."); (shift)->_get_plugins(@_) }
sub getPlugins { carp("deprecated method."); (shift)->get_plugins(@_) }
sub addHook { carp("deprecated method."); (shift)->add_hook(@_) }
sub runHook { carp("deprecated method."); (shift)->run_hook(@_) }
sub removeHook { carp("deprecated method."); (shift)->remove_hook(@_) }
sub executePluginMethod { carp("deprecated method."); (shift)->execute_plugin_method(@_) }
sub executeAllPluginsMethod { carp("deprecated method."); (shift)->execute_all_plugins_method(@_) }

1;
__END__