/[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 406 by dpavlin, Tue Nov 18 11:53:58 2008 UTC revision 1111 by dpavlin, Mon Jun 29 17:01:28 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  }  }
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    
         $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 146  sub markup { Line 127  sub 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 154  sub markup { Line 138  sub 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;
# Line 163  sub markup { Line 147  sub markup {
147                          grep { ! m/\Q$class\E/ }        # skip me                          grep { ! m/\Q$class\E/ }        # skip me
148                          map {                          map {
149                                  my $name = $_->name;                                  my $name = $_->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                                  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;
153    
154                                      qq|<a target="$name" href="/$name" title="introspect $name">$name</a>|
155    #                               . qq|<sup>| . $self->dropdown( $role_nr++, $name->meta ) . qq|</sup>|
156                                    . $self->dropdown(
157                                            qq|<sup>| . $role_nr++ . qq|</sup>|,
158                                            $name->meta
159                                    )
160                                    ;
161                          }                          }
162                          $meta->calculate_all_roles                          $meta->calculate_all_roles
163                  );                  );
164                  $roles = qq| with roles: $roles| if $roles;                  $roles = qq|with roles: $roles| if $roles;
165          }          }
166          warn "# role_method ",dump( $role_method );          warn "# method_from_role ",dump( $method_from_role );
167    
168          my @methods;          my @methods;
169          @methods = map {          @methods = map {
170                  my $name = $_;                  my $name = $_;
171                  if ( $role_method->{$name} ) {                  if ( $method_from_role->{$name} ) {
172                          my ( $role_name, $nr ) = each %{ $role_method->{$name} };                          my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
173                            $introspect->{methods}->{$name}->{role} = $role_name;
174                          $name .= qq|<sup title="$role_name">$nr</sup>|;                          $name .= qq|<sup title="$role_name">$nr</sup>|;
175                    } else {
176                            $introspect->{methods}->{$name} = {};
177                  }                  }
178                  qq|<td class="m">$name</td>|                  qq|<td class="m">$name</td>|
179          } $self->methods;          } sort {
180                    lc($a) cmp lc($b)      
181            } $self->class_methods( $class );
182    
183          my @attributes;          my @attributes;
184          if ( $meta->get_attribute_list ) {          if ( $meta->get_attribute_list ) {
185          @attributes = map {                  @attributes = map {
186                          my $name = $_;                          my $name = $_;
187                            $introspect->{attribute}->{$name} = {};
188                            my $html_name = $name;
189                          my $attr = $meta->get_attribute($name);                          my $attr = $meta->get_attribute($name);
190                            confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
191                          warn "## attr $name ref ",ref( $attr ) if $self->debug;                          warn "## attr $name ref ",ref( $attr ) if $self->debug;
192                          my ( $before, $title, $after ) = ( '', '', '' );  
193                          ( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required;                          my ( $title, $properties ) = ( '', '' );
194                          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 ) {
195                                    ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' );
196                                    $introspect->{attribute}->{$name}->{required} = 1;
197                            }
198    
199                            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/ ) {
200                                  my $getter;                                  my $getter;
201                                                                    
202                                  $getter = $check;                                  $getter = $check;
203                                  $getter =~ s/^has_//;                                  $getter =~ s/^has_//;
204                                                                    
205                                  if ( $attr->$check ) {                                  if ( $attr->can($check) && $attr->$check ) {
206                                          if ( $getter eq $check ) {                                          $properties .= $check;
207                                                  $after .= "$check";                                          # we need our dump here instead of $attr->$getter->dump because default can return scalar
208                                          } else {                                          my $v = $attr->$getter;
209                                                  $after .= qq{<span class="frey-popdown">$check};                                          $properties .= ref($v)
210                                                  # we need dump here instead of $attr->$getter->dump because default can return scalar                                                  ? $self->dropdown( qq|<sup>?</sup>|, $attr->$getter )
211                                                  $after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check;                                                  : qq| <code>$v</code>|
212                                                  $after .= '</span>';                                                  ;
                                         }  
213                                  }                                  }
214                                  $after .= ' ';                                  $properties .= ' ';
215                          }                          }
216                          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 : '';
217    
218                          if ( $role_attribute->{$name} ) {                          if ( $attribute_from_role->{$name} ) {
219                                  my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };                                  my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
220                                  $name .= qq|<sup title="$role_name">$nr</sup>|;                                  $name .= qq|<sup title="$role_name">$nr</sup>|;
221                          }                          }
222    
223                          qq|<td class="a">$before $name</td><td class="t">$type</td><td>$after</td>|                          if ( my $doc = eval { $attr->documentation } ) {
224                                    $properties = qq|
225                                            $properties
226                                            <span class="documentation">$doc</span>
227                                    |;
228                                    $self->add_css(qq|
229                                            span.documentation {
230                                                    background: #eee;
231                                                    padding: 0.25em;
232                                                    float: left;
233                                                    clear: left;
234                                            }
235                                    |);
236                                    $introspect->{action}->{$name}->{documentation} = $doc;
237                            }
238    
239                            qq|<td class="a">$html_name</td><td class="t">$type</td><td class="p">$properties</td>|
240                  } sort $meta->get_attribute_list                  } sort $meta->get_attribute_list
241          }          }
242    
# Line 229  sub markup { Line 249  sub markup {
249          }          }
250          $table .= qq|</table>|;          $table .= qq|</table>|;
251    
         my $pod = Frey::Pod->new( class => $class )->markup;  
         $pod = $pod->{body} if ref($pod);  
   
252          my $path = $self->class_path( $class );          my $path = $self->class_path( $class );
253    
254            my ( $pod_toc, $pod ) = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
255            return $pod_toc . $pod if $path =~ m{\.pod};
256    
257            warn "# ", $pod_toc ? 'toc' : '', ' ', $pod ? 'pod' : '';
258    
259          my $Document = PPI::Document->new( $path );          my $Document = PPI::Document->new( $path );
260    
261          # Create a reusable syntax highlighter          # Create a reusable syntax highlighter
# Line 248  sub markup { Line 271  sub markup {
271          # Spit out the HTML          # Spit out the HTML
272          my $source = $Highlight->html( $Document );          my $source = $Highlight->html( $Document );
273    
274          $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a href="/editor+$path+$2" title="edit $path +$2" target="editor">$2</a>$3}g;          $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          # strip page html
277  #       $source =~ s{^.*<body[^>]+>}{}s;  #       $source =~ s{^.*<body[^>]+>}{}s;
278  #       $source =~ s{</body.*$}{}s;  #       $source =~ s{</body.*$}{}s;
279    
280            my $runnable = join("</dd><dd>",
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 = "<dt>runnable</dt><dd>$runnable</dd>" if $runnable;
289    
290          use Frey::Run;          my $has_tests = '';
291          my $runnable = join("\n", map { qq|<a href="/$class/$_">$_</a>| } grep { $class->can($_) } Frey::Run->runnable );          my @tests = sort { lc($a) cmp lc($b) } grep { defined $_ } $self->has_tests;
292          $runnable = " runnable: $runnable" if $runnable;          if ( @tests ) {
293                    $has_tests
294          my $html = {                          = qq|<dt>test|
295                  title => $class,                          . ( $#tests > 0 ? 's' : '' )
296                  body => join("\n",                          . qq|<dt><dd>|
297                          qq|<h1>$class</h1>|,                          . join("</dd><dd>", map {
298                          qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,                                  qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
299                          $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',                          } @tests )
300                          $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',                          . qq|</dd>|
301                          qq|$table\n$pod\n</div>\n|,                          ;
302                          qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,                  $introspect->{tests} = [ @tests ],
303                  ),          }
304          };  
305            my $includes = '';
306            if ( my $inc = $self->includes ) {
307                    $introspect->{includes} = $inc;
308                    foreach my $type ( keys %$inc ) {
309                            $includes
310                                    .= ucfirst($type)
311                                    . qq|: |
312                                    . join("\n",
313                                            map {
314                                                    qq|<a target="$_" href="/$_">$_</a>|
315                                            } @{
316                                                    $inc->{$type}
317                                            }
318                                    )
319                                    ;
320                    }
321            }
322    
323            $self->store( $introspect_path, $introspect );
324    
325            $self->add_css(qq|
326                    .frey-introspect-right {
327                            position: fixed;
328                            top: 1em;
329                            right: 1em;
330                            z-index: 10;
331                            background: #ffc;
332                            padding: 0.5em;
333                            width: 20%;
334                            font-size: 80%;
335                    }
336                    .frey-introspect-right dl dd {
337                            margin-left: 1em;
338                    }
339    
340                    /* fix pod */
341                    .frey-introspect-right dd ul {
342                            padding-left: 0;
343                    }
344                    .frey-introspect-right dl ul > li {
345                            list-style: none;
346                    }
347            |);
348    
349          return $html;          my $has_pod = qq|
350                    <dt><a href="#___top" title="Skip to POD">pod</a></dt>
351                    <dd>$pod_toc</dd>
352            | if $pod_toc;
353    
354            my $has_source = qq|
355                    <dt><a href="#source" title="Skip to source">source</a></dt>
356            | if $source;
357    
358            my $right = qq|
359                    <dl>
360                    $runnable
361                    $has_tests
362                    $has_pod
363                    $has_source
364                    </dl>
365            |;
366    
367    
368            return
369                    qq|
370                            <h1>$class</h1>
371                            <div class="frey-introspect">
372                                    $superclasses $roles
373                                    <br>$includes
374                            </div>
375                            <div class="frey-introspect-right">
376                                    $right
377                            </div>
378                            $table
379                            $pod
380                            </div>
381    
382                            <h1>Source</h1><a name="source"></a>
383                            <div class="frey-source">$source</div>
384                    |
385                    ;
386  }  }
387    
388  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.406  
changed lines
  Added in v.1111
  ViewVC Help
Powered by ViewVC 1.1.26