/[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 455 by dpavlin, Wed Nov 19 15:28:23 2008 UTC revision 1125 by dpavlin, Tue Jun 30 14:03:17 2009 UTC
# Line 12  use PPI; Line 12  use PPI;
12  use PPI::HTML;  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 22  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 56  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 98  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  }  }
# Line 106  sub joose { Line 111  sub joose {
111  sub as_markup {  sub as_markup {
112          my ( $self ) = @_;          my ( $self ) = @_;
113    
         $self->add_head( 'static/introspect.css' );  
   
114          my ( $meta, $is_role ) = $self->class_meta;          my ( $meta, $is_role ) = $self->class_meta;
115    
116          my $class = $self->class;          my $class = $self->class;
117            $self->title( $class );
118    
119            my $introspect_path = "var/introspect/$class.yaml";
120            $self->mkbasepath( $introspect_path );
121            my $introspect; # FIXME update with = $self->load( $introspect_path );
122    
123          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
124          if ( ! $is_role ) {          if ( ! $is_role ) {
# Line 119  sub as_markup { Line 127  sub as_markup {
127                                  join(', ',                                  join(', ',
128                                          map {                                          map {
129                                                  my $name = $_->meta->name;                                                  my $name = $_->meta->name;
130                                                  qq|<a class="frey-popdown" href="/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|;                                                  $introspect->{superclass}->{$name} = {};
131    
132                                                    qq|<a target="$name" href="/$name" title="introspect $name">$name</a>| .
133                                                    $self->dropdown( qq|<sup>?</sup>|, $_->meta )
134                                          }                                          }
135                                          #grep { $_ ne 'Moose::Object' }                                          #grep { $_ ne 'Moose::Object' }
136                                          $meta->superclasses                                          $meta->superclasses
# Line 127  sub as_markup { Line 138  sub as_markup {
138                  }                  }
139          }          }
140    
141          my $role_method;          my $method_from_role;
142          my $role_attribute;          my $attribute_from_role;
143    
144          if ( $meta->can('roles') ) {          if ( $meta->can('roles') ) {
145                  my $role_nr = 1;                  my $role_nr = 1;
146                  $roles = join(' ',                  $roles = join(' ',
147                          grep { ! m/\Q$class\E/ }        # skip me                          grep { ! m/\Q$class\E/ }        # skip me
148                          map {                          map {
149                                  my $name = $_->name;                                  my $r = '';
150                                  $role_method->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;                                  foreach my $name ( split(/\|/, $_->name) ) {
151                                  $role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;                                          $introspect->{roles}->{$name} = {};
152                                  qq|<a class="frey-popdown" href="/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a><sup>| . $role_nr++ . qq|</sup>|;                                          $method_from_role->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
153                                            $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
154    
155                                            $r .=
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                                    $r;
165                          }                          }
166                          $meta->calculate_all_roles                          $meta->calculate_all_roles
167                  );                  );
168                  $roles = qq| with roles: $roles| if $roles;                  $roles = qq|with roles: $roles| if $roles;
169          }          }
170          warn "# role_method ",dump( $role_method );          warn "# method_from_role ",dump( $method_from_role );
171    
172          my @methods;          my @methods;
173          @methods = map {          @methods = map {
174                  my $name = $_;                  my $name = $_;
175                  if ( $role_method->{$name} ) {                  if ( $method_from_role->{$name} ) {
176                          my ( $role_name, $nr ) = each %{ $role_method->{$name} };                          my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
177                            $introspect->{methods}->{$name}->{role} = $role_name;
178                          $name .= qq|<sup title="$role_name">$nr</sup>|;                          $name .= qq|<sup title="$role_name">$nr</sup>|;
179                    } else {
180                            $introspect->{methods}->{$name} = {};
181                  }                  }
182                  qq|<td class="m">$name</td>|                  qq|<td class="m">$name</td>|
183            } sort {
184                    lc($a) cmp lc($b)      
185          } $self->class_methods( $class );          } $self->class_methods( $class );
186    
187          my @attributes;          my @attributes;
188          if ( $meta->get_attribute_list ) {          if ( $meta->get_attribute_list ) {
189                  @attributes = map {                  @attributes = map {
190                          my $name = $_;                          my $name = $_;
191                            $introspect->{attribute}->{$name} = {};
192                            my $html_name = $name;
193                          my $attr = $meta->get_attribute($name);                          my $attr = $meta->get_attribute($name);
194                          confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;                          confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
195                          warn "## attr $name ref ",ref( $attr ) if $self->debug;                          warn "## attr $name ref ",ref( $attr ) if $self->debug;
196                          my ( $before, $title, $after ) = ( '', '', '' );  
197                          ( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->can('is_required') && $attr->is_required;                          my ( $title, $properties ) = ( '', '' );
198                          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 ) {
199                                    ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' );
200                                    $introspect->{attribute}->{$name}->{required} = 1;
201                            }
202    
203                            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/ ) {
204                                  my $getter;                                  my $getter;
205                                                                    
206                                  $getter = $check;                                  $getter = $check;
207                                  $getter =~ s/^has_//;                                  $getter =~ s/^has_//;
208                                                                    
209                                  if ( $attr->can($check) && $attr->$check ) {                                  if ( $attr->can($check) && $attr->$check ) {
210                                          if ( $getter eq $check ) {                                          $properties .= $check;
211                                                  $after .= "$check";                                          # we need our dump here instead of $attr->$getter->dump because default can return scalar
212                                          } else {                                          my $v = $attr->$getter;
213                                                  $after .= qq{<span class="frey-popdown">$check};                                          $properties .= ref($v)
214                                                  # we need dump here instead of $attr->$getter->dump because default can return scalar                                                  ? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter )
215                                                  $after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check;                                                  : qq| <code>$v</code>|
216                                                  $after .= '</span>';                                                  ;
                                         }  
217                                  }                                  }
218                                  $after .= ' ';                                  $properties .= ' ';
219                          }                          }
220                          my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';                          my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
221    
222                          if ( $role_attribute->{$name} ) {                          if ( $attribute_from_role->{$name} ) {
223                                  my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };                                  my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
224                                  $name .= qq|<sup title="$role_name">$nr</sup>|;                                  $name .= qq|<sup title="$role_name">$nr</sup>|;
225                          }                          }
226    
227                          qq|<td class="a">$before $name</td><td class="t">$type</td><td>$after</td>|                          if ( my $doc = eval { $attr->documentation } ) {
228                  } $meta->get_attribute_list                                  $properties = qq|
229                                            $properties
230                                            <span class="documentation">$doc</span>
231                                    |;
232                                    $self->add_css(qq|
233                                            span.documentation {
234                                                    background: #eee;
235                                                    padding: 0.25em;
236                                                    float: left;
237                                                    clear: left;
238                                            }
239                                    |);
240                                    $introspect->{action}->{$name}->{documentation} = $doc;
241                            }
242    
243                            qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>|
244                    } sort $meta->get_attribute_list
245          }          }
246    
247          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>|;          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>|;
# Line 203  sub as_markup { Line 253  sub as_markup {
253          }          }
254          $table .= qq|</table>|;          $table .= qq|</table>|;
255    
         my $pod = Frey::Pod->new( class => $class )->as_markup;  
         $pod = $pod->{body} if ref($pod);  
   
256          my $path = $self->class_path( $class );          my $path = $self->class_path( $class );
257    
258            my ( $pod_toc, $pod ) = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
259            return $pod_toc . $pod if $path =~ m{\.pod};
260    
261            warn "# ", $pod_toc ? 'toc' : '', ' ', $pod ? 'pod' : '';
262    
263          my $Document = PPI::Document->new( $path );          my $Document = PPI::Document->new( $path );
264    
265          # Create a reusable syntax highlighter          # Create a reusable syntax highlighter
# Line 228  sub as_markup { Line 281  sub as_markup {
281  #       $source =~ s{^.*<body[^>]+>}{}s;  #       $source =~ s{^.*<body[^>]+>}{}s;
282  #       $source =~ s{</body.*$}{}s;  #       $source =~ s{</body.*$}{}s;
283    
284            my $runnable = join("</dd><dd>",
285          use Frey::Run;                  map {
286          my $class_method = $self->class_methods( $class );                          $introspect->{runnable}->{$_} = {};
287          my $runnable = join("\n",                          my $short = $_;
288                  map { $class_method->{$_} ? qq|<a href="/$class/$_">$_</a>| : '' } grep { $class->can($_) } Frey::Run->runnable                          $short =~ s{_as_(?:markup|data|sponge)$}{};
289                            qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>|
290                    } $self->class_runnable( $class )
291          );          );
292          $runnable = " runnable: $runnable" if $runnable;          $runnable = "<dt>runnable</dt><dd>$runnable</dd>" if $runnable;
293    
294          $self->title( $class );          my $has_tests = '';
295            my @tests = sort { lc($a) cmp lc($b) } grep { defined $_ } $self->has_tests;
296            if ( @tests ) {
297                    $has_tests
298                            = qq|<dt>test|
299                            . ( $#tests > 0 ? 's' : '' )
300                            . qq|<dt><dd>|
301                            . join("</dd><dd>", map {
302                                    qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
303                            } @tests )
304                            . qq|</dd>|
305                            ;
306                    $introspect->{tests} = [ @tests ],
307            }
308    
309          return join("\n",          my $includes = '';
310                  qq|<h1>$class</h1>|,          if ( my $inc = $self->includes ) {
311                  qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,                  $introspect->{includes} = $inc;
312                  $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',                  foreach my $type ( keys %$inc ) {
313                  $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',                          $includes
314                  qq|$table\n$pod\n</div>\n|,                                  .= ucfirst($type)
315                  qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,                                  . qq|: |
316          );                                  . join("\n",
317                                            map {
318                                                    qq|<a target="$_" href="/$_">$_</a>|
319                                            } @{
320                                                    $inc->{$type}
321                                            }
322                                    )
323                                    ;
324                    }
325            }
326    
327            $self->store( $introspect_path, $introspect );
328    
329            $self->add_css(qq|
330                    .frey-introspect-right {
331                            position: fixed;
332                            top: 1em;
333                            right: 1em;
334                            z-index: 10;
335                            background: #ffc;
336                            padding: 0.5em;
337                            width: 20%;
338                            font-size: 80%;
339                    }
340                    .frey-introspect-right dl dd {
341                            margin-left: 1em;
342                    }
343    
344                    /* fix pod */
345                    .frey-introspect-right dd ul {
346                            padding-left: 0;
347                    }
348                    .frey-introspect-right dl ul > li {
349                            list-style: none;
350                    }
351            |);
352    
353            my $has_pod = qq|
354                    <dt><a href="#___top" title="Skip to POD">pod</a></dt>
355                    <dd>$pod_toc</dd>
356            | if $pod_toc;
357    
358            my $has_source = qq|
359                    <dt><a href="#source" title="Skip to source">source</a></dt>
360            | if $source;
361    
362            my $right = qq|
363                    <dl>
364                    $runnable
365                    $has_tests
366                    $has_pod
367                    $has_source
368                    </dl>
369            |;
370    
371    
372            return
373                    qq|
374                            <h1>$class</h1>
375                            <div class="frey-introspect">
376                                    $superclasses $roles
377                                    <br>$includes
378                            </div>
379                            <div class="frey-introspect-right">
380                                    $right
381                            </div>
382                            $table
383                            $pod
384                            </div>
385    
386                            <h1>Source</h1><a name="source"></a>
387                            <div class="frey-source">$source</div>
388                    |
389                    ;
390  }  }
391    
392  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.455  
changed lines
  Added in v.1125
  ViewVC Help
Powered by ViewVC 1.1.26