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