1 |
dpavlin |
49 |
package Frey::Introspect; |
2 |
|
|
|
3 |
|
|
use Moose; |
4 |
|
|
use Carp; |
5 |
dpavlin |
100 |
#use Moose::Meta::Role; |
6 |
|
|
#use Moose::Meta::Class; |
7 |
dpavlin |
49 |
use Data::Dump qw/dump/; |
8 |
|
|
use File::Slurp; |
9 |
dpavlin |
51 |
use List::Util; |
10 |
dpavlin |
49 |
|
11 |
dpavlin |
380 |
use PPI; |
12 |
|
|
use PPI::HTML; |
13 |
|
|
|
14 |
dpavlin |
733 |
use lib 'lib'; |
15 |
dpavlin |
631 |
use Frey::Pod; |
16 |
|
|
|
17 |
dpavlin |
496 |
extends 'Frey::PPI'; |
18 |
dpavlin |
100 |
with 'Frey::Web'; |
19 |
dpavlin |
602 |
with 'Frey::Storage'; |
20 |
dpavlin |
49 |
|
21 |
dpavlin |
270 |
has 'class' => ( |
22 |
dpavlin |
49 |
is => 'rw', |
23 |
|
|
isa => 'Str', |
24 |
|
|
required => 1, |
25 |
|
|
); |
26 |
|
|
|
27 |
dpavlin |
53 |
=head2 joose |
28 |
|
|
|
29 |
dpavlin |
137 |
my $js = $o->joose; |
30 |
dpavlin |
53 |
|
31 |
|
|
=cut |
32 |
|
|
|
33 |
|
|
sub joose { |
34 |
|
|
my ($self) = @_; |
35 |
|
|
|
36 |
dpavlin |
308 |
my ( $meta, $is_role ) = $self->class_meta; |
37 |
dpavlin |
53 |
|
38 |
|
|
if ( ! $is_role ) { |
39 |
dpavlin |
50 |
my @superclasses = map{ $_->meta->name } |
40 |
|
|
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
41 |
dpavlin |
100 |
warn "superclasses ",dump( @superclasses ) if $self->debug; |
42 |
dpavlin |
50 |
} |
43 |
dpavlin |
49 |
|
44 |
|
|
my $out; |
45 |
|
|
|
46 |
dpavlin |
270 |
my ( $m, $c ) = split(/::/, $self->class, 2); |
47 |
dpavlin |
51 |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
48 |
dpavlin |
49 |
|
49 |
dpavlin |
137 |
$c ||= ''; |
50 |
|
|
|
51 |
dpavlin |
49 |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
52 |
|
|
|
53 |
dpavlin |
137 |
foreach ( $meta->get_attribute_list ) { |
54 |
dpavlin |
49 |
$out .= "\t\t\t$_: {\n"; |
55 |
|
|
|
56 |
dpavlin |
137 |
my $attr = $meta->get_attribute($_); |
57 |
dpavlin |
50 |
my $is = $attr->_is_metadata; |
58 |
|
|
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
59 |
|
|
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
60 |
|
|
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
61 |
|
|
$out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME |
62 |
|
|
|
63 |
|
|
if( defined(my $isa = $attr->_isa_metadata) ){ |
64 |
|
|
if( blessed $isa ){ |
65 |
|
|
while( blessed $isa ){ |
66 |
|
|
$isa = $isa->name; |
67 |
|
|
} |
68 |
|
|
} |
69 |
|
|
$isa =~ s/\s+\|\s+undef//gi; |
70 |
|
|
$out .= "\t\t\t\tisa: Moose.$isa,\n"; |
71 |
|
|
} |
72 |
|
|
|
73 |
|
|
|
74 |
dpavlin |
49 |
$out .= "\t\t\t},\n"; |
75 |
|
|
|
76 |
|
|
} |
77 |
|
|
|
78 |
dpavlin |
51 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
79 |
|
|
classMethods: { |
80 |
|
|
renderHTML: function () { |
81 |
dpavlin |
292 |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
82 |
dpavlin |
51 |
},\n"; |
83 |
|
|
|
84 |
dpavlin |
49 |
$out .= "\t\t},\n"; |
85 |
|
|
|
86 |
|
|
$out .= "\t}),\n"; |
87 |
dpavlin |
50 |
|
88 |
|
|
$out =~ s/,\n$/\n/; |
89 |
dpavlin |
49 |
$out .= "});\n"; |
90 |
|
|
|
91 |
dpavlin |
270 |
$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; |
92 |
dpavlin |
49 |
|
93 |
dpavlin |
137 |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
94 |
dpavlin |
49 |
|
95 |
dpavlin |
51 |
# print $out; |
96 |
dpavlin |
49 |
my $path = "static/blib/$filename"; |
97 |
|
|
write_file( $path, $out ); |
98 |
|
|
warn "# created $path\n"; |
99 |
dpavlin |
51 |
|
100 |
|
|
return $out; |
101 |
dpavlin |
49 |
} |
102 |
|
|
|
103 |
dpavlin |
455 |
sub as_markup { |
104 |
dpavlin |
269 |
my ( $self ) = @_; |
105 |
dpavlin |
53 |
|
106 |
dpavlin |
160 |
$self->add_head( 'static/introspect.css' ); |
107 |
dpavlin |
139 |
|
108 |
dpavlin |
308 |
my ( $meta, $is_role ) = $self->class_meta; |
109 |
dpavlin |
53 |
|
110 |
dpavlin |
270 |
my $class = $self->class; |
111 |
dpavlin |
802 |
$self->title( $class ); |
112 |
dpavlin |
54 |
|
113 |
dpavlin |
602 |
my $introspect_path = "var/introspect/$class.yaml"; |
114 |
|
|
$self->mkbasepath( $introspect_path ); |
115 |
dpavlin |
735 |
my $introspect; # FIXME update with = $self->load( $introspect_path ); |
116 |
dpavlin |
602 |
|
117 |
dpavlin |
310 |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
118 |
|
|
if ( ! $is_role ) { |
119 |
|
|
if ( $meta->superclasses ) { |
120 |
|
|
$superclasses = 'Superclasses: ' . |
121 |
|
|
join(', ', |
122 |
|
|
map { |
123 |
|
|
my $name = $_->meta->name; |
124 |
dpavlin |
733 |
$introspect->{superclass}->{$name} = {}; |
125 |
dpavlin |
543 |
$self->dropdown( $name, $_->meta ) |
126 |
dpavlin |
310 |
} |
127 |
|
|
#grep { $_ ne 'Moose::Object' } |
128 |
|
|
$meta->superclasses |
129 |
|
|
); |
130 |
|
|
} |
131 |
|
|
} |
132 |
|
|
|
133 |
dpavlin |
733 |
my $method_from_role; |
134 |
|
|
my $attribute_from_role; |
135 |
dpavlin |
310 |
|
136 |
|
|
if ( $meta->can('roles') ) { |
137 |
|
|
my $role_nr = 1; |
138 |
|
|
$roles = join(' ', |
139 |
|
|
grep { ! m/\Q$class\E/ } # skip me |
140 |
|
|
map { |
141 |
|
|
my $name = $_->name; |
142 |
dpavlin |
733 |
$introspect->{roles}->{$name} = {}; |
143 |
|
|
$method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
144 |
|
|
$attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
145 |
dpavlin |
543 |
$self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|; |
146 |
dpavlin |
310 |
} |
147 |
|
|
$meta->calculate_all_roles |
148 |
|
|
); |
149 |
|
|
$roles = qq| with roles: $roles| if $roles; |
150 |
|
|
} |
151 |
dpavlin |
733 |
warn "# method_from_role ",dump( $method_from_role ); |
152 |
dpavlin |
310 |
|
153 |
dpavlin |
269 |
my @methods; |
154 |
dpavlin |
310 |
@methods = map { |
155 |
dpavlin |
313 |
my $name = $_; |
156 |
dpavlin |
733 |
if ( $method_from_role->{$name} ) { |
157 |
|
|
my ( $role_name, $nr ) = each %{ $method_from_role->{$name} }; |
158 |
|
|
$introspect->{methods}->{$name}->{role} = $role_name; |
159 |
dpavlin |
313 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
160 |
dpavlin |
733 |
} else { |
161 |
|
|
$introspect->{methods}->{$name} = {}; |
162 |
dpavlin |
310 |
} |
163 |
dpavlin |
313 |
qq|<td class="m">$name</td>| |
164 |
dpavlin |
884 |
} sort { |
165 |
|
|
lc($a) cmp lc($b) |
166 |
|
|
} $self->class_methods( $class ); |
167 |
dpavlin |
53 |
|
168 |
dpavlin |
269 |
my @attributes; |
169 |
|
|
if ( $meta->get_attribute_list ) { |
170 |
dpavlin |
409 |
@attributes = map { |
171 |
dpavlin |
313 |
my $name = $_; |
172 |
dpavlin |
733 |
$introspect->{attribute}->{$name} = {}; |
173 |
dpavlin |
582 |
my $html_name = $name; |
174 |
dpavlin |
313 |
my $attr = $meta->get_attribute($name); |
175 |
dpavlin |
416 |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
176 |
dpavlin |
393 |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
177 |
dpavlin |
582 |
|
178 |
|
|
my ( $title, $properties ) = ( '', '' ); |
179 |
dpavlin |
733 |
if ( $attr->can('is_required') && $attr->is_required ) { |
180 |
|
|
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ); |
181 |
|
|
$introspect->{attribute}->{$name}->{required} = 1; |
182 |
|
|
} |
183 |
dpavlin |
582 |
|
184 |
|
|
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/ ) { |
185 |
dpavlin |
269 |
my $getter; |
186 |
|
|
|
187 |
|
|
$getter = $check; |
188 |
|
|
$getter =~ s/^has_//; |
189 |
|
|
|
190 |
dpavlin |
416 |
if ( $attr->can($check) && $attr->$check ) { |
191 |
dpavlin |
269 |
if ( $getter eq $check ) { |
192 |
dpavlin |
582 |
$properties .= "$check"; |
193 |
dpavlin |
269 |
} else { |
194 |
dpavlin |
543 |
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
195 |
dpavlin |
582 |
$properties .= $self->dropdown( $check, $attr->$getter ); |
196 |
dpavlin |
197 |
} |
197 |
|
|
} |
198 |
dpavlin |
582 |
$properties .= ' '; |
199 |
dpavlin |
269 |
} |
200 |
dpavlin |
416 |
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
201 |
dpavlin |
313 |
|
202 |
dpavlin |
733 |
if ( $attribute_from_role->{$name} ) { |
203 |
|
|
my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; |
204 |
dpavlin |
313 |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
205 |
|
|
} |
206 |
|
|
|
207 |
dpavlin |
735 |
if ( my $doc = eval { $attr->documentation } ) { |
208 |
|
|
$properties = qq| |
209 |
|
|
$properties |
210 |
|
|
<span class="documentation">$doc</span> |
211 |
|
|
|; |
212 |
|
|
$self->add_css(qq| |
213 |
|
|
span.documentation { |
214 |
|
|
background: #eee; |
215 |
|
|
padding: 0.25em; |
216 |
dpavlin |
736 |
float: left; |
217 |
|
|
clear: left; |
218 |
dpavlin |
735 |
} |
219 |
|
|
|); |
220 |
|
|
$introspect->{action}->{$name}->{documentation} = $doc; |
221 |
|
|
} |
222 |
dpavlin |
582 |
|
223 |
|
|
qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>| |
224 |
dpavlin |
727 |
} sort $meta->get_attribute_list |
225 |
dpavlin |
269 |
} |
226 |
dpavlin |
54 |
|
227 |
dpavlin |
312 |
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>|; |
228 |
dpavlin |
269 |
while ( @methods || @attributes ) { |
229 |
|
|
my ($m,$a) = ( shift @methods, shift @attributes ); |
230 |
|
|
$m ||= '<td></td>'; |
231 |
|
|
$a ||= '<td></td>'; |
232 |
|
|
$table .= qq|<tr>$m$a</tr>|; |
233 |
|
|
} |
234 |
|
|
$table .= qq|</table>|; |
235 |
|
|
|
236 |
dpavlin |
688 |
my $path = $self->class_path( $class ); |
237 |
|
|
|
238 |
dpavlin |
635 |
my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
239 |
dpavlin |
688 |
return $pod if $path =~ m{\.pod}; |
240 |
dpavlin |
134 |
|
241 |
dpavlin |
406 |
my $Document = PPI::Document->new( $path ); |
242 |
dpavlin |
380 |
|
243 |
|
|
# Create a reusable syntax highlighter |
244 |
|
|
my $Highlight = PPI::HTML->new( |
245 |
dpavlin |
406 |
line_numbers => 1, |
246 |
dpavlin |
380 |
# page => 1, |
247 |
|
|
# colors => { |
248 |
|
|
# line_number => '#CCCCCC', |
249 |
|
|
# number => '#990000', |
250 |
|
|
# }, |
251 |
|
|
); |
252 |
|
|
|
253 |
|
|
# Spit out the HTML |
254 |
|
|
my $source = $Highlight->html( $Document ); |
255 |
|
|
|
256 |
dpavlin |
407 |
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
257 |
dpavlin |
406 |
|
258 |
|
|
# strip page html |
259 |
dpavlin |
380 |
# $source =~ s{^.*<body[^>]+>}{}s; |
260 |
|
|
# $source =~ s{</body.*$}{}s; |
261 |
|
|
|
262 |
dpavlin |
409 |
my $runnable = join("\n", |
263 |
dpavlin |
458 |
map { |
264 |
dpavlin |
733 |
$introspect->{runnable}->{$_} = {}; |
265 |
dpavlin |
662 |
my $short = $_; |
266 |
|
|
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
267 |
|
|
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
268 |
dpavlin |
458 |
} $self->class_runnable( $class ) |
269 |
dpavlin |
409 |
); |
270 |
dpavlin |
717 |
$runnable = "<br>run: $runnable" if $runnable; |
271 |
dpavlin |
128 |
|
272 |
dpavlin |
602 |
$self->store( $introspect_path, $introspect ); |
273 |
|
|
|
274 |
dpavlin |
496 |
my $has_tests = ''; |
275 |
dpavlin |
635 |
my @tests = grep { defined $_ } $self->has_tests; |
276 |
|
|
if ( @tests ) { |
277 |
dpavlin |
496 |
$has_tests = |
278 |
|
|
'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
279 |
|
|
join("\n", map { |
280 |
dpavlin |
534 |
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
281 |
dpavlin |
496 |
} @tests ); |
282 |
|
|
} |
283 |
|
|
|
284 |
dpavlin |
418 |
return join("\n", |
285 |
|
|
qq|<h1>$class</h1>|, |
286 |
|
|
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
287 |
dpavlin |
717 |
$has_tests, |
288 |
dpavlin |
418 |
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
289 |
|
|
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
290 |
|
|
qq|$table\n$pod\n</div>\n|, |
291 |
|
|
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
292 |
|
|
); |
293 |
dpavlin |
53 |
} |
294 |
|
|
|
295 |
dpavlin |
49 |
=head1 SEE ALSO |
296 |
|
|
|
297 |
|
|
L<MooseX::AutoDoc> on which this code is based |
298 |
|
|
|
299 |
|
|
=cut |
300 |
|
|
|
301 |
|
|
1; |