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