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