/[Frey]/trunk/lib/Frey/Introspect.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Annotation of /trunk/lib/Frey/Introspect.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1012 - (hide annotations)
Sat Jan 24 19:21:14 2009 UTC (15 years, 3 months ago) by dpavlin
File size: 8884 byte(s)
add <br>s just for defined parts

(skipping all if pod or pure perl class)
1 dpavlin 49 package Frey::Introspect;
2    
3     use Moose;
4     use Carp;
5 dpavlin 100 #use Moose::Meta::Role;
6     #use Moose::Meta::Class;
7 dpavlin 49 use Data::Dump qw/dump/;
8     use File::Slurp;
9 dpavlin 51 use List::Util;
10 dpavlin 49
11 dpavlin 380 use PPI;
12     use PPI::HTML;
13    
14 dpavlin 733 use lib 'lib';
15 dpavlin 631 use Frey::Pod;
16    
17 dpavlin 496 extends 'Frey::PPI';
18 dpavlin 100 with 'Frey::Web';
19 dpavlin 602 with 'Frey::Storage';
20 dpavlin 49
21 dpavlin 943 =head1 DESCRIPTION
22    
23     Provide introspection on any perl class installed on system
24    
25     =cut
26    
27 dpavlin 270 has 'class' => (
28 dpavlin 49 is => 'rw',
29     isa => 'Str',
30     required => 1,
31     );
32    
33 dpavlin 53 =head2 joose
34    
35 dpavlin 137 my $js = $o->joose;
36 dpavlin 53
37     =cut
38    
39     sub joose {
40     my ($self) = @_;
41    
42 dpavlin 308 my ( $meta, $is_role ) = $self->class_meta;
43 dpavlin 53
44     if ( ! $is_role ) {
45 dpavlin 50 my @superclasses = map{ $_->meta->name }
46     grep { $_ ne 'Moose::Object' } $meta->superclasses;
47 dpavlin 100 warn "superclasses ",dump( @superclasses ) if $self->debug;
48 dpavlin 50 }
49 dpavlin 49
50     my $out;
51    
52 dpavlin 270 my ( $m, $c ) = split(/::/, $self->class, 2);
53 dpavlin 51 my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';
54 dpavlin 49
55 dpavlin 137 $c ||= '';
56    
57 dpavlin 49 $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";
58    
59 dpavlin 137 foreach ( $meta->get_attribute_list ) {
60 dpavlin 49 $out .= "\t\t\t$_: {\n";
61    
62 dpavlin 137 my $attr = $meta->get_attribute($_);
63 dpavlin 972 my $is = eval { $attr->_is_metadata; };
64     return if $@;
65    
66 dpavlin 50 $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
67     $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
68     $out .= "\t\t\t\trequired: true,\n" if $attr->is_required;
69     $out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME
70    
71     if( defined(my $isa = $attr->_isa_metadata) ){
72     if( blessed $isa ){
73     while( blessed $isa ){
74     $isa = $isa->name;
75     }
76     }
77     $isa =~ s/\s+\|\s+undef//gi;
78     $out .= "\t\t\t\tisa: Moose.$isa,\n";
79     }
80    
81    
82 dpavlin 49 $out .= "\t\t\t},\n";
83    
84     }
85    
86 dpavlin 51 $out .= "\t\t},\n\t\tmeta: Frey.HTML,
87     classMethods: {
88     renderHTML: function () {
89 dpavlin 292 return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
90 dpavlin 51 },\n";
91    
92 dpavlin 49 $out .= "\t\t},\n";
93    
94     $out .= "\t}),\n";
95 dpavlin 50
96     $out =~ s/,\n$/\n/;
97 dpavlin 49 $out .= "});\n";
98    
99 dpavlin 270 $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";
100 dpavlin 49
101 dpavlin 137 warn "method_list = ",dump( $meta->get_method_list ) if $self->debug;
102 dpavlin 49
103 dpavlin 51 # print $out;
104 dpavlin 49 my $path = "static/blib/$filename";
105     write_file( $path, $out );
106     warn "# created $path\n";
107 dpavlin 51
108     return $out;
109 dpavlin 49 }
110    
111 dpavlin 455 sub as_markup {
112 dpavlin 269 my ( $self ) = @_;
113 dpavlin 53
114 dpavlin 160 $self->add_head( 'static/introspect.css' );
115 dpavlin 139
116 dpavlin 308 my ( $meta, $is_role ) = $self->class_meta;
117 dpavlin 53
118 dpavlin 270 my $class = $self->class;
119 dpavlin 802 $self->title( $class );
120 dpavlin 54
121 dpavlin 602 my $introspect_path = "var/introspect/$class.yaml";
122     $self->mkbasepath( $introspect_path );
123 dpavlin 735 my $introspect; # FIXME update with = $self->load( $introspect_path );
124 dpavlin 602
125 dpavlin 310 my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
126     if ( ! $is_role ) {
127     if ( $meta->superclasses ) {
128     $superclasses = 'Superclasses: ' .
129     join(', ',
130     map {
131     my $name = $_->meta->name;
132 dpavlin 733 $introspect->{superclass}->{$name} = {};
133 dpavlin 943
134     qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| .
135     $self->dropdown( qq|<sup>?</sup>|, $_->meta )
136 dpavlin 310 }
137     #grep { $_ ne 'Moose::Object' }
138     $meta->superclasses
139     );
140     }
141     }
142    
143 dpavlin 733 my $method_from_role;
144     my $attribute_from_role;
145 dpavlin 310
146     if ( $meta->can('roles') ) {
147     my $role_nr = 1;
148     $roles = join(' ',
149     grep { ! m/\Q$class\E/ } # skip me
150     map {
151     my $name = $_->name;
152 dpavlin 733 $introspect->{roles}->{$name} = {};
153     $method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list;
154     $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
155 dpavlin 943
156     qq|<a target="$name" href="/$name" title="introspect $name">$name</a>|
157     # . qq|<sup>| . $self->dropdown( $role_nr++, $name->meta ) . qq|</sup>|
158     . $self->dropdown(
159     qq|<sup>| . $role_nr++ . qq|</sup>|,
160     $name->meta
161     )
162     ;
163 dpavlin 310 }
164     $meta->calculate_all_roles
165     );
166 dpavlin 943 $roles = qq|with roles: $roles| if $roles;
167 dpavlin 310 }
168 dpavlin 733 warn "# method_from_role ",dump( $method_from_role );
169 dpavlin 310
170 dpavlin 269 my @methods;
171 dpavlin 310 @methods = map {
172 dpavlin 313 my $name = $_;
173 dpavlin 733 if ( $method_from_role->{$name} ) {
174     my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
175     $introspect->{methods}->{$name}->{role} = $role_name;
176 dpavlin 313 $name .= qq|<sup title="$role_name">$nr</sup>|;
177 dpavlin 733 } else {
178     $introspect->{methods}->{$name} = {};
179 dpavlin 310 }
180 dpavlin 313 qq|<td class="m">$name</td>|
181 dpavlin 884 } sort {
182     lc($a) cmp lc($b)
183     } $self->class_methods( $class );
184 dpavlin 53
185 dpavlin 269 my @attributes;
186     if ( $meta->get_attribute_list ) {
187 dpavlin 409 @attributes = map {
188 dpavlin 313 my $name = $_;
189 dpavlin 733 $introspect->{attribute}->{$name} = {};
190 dpavlin 582 my $html_name = $name;
191 dpavlin 313 my $attr = $meta->get_attribute($name);
192 dpavlin 416 confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
193 dpavlin 393 warn "## attr $name ref ",ref( $attr ) if $self->debug;
194 dpavlin 582
195     my ( $title, $properties ) = ( '', '' );
196 dpavlin 733 if ( $attr->can('is_required') && $attr->is_required ) {
197     ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' );
198     $introspect->{attribute}->{$name}->{required} = 1;
199     }
200 dpavlin 582
201     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/ ) {
202 dpavlin 269 my $getter;
203    
204     $getter = $check;
205     $getter =~ s/^has_//;
206    
207 dpavlin 416 if ( $attr->can($check) && $attr->$check ) {
208 dpavlin 943 $properties .= $check;
209     # we need our dump here instead of $attr->$getter->dump because default can return scalar
210     my $v = $attr->$getter;
211     $properties .= ref($v)
212     ? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter )
213     : qq| <code>$v</code>|
214     ;
215 dpavlin 197 }
216 dpavlin 582 $properties .= ' ';
217 dpavlin 269 }
218 dpavlin 416 my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
219 dpavlin 313
220 dpavlin 733 if ( $attribute_from_role->{$name} ) {
221     my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
222 dpavlin 313 $name .= qq|<sup title="$role_name">$nr</sup>|;
223     }
224    
225 dpavlin 735 if ( my $doc = eval { $attr->documentation } ) {
226     $properties = qq|
227     $properties
228     <span class="documentation">$doc</span>
229     |;
230     $self->add_css(qq|
231     span.documentation {
232     background: #eee;
233     padding: 0.25em;
234 dpavlin 736 float: left;
235     clear: left;
236 dpavlin 735 }
237     |);
238     $introspect->{action}->{$name}->{documentation} = $doc;
239     }
240 dpavlin 582
241 dpavlin 943 qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>|
242 dpavlin 727 } sort $meta->get_attribute_list
243 dpavlin 269 }
244 dpavlin 54
245 dpavlin 312 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>|;
246 dpavlin 269 while ( @methods || @attributes ) {
247     my ($m,$a) = ( shift @methods, shift @attributes );
248     $m ||= '<td></td>';
249     $a ||= '<td></td>';
250     $table .= qq|<tr>$m$a</tr>|;
251     }
252     $table .= qq|</table>|;
253    
254 dpavlin 688 my $path = $self->class_path( $class );
255    
256 dpavlin 635 my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
257 dpavlin 688 return $pod if $path =~ m{\.pod};
258 dpavlin 134
259 dpavlin 406 my $Document = PPI::Document->new( $path );
260 dpavlin 380
261     # Create a reusable syntax highlighter
262     my $Highlight = PPI::HTML->new(
263 dpavlin 406 line_numbers => 1,
264 dpavlin 380 # page => 1,
265     # colors => {
266     # line_number => '#CCCCCC',
267     # number => '#990000',
268     # },
269     );
270    
271     # Spit out the HTML
272     my $source = $Highlight->html( $Document );
273    
274 dpavlin 407 $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
275 dpavlin 406
276     # strip page html
277 dpavlin 380 # $source =~ s{^.*<body[^>]+>}{}s;
278     # $source =~ s{</body.*$}{}s;
279    
280 dpavlin 409 my $runnable = join("\n",
281 dpavlin 458 map {
282 dpavlin 733 $introspect->{runnable}->{$_} = {};
283 dpavlin 662 my $short = $_;
284     $short =~ s{_as_(?:markup|data|sponge)$}{};
285     qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>|
286 dpavlin 458 } $self->class_runnable( $class )
287 dpavlin 409 );
288 dpavlin 943 $runnable = "Runnable: $runnable" if $runnable;
289 dpavlin 128
290 dpavlin 496 my $has_tests = '';
291 dpavlin 635 my @tests = grep { defined $_ } $self->has_tests;
292     if ( @tests ) {
293 dpavlin 496 $has_tests =
294 dpavlin 943 'Test' . ( $#tests > 0 ? 's' : '' ) . ': ' .
295 dpavlin 496 join("\n", map {
296 dpavlin 534 qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
297 dpavlin 496 } @tests );
298 dpavlin 943 $introspect->{tests} = [ @tests ],
299 dpavlin 496 }
300    
301 dpavlin 943 my $includes = '';
302     if ( my $inc = $self->includes ) {
303     $introspect->{includes} = $inc;
304     foreach my $type ( keys %$inc ) {
305     $includes
306     .= ucfirst($type)
307     . qq|: |
308     . join("\n",
309     map {
310     qq|<a target="$_" href="/$_">$_</a>|
311     } @{
312     $inc->{$type}
313     }
314     )
315     ;
316     }
317     }
318    
319     $self->store( $introspect_path, $introspect );
320    
321 dpavlin 993 $self->add_css(qq|
322     .right {
323     position: fixed;
324     top: 1em;
325     right: 1em;
326     z-index: 10;
327     background: #fff;
328     padding: 0.2em;
329     border: 1px dashed #ee8;
330     }
331     |);
332    
333 dpavlin 418 return join("\n",
334 dpavlin 993 qq|
335     <h1>$class</h1>
336     <div class="frey-introspect">
337     $superclasses $roles
338     <br>$includes
339     </div>
340     <div class="right">
341 dpavlin 943 |,
342 dpavlin 1012 join('<br>', grep { $_ } ( $runnable, $has_tests )),
343 dpavlin 418 $pod ? qq|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>| : '',
344     $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
345 dpavlin 993 qq|
346     </div>
347     $table
348     $pod
349     </div>
350    
351     <h1>Source</h1><a name="source"></a>
352     <div class="frey-source">$source</div>
353     |,
354 dpavlin 418 );
355 dpavlin 53 }
356    
357 dpavlin 49 =head1 SEE ALSO
358    
359     L<MooseX::AutoDoc> on which this code is based
360    
361     =cut
362    
363     1;

  ViewVC Help
Powered by ViewVC 1.1.26