2 |
|
|
3 |
use Moose; |
use Moose; |
4 |
use Carp; |
use Carp; |
5 |
use Class::MOP; |
#use Moose::Meta::Role; |
6 |
use Moose::Meta::Role; |
#use Moose::Meta::Class; |
|
use Moose::Meta::Class; |
|
|
use Scalar::Util qw/blessed/; |
|
7 |
use Data::Dump qw/dump/; |
use Data::Dump qw/dump/; |
8 |
use File::Slurp; |
use File::Slurp; |
9 |
use List::Util; |
use List::Util; |
10 |
|
|
11 |
use Continuity::Widget::DomNode; |
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'; |
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', |
|
|
); |
|
|
|
|
|
=head2 load_package |
|
|
|
|
|
my ( $class, $meta, $is_role ) = $o->load_package( 'Some::Package' ); |
|
|
|
|
|
=cut |
|
|
|
|
|
sub load_package { |
|
|
my ( $self ) = @_; |
|
|
|
|
|
my $package = $self->package; |
|
|
|
|
|
#intercept role application so we can accurately generate |
|
|
#method and attribute information for the parent class. |
|
|
#this is fragile, but there is not better way that i am aware of |
|
|
my $rmeta = Moose::Meta::Role->meta; |
|
|
$rmeta->make_mutable if $rmeta->is_immutable; |
|
|
my $original_apply = $rmeta->get_method("apply")->body; |
|
|
$rmeta->remove_method("apply"); |
|
|
my @roles_to_apply; |
|
|
$rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])}); |
|
|
#load the package with the hacked Moose::Meta::Role |
|
|
eval { Class::MOP::load_class($package); }; |
|
|
confess "Failed to load package ${package} $@" if $@; |
|
|
|
|
|
my $meta = $package->meta; |
|
|
|
|
|
my ($class, $is_role); |
|
|
if($package->meta->isa('Moose::Meta::Role')){ |
|
|
$is_role = 1; |
|
|
# we need to apply the role to a class to be able to properly introspect it |
|
|
$class = Moose::Meta::Class->create_anon_class; |
|
|
$original_apply->($meta, $class); |
|
|
} else { |
|
|
#roles don't have superclasses ... |
|
|
$class = $meta; |
|
|
} |
|
|
return ( $class, $meta, $is_role ); |
|
|
} |
|
|
|
|
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 } |
41 |
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
grep { $_ ne 'Moose::Object' } $meta->superclasses; |
42 |
warn "superclasses ",dump( @superclasses ); |
warn "superclasses ",dump( @superclasses ) if $self->debug; |
43 |
} |
} |
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(\"/~/${m}::${c}\") |
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"; |
|
|
|
|
warn $class->dump(2); |
|
93 |
|
|
94 |
warn "method_list = ",dump( $class->get_method_list ); |
warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; |
|
warn dump( map{ $class->get_method($_)->name } sort $class->get_method_list ); |
|
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 ); |
|
106 |
|
|
107 |
return @methods; |
$self->add_head( 'static/introspect.css' ); |
|
} |
|
108 |
|
|
109 |
=head1 OUTPUT GENERATION |
my ( $meta, $is_role ) = $self->class_meta; |
110 |
|
|
111 |
=head2 html |
my $class = $self->class; |
112 |
|
|
113 |
$o->html( $request ); |
my $introspect_path = "var/introspect/$class.yaml"; |
114 |
|
$self->mkbasepath( $introspect_path ); |
115 |
|
my $introspect = $self->load( $introspect_path ); |
116 |
|
|
117 |
=cut |
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 |
our @javascript = ( qw' |
my $role_method; |
134 |
../lib/Joose.js |
my $role_attribute; |
|
'); |
|
135 |
|
|
136 |
sub html { |
if ( $meta->can('roles') ) { |
137 |
my ( $self, $request ) = @_; |
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 |
while (1) { |
my @methods; |
154 |
|
@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 $js = Continuity::Widget::DomNode->create( |
my @attributes; |
165 |
map { |
if ( $meta->get_attribute_list ) { |
166 |
( script => { type => 'text/javascript', src => $_ } ) |
@attributes = map { |
167 |
} @javascript |
my $name = $_; |
168 |
)->to_string; |
$introspect->{attribute}->{$name}++; |
169 |
|
my $html_name = $name; |
170 |
$js .= << '__END_OF_JS__'; |
my $attr = $meta->get_attribute($name); |
171 |
<script type="text/javascript"> |
confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; |
172 |
joose.loadComponents("../lib") |
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 |
function $(id) { |
if ( $role_attribute->{$name} ) { |
197 |
return document.getElementById(id) |
my ( $role_name, $nr ) = each %{ $role_attribute->{$name} }; |
198 |
} |
$name .= qq|<sup title="$role_name">$nr</sup>|; |
199 |
|
} |
200 |
|
|
201 |
</script> |
eval { $properties = $attr->documentation . ' ' . $properties }; |
|
__END_OF_JS__ |
|
202 |
|
|
203 |
warn "# >>> js\n$js\n"; |
qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>| |
204 |
|
} $meta->get_attribute_list |
205 |
|
} |
206 |
|
|
207 |
my $methods; |
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 ( $class, $meta, $is_role ); |
my $path = $self->class_path( $class ); |
|
eval { ( $class, $meta, $is_role ) = $self->load_package(); }; |
|
|
if ( $@ ) { |
|
|
warn "ERROR: $@"; |
|
|
$request->conn->send_status_line( 500, $@ ); |
|
|
$request->print( $@ ); |
|
|
$request->next; |
|
|
return; |
|
|
} |
|
217 |
|
|
218 |
if ( $class->can('meta') ) { |
my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; |
219 |
$methods = Continuity::Widget::DomNode->create( |
return $pod if $path =~ m{\.pod}; |
|
ul => [ |
|
|
map { ( |
|
|
li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ] ] |
|
|
) } $self->methods |
|
|
] |
|
|
)->to_string; |
|
|
} else { |
|
|
$methods = '<b>not introspectable</b>'; |
|
|
} |
|
220 |
|
|
221 |
my $attributes = Continuity::Widget::DomNode->create( |
my $Document = PPI::Document->new( $path ); |
|
ul => [ |
|
|
map { |
|
|
my $attr = $class->get_attribute($_); |
|
|
warn "## $_ ", $attr->is_required ? 'required' : 'optional'; |
|
|
( li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ], ( $attr->is_required ? ' <b>required</b>' : '' ) ] ) |
|
|
} $class->get_attribute_list |
|
|
], |
|
|
)->to_string; |
|
|
|
|
|
my $doc = Continuity::Widget::DomNode->create( |
|
|
html => [ |
|
|
head => [ |
|
|
link => { rel=>"stylesheet", href=>"/static/app.css", type=>"text/css", media=>"screen" }, |
|
|
$js, |
|
|
title => [ 'Introspect ', $self->package ], |
|
|
], |
|
|
body => [ |
|
|
h1 => [ $self->package ], |
|
|
h2 => [ 'Methods' ], |
|
|
$methods, |
|
|
h2 => [ 'Atrributes' ], |
|
|
$attributes, |
|
|
], |
|
|
] |
|
|
); |
|
222 |
|
|
223 |
$request->print($doc->to_string); |
# Create a reusable syntax highlighter |
224 |
warn "# >>> html\n", $doc->to_string, "\n"; |
my $Highlight = PPI::HTML->new( |
225 |
$request->next; |
line_numbers => 1, |
226 |
|
# page => 1, |
227 |
|
# colors => { |
228 |
|
# line_number => '#CCCCCC', |
229 |
|
# number => '#990000', |
230 |
|
# }, |
231 |
|
); |
232 |
|
|
233 |
|
# Spit out the HTML |
234 |
|
my $source = $Highlight->html( $Document ); |
235 |
|
|
236 |
|
$source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g; |
237 |
|
|
238 |
|
# strip page html |
239 |
|
# $source =~ s{^.*<body[^>]+>}{}s; |
240 |
|
# $source =~ s{</body.*$}{}s; |
241 |
|
|
242 |
|
my $runnable = join("\n", |
243 |
|
map { |
244 |
|
$introspect->{runnable}->{$_}++; |
245 |
|
my $short = $_; |
246 |
|
$short =~ s{_as_(?:markup|data|sponge)$}{}; |
247 |
|
qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>| |
248 |
|
} $self->class_runnable( $class ) |
249 |
|
); |
250 |
|
$runnable = " runnable: $runnable" if $runnable; |
251 |
|
|
252 |
|
$self->store( $introspect_path, $introspect ); |
253 |
|
|
254 |
|
$self->title( $class ); |
255 |
|
|
256 |
|
my $has_tests = ''; |
257 |
|
my @tests = grep { defined $_ } $self->has_tests; |
258 |
|
if ( @tests ) { |
259 |
|
$has_tests = |
260 |
|
'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' . |
261 |
|
join("\n", map { |
262 |
|
qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>| |
263 |
|
} @tests ); |
264 |
} |
} |
265 |
warn "# exit html"; |
|
266 |
|
return join("\n", |
267 |
|
qq|<h1>$class</h1>|, |
268 |
|
qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|, |
269 |
|
$pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '', |
270 |
|
$source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '', |
271 |
|
$has_tests, |
272 |
|
qq|$table\n$pod\n</div>\n|, |
273 |
|
qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|, |
274 |
|
); |
275 |
} |
} |
276 |
|
|
277 |
=head1 SEE ALSO |
=head1 SEE ALSO |