11 |
use PPI; |
use PPI; |
12 |
use PPI::HTML; |
use PPI::HTML; |
13 |
|
|
|
use Frey::Pod; |
|
|
|
|
14 |
use lib 'lib'; |
use lib 'lib'; |
15 |
|
use Frey::Pod; |
16 |
|
|
17 |
extends 'Frey::PPI'; |
extends 'Frey::PPI'; |
18 |
with 'Frey::Web'; |
with 'Frey::Web'; |
19 |
with 'Frey::Storage'; |
with 'Frey::Storage'; |
20 |
|
|
21 |
|
=head1 DESCRIPTION |
22 |
|
|
23 |
|
Provide introspection on any perl class installed on system |
24 |
|
|
25 |
|
=cut |
26 |
|
|
27 |
has 'class' => ( |
has 'class' => ( |
28 |
is => 'rw', |
is => 'rw', |
29 |
isa => 'Str', |
isa => 'Str', |
60 |
$out .= "\t\t\t$_: {\n"; |
$out .= "\t\t\t$_: {\n"; |
61 |
|
|
62 |
my $attr = $meta->get_attribute($_); |
my $attr = $meta->get_attribute($_); |
63 |
my $is = $attr->_is_metadata; |
my $is = eval { $attr->_is_metadata; }; |
64 |
|
return if $@; |
65 |
|
|
66 |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
67 |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
68 |
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
116 |
my ( $meta, $is_role ) = $self->class_meta; |
my ( $meta, $is_role ) = $self->class_meta; |
117 |
|
|
118 |
my $class = $self->class; |
my $class = $self->class; |
119 |
|
$self->title( $class ); |
120 |
|
|
121 |
my $introspect_path = "var/introspect/$class.yaml"; |
my $introspect_path = "var/introspect/$class.yaml"; |
122 |
$self->mkbasepath( $introspect_path ); |
$self->mkbasepath( $introspect_path ); |
123 |
my $introspect = $self->load( $introspect_path ); |
my $introspect; # FIXME update with = $self->load( $introspect_path ); |
124 |
|
|
125 |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
126 |
if ( ! $is_role ) { |
if ( ! $is_role ) { |
129 |
join(', ', |
join(', ', |
130 |
map { |
map { |
131 |
my $name = $_->meta->name; |
my $name = $_->meta->name; |
132 |
$introspect->{superclass}->{$name}++; |
$introspect->{superclass}->{$name} = {}; |
133 |
$self->dropdown( $name, $_->meta ) |
|
134 |
|
qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| . |
135 |
|
$self->dropdown( qq|<sup>?</sup>|, $_->meta ) |
136 |
} |
} |
137 |
#grep { $_ ne 'Moose::Object' } |
#grep { $_ ne 'Moose::Object' } |
138 |
$meta->superclasses |
$meta->superclasses |
140 |
} |
} |
141 |
} |
} |
142 |
|
|
143 |
my $role_method; |
my $method_from_role; |
144 |
my $role_attribute; |
my $attribute_from_role; |
145 |
|
|
146 |
if ( $meta->can('roles') ) { |
if ( $meta->can('roles') ) { |
147 |
my $role_nr = 1; |
my $role_nr = 1; |
149 |
grep { ! m/\Q$class\E/ } # skip me |
grep { ! m/\Q$class\E/ } # skip me |
150 |
map { |
map { |
151 |
my $name = $_->name; |
my $name = $_->name; |
152 |
$introspect->{role}->{$name}++; |
$introspect->{roles}->{$name} = {}; |
153 |
$role_method->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
$method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
154 |
$role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
$attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
155 |
$self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|; |
|
156 |
|
qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| |
157 |
|
# . qq|<sup>| . $self->dropdown( $role_nr++, $name->meta ) . qq|</sup>| |
158 |
|
. $self->dropdown( |
159 |
|
qq|<sup>| . $role_nr++ . qq|</sup>|, |
160 |
|
$name->meta |
161 |
|
) |
162 |
|
; |
163 |
} |
} |
164 |
$meta->calculate_all_roles |
$meta->calculate_all_roles |
165 |
); |
); |
166 |
$roles = qq| with roles: $roles| if $roles; |
$roles = qq|with roles: $roles| if $roles; |
167 |
} |
} |
168 |
warn "# role_method ",dump( $role_method ); |
warn "# method_from_role ",dump( $method_from_role ); |
169 |
|
|
170 |
my @methods; |
my @methods; |
171 |
@methods = map { |
@methods = map { |
172 |
my $name = $_; |
my $name = $_; |
173 |
$introspect->{method}->{$name}++; |
if ( $method_from_role->{$name} ) { |
174 |
if ( $role_method->{$name} ) { |
my ( $role_name, $nr ) = each %{ $method_from_role->{$name} }; |
175 |
my ( $role_name, $nr ) = each %{ $role_method->{$name} }; |
$introspect->{methods}->{$name}->{role} = $role_name; |
176 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
177 |
|
} else { |
178 |
|
$introspect->{methods}->{$name} = {}; |
179 |
} |
} |
180 |
qq|<td class="m">$name</td>| |
qq|<td class="m">$name</td>| |
181 |
|
} sort { |
182 |
|
lc($a) cmp lc($b) |
183 |
} $self->class_methods( $class ); |
} $self->class_methods( $class ); |
184 |
|
|
185 |
my @attributes; |
my @attributes; |
186 |
if ( $meta->get_attribute_list ) { |
if ( $meta->get_attribute_list ) { |
187 |
@attributes = map { |
@attributes = map { |
188 |
my $name = $_; |
my $name = $_; |
189 |
$introspect->{attribute}->{$name}++; |
$introspect->{attribute}->{$name} = {}; |
190 |
my $html_name = $name; |
my $html_name = $name; |
191 |
my $attr = $meta->get_attribute($name); |
my $attr = $meta->get_attribute($name); |
192 |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
193 |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
194 |
|
|
195 |
my ( $title, $properties ) = ( '', '' ); |
my ( $title, $properties ) = ( '', '' ); |
196 |
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ) |
if ( $attr->can('is_required') && $attr->is_required ) { |
197 |
if $attr->can('is_required') && $attr->is_required; |
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ); |
198 |
|
$introspect->{attribute}->{$name}->{required} = 1; |
199 |
|
} |
200 |
|
|
201 |
foreach my $check ( qw/has_type_constraint has_handles is_weak_ref is_required is_lazy should_coerce should_auto_deref has_default has_trigger has_applied_traits/ ) { |
foreach my $check ( qw/has_type_constraint has_handles is_weak_ref is_required is_lazy should_coerce should_auto_deref has_default has_trigger has_applied_traits/ ) { |
202 |
my $getter; |
my $getter; |
205 |
$getter =~ s/^has_//; |
$getter =~ s/^has_//; |
206 |
|
|
207 |
if ( $attr->can($check) && $attr->$check ) { |
if ( $attr->can($check) && $attr->$check ) { |
208 |
if ( $getter eq $check ) { |
$properties .= $check; |
209 |
$properties .= "$check"; |
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
210 |
} else { |
my $v = $attr->$getter; |
211 |
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
$properties .= ref($v) |
212 |
$properties .= $self->dropdown( $check, $attr->$getter ); |
? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter ) |
213 |
} |
: qq| <code>$v</code>| |
214 |
|
; |
215 |
} |
} |
216 |
$properties .= ' '; |
$properties .= ' '; |
217 |
} |
} |
218 |
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
219 |
|
|
220 |
if ( $role_attribute->{$name} ) { |
if ( $attribute_from_role->{$name} ) { |
221 |
my ( $role_name, $nr ) = each %{ $role_attribute->{$name} }; |
my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; |
222 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
223 |
} |
} |
224 |
|
|
225 |
eval { $properties = $attr->documentation . ' ' . $properties }; |
if ( my $doc = eval { $attr->documentation } ) { |
226 |
|
$properties = qq| |
227 |
|
$properties |
228 |
|
<span class="documentation">$doc</span> |
229 |
|
|; |
230 |
|
$self->add_css(qq| |
231 |
|
span.documentation { |
232 |
|
background: #eee; |
233 |
|
padding: 0.25em; |
234 |
|
float: left; |
235 |
|
clear: left; |
236 |
|
} |
237 |
|
|); |
238 |
|
$introspect->{action}->{$name}->{documentation} = $doc; |
239 |
|
} |
240 |
|
|
241 |
qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>| |
qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>| |
242 |
} $meta->get_attribute_list |
} sort $meta->get_attribute_list |
243 |
} |
} |
244 |
|
|
245 |
my $table = qq|<table class="frey-introspect"><tr><th class="m">Methods</th><th class="a">Attributes</th><th>Type</th><th class="p">Properties</th></tr>|; |
my $table = qq|<table class="frey-introspect"><tr><th class="m">Methods</th><th class="a">Attributes</th><th>Type</th><th class="p">Properties</th></tr>|; |
279 |
|
|
280 |
my $runnable = join("\n", |
my $runnable = join("\n", |
281 |
map { |
map { |
282 |
$introspect->{runnable}->{$_}++; |
$introspect->{runnable}->{$_} = {}; |
283 |
my $short = $_; |
my $short = $_; |
284 |
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
285 |
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
286 |
} $self->class_runnable( $class ) |
} $self->class_runnable( $class ) |
287 |
); |
); |
288 |
$runnable = " runnable: $runnable" if $runnable; |
$runnable = "Runnable: $runnable" if $runnable; |
|
|
|
|
$self->store( $introspect_path, $introspect ); |
|
|
|
|
|
$self->title( $class ); |
|
289 |
|
|
290 |
my $has_tests = ''; |
my $has_tests = ''; |
291 |
my @tests = grep { defined $_ } $self->has_tests; |
my @tests = grep { defined $_ } $self->has_tests; |
292 |
if ( @tests ) { |
if ( @tests ) { |
293 |
$has_tests = |
$has_tests = |
294 |
'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
'Test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
295 |
join("\n", map { |
join("\n", map { |
296 |
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
297 |
} @tests ); |
} @tests ); |
298 |
|
$introspect->{tests} = [ @tests ], |
299 |
|
} |
300 |
|
|
301 |
|
my $includes = ''; |
302 |
|
if ( my $inc = $self->includes ) { |
303 |
|
$introspect->{includes} = $inc; |
304 |
|
foreach my $type ( keys %$inc ) { |
305 |
|
$includes |
306 |
|
.= ucfirst($type) |
307 |
|
. qq|: | |
308 |
|
. join("\n", |
309 |
|
map { |
310 |
|
qq|<a target="$_" href="/$_">$_</a>| |
311 |
|
} @{ |
312 |
|
$inc->{$type} |
313 |
|
} |
314 |
|
) |
315 |
|
; |
316 |
|
} |
317 |
} |
} |
318 |
|
|
319 |
return join("\n", |
$self->store( $introspect_path, $introspect ); |
320 |
qq|<h1>$class</h1>|, |
|
321 |
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
$self->add_css(qq| |
322 |
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
.right { |
323 |
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
position: fixed; |
324 |
$has_tests, |
top: 1em; |
325 |
qq|$table\n$pod\n</div>\n|, |
right: 1em; |
326 |
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
z-index: 10; |
327 |
|
background: #fff; |
328 |
|
padding: 0.2em; |
329 |
|
border: 1px dashed #ee8; |
330 |
|
} |
331 |
|
|); |
332 |
|
|
333 |
|
my $right = join('<br>', |
334 |
|
grep { $_ } ( |
335 |
|
$runnable, |
336 |
|
$has_tests, |
337 |
|
( $pod ? qq|<a class="frey-skip" style="float: left;" href="#___top" title="Skip to POD" >pod</a>| : '' ) . ' ' . |
338 |
|
( $source ? qq|<a class="frey-skip" style="float: right;" href="#source" title="Skip to source" >source</a>| : '' ) |
339 |
|
) |
340 |
); |
); |
341 |
|
|
342 |
|
return |
343 |
|
qq| |
344 |
|
<h1>$class</h1> |
345 |
|
<div class="frey-introspect"> |
346 |
|
$superclasses $roles |
347 |
|
<br>$includes |
348 |
|
</div> |
349 |
|
<div class="right"> |
350 |
|
$right |
351 |
|
</div> |
352 |
|
$table |
353 |
|
$pod |
354 |
|
</div> |
355 |
|
|
356 |
|
<h1>Source</h1><a name="source"></a> |
357 |
|
<div class="frey-source">$source</div> |
358 |
|
| |
359 |
|
; |
360 |
} |
} |
361 |
|
|
362 |
=head1 SEE ALSO |
=head1 SEE ALSO |