File Coverage

blib/lib/circular/require.pm

Criterion	Covered	Total	%
statement	31	31	100.0
branch	8	10	80.0
condition			n/a
subroutine	9	9	100.0
pod			n/a
total	48	50	96.0

package circular::require;
BEGIN {
  $circular::require::AUTHORITY = 'cpan:DOY';
}
{
  $circular::require::VERSION = '0.11';
}
use strict;
use warnings;
# ABSTRACT: detect circularity in use/require statements

use 5.010;
use Devel::OverrideGlobalRequire;
use Module::Runtime 'module_notional_filename';


our %loaded_from;
our $previous_file;
my @hide;

Devel::OverrideGlobalRequire::override_global_require {
    my ($require, $file) = @_;

    if (exists $loaded_from{$file}) {
        my @cycle = ($file);

        my $caller = $previous_file;

        while (defined($caller)) {
            unshift @cycle, $caller
                unless grep { /^$caller$/ } @hide;
            last if $caller eq $file;
            $caller = $loaded_from{$caller};
        }

        if (_find_enable_state()) {
            if (@cycle > 1) {
                warn "Circular require detected:\n  " . join("\n  ", @cycle) . "\n";
            }
            else {
                warn "Circular require detected in $file (from unknown file)\n";
            }
        }
    }

    local $loaded_from{$file} = $previous_file;
    local $previous_file = $file;

    $require->();
};

sub import {
    # not delete, because we want to see it being explicitly disabled
    $^H{'circular::require'} = 0;
}

sub unimport {
    my $class = shift;
    my %params = @_;

    @hide = ref($params{'-hide'}) ? @{ $params{'-hide'} } : ($params{'-hide'})
        if exists $params{'-hide'};
    @hide = map { /\.pm$/ ? $_ : module_notional_filename($_) } @hide;

    $^H{'circular::require'} = 1;
}

sub _find_enable_state {
    my $depth = 0;
    while (defined(scalar(caller(++$depth)))) {
        my $hh = (caller($depth))[10];
        next unless defined $hh;
        next unless exists $hh->{'circular::require'};
        return $hh->{'circular::require'};
    }
    return 0;
}


1;

__END__