Add explicit notes wrt DBI/DBD::SQLite dep versions
[dbsrgits/DBIx-Class.git] / t / 55namespaces_cleaned.t
CommitLineData
88b1530a 1BEGIN {
2 if ($] < 5.010) {
6a0067ea 3
45638aed 4 # Pre-5.10 perls pollute %INC on unsuccesfull module
5 # require, making it appear as if the module is already
6 # loaded on subsequent require()s
7 # Can't seem to find the exact RT/perldelta entry
8 #
9 # The reason we can't just use a sane, clean loader, is because
10 # if a Module require()s another module the %INC will still
11 # get filled with crap and we are back to square one. A global
12 # fix is really the only way for this test, as we try to load
13 # each available module separately, and have no control (nor
14 # knowledge) over their common dependencies.
15 #
16 # we want to do this here, in the very beginning, before even
17 # warnings/strict are loaded
18
19 unshift @INC, 't/lib';
20 require DBICTest::Util::OverrideRequire;
21
22 DBICTest::Util::OverrideRequire::override_global_require( sub {
23 my $res = eval { $_[0]->() };
6a0067ea 24 if ($@ ne '') {
45638aed 25 delete $INC{$_[1]};
6a0067ea 26 die $@;
88b1530a 27 }
45638aed 28 return $res;
29 } );
88b1530a 30 }
31}
32
9c1700e3 33use strict;
34use warnings;
35
36use Test::More;
37
8d6b1478 38use lib 't/lib';
39use DBICTest;
40
9c1700e3 41use File::Find;
42use File::Spec;
43use B qw/svref_2object/;
90cfe42b 44use Package::Stash;
9c1700e3 45
46# makes sure we can load at least something
47use DBIx::Class;
90cfe42b 48use DBIx::Class::Carp;
9c1700e3 49
50my @modules = grep {
f3ec358e 51 my ($mod) = $_ =~ /(.+)/;
9c1700e3 52
9c1700e3 53 # not all modules are loadable at all times
88b1530a 54 do {
55 # trap deprecation warnings and whatnot
56 local $SIG{__WARN__} = sub {};
57 eval "require $mod";
58 } ? $mod : do {
59 SKIP: { skip "Failed require of $mod: " . ($@ =~ /^(.+?)$/m)[0], 1 };
60 (); # empty RV for @modules
9c1700e3 61 };
62
9c1700e3 63} find_modules();
64
65# have an exception table for old and/or weird code we are not sure
66# we *want* to clean in the first place
67my $skip_idx = { map { $_ => 1 } (
68 (grep { /^DBIx::Class::CDBICompat/ } @modules), # too crufty to touch
69 'SQL::Translator::Producer::DBIx::Class::File', # ditto
70
71 # not sure how to handle type libraries
72 'DBIx::Class::Storage::DBI::Replicated::Types',
73 'DBIx::Class::Admin::Types',
74
75 # G::L::D is unclean, but we never inherit from it
76 'DBIx::Class::Admin::Descriptive',
77 'DBIx::Class::Admin::Usage',
cd122820 78
79 # this subclass is expected to inherit whatever crap comes
80 # from the parent
81 'DBIx::Class::ResultSet::Pager',
9f98c4b2 82
b1dbf716 83 # utility classes, not part of the inheritance chain
9f98c4b2 84 'DBIx::Class::ResultSource::RowParser::Util',
b1dbf716 85 'DBIx::Class::_Util',
9c1700e3 86) };
87
bfcecabc 88my $has_moose = eval { require Moose::Util };
9c1700e3 89
90# can't use Class::Inspector for the mundane parts as it does not
91# distinguish imports from anything else, what a crock of...
bfcecabc 92# Moose is not always available either - hence just do it ourselves
9c1700e3 93
94my $seen; #inheritance means we will see the same method multiple times
95
96for my $mod (@modules) {
97 SKIP: {
98 skip "$mod exempt from namespace checks",1 if $skip_idx->{$mod};
99
90cfe42b 100 my %all_method_like = (map
101 { %{Package::Stash->new($_)->get_all_symbols('CODE')} }
102 (reverse @{mro::get_linear_isa($mod)})
103 );
9c1700e3 104
105 my %parents = map { $_ => 1 } @{mro::get_linear_isa($mod)};
106
107 my %roles;
bfcecabc 108 if ($has_moose and my $mc = Moose::Util::find_meta($mod)) {
9c1700e3 109 if ($mc->can('calculate_all_roles_with_inheritance')) {
110 $roles{$_->name} = 1 for ($mc->calculate_all_roles_with_inheritance);
111 }
112 }
113
114 for my $name (keys %all_method_like) {
115
6a0067ea 116 # overload is a funky thing - it is not cleaned, and its imports are named funny
9c1700e3 117 next if $name =~ /^\(/;
118
119 my $gv = svref_2object($all_method_like{$name})->GV;
120 my $origin = $gv->STASH->NAME;
121
8b4d8064 122 is ($gv->NAME, $name, "Properly named $name method at $origin" . ($origin eq $mod
123 ? ''
124 : " (inherited by $mod)"
125 ));
9c1700e3 126
70c28808 127 next if $seen->{"${origin}:${name}"}++;
128
9c1700e3 129 if ($origin eq $mod) {
130 pass ("$name is a native $mod method");
131 }
132 elsif ($roles{$origin}) {
133 pass ("${mod}::${name} came from consumption of role $origin");
134 }
135 elsif ($parents{$origin}) {
136 pass ("${mod}::${name} came from proper parent-class $origin");
137 }
138 else {
139 my $via;
140 for (reverse @{mro::get_linear_isa($mod)} ) {
141 if ( ($_->can($name)||'') eq $all_method_like{$name} ) {
142 $via = $_;
143 last;
144 }
145 }
146 fail ("${mod}::${name} appears to have entered inheritance chain by import into "
147 . ($via || 'UNKNOWN')
148 );
149 }
150 }
70c28808 151
152 # some common import names (these should never ever be methods)
153 for my $f (qw/carp carp_once carp_unique croak confess cluck try catch finally/) {
154 if ($mod->can($f)) {
155 my $via;
156 for (reverse @{mro::get_linear_isa($mod)} ) {
157 if ( ($_->can($f)||'') eq $all_method_like{$f} ) {
158 $via = $_;
159 last;
160 }
161 }
162 fail ("Import $f leaked into method list of ${mod}, appears to have entered inheritance chain at "
163 . ($via || 'UNKNOWN')
164 );
165 }
166 else {
167 pass ("Import $f not leaked into method list of $mod");
168 }
169 }
9c1700e3 170 }
171}
172
173sub find_modules {
174 my @modules;
175
176 find({
177 wanted => sub {
178 -f $_ or return;
179 s/\.pm$// or return;
180 s/^ (?: lib | blib . (?:lib|arch) ) . //x;
181 push @modules, join ('::', File::Spec->splitdir($_));
182 },
183 no_chdir => 1,
184 }, (-e 'blib' ? 'blib' : 'lib') );
185
186 return sort @modules;
187}
188
9c1700e3 189done_testing;