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'; |
19 |
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' => ( |
28 |
is => 'rw', |
29 |
isa => 'Str', |
30 |
required => 1, |
31 |
); |
32 |
|
33 |
=head2 joose |
34 |
|
35 |
my $js = $o->joose; |
36 |
|
37 |
=cut |
38 |
|
39 |
sub joose { |
40 |
my ($self) = @_; |
41 |
|
42 |
my ( $meta, $is_role ) = $self->class_meta; |
43 |
|
44 |
if ( ! $is_role ) { |
45 |
my @superclasses = map{ $_->meta->name } |
46 |
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
47 |
warn "superclasses ",dump( @superclasses ) if $self->debug; |
48 |
} |
49 |
|
50 |
my $out; |
51 |
|
52 |
my ( $m, $c ) = split(/::/, $self->class, 2); |
53 |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
54 |
|
55 |
$c ||= ''; |
56 |
|
57 |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
58 |
|
59 |
foreach ( $meta->get_attribute_list ) { |
60 |
$out .= "\t\t\t$_: {\n"; |
61 |
|
62 |
my $attr = $meta->get_attribute($_); |
63 |
my $is = $attr->_is_metadata; |
64 |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
65 |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
66 |
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
67 |
$out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME |
68 |
|
69 |
if( defined(my $isa = $attr->_isa_metadata) ){ |
70 |
if( blessed $isa ){ |
71 |
while( blessed $isa ){ |
72 |
$isa = $isa->name; |
73 |
} |
74 |
} |
75 |
$isa =~ s/\s+\|\s+undef//gi; |
76 |
$out .= "\t\t\t\tisa: Moose.$isa,\n"; |
77 |
} |
78 |
|
79 |
|
80 |
$out .= "\t\t\t},\n"; |
81 |
|
82 |
} |
83 |
|
84 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
85 |
classMethods: { |
86 |
renderHTML: function () { |
87 |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
88 |
},\n"; |
89 |
|
90 |
$out .= "\t\t},\n"; |
91 |
|
92 |
$out .= "\t}),\n"; |
93 |
|
94 |
$out =~ s/,\n$/\n/; |
95 |
$out .= "});\n"; |
96 |
|
97 |
$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; |
98 |
|
99 |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
100 |
|
101 |
# print $out; |
102 |
my $path = "static/blib/$filename"; |
103 |
write_file( $path, $out ); |
104 |
warn "# created $path\n"; |
105 |
|
106 |
return $out; |
107 |
} |
108 |
|
109 |
sub as_markup { |
110 |
my ( $self ) = @_; |
111 |
|
112 |
$self->add_head( 'static/introspect.css' ); |
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 = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
255 |
return $pod if $path =~ m{\.pod}; |
256 |
|
257 |
my $Document = PPI::Document->new( $path ); |
258 |
|
259 |
# Create a reusable syntax highlighter |
260 |
my $Highlight = PPI::HTML->new( |
261 |
line_numbers => 1, |
262 |
# page => 1, |
263 |
# colors => { |
264 |
# line_number => '#CCCCCC', |
265 |
# number => '#990000', |
266 |
# }, |
267 |
); |
268 |
|
269 |
# Spit out the HTML |
270 |
my $source = $Highlight->html( $Document ); |
271 |
|
272 |
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
273 |
|
274 |
# strip page html |
275 |
# $source =~ s{^.*<body[^>]+>}{}s; |
276 |
# $source =~ s{</body.*$}{}s; |
277 |
|
278 |
my $runnable = join("\n", |
279 |
map { |
280 |
$introspect->{runnable}->{$_} = {}; |
281 |
my $short = $_; |
282 |
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
283 |
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
284 |
} $self->class_runnable( $class ) |
285 |
); |
286 |
$runnable = "Runnable: $runnable" if $runnable; |
287 |
|
288 |
my $has_tests = ''; |
289 |
my @tests = grep { defined $_ } $self->has_tests; |
290 |
if ( @tests ) { |
291 |
$has_tests = |
292 |
'Test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
293 |
join("\n", map { |
294 |
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
295 |
} @tests ); |
296 |
$introspect->{tests} = [ @tests ], |
297 |
} |
298 |
|
299 |
my $includes = ''; |
300 |
if ( my $inc = $self->includes ) { |
301 |
$introspect->{includes} = $inc; |
302 |
foreach my $type ( keys %$inc ) { |
303 |
$includes |
304 |
.= ucfirst($type) |
305 |
. qq|: | |
306 |
. join("\n", |
307 |
map { |
308 |
qq|<a target="$_" href="/$_">$_</a>| |
309 |
} @{ |
310 |
$inc->{$type} |
311 |
} |
312 |
) |
313 |
; |
314 |
} |
315 |
} |
316 |
|
317 |
$self->store( $introspect_path, $introspect ); |
318 |
|
319 |
return join("\n", |
320 |
qq|<h1>$class</h1>|, |
321 |
qq|<div class="frey-introspect"> |
322 |
$superclasses $roles |
323 |
<br> |
324 |
$includes |
325 |
<br> |
326 |
$runnable |
327 |
|, |
328 |
$has_tests, |
329 |
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
330 |
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
331 |
qq|$table\n$pod\n</div>\n|, |
332 |
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
333 |
); |
334 |
} |
335 |
|
336 |
=head1 SEE ALSO |
337 |
|
338 |
L<MooseX::AutoDoc> on which this code is based |
339 |
|
340 |
=cut |
341 |
|
342 |
1; |