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 |
55 |
use lib 'lib'; |
15 |
dpavlin |
53 |
|
16 |
dpavlin |
308 |
extends 'Frey::ClassLoader'; |
17 |
dpavlin |
100 |
with 'Frey::Web'; |
18 |
dpavlin |
49 |
|
19 |
dpavlin |
270 |
has 'class' => ( |
20 |
dpavlin |
49 |
is => 'rw', |
21 |
|
|
isa => 'Str', |
22 |
|
|
required => 1, |
23 |
|
|
); |
24 |
|
|
|
25 |
dpavlin |
51 |
has 'path' => ( |
26 |
|
|
is => 'rw', |
27 |
|
|
); |
28 |
|
|
|
29 |
dpavlin |
53 |
=head2 joose |
30 |
|
|
|
31 |
dpavlin |
137 |
my $js = $o->joose; |
32 |
dpavlin |
53 |
|
33 |
|
|
=cut |
34 |
|
|
|
35 |
|
|
sub joose { |
36 |
|
|
my ($self) = @_; |
37 |
|
|
|
38 |
dpavlin |
308 |
my ( $meta, $is_role ) = $self->class_meta; |
39 |
dpavlin |
53 |
|
40 |
|
|
if ( ! $is_role ) { |
41 |
dpavlin |
50 |
my @superclasses = map{ $_->meta->name } |
42 |
|
|
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
43 |
dpavlin |
100 |
warn "superclasses ",dump( @superclasses ) if $self->debug; |
44 |
dpavlin |
50 |
} |
45 |
dpavlin |
49 |
|
46 |
|
|
my $out; |
47 |
|
|
|
48 |
dpavlin |
270 |
my ( $m, $c ) = split(/::/, $self->class, 2); |
49 |
dpavlin |
51 |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
50 |
dpavlin |
49 |
|
51 |
dpavlin |
137 |
$c ||= ''; |
52 |
|
|
|
53 |
dpavlin |
49 |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
54 |
|
|
|
55 |
dpavlin |
137 |
foreach ( $meta->get_attribute_list ) { |
56 |
dpavlin |
49 |
$out .= "\t\t\t$_: {\n"; |
57 |
|
|
|
58 |
dpavlin |
137 |
my $attr = $meta->get_attribute($_); |
59 |
dpavlin |
50 |
my $is = $attr->_is_metadata; |
60 |
|
|
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
61 |
|
|
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
62 |
|
|
$out .= "\t\t\t\trequired: true,\n" if $attr->is_required; |
63 |
|
|
$out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME |
64 |
|
|
|
65 |
|
|
if( defined(my $isa = $attr->_isa_metadata) ){ |
66 |
|
|
if( blessed $isa ){ |
67 |
|
|
while( blessed $isa ){ |
68 |
|
|
$isa = $isa->name; |
69 |
|
|
} |
70 |
|
|
} |
71 |
|
|
$isa =~ s/\s+\|\s+undef//gi; |
72 |
|
|
$out .= "\t\t\t\tisa: Moose.$isa,\n"; |
73 |
|
|
} |
74 |
|
|
|
75 |
|
|
|
76 |
dpavlin |
49 |
$out .= "\t\t\t},\n"; |
77 |
|
|
|
78 |
|
|
} |
79 |
|
|
|
80 |
dpavlin |
51 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
81 |
|
|
classMethods: { |
82 |
|
|
renderHTML: function () { |
83 |
dpavlin |
292 |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
84 |
dpavlin |
51 |
},\n"; |
85 |
|
|
|
86 |
dpavlin |
49 |
$out .= "\t\t},\n"; |
87 |
|
|
|
88 |
|
|
$out .= "\t}),\n"; |
89 |
dpavlin |
50 |
|
90 |
|
|
$out =~ s/,\n$/\n/; |
91 |
dpavlin |
49 |
$out .= "});\n"; |
92 |
|
|
|
93 |
dpavlin |
270 |
$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; |
94 |
dpavlin |
49 |
|
95 |
dpavlin |
137 |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
96 |
dpavlin |
49 |
|
97 |
dpavlin |
51 |
# print $out; |
98 |
dpavlin |
49 |
my $path = "static/blib/$filename"; |
99 |
|
|
write_file( $path, $out ); |
100 |
|
|
warn "# created $path\n"; |
101 |
dpavlin |
51 |
$self->path( $path ); |
102 |
|
|
|
103 |
|
|
return $out; |
104 |
dpavlin |
49 |
} |
105 |
|
|
|
106 |
dpavlin |
53 |
=head1 OUTPUT GENERATION |
107 |
|
|
|
108 |
dpavlin |
269 |
=head2 markup |
109 |
dpavlin |
53 |
|
110 |
dpavlin |
269 |
$o->markup; |
111 |
dpavlin |
53 |
|
112 |
|
|
=cut |
113 |
|
|
|
114 |
dpavlin |
269 |
sub markup { |
115 |
|
|
my ( $self ) = @_; |
116 |
dpavlin |
53 |
|
117 |
dpavlin |
160 |
$self->add_head( 'static/introspect.css' ); |
118 |
dpavlin |
139 |
|
119 |
dpavlin |
308 |
my ( $meta, $is_role ) = $self->class_meta; |
120 |
dpavlin |
53 |
|
121 |
dpavlin |
270 |
my $class = $self->class; |
122 |
dpavlin |
54 |
|
123 |
dpavlin |
310 |
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 |
|
|
qq|<a class="frey-popdown" href="/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|; |
131 |
|
|
} |
132 |
|
|
#grep { $_ ne 'Moose::Object' } |
133 |
|
|
$meta->superclasses |
134 |
|
|
); |
135 |
|
|
} |
136 |
|
|
} |
137 |
|
|
|
138 |
|
|
my $role_method; |
139 |
dpavlin |
313 |
my $role_attribute; |
140 |
dpavlin |
310 |
|
141 |
|
|
if ( $meta->can('roles') ) { |
142 |
|
|
my $role_nr = 1; |
143 |
|
|
$roles = join(' ', |
144 |
|
|
grep { ! m/\Q$class\E/ } # skip me |
145 |
|
|
map { |
146 |
|
|
my $name = $_->name; |
147 |
dpavlin |
313 |
$role_method->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
148 |
|
|
$role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
149 |
dpavlin |
310 |
qq|<a class="frey-popdown" href="/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a><sup>| . $role_nr++ . qq|</sup>|; |
150 |
|
|
} |
151 |
|
|
$meta->calculate_all_roles |
152 |
|
|
); |
153 |
|
|
$roles = qq| with roles: $roles| if $roles; |
154 |
|
|
} |
155 |
|
|
warn "# role_method ",dump( $role_method ); |
156 |
|
|
|
157 |
dpavlin |
269 |
my @methods; |
158 |
dpavlin |
310 |
@methods = map { |
159 |
dpavlin |
313 |
my $name = $_; |
160 |
|
|
if ( $role_method->{$name} ) { |
161 |
|
|
my ( $role_name, $nr ) = each %{ $role_method->{$name} }; |
162 |
|
|
$name .= qq|<sup title="$role_name">$nr</sup>|; |
163 |
dpavlin |
310 |
} |
164 |
dpavlin |
313 |
qq|<td class="m">$name</td>| |
165 |
dpavlin |
408 |
} $self->class_methods( $class ); |
166 |
dpavlin |
53 |
|
167 |
dpavlin |
269 |
my @attributes; |
168 |
|
|
if ( $meta->get_attribute_list ) { |
169 |
dpavlin |
409 |
@attributes = map { |
170 |
dpavlin |
313 |
my $name = $_; |
171 |
|
|
my $attr = $meta->get_attribute($name); |
172 |
dpavlin |
409 |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless ref $attr; |
173 |
dpavlin |
393 |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
174 |
dpavlin |
269 |
my ( $before, $title, $after ) = ( '', '', '' ); |
175 |
|
|
( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required; |
176 |
dpavlin |
288 |
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_documentation has_applied_traits/ ) { |
177 |
dpavlin |
269 |
my $getter; |
178 |
|
|
|
179 |
|
|
$getter = $check; |
180 |
|
|
$getter =~ s/^has_//; |
181 |
|
|
|
182 |
|
|
if ( $attr->$check ) { |
183 |
|
|
if ( $getter eq $check ) { |
184 |
|
|
$after .= "$check"; |
185 |
|
|
} else { |
186 |
|
|
$after .= qq{<span class="frey-popdown">$check}; |
187 |
dpavlin |
288 |
# we need dump here instead of $attr->$getter->dump because default can return scalar |
188 |
|
|
$after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check; |
189 |
dpavlin |
269 |
$after .= '</span>'; |
190 |
dpavlin |
197 |
} |
191 |
|
|
} |
192 |
dpavlin |
269 |
$after .= ' '; |
193 |
|
|
} |
194 |
dpavlin |
290 |
my $type = $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
195 |
dpavlin |
313 |
|
196 |
|
|
if ( $role_attribute->{$name} ) { |
197 |
|
|
my ( $role_name, $nr ) = each %{ $role_attribute->{$name} }; |
198 |
|
|
$name .= qq|<sup title="$role_name">$nr</sup>|; |
199 |
|
|
} |
200 |
|
|
|
201 |
|
|
qq|<td class="a">$before $name</td><td class="t">$type</td><td>$after</td>| |
202 |
dpavlin |
409 |
} $meta->get_attribute_list |
203 |
dpavlin |
269 |
} |
204 |
dpavlin |
54 |
|
205 |
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>|; |
206 |
dpavlin |
269 |
while ( @methods || @attributes ) { |
207 |
|
|
my ($m,$a) = ( shift @methods, shift @attributes ); |
208 |
|
|
$m ||= '<td></td>'; |
209 |
|
|
$a ||= '<td></td>'; |
210 |
|
|
$table .= qq|<tr>$m$a</tr>|; |
211 |
|
|
} |
212 |
|
|
$table .= qq|</table>|; |
213 |
|
|
|
214 |
dpavlin |
270 |
my $pod = Frey::Pod->new( class => $class )->markup; |
215 |
dpavlin |
380 |
$pod = $pod->{body} if ref($pod); |
216 |
dpavlin |
134 |
|
217 |
dpavlin |
406 |
my $path = $self->class_path( $class ); |
218 |
|
|
my $Document = PPI::Document->new( $path ); |
219 |
dpavlin |
380 |
|
220 |
|
|
# Create a reusable syntax highlighter |
221 |
|
|
my $Highlight = PPI::HTML->new( |
222 |
dpavlin |
406 |
line_numbers => 1, |
223 |
dpavlin |
380 |
# page => 1, |
224 |
|
|
# colors => { |
225 |
|
|
# line_number => '#CCCCCC', |
226 |
|
|
# number => '#990000', |
227 |
|
|
# }, |
228 |
|
|
); |
229 |
|
|
|
230 |
|
|
# Spit out the HTML |
231 |
|
|
my $source = $Highlight->html( $Document ); |
232 |
|
|
|
233 |
dpavlin |
407 |
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
234 |
dpavlin |
406 |
|
235 |
|
|
# strip page html |
236 |
dpavlin |
380 |
# $source =~ s{^.*<body[^>]+>}{}s; |
237 |
|
|
# $source =~ s{</body.*$}{}s; |
238 |
|
|
|
239 |
dpavlin |
406 |
|
240 |
dpavlin |
269 |
use Frey::Run; |
241 |
dpavlin |
409 |
my $class_method = $self->class_methods( $class ); |
242 |
|
|
my $runnable = join("\n", |
243 |
|
|
map { $class_method->{$_} ? qq|<a href="/$class/$_">$_</a>| : '' } grep { $class->can($_) } Frey::Run->runnable |
244 |
|
|
); |
245 |
dpavlin |
314 |
$runnable = " runnable: $runnable" if $runnable; |
246 |
dpavlin |
128 |
|
247 |
dpavlin |
358 |
my $html = { |
248 |
dpavlin |
380 |
title => $class, |
249 |
dpavlin |
381 |
body => join("\n", |
250 |
|
|
qq|<h1>$class</h1>|, |
251 |
|
|
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
252 |
|
|
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
253 |
|
|
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
254 |
|
|
qq|$table\n$pod\n</div>\n|, |
255 |
|
|
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
256 |
dpavlin |
380 |
), |
257 |
dpavlin |
358 |
}; |
258 |
dpavlin |
128 |
|
259 |
dpavlin |
269 |
return $html; |
260 |
dpavlin |
53 |
} |
261 |
|
|
|
262 |
dpavlin |
49 |
=head1 SEE ALSO |
263 |
|
|
|
264 |
|
|
L<MooseX::AutoDoc> on which this code is based |
265 |
|
|
|
266 |
|
|
=cut |
267 |
|
|
|
268 |
|
|
1; |