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 lib 'lib'; |
use lib 'lib'; |
15 |
|
use Frey::Pod; |
16 |
|
|
17 |
extends 'Frey'; |
extends 'Frey::PPI'; |
18 |
with 'Frey::Web'; |
with 'Frey::Web'; |
19 |
|
with 'Frey::Storage'; |
20 |
|
|
21 |
has 'class' => ( |
has 'class' => ( |
22 |
is => 'rw', |
is => 'rw', |
24 |
required => 1, |
required => 1, |
25 |
); |
); |
26 |
|
|
|
has 'path' => ( |
|
|
is => 'rw', |
|
|
); |
|
|
|
|
27 |
=head2 joose |
=head2 joose |
28 |
|
|
29 |
my $js = $o->joose; |
my $js = $o->joose; |
33 |
sub joose { |
sub joose { |
34 |
my ($self) = @_; |
my ($self) = @_; |
35 |
|
|
36 |
my ( $meta, $is_role ) = $self->load_class; |
my ( $meta, $is_role ) = $self->class_meta; |
37 |
|
|
38 |
if ( ! $is_role ) { |
if ( ! $is_role ) { |
39 |
my @superclasses = map{ $_->meta->name } |
my @superclasses = map{ $_->meta->name } |
78 |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
$out .= "\t\t},\n\t\tmeta: Frey.HTML, |
79 |
classMethods: { |
classMethods: { |
80 |
renderHTML: function () { |
renderHTML: function () { |
81 |
return new Joose.SimpleRequest().getText(\"/~/" . $self->class . "\") |
return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") |
82 |
},\n"; |
},\n"; |
83 |
|
|
84 |
$out .= "\t\t},\n"; |
$out .= "\t\t},\n"; |
96 |
my $path = "static/blib/$filename"; |
my $path = "static/blib/$filename"; |
97 |
write_file( $path, $out ); |
write_file( $path, $out ); |
98 |
warn "# created $path\n"; |
warn "# created $path\n"; |
|
$self->path( $path ); |
|
99 |
|
|
100 |
return $out; |
return $out; |
101 |
} |
} |
102 |
|
|
103 |
=head2 methods |
sub as_markup { |
104 |
|
my ( $self ) = @_; |
|
my @methods = $o->methods; |
|
|
|
|
|
=cut |
|
|
|
|
|
sub methods { |
|
|
my $self = shift; |
|
|
|
|
|
my ( $meta, $is_role ) = $self->load_class; |
|
|
|
|
|
my $attr; |
|
|
$attr->{$_}++ foreach $meta->get_attribute_list; |
|
|
my @methods = grep { ! defined($attr->{$_}) } $meta->get_method_list; |
|
|
warn "# methods = ",dump( @methods ) if $self->debug; |
|
|
|
|
|
return sort @methods; |
|
|
} |
|
|
|
|
|
use Frey::ClassLoader; |
|
|
|
|
|
sub load_class { |
|
|
my $self = shift; |
|
|
return Frey::ClassLoader->load_package( $self->class ); |
|
|
} |
|
|
|
|
|
|
|
|
=head1 OUTPUT GENERATION |
|
105 |
|
|
106 |
=head2 markup |
$self->add_head( 'static/introspect.css' ); |
107 |
|
|
108 |
$o->markup; |
my ( $meta, $is_role ) = $self->class_meta; |
109 |
|
|
110 |
=cut |
my $class = $self->class; |
111 |
|
|
112 |
sub markup { |
my $introspect_path = "var/introspect/$class.yaml"; |
113 |
my ( $self ) = @_; |
$self->mkbasepath( $introspect_path ); |
114 |
|
my $introspect = $self->load( $introspect_path ); |
115 |
|
|
116 |
$self->add_head( 'static/introspect.css' ); |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
117 |
|
if ( ! $is_role ) { |
118 |
|
if ( $meta->superclasses ) { |
119 |
|
$superclasses = 'Superclasses: ' . |
120 |
|
join(', ', |
121 |
|
map { |
122 |
|
my $name = $_->meta->name; |
123 |
|
$introspect->{superclass}->{$name} = {}; |
124 |
|
$self->dropdown( $name, $_->meta ) |
125 |
|
} |
126 |
|
#grep { $_ ne 'Moose::Object' } |
127 |
|
$meta->superclasses |
128 |
|
); |
129 |
|
} |
130 |
|
} |
131 |
|
|
132 |
my ( $meta, $is_role ) = $self->load_class; |
my $method_from_role; |
133 |
|
my $attribute_from_role; |
134 |
|
|
135 |
my $class = $self->class; |
if ( $meta->can('roles') ) { |
136 |
|
my $role_nr = 1; |
137 |
|
$roles = join(' ', |
138 |
|
grep { ! m/\Q$class\E/ } # skip me |
139 |
|
map { |
140 |
|
my $name = $_->name; |
141 |
|
$introspect->{roles}->{$name} = {}; |
142 |
|
$method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; |
143 |
|
$attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; |
144 |
|
$self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|; |
145 |
|
} |
146 |
|
$meta->calculate_all_roles |
147 |
|
); |
148 |
|
$roles = qq| with roles: $roles| if $roles; |
149 |
|
} |
150 |
|
warn "# method_from_role ",dump( $method_from_role ); |
151 |
|
|
152 |
my @methods; |
my @methods; |
153 |
@methods = map { qq|<td class="m">$_</td>| } $self->methods; |
@methods = map { |
154 |
|
my $name = $_; |
155 |
|
if ( $method_from_role->{$name} ) { |
156 |
|
my ( $role_name, $nr ) = each %{ $method_from_role->{$name} }; |
157 |
|
$introspect->{methods}->{$name}->{role} = $role_name; |
158 |
|
$name .= qq|<sup title="$role_name">$nr</sup>|; |
159 |
|
} else { |
160 |
|
$introspect->{methods}->{$name} = {}; |
161 |
|
} |
162 |
|
qq|<td class="m">$name</td>| |
163 |
|
} sort $self->class_methods( $class ); |
164 |
|
|
165 |
my @attributes; |
my @attributes; |
166 |
if ( $meta->get_attribute_list ) { |
if ( $meta->get_attribute_list ) { |
167 |
@attributes = map { |
@attributes = map { |
168 |
my $attr = $meta->get_attribute($_); |
my $name = $_; |
169 |
my ( $before, $title, $after ) = ( '', '', '' ); |
$introspect->{attribute}->{$name} = {}; |
170 |
( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required; |
my $html_name = $name; |
171 |
warn $attr->dump(3); |
my $attr = $meta->get_attribute($name); |
172 |
foreach my $check ( qw/has_type_constraint has_handles is_weak_ref is_required is_lazy should_coerce should_auto_deref has_trigger has_documentation has_applied_traits/ ) { |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
173 |
|
warn "## attr $name ref ",ref( $attr ) if $self->debug; |
174 |
|
|
175 |
|
my ( $title, $properties ) = ( '', '' ); |
176 |
|
if ( $attr->can('is_required') && $attr->is_required ) { |
177 |
|
( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' ); |
178 |
|
$introspect->{attribute}->{$name}->{required} = 1; |
179 |
|
} |
180 |
|
|
181 |
|
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/ ) { |
182 |
my $getter; |
my $getter; |
183 |
|
|
184 |
$getter = $check; |
$getter = $check; |
185 |
$getter =~ s/^has_//; |
$getter =~ s/^has_//; |
186 |
|
|
187 |
if ( $attr->$check ) { |
if ( $attr->can($check) && $attr->$check ) { |
188 |
if ( $getter eq $check ) { |
if ( $getter eq $check ) { |
189 |
$after .= "$check"; |
$properties .= "$check"; |
190 |
} else { |
} else { |
191 |
$after .= qq{<span class="frey-popdown">$check}; |
# we need our dump here instead of $attr->$getter->dump because default can return scalar |
192 |
$after .= '<code>' . $attr->$getter->dump . '</code>' if $getter ne $check; |
$properties .= $self->dropdown( $check, $attr->$getter ); |
|
$after .= '</span>'; |
|
193 |
} |
} |
194 |
} |
} |
195 |
$after .= ' '; |
$properties .= ' '; |
196 |
|
} |
197 |
|
my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; |
198 |
|
|
199 |
|
if ( $attribute_from_role->{$name} ) { |
200 |
|
my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; |
201 |
|
$name .= qq|<sup title="$role_name">$nr</sup>|; |
202 |
} |
} |
203 |
qq|<td class="a">$before $_</td><td>$after</td>| |
|
204 |
|
eval { $properties = $attr->documentation . ' ' . $properties }; |
205 |
|
|
206 |
|
qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>| |
207 |
} sort $meta->get_attribute_list |
} sort $meta->get_attribute_list |
208 |
} |
} |
209 |
|
|
210 |
my $table = qq|<table class="frey-object-browser"><tr><th class="m">Methods</th><th class="a">Attributes</th><th class="p">Properties</th></tr>|; |
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>|; |
211 |
while ( @methods || @attributes ) { |
while ( @methods || @attributes ) { |
212 |
my ($m,$a) = ( shift @methods, shift @attributes ); |
my ($m,$a) = ( shift @methods, shift @attributes ); |
213 |
$m ||= '<td></td>'; |
$m ||= '<td></td>'; |
216 |
} |
} |
217 |
$table .= qq|</table>|; |
$table .= qq|</table>|; |
218 |
|
|
219 |
my ( $superclasses, $roles ) = ( '<b>Role</b>', '' ); |
my $path = $self->class_path( $class ); |
|
if ( ! $is_role ) { |
|
|
if ( $meta->superclasses ) { |
|
|
$superclasses = 'Superclasses: ' . |
|
|
join(', ', |
|
|
map { |
|
|
my $name = $_->meta->name; |
|
|
qq|<a class="frey-popdown" href="/~/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|; |
|
|
} |
|
|
#grep { $_ ne 'Moose::Object' } |
|
|
$meta->superclasses |
|
|
); |
|
|
} |
|
|
} |
|
220 |
|
|
221 |
if ( $meta->can('roles') ) { |
my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
222 |
$roles = join(', ', |
return $pod if $path =~ m{\.pod}; |
|
grep { ! m/\Q$class\E/ } # skip me |
|
|
map { |
|
|
my $name = $_->name; |
|
|
qq|<a class="frey-popdown" href="/~/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a>|; |
|
|
} |
|
|
$meta->calculate_all_roles |
|
|
); |
|
|
$roles = " with roles: $roles" if $roles; |
|
|
} |
|
223 |
|
|
224 |
my $pod = Frey::Pod->new( class => $class )->markup; |
my $Document = PPI::Document->new( $path ); |
225 |
|
|
226 |
|
# Create a reusable syntax highlighter |
227 |
|
my $Highlight = PPI::HTML->new( |
228 |
|
line_numbers => 1, |
229 |
|
# page => 1, |
230 |
|
# colors => { |
231 |
|
# line_number => '#CCCCCC', |
232 |
|
# number => '#990000', |
233 |
|
# }, |
234 |
|
); |
235 |
|
|
236 |
use Frey::Run; |
# Spit out the HTML |
237 |
my $execute = join("\n", map { qq|<a href="/$_/$class">$_</a>| } grep { $class->can($_) } Frey::Run->execute ); |
my $source = $Highlight->html( $Document ); |
|
$execute = " execute: $execute" if $execute; |
|
238 |
|
|
239 |
my $html = $self->page( |
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
|
title => "Introspect $class", |
|
|
body => qq|<h1>$class</h1>| |
|
|
. qq|$superclasses\n$roles\n$execute\n| |
|
|
. ( $pod ? qq|<a href="#___top" title="Skip to POD" style="font-size: 80%; color: #aaa;">↓pod&darr</a>| : '' ) |
|
|
. qq|$table\n$pod| |
|
240 |
|
|
241 |
|
# strip page html |
242 |
|
# $source =~ s{^.*<body[^>]+>}{}s; |
243 |
|
# $source =~ s{</body.*$}{}s; |
244 |
|
|
245 |
|
my $runnable = join("\n", |
246 |
|
map { |
247 |
|
$introspect->{runnable}->{$_} = {}; |
248 |
|
my $short = $_; |
249 |
|
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
250 |
|
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
251 |
|
} $self->class_runnable( $class ) |
252 |
); |
); |
253 |
|
$runnable = "<br>run: $runnable" if $runnable; |
254 |
|
|
255 |
return $html; |
$self->store( $introspect_path, $introspect ); |
256 |
|
|
257 |
|
$self->title( $class ); |
258 |
|
|
259 |
|
my $has_tests = ''; |
260 |
|
my @tests = grep { defined $_ } $self->has_tests; |
261 |
|
if ( @tests ) { |
262 |
|
$has_tests = |
263 |
|
'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
264 |
|
join("\n", map { |
265 |
|
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
266 |
|
} @tests ); |
267 |
|
} |
268 |
|
|
269 |
|
return join("\n", |
270 |
|
qq|<h1>$class</h1>|, |
271 |
|
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
272 |
|
$has_tests, |
273 |
|
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
274 |
|
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
275 |
|
qq|$table\n$pod\n</div>\n|, |
276 |
|
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
277 |
|
); |
278 |
} |
} |
279 |
|
|
280 |
=head1 SEE ALSO |
=head1 SEE ALSO |