8 |
use File::Slurp; |
use File::Slurp; |
9 |
use List::Util; |
use List::Util; |
10 |
|
|
11 |
|
use PPI; |
12 |
|
use PPI::HTML; |
13 |
|
|
14 |
|
use Frey::Pod; |
15 |
|
|
16 |
use lib 'lib'; |
use lib 'lib'; |
17 |
|
|
18 |
extends 'Frey'; |
extends 'Frey::PPI'; |
19 |
with 'Frey::Web'; |
with 'Frey::Web'; |
20 |
|
with 'Frey::Storage'; |
21 |
|
|
22 |
has 'package' => ( |
has 'class' => ( |
23 |
is => 'rw', |
is => 'rw', |
24 |
isa => 'Str', |
isa => 'Str', |
25 |
required => 1, |
required => 1, |
26 |
); |
); |
27 |
|
|
|
has 'path' => ( |
|
|
is => 'rw', |
|
|
); |
|
|
|
|
28 |
=head2 joose |
=head2 joose |
29 |
|
|
30 |
my $js = $o->joose( 'Some::Package' ); |
my $js = $o->joose; |
31 |
|
|
32 |
=cut |
=cut |
33 |
|
|
34 |
sub joose { |
sub joose { |
35 |
my ($self) = @_; |
my ($self) = @_; |
36 |
|
|
37 |
my ( $class, $meta, $is_role ) = $self->load_package; |
my ( $meta, $is_role ) = $self->class_meta; |
38 |
|
|
39 |
if ( ! $is_role ) { |
if ( ! $is_role ) { |
40 |
my @superclasses = map{ $_->meta->name } |
my @superclasses = map{ $_->meta->name } |
44 |
|
|
45 |
my $out; |
my $out; |
46 |
|
|
47 |
my ( $m, $c ) = split(/::/, $class->name, 2); |
my ( $m, $c ) = split(/::/, $self->class, 2); |
48 |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; |
49 |
|
|
50 |
|
$c ||= ''; |
51 |
|
|
52 |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; |
53 |
|
|
54 |
foreach ( $class->get_attribute_list ) { |
foreach ( $meta->get_attribute_list ) { |
55 |
$out .= "\t\t\t$_: {\n"; |
$out .= "\t\t\t$_: {\n"; |
56 |
|
|
57 |
my $attr = $class->get_attribute($_); |
my $attr = $meta->get_attribute($_); |
58 |
my $is = $attr->_is_metadata; |
my $is = $attr->_is_metadata; |
59 |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
$out .= "\t\t\t\tis: \"$is\",\n" if defined $is; |
60 |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; |
79 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
80 |
classMethods: { |
classMethods: { |
81 |
renderHTML: function () { |
renderHTML: function () { |
82 |
return new Joose.SimpleRequest().getText(\"/~/" . $self->package . "\") |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
83 |
},\n"; |
},\n"; |
84 |
|
|
85 |
$out .= "\t\t},\n"; |
$out .= "\t\t},\n"; |
89 |
$out =~ s/,\n$/\n/; |
$out =~ s/,\n$/\n/; |
90 |
$out .= "});\n"; |
$out .= "});\n"; |
91 |
|
|
92 |
$out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n"; |
$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; |
93 |
|
|
94 |
warn "method_list = ",dump( $class->get_method_list ) if $self->debug; |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
95 |
|
|
96 |
# print $out; |
# print $out; |
97 |
my $path = "static/blib/$filename"; |
my $path = "static/blib/$filename"; |
98 |
write_file( $path, $out ); |
write_file( $path, $out ); |
99 |
warn "# created $path\n"; |
warn "# created $path\n"; |
|
$self->path( $path ); |
|
100 |
|
|
101 |
return $out; |
return $out; |
102 |
} |
} |
103 |
|
|
104 |
=head2 methods |
sub as_markup { |
105 |
|
my ( $self ) = @_; |
|
my @methods = $o->methods; |
|
|
|
|
|
=cut |
|
|
|
|
|
sub methods { |
|
|
my $self = shift; |
|
|
|
|
|
my ( $class, $meta, $is_role ) = $self->load_package; |
|
|
|
|
|
my $attr; |
|
|
$attr->{$_}++ foreach $class->get_attribute_list; |
|
|
my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list; |
|
|
warn "# methods = ",dump( @methods ) if $self->debug; |
|
|
|
|
|
return sort @methods; |
|
|
} |
|
|
|
|
|
use Frey::ClassLoader; |
|
106 |
|
|
107 |
sub load_package { |
$self->add_head( 'static/introspect.css' ); |
|
my $self = shift; |
|
|
return Frey::ClassLoader->load_package( $self->package ); |
|
|
} |
|
|
|
|
|
|
|
|
=head1 OUTPUT GENERATION |
|
108 |
|
|
109 |
=head2 html |
my ( $meta, $is_role ) = $self->class_meta; |
110 |
|
|
111 |
$o->html( $request ); |
my $class = $self->class; |
|
|
|
|
=cut |
|
112 |
|
|
113 |
sub html { |
my $introspect_path = "var/introspect/$class.yaml"; |
114 |
my ( $self, $request ) = @_; |
$self->mkbasepath( $introspect_path ); |
115 |
|
my $introspect = $self->load( $introspect_path ); |
116 |
|
|
117 |
while (1) { |
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 ( $class, $meta, $is_role ) = $self->load_package; |
my $role_method; |
134 |
|
my $role_attribute; |
135 |
|
|
136 |
my $package = $self->package; |
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->{role}->{$name}++; |
143 |
|
$role_method->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
144 |
|
$role_attribute->{ $_ }->{$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 "# role_method ",dump( $role_method ); |
152 |
|
|
153 |
my @methods; |
my @methods; |
154 |
@methods = map { qq|<td><a href="/~/$package/$_">$_</a></td>| } $self->methods if $class->can('meta'); |
@methods = map { |
155 |
|
my $name = $_; |
156 |
|
$introspect->{method}->{$name}++; |
157 |
|
if ( $role_method->{$name} ) { |
158 |
|
my ( $role_name, $nr ) = each %{ $role_method->{$name} }; |
159 |
|
$name .= qq|<sup title="$role_name">$nr</sup>|; |
160 |
|
} |
161 |
|
qq|<td class="m">$name</td>| |
162 |
|
} $self->class_methods( $class ); |
163 |
|
|
164 |
my @attributes; |
my @attributes; |
165 |
if ( $class->get_attribute_list ) { |
if ( $meta->get_attribute_list ) { |
166 |
@attributes = map { |
@attributes = map { |
167 |
my $attr = $class->get_attribute($_); |
my $name = $_; |
168 |
# warn "## $_ ", $attr->is_required ? 'required' : 'optional'; |
$introspect->{attribute}->{$name}++; |
169 |
qq|<td><a href="/~/$package/$_?">$_</a></td><td>| . |
my $html_name = $name; |
170 |
( $attr->is_required ? ' <b>required</b>' : '' ) . |
my $attr = $meta->get_attribute($name); |
171 |
qq|</td>|; |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
172 |
} sort $class->get_attribute_list |
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
173 |
} |
|
174 |
|
my ( $title, $properties ) = ( '', '' ); |
175 |
|
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ) |
176 |
|
if $attr->can('is_required') && $attr->is_required; |
177 |
|
|
178 |
|
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/ ) { |
179 |
|
my $getter; |
180 |
|
|
181 |
|
$getter = $check; |
182 |
|
$getter =~ s/^has_//; |
183 |
|
|
184 |
|
if ( $attr->can($check) && $attr->$check ) { |
185 |
|
if ( $getter eq $check ) { |
186 |
|
$properties .= "$check"; |
187 |
|
} else { |
188 |
|
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
189 |
|
$properties .= $self->dropdown( $check, $attr->$getter ); |
190 |
|
} |
191 |
|
} |
192 |
|
$properties .= ' '; |
193 |
|
} |
194 |
|
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
195 |
|
|
196 |
my $table = qq|<table><tr><th>Methods</th><th>Attributes</th></tr>|; |
if ( $role_attribute->{$name} ) { |
197 |
while ( @methods || @attributes ) { |
my ( $role_name, $nr ) = each %{ $role_attribute->{$name} }; |
198 |
my ($m,$a) = ( shift @methods, shift @attributes ); |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
199 |
$m ||= '<td></td>'; |
} |
|
$a ||= '<td></td>'; |
|
|
$table .= qq|<tr>$m$a</tr>|; |
|
|
} |
|
|
$table .= qq|</table>|; |
|
200 |
|
|
201 |
my $classes = |
eval { $properties = $attr->documentation . ' ' . $properties }; |
|
qq|<div class="classes">| . |
|
|
Frey::ClassBrowser->new->markup . |
|
|
qq|</div>|; |
|
202 |
|
|
203 |
$self->add_css( 'static/introspect.css' ); |
qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>| |
204 |
|
} $meta->get_attribute_list |
205 |
|
} |
206 |
|
|
207 |
warn "## css = ",dump( $self->css ); |
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>|; |
208 |
|
while ( @methods || @attributes ) { |
209 |
|
my ($m,$a) = ( shift @methods, shift @attributes ); |
210 |
|
$m ||= '<td></td>'; |
211 |
|
$a ||= '<td></td>'; |
212 |
|
$table .= qq|<tr>$m$a</tr>|; |
213 |
|
} |
214 |
|
$table .= qq|</table>|; |
215 |
|
|
216 |
my $superclasses = 'Role'; |
my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
217 |
$superclasses = 'Superclasses: ' . join(', ', |
$pod = $pod->{body} if ref($pod); |
|
map { |
|
|
my $s = $_->meta->name; |
|
|
qq|<a href="/~/$s">$s</a>| |
|
|
} |
|
|
#grep { $_ ne 'Moose::Object' } |
|
|
$meta->superclasses |
|
|
) if ! $is_role && $meta->superclasses; |
|
|
|
|
|
my $pod = Frey::Pod->new( class => $package )->markup; |
|
|
|
|
|
my $html = $self->page( |
|
|
title => "Introspect $package", |
|
|
body => qq|<h1>$package</h1>| |
|
|
. ( $pod ? qq|<a href="#___top" title="Skip to POD" style="font-size: 80%; color: #aaa;">↓pod&darr</a> | : '' ) |
|
|
. qq|$superclasses\n$table\n$pod\n$classes|, |
|
218 |
|
|
219 |
); |
my $path = $self->class_path( $class ); |
220 |
|
my $Document = PPI::Document->new( $path ); |
221 |
|
|
222 |
$request->print($html); |
# Create a reusable syntax highlighter |
223 |
warn "# >>> html ",length($html)," bytes\n"; |
my $Highlight = PPI::HTML->new( |
224 |
$request->next; |
line_numbers => 1, |
225 |
|
# page => 1, |
226 |
|
# colors => { |
227 |
|
# line_number => '#CCCCCC', |
228 |
|
# number => '#990000', |
229 |
|
# }, |
230 |
|
); |
231 |
|
|
232 |
|
# Spit out the HTML |
233 |
|
my $source = $Highlight->html( $Document ); |
234 |
|
|
235 |
|
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
236 |
|
|
237 |
|
# strip page html |
238 |
|
# $source =~ s{^.*<body[^>]+>}{}s; |
239 |
|
# $source =~ s{</body.*$}{}s; |
240 |
|
|
241 |
|
my $runnable = join("\n", |
242 |
|
map { |
243 |
|
$introspect->{runnable}->{$_}++; |
244 |
|
my $short = $_; |
245 |
|
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
246 |
|
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
247 |
|
} $self->class_runnable( $class ) |
248 |
|
); |
249 |
|
$runnable = " runnable: $runnable" if $runnable; |
250 |
|
|
251 |
|
$self->store( $introspect_path, $introspect ); |
252 |
|
|
253 |
|
$self->title( $class ); |
254 |
|
|
255 |
|
my $has_tests = ''; |
256 |
|
my @tests = grep { defined $_ } $self->has_tests; |
257 |
|
if ( @tests ) { |
258 |
|
$has_tests = |
259 |
|
'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
260 |
|
join("\n", map { |
261 |
|
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
262 |
|
} @tests ); |
263 |
} |
} |
264 |
warn "# exit html"; |
|
265 |
|
return join("\n", |
266 |
|
qq|<h1>$class</h1>|, |
267 |
|
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
268 |
|
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
269 |
|
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
270 |
|
$has_tests, |
271 |
|
qq|$table\n$pod\n</div>\n|, |
272 |
|
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
273 |
|
); |
274 |
} |
} |
275 |
|
|
276 |
=head1 SEE ALSO |
=head1 SEE ALSO |