/[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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 358 by dpavlin, Sun Nov 16 16:36:53 2008 UTC revision 993 by dpavlin, Sun Jan 11 12:09:58 2009 UTC
# Line 8  use Data::Dump qw/dump/; Line 8  use Data::Dump qw/dump/;
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::ClassLoader';  extends 'Frey::PPI';
18  with 'Frey::Web';  with 'Frey::Web';
19    with 'Frey::Storage';
20    
21    =head1 DESCRIPTION
22    
23    Provide introspection on any perl class installed on system
24    
25    =cut
26    
27  has 'class' => (  has 'class' => (
28          is => 'rw',          is => 'rw',
# Line 19  has 'class' => ( Line 30  has 'class' => (
30          required => 1,          required => 1,
31  );  );
32    
 has 'path' => (  
         is => 'rw',  
 );  
   
33  =head2 joose  =head2 joose
34    
35    my $js = $o->joose;    my $js = $o->joose;
# Line 53  sub joose { Line 60  sub joose {
60                  $out .= "\t\t\t$_: {\n";                  $out .= "\t\t\t$_: {\n";
61    
62                  my $attr = $meta->get_attribute($_);                  my $attr = $meta->get_attribute($_);
63                  my $is = $attr->_is_metadata;                  my $is = eval { $attr->_is_metadata; };
64                    return if $@;
65    
66                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
67                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
68                  $out .= "\t\t\t\trequired: true,\n" if $attr->is_required;                  $out .= "\t\t\t\trequired: true,\n" if $attr->is_required;
# Line 95  sub joose { Line 104  sub joose {
104          my $path = "static/blib/$filename";          my $path = "static/blib/$filename";
105          write_file( $path, $out );          write_file( $path, $out );
106          warn "# created $path\n";          warn "# created $path\n";
         $self->path( $path );  
107    
108          return $out;          return $out;
109  }  }
110    
111  =head2 methods  sub as_markup {
   
   my @methods = $o->methods;  
   
 =cut  
   
 sub methods {  
         my $self = shift;  
   
         my ( $meta, $is_role ) = $self->class_meta;  
   
         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;  
 }  
   
 =head1 OUTPUT GENERATION  
   
 =head2 markup  
   
   $o->markup;  
   
 =cut  
   
 sub markup {  
112          my ( $self ) = @_;          my ( $self ) = @_;
113    
114          $self->add_head( 'static/introspect.css' );          $self->add_head( 'static/introspect.css' );
# Line 135  sub markup { Line 116  sub markup {
116          my ( $meta, $is_role ) = $self->class_meta;          my ( $meta, $is_role ) = $self->class_meta;
117    
118          my $class = $self->class;          my $class = $self->class;
119            $self->title( $class );
120    
121            my $introspect_path = "var/introspect/$class.yaml";
122            $self->mkbasepath( $introspect_path );
123            my $introspect; # FIXME update with = $self->load( $introspect_path );
124    
125          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
126          if ( ! $is_role ) {          if ( ! $is_role ) {
# Line 143  sub markup { Line 129  sub markup {
129                                  join(', ',                                  join(', ',
130                                          map {                                          map {
131                                                  my $name = $_->meta->name;                                                  my $name = $_->meta->name;
132                                                  qq|<a class="frey-popdown" href="/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|;                                                  $introspect->{superclass}->{$name} = {};
133    
134                                                    qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| .
135                                                    $self->dropdown( qq|<sup>?</sup>|, $_->meta )
136                                          }                                          }
137                                          #grep { $_ ne 'Moose::Object' }                                          #grep { $_ ne 'Moose::Object' }
138                                          $meta->superclasses                                          $meta->superclasses
# Line 151  sub markup { Line 140  sub markup {
140                  }                  }
141          }          }
142    
143          my $role_method;          my $method_from_role;
144          my $role_attribute;          my $attribute_from_role;
145    
146          if ( $meta->can('roles') ) {          if ( $meta->can('roles') ) {
147                  my $role_nr = 1;                  my $role_nr = 1;
# Line 160  sub markup { Line 149  sub markup {
149                          grep { ! m/\Q$class\E/ }        # skip me                          grep { ! m/\Q$class\E/ }        # skip me
150                          map {                          map {
151                                  my $name = $_->name;                                  my $name = $_->name;
152                                  $role_method->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;                                  $introspect->{roles}->{$name} = {};
153                                  $role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;                                  $method_from_role->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
154                                  qq|<a class="frey-popdown" href="/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a><sup>| . $role_nr++ . qq|</sup>|;                                  $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
155    
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                          }                          }
164                          $meta->calculate_all_roles                          $meta->calculate_all_roles
165                  );                  );
166                  $roles = qq| with roles: $roles| if $roles;                  $roles = qq|with roles: $roles| if $roles;
167          }          }
168          warn "# role_method ",dump( $role_method );          warn "# method_from_role ",dump( $method_from_role );
169    
170          my @methods;          my @methods;
171          @methods = map {          @methods = map {
172                  my $name = $_;                  my $name = $_;
173                  if ( $role_method->{$name} ) {                  if ( $method_from_role->{$name} ) {
174                          my ( $role_name, $nr ) = each %{ $role_method->{$name} };                          my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
175                            $introspect->{methods}->{$name}->{role} = $role_name;
176                          $name .= qq|<sup title="$role_name">$nr</sup>|;                          $name .= qq|<sup title="$role_name">$nr</sup>|;
177                    } else {
178                            $introspect->{methods}->{$name} = {};
179                  }                  }
180                  qq|<td class="m">$name</td>|                  qq|<td class="m">$name</td>|
181          } $self->methods;          } sort {
182                    lc($a) cmp lc($b)      
183            } $self->class_methods( $class );
184    
185          my @attributes;          my @attributes;
186          if ( $meta->get_attribute_list ) {          if ( $meta->get_attribute_list ) {
187          @attributes = map {                  @attributes = map {
188                          my $name = $_;                          my $name = $_;
189                            $introspect->{attribute}->{$name} = {};
190                            my $html_name = $name;
191                          my $attr = $meta->get_attribute($name);                          my $attr = $meta->get_attribute($name);
192                          warn "## ref attr: ",ref( $attr );                          confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
193                          my ( $before, $title, $after ) = ( '', '', '' );                          warn "## attr $name ref ",ref( $attr ) if $self->debug;
194                          ( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required;  
195  warn $attr->dump(3);                          my ( $title, $properties ) = ( '', '' );
196                          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/ ) {                          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    
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                                  my $getter;                                  my $getter;
203                                                                    
204                                  $getter = $check;                                  $getter = $check;
205                                  $getter =~ s/^has_//;                                  $getter =~ s/^has_//;
206                                                                    
207                                  if ( $attr->$check ) {                                  if ( $attr->can($check) && $attr->$check ) {
208                                          if ( $getter eq $check ) {                                          $properties .= $check;
209                                                  $after .= "$check";                                          # we need our dump here instead of $attr->$getter->dump because default can return scalar
210                                          } else {                                          my $v = $attr->$getter;
211                                                  $after .= qq{<span class="frey-popdown">$check};                                          $properties .= ref($v)
212                                                  # we need dump here instead of $attr->$getter->dump because default can return scalar                                                  ? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter )
213                                                  $after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check;                                                  : qq| <code>$v</code>|
214                                                  $after .= '</span>';                                                  ;
                                         }  
215                                  }                                  }
216                                  $after .= ' ';                                  $properties .= ' ';
217                          }                          }
218                          my $type = $attr->has_type_constraint ? $attr->type_constraint->name : '';                          my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
219    
220                          if ( $role_attribute->{$name} ) {                          if ( $attribute_from_role->{$name} ) {
221                                  my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };                                  my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
222                                  $name .= qq|<sup title="$role_name">$nr</sup>|;                                  $name .= qq|<sup title="$role_name">$nr</sup>|;
223                          }                          }
224    
225                          qq|<td class="a">$before $name</td><td class="t">$type</td><td>$after</td>|                          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                                                    float: left;
235                                                    clear: left;
236                                            }
237                                    |);
238                                    $introspect->{action}->{$name}->{documentation} = $doc;
239                            }
240    
241                            qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>|
242                  } sort $meta->get_attribute_list                  } sort $meta->get_attribute_list
243          }          }
244    
# Line 227  warn $attr->dump(3); Line 251  warn $attr->dump(3);
251          }          }
252          $table .= qq|</table>|;          $table .= qq|</table>|;
253    
254          my $pod = Frey::Pod->new( class => $class )->markup;          my $path = $self->class_path( $class );
255    
256          use Frey::Run;          my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
257          my $runnable = join("\n", map { qq|<a href="/$class/$_">$_</a>| } grep { $class->can($_) } Frey::Run->runnable );          return $pod if $path =~ m{\.pod};
         $runnable = " runnable: $runnable" if $runnable;  
   
         my $html = {  
                 title => "Introspect $class",  
                 body => qq|<h1>$class</h1>|  
                         . qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|  
                         . ( $pod ? qq|<a href="#___top" title="Skip to POD" style="font-size: 80%; color: #aaa;">&darr;pod&darr</a>| : '' )  
                         . qq|$table\n$pod</div>|  
258    
259          };          my $Document = PPI::Document->new( $path );
260    
261            # Create a reusable syntax highlighter
262            my $Highlight = PPI::HTML->new(
263                    line_numbers => 1,
264    #               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            $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
275    
276            # strip page html
277    #       $source =~ s{^.*<body[^>]+>}{}s;
278    #       $source =~ s{</body.*$}{}s;
279    
280            my $runnable = join("\n",
281                    map {
282                            $introspect->{runnable}->{$_} = {};
283                            my $short = $_;
284                            $short =~ s{_as_(?:markup|data|sponge)$}{};
285                            qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>|
286                    } $self->class_runnable( $class )
287            );
288            $runnable = "Runnable: $runnable" if $runnable;
289    
290            my $has_tests = '';
291            my @tests = grep { defined $_ } $self->has_tests;
292            if ( @tests ) {
293                    $has_tests =
294                    'Test' . ( $#tests > 0 ? 's' : '' ) . ': ' .    
295                    join("\n", map {
296                            qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
297                    } @tests );
298                    $introspect->{tests} = [ @tests ],
299            }
300    
301            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            $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          return $html;          return join("\n",
334                    qq|
335                            <h1>$class</h1>
336                            <div class="frey-introspect">
337                                    $superclasses $roles
338                                    <br>$includes
339                            </div>
340                            <div class="right">
341                                    $runnable
342                    |,
343                    $has_tests,
344                    $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',
345                    $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
346                    qq|
347                            </div>
348                            $table
349                            $pod
350                            </div>
351    
352                            <h1>Source</h1><a name="source"></a>
353                            <div class="frey-source">$source</div>
354                    |,
355            );
356  }  }
357    
358  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.358  
changed lines
  Added in v.993
  ViewVC Help
Powered by ViewVC 1.1.26