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