| 1 |
package Frey::Introspect; |
| 2 |
|
| 3 |
use Moose; |
| 4 |
use Carp; |
| 5 |
#use Moose::Meta::Role; |
| 6 |
#use Moose::Meta::Class; |
| 7 |
use Data::Dump qw/dump/; |
| 8 |
use File::Slurp; |
| 9 |
use List::Util; |
| 10 |
|
| 11 |
use PPI; |
| 12 |
use PPI::HTML; |
| 13 |
|
| 14 |
use lib 'lib'; |
| 15 |
use Frey::Pod; |
| 16 |
|
| 17 |
extends 'Frey::PPI'; |
| 18 |
with 'Frey::Web', 'Frey::Storage'; |
| 19 |
|
| 20 |
=head1 DESCRIPTION |
| 21 |
|
| 22 |
Provide introspection on any perl class installed on system |
| 23 |
|
| 24 |
=cut |
| 25 |
|
| 26 |
has 'class' => ( |
| 27 |
is => 'rw', |
| 28 |
isa => 'Str', |
| 29 |
required => 1, |
| 30 |
); |
| 31 |
|
| 32 |
=head2 joose |
| 33 |
|
| 34 |
my $js = $o->joose; |
| 35 |
|
| 36 |
=cut |
| 37 |
|
| 38 |
sub joose { |
| 39 |
my ($self) = @_; |
| 40 |
|
| 41 |
my ( $meta, $is_role ) = $self->class_meta; |
| 42 |
|
| 43 |
if ( ! $is_role ) { |
| 44 |
my @superclasses = map{ $_->meta->name } |
| 45 |
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
| 46 |
warn "superclasses ",dump( @superclasses ) if $self->debug; |
| 47 |
} |
| 48 |
|
| 49 |
my $out; |
| 50 |
|
| 51 |
my ( $m, $c ) = split(/::/, $self->class, 2); |
| 52 |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
| 53 |
|
| 54 |
$c ||= ''; |
| 55 |
|
| 56 |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
| 57 |
|
| 58 |
foreach ( $meta->get_attribute_list ) { |
| 59 |
$out .= "\t\t\t$_: {\n"; |
| 60 |
|
| 61 |
my $attr = $meta->get_attribute($_); |
| 62 |
my $is = eval { $attr->_is_metadata; }; |
| 63 |
return if $@; |
| 64 |
|
| 65 |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
| 66 |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
| 67 |
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
| 68 |
$out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME |
| 69 |
|
| 70 |
if( defined(my $isa = $attr->_isa_metadata) ){ |
| 71 |
if( blessed $isa ){ |
| 72 |
while( blessed $isa ){ |
| 73 |
$isa = $isa->name; |
| 74 |
} |
| 75 |
} |
| 76 |
$isa =~ s/\s+\|\s+undef//gi; |
| 77 |
$out .= "\t\t\t\tisa: Moose.$isa,\n"; |
| 78 |
} |
| 79 |
|
| 80 |
|
| 81 |
$out .= "\t\t\t},\n"; |
| 82 |
|
| 83 |
} |
| 84 |
|
| 85 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
| 86 |
classMethods: { |
| 87 |
renderHTML: function () { |
| 88 |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
| 89 |
},\n"; |
| 90 |
|
| 91 |
$out .= "\t\t},\n"; |
| 92 |
|
| 93 |
$out .= "\t}),\n"; |
| 94 |
|
| 95 |
$out =~ s/,\n$/\n/; |
| 96 |
$out .= "});\n"; |
| 97 |
|
| 98 |
$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; |
| 99 |
|
| 100 |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
| 101 |
|
| 102 |
# print $out; |
| 103 |
my $path = "static/blib/$filename"; |
| 104 |
write_file( $path, $out ); |
| 105 |
warn "# created $path\n"; |
| 106 |
|
| 107 |
return $out; |
| 108 |
} |
| 109 |
|
| 110 |
sub as_markup { |
| 111 |
my ( $self ) = @_; |
| 112 |
|
| 113 |
my ( $meta, $is_role ) = $self->class_meta; |
| 114 |
|
| 115 |
my $class = $self->class; |
| 116 |
$self->title( $class ); |
| 117 |
|
| 118 |
my $introspect_path = "var/introspect/$class.yaml"; |
| 119 |
$self->mkbasepath( $introspect_path ); |
| 120 |
my $introspect; # FIXME update with = $self->load( $introspect_path ); |
| 121 |
|
| 122 |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
| 123 |
if ( ! $is_role ) { |
| 124 |
if ( $meta->superclasses ) { |
| 125 |
$superclasses = 'Superclasses: ' . |
| 126 |
join(', ', |
| 127 |
map { |
| 128 |
my $name = $_->meta->name; |
| 129 |
$introspect->{superclass}->{$name} = {}; |
| 130 |
|
| 131 |
qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| . |
| 132 |
$self->dropdown( qq|<sup>?</sup>|, $_->meta ) |
| 133 |
} |
| 134 |
#grep { $_ ne 'Moose::Object' } |
| 135 |
$meta->superclasses |
| 136 |
); |
| 137 |
} |
| 138 |
} |
| 139 |
|
| 140 |
my $method_from_role; |
| 141 |
my $attribute_from_role; |
| 142 |
|
| 143 |
if ( $meta->can('roles') ) { |
| 144 |
my $role_nr = 1; |
| 145 |
$roles = join(' ', |
| 146 |
grep { ! m/\Q$class\E/ } # skip me |
| 147 |
map { |
| 148 |
my $r = ''; |
| 149 |
foreach my $name ( split(/\|/, $_->name) ) { |
| 150 |
$introspect->{roles}->{$name} = {}; |
| 151 |
$method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
| 152 |
$attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
| 153 |
|
| 154 |
$r .= |
| 155 |
qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| |
| 156 |
# . qq|<sup>| . $self->dropdown( $role_nr++, $name->meta ) . qq|</sup>| |
| 157 |
. $self->dropdown( |
| 158 |
qq|<sup>| . $role_nr++ . qq|</sup>|, |
| 159 |
$name->meta |
| 160 |
) |
| 161 |
; |
| 162 |
} |
| 163 |
$r; |
| 164 |
} |
| 165 |
$meta->calculate_all_roles |
| 166 |
); |
| 167 |
$roles = qq|with roles: $roles| if $roles; |
| 168 |
} |
| 169 |
warn "# method_from_role ",dump( $method_from_role ); |
| 170 |
|
| 171 |
my @methods; |
| 172 |
@methods = map { |
| 173 |
my $name = $_; |
| 174 |
if ( $method_from_role->{$name} ) { |
| 175 |
my ( $role_name, $nr ) = each %{ $method_from_role->{$name} }; |
| 176 |
$introspect->{methods}->{$name}->{role} = $role_name; |
| 177 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
| 178 |
} else { |
| 179 |
$introspect->{methods}->{$name} = {}; |
| 180 |
} |
| 181 |
qq|<td class="m">$name</td>| |
| 182 |
} sort { |
| 183 |
lc($a) cmp lc($b) |
| 184 |
} $self->class_methods( $class ); |
| 185 |
|
| 186 |
my @attributes; |
| 187 |
if ( $meta->get_attribute_list ) { |
| 188 |
@attributes = map { |
| 189 |
my $name = $_; |
| 190 |
$introspect->{attribute}->{$name} = {}; |
| 191 |
my $html_name = $name; |
| 192 |
my $attr = $meta->get_attribute($name); |
| 193 |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
| 194 |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
| 195 |
|
| 196 |
my ( $title, $properties ) = ( '', '' ); |
| 197 |
if ( $attr->can('is_required') && $attr->is_required ) { |
| 198 |
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ); |
| 199 |
$introspect->{attribute}->{$name}->{required} = 1; |
| 200 |
} |
| 201 |
|
| 202 |
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/ ) { |
| 203 |
my $getter; |
| 204 |
|
| 205 |
$getter = $check; |
| 206 |
$getter =~ s/^has_//; |
| 207 |
|
| 208 |
if ( $attr->can($check) && $attr->$check ) { |
| 209 |
$properties .= $check; |
| 210 |
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
| 211 |
my $v = $attr->$getter; |
| 212 |
$properties .= ref($v) |
| 213 |
? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter ) |
| 214 |
: qq| <code>$v</code>| |
| 215 |
; |
| 216 |
} |
| 217 |
$properties .= ' '; |
| 218 |
} |
| 219 |
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
| 220 |
|
| 221 |
if ( $attribute_from_role->{$name} ) { |
| 222 |
my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; |
| 223 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
| 224 |
} |
| 225 |
|
| 226 |
if ( my $doc = eval { $attr->documentation } ) { |
| 227 |
$properties = qq| |
| 228 |
$properties |
| 229 |
<span class="documentation">$doc</span> |
| 230 |
|; |
| 231 |
$self->add_css(qq| |
| 232 |
span.documentation { |
| 233 |
background: #eee; |
| 234 |
padding: 0.25em; |
| 235 |
float: left; |
| 236 |
clear: left; |
| 237 |
} |
| 238 |
|); |
| 239 |
$introspect->{action}->{$name}->{documentation} = $doc; |
| 240 |
} |
| 241 |
|
| 242 |
qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>| |
| 243 |
} sort $meta->get_attribute_list |
| 244 |
} |
| 245 |
|
| 246 |
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>|; |
| 247 |
while ( @methods || @attributes ) { |
| 248 |
my ($m,$a) = ( shift @methods, shift @attributes ); |
| 249 |
$m ||= '<td></td>'; |
| 250 |
$a ||= '<td></td>'; |
| 251 |
$table .= qq|<tr>$m$a</tr>|; |
| 252 |
} |
| 253 |
$table .= qq|</table>|; |
| 254 |
|
| 255 |
my $path = $self->class_path( $class ); |
| 256 |
|
| 257 |
my ( $pod_toc, $pod ) = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
| 258 |
return $pod_toc . $pod if $path =~ m{\.pod}; |
| 259 |
|
| 260 |
warn "# ", $pod_toc ? 'toc' : '', ' ', $pod ? 'pod' : ''; |
| 261 |
|
| 262 |
my $Document = PPI::Document->new( $path ); |
| 263 |
|
| 264 |
# Create a reusable syntax highlighter |
| 265 |
my $Highlight = PPI::HTML->new( |
| 266 |
line_numbers => 1, |
| 267 |
# page => 1, |
| 268 |
# colors => { |
| 269 |
# line_number => '#CCCCCC', |
| 270 |
# number => '#990000', |
| 271 |
# }, |
| 272 |
); |
| 273 |
|
| 274 |
# Spit out the HTML |
| 275 |
my $source = $Highlight->html( $Document ); |
| 276 |
|
| 277 |
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
| 278 |
|
| 279 |
# strip page html |
| 280 |
# $source =~ s{^.*<body[^>]+>}{}s; |
| 281 |
# $source =~ s{</body.*$}{}s; |
| 282 |
|
| 283 |
my $runnable = join("</dd><dd>", |
| 284 |
map { |
| 285 |
$introspect->{runnable}->{$_} = {}; |
| 286 |
my $short = $_; |
| 287 |
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
| 288 |
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
| 289 |
} $self->class_runnable( $class ) |
| 290 |
); |
| 291 |
$runnable = "<dt>runnable</dt><dd>$runnable</dd>" if $runnable; |
| 292 |
|
| 293 |
my $has_tests = ''; |
| 294 |
my @tests = sort { lc($a) cmp lc($b) } grep { defined $_ } $self->has_tests; |
| 295 |
if ( @tests ) { |
| 296 |
$has_tests |
| 297 |
= qq|<dt>test| |
| 298 |
. ( $#tests > 0 ? 's' : '' ) |
| 299 |
. qq|<dt><dd>| |
| 300 |
. join("</dd><dd>", map { |
| 301 |
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
| 302 |
} @tests ) |
| 303 |
. qq|</dd>| |
| 304 |
; |
| 305 |
$introspect->{tests} = [ @tests ], |
| 306 |
} |
| 307 |
|
| 308 |
my $includes = ''; |
| 309 |
if ( my $inc = $self->includes ) { |
| 310 |
$introspect->{includes} = $inc; |
| 311 |
foreach my $type ( keys %$inc ) { |
| 312 |
$includes |
| 313 |
.= ucfirst($type) |
| 314 |
. qq|: | |
| 315 |
. join("\n", |
| 316 |
map { |
| 317 |
qq|<a target="$_" href="/$_">$_</a>| |
| 318 |
} @{ |
| 319 |
$inc->{$type} |
| 320 |
} |
| 321 |
) |
| 322 |
; |
| 323 |
} |
| 324 |
} |
| 325 |
|
| 326 |
$self->store( $introspect_path, $introspect ); |
| 327 |
|
| 328 |
$self->add_css(qq| |
| 329 |
.frey-introspect-right { |
| 330 |
position: fixed; |
| 331 |
top: 1em; |
| 332 |
right: 1em; |
| 333 |
z-index: 10; |
| 334 |
background: #ffc; |
| 335 |
padding: 0.5em; |
| 336 |
width: 20%; |
| 337 |
font-size: 80%; |
| 338 |
} |
| 339 |
.frey-introspect-right dl dd { |
| 340 |
margin-left: 1em; |
| 341 |
} |
| 342 |
|
| 343 |
/* fix pod */ |
| 344 |
.frey-introspect-right dd ul { |
| 345 |
padding-left: 0; |
| 346 |
} |
| 347 |
.frey-introspect-right dl ul > li { |
| 348 |
list-style: none; |
| 349 |
} |
| 350 |
|); |
| 351 |
|
| 352 |
my $has_pod = qq| |
| 353 |
<dt><a href="#___top" title="Skip to POD">pod</a></dt> |
| 354 |
<dd>$pod_toc</dd> |
| 355 |
| if $pod_toc; |
| 356 |
|
| 357 |
my $has_source = qq| |
| 358 |
<dt><a href="#source" title="Skip to source">source</a></dt> |
| 359 |
| if $source; |
| 360 |
|
| 361 |
my $right = qq| |
| 362 |
<dl> |
| 363 |
$runnable |
| 364 |
$has_tests |
| 365 |
$has_pod |
| 366 |
$has_source |
| 367 |
</dl> |
| 368 |
|; |
| 369 |
|
| 370 |
|
| 371 |
return |
| 372 |
qq| |
| 373 |
<h1>$class</h1> |
| 374 |
<div class="frey-introspect"> |
| 375 |
$superclasses $roles |
| 376 |
<br>$includes |
| 377 |
</div> |
| 378 |
<div class="frey-introspect-right"> |
| 379 |
$right |
| 380 |
</div> |
| 381 |
$table |
| 382 |
$pod |
| 383 |
</div> |
| 384 |
|
| 385 |
<h1>Source</h1><a name="source"></a> |
| 386 |
<div class="frey-source">$source</div> |
| 387 |
| |
| 388 |
; |
| 389 |
} |
| 390 |
|
| 391 |
=head1 SEE ALSO |
| 392 |
|
| 393 |
L<MooseX::AutoDoc> on which this code is based |
| 394 |
|
| 395 |
=cut |
| 396 |
|
| 397 |
__PACKAGE__->meta->make_immutable; |
| 398 |
no Moose; |
| 399 |
|
| 400 |
1; |
Parent Directory
| 
Revision Log