/[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 308 by dpavlin, Wed Nov 5 19:13:01 2008 UTC revision 884 by dpavlin, Wed Dec 24 12:43:41 2008 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  has 'class' => (  has 'class' => (
22          is => 'rw',          is => 'rw',
# Line 19  has 'class' => ( Line 24  has 'class' => (
24          required => 1,          required => 1,
25  );  );
26    
 has 'path' => (  
         is => 'rw',  
 );  
   
27  =head2 joose  =head2 joose
28    
29    my $js = $o->joose;    my $js = $o->joose;
# Line 95  sub joose { Line 96  sub joose {
96          my $path = "static/blib/$filename";          my $path = "static/blib/$filename";
97          write_file( $path, $out );          write_file( $path, $out );
98          warn "# created $path\n";          warn "# created $path\n";
         $self->path( $path );  
99    
100          return $out;          return $out;
101  }  }
102    
103  =head2 methods  sub as_markup {
104            my ( $self ) = @_;
   my @methods = $o->methods;  
   
 =cut  
105    
106  sub methods {          $self->add_head( 'static/introspect.css' );
         my $self = shift;  
107    
108          my ( $meta, $is_role ) = $self->class_meta;          my ( $meta, $is_role ) = $self->class_meta;
109    
110          my $attr;          my $class = $self->class;
111          $attr->{$_}++ foreach $meta->get_attribute_list;          $self->title( $class );
         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  
112    
113  sub markup {          my $introspect_path = "var/introspect/$class.yaml";
114          my ( $self ) = @_;          $self->mkbasepath( $introspect_path );
115            my $introspect; # FIXME update with = $self->load( $introspect_path );
116    
117          $self->add_head( 'static/introspect.css' );          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
118            if ( ! $is_role ) {
119                    if ( $meta->superclasses ) {
120                            $superclasses = 'Superclasses: ' .
121                                    join(', ',
122                                            map {
123                                                    my $name = $_->meta->name;
124                                                    $introspect->{superclass}->{$name} = {};
125                                                    $self->dropdown( $name, $_->meta )
126                                            }
127                                            #grep { $_ ne 'Moose::Object' }
128                                            $meta->superclasses
129                                    );
130                    }
131            }
132    
133          my ( $meta, $is_role ) = $self->class_meta;          my $method_from_role;
134            my $attribute_from_role;
135    
136          my $class = $self->class;          if ( $meta->can('roles') ) {
137                    my $role_nr = 1;
138                    $roles = join(' ',
139                            grep { ! m/\Q$class\E/ }        # skip me
140                            map {
141                                    my $name = $_->name;
142                                    $introspect->{roles}->{$name} = {};
143                                    $method_from_role->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
144                                    $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
145                                    $self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|;
146                            }
147                            $meta->calculate_all_roles
148                    );
149                    $roles = qq| with roles: $roles| if $roles;
150            }
151            warn "# method_from_role ",dump( $method_from_role );
152    
153          my @methods;          my @methods;
154          @methods = map { qq|<td class="m">$_</td>| } $self->methods;          @methods = map {
155                    my $name = $_;
156                    if ( $method_from_role->{$name} ) {
157                            my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
158                            $introspect->{methods}->{$name}->{role} = $role_name;
159                            $name .= qq|<sup title="$role_name">$nr</sup>|;
160                    } else {
161                            $introspect->{methods}->{$name} = {};
162                    }
163                    qq|<td class="m">$name</td>|
164            } sort {
165                    lc($a) cmp lc($b)      
166            } $self->class_methods( $class );
167    
168          my @attributes;          my @attributes;
169          if ( $meta->get_attribute_list ) {          if ( $meta->get_attribute_list ) {
170          @attributes = map {                  @attributes = map {
171                          my $attr = $meta->get_attribute($_);                          my $name = $_;
172                          my ( $before, $title, $after ) = ( '', '', '' );                          $introspect->{attribute}->{$name} = {};
173                          ( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required;                          my $html_name = $name;
174  warn $attr->dump(3);                          my $attr = $meta->get_attribute($name);
175                          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/ ) {                          confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
176                            warn "## attr $name ref ",ref( $attr ) if $self->debug;
177    
178                            my ( $title, $properties ) = ( '', '' );
179                            if ( $attr->can('is_required') && $attr->is_required ) {
180                                    ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' );
181                                    $introspect->{attribute}->{$name}->{required} = 1;
182                            }
183    
184                            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/ ) {
185                                  my $getter;                                  my $getter;
186                                                                    
187                                  $getter = $check;                                  $getter = $check;
188                                  $getter =~ s/^has_//;                                  $getter =~ s/^has_//;
189                                                                    
190                                  if ( $attr->$check ) {                                  if ( $attr->can($check) && $attr->$check ) {
191                                          if ( $getter eq $check ) {                                          if ( $getter eq $check ) {
192                                                  $after .= "$check";                                                  $properties .= "$check";
193                                          } else {                                          } else {
194                                                  $after .= qq{<span class="frey-popdown">$check};                                                  # we need our dump here instead of $attr->$getter->dump because default can return scalar
195                                                  # we need dump here instead of $attr->$getter->dump because default can return scalar                                                  $properties .= $self->dropdown( $check, $attr->$getter );
                                                 $after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check;  
                                                 $after .= '</span>';  
196                                          }                                          }
197                                  }                                  }
198                                  $after .= ' ';                                  $properties .= ' ';
199                            }
200                            my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
201    
202                            if ( $attribute_from_role->{$name} ) {
203                                    my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
204                                    $name .= qq|<sup title="$role_name">$nr</sup>|;
205                            }
206    
207                            if ( my $doc = eval { $attr->documentation } ) {
208                                    $properties = qq|
209                                            $properties
210                                            <span class="documentation">$doc</span>
211                                    |;
212                                    $self->add_css(qq|
213                                            span.documentation {
214                                                    background: #eee;
215                                                    padding: 0.25em;
216                                                    float: left;
217                                                    clear: left;
218                                            }
219                                    |);
220                                    $introspect->{action}->{$name}->{documentation} = $doc;
221                          }                          }
222                          my $type = $attr->has_type_constraint ? $attr->type_constraint->name : '';  
223                          qq|<td class="a">$before $_</td><td class="t">$type</td><td>$after</td>|                          qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>|
224                  } sort $meta->get_attribute_list                  } sort $meta->get_attribute_list
225          }          }
226    
227          my $table = qq|<table class="frey-object-browser"><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>|;
228          while ( @methods || @attributes ) {          while ( @methods || @attributes ) {
229                  my ($m,$a) = ( shift @methods, shift @attributes );                  my ($m,$a) = ( shift @methods, shift @attributes );
230                  $m ||= '<td></td>';                  $m ||= '<td></td>';
# Line 178  warn $attr->dump(3); Line 233  warn $attr->dump(3);
233          }          }
234          $table .= qq|</table>|;          $table .= qq|</table>|;
235    
236          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );          my $path = $self->class_path( $class );
         if ( ! $is_role ) {  
                 if ( $meta->superclasses ) {  
                         $superclasses = 'Superclasses: ' .  
                                 join(', ',  
                                         map {  
                                                 my $name = $_->meta->name;  
                                                 qq|<a class="frey-popdown" href="/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|;  
                                         }  
                                         #grep { $_ ne 'Moose::Object' }  
                                         $meta->superclasses  
                                 );  
                 }  
         }  
237    
238          if ( $meta->can('roles') ) {          my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
239                  $roles = join(', ',          return $pod if $path =~ m{\.pod};
                         grep { ! m/\Q$class\E/ }        # skip me  
                         map {  
                                 my $name = $_->name;  
                                 qq|<a class="frey-popdown" href="/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a>|;  
                         }  
                         $meta->calculate_all_roles  
                 );  
                 $roles = " with roles: $roles" if $roles;  
         }  
240    
241          my $pod = Frey::Pod->new( class => $class )->markup;          my $Document = PPI::Document->new( $path );
242    
243            # Create a reusable syntax highlighter
244            my $Highlight = PPI::HTML->new(
245                    line_numbers => 1,
246    #               page => 1,
247    #               colors => {
248    #                       line_number => '#CCCCCC',
249    #                       number      => '#990000',
250    #               },
251            );
252    
253          use Frey::Run;          # Spit out the HTML
254          my $execute = join("\n", map { qq|<a href="/$class/$_">$_</a>| } grep { $class->can($_) } Frey::Run->execute );          my $source = $Highlight->html( $Document );
         $execute = " execute: $execute" if $execute;  
255    
256          my $html = $self->page(          $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
                 title => "Introspect $class",  
                 body => qq|<h1>$class</h1>|  
                         . qq|$superclasses\n$roles\n$execute\n|  
                         . ( $pod ? qq|<a href="#___top" title="Skip to POD" style="font-size: 80%; color: #aaa;">&darr;pod&darr</a>| : '' )  
                         . qq|$table\n$pod|  
257    
258            # strip page html
259    #       $source =~ s{^.*<body[^>]+>}{}s;
260    #       $source =~ s{</body.*$}{}s;
261    
262            my $runnable = join("\n",
263                    map {
264                            $introspect->{runnable}->{$_} = {};
265                            my $short = $_;
266                            $short =~ s{_as_(?:markup|data|sponge)$}{};
267                            qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>|
268                    } $self->class_runnable( $class )
269          );          );
270            $runnable = "<br>run: $runnable" if $runnable;
271    
272          return $html;          $self->store( $introspect_path, $introspect );
273    
274            my $has_tests = '';
275            my @tests = grep { defined $_ } $self->has_tests;
276            if ( @tests ) {
277                    $has_tests =
278                    '<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' .      
279                    join("\n", map {
280                            qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
281                    } @tests );
282            }
283    
284            return join("\n",
285                    qq|<h1>$class</h1>|,
286                    qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,
287                    $has_tests,
288                    $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',
289                    $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
290                    qq|$table\n$pod\n</div>\n|,
291                    qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,
292            );
293  }  }
294    
295  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.308  
changed lines
  Added in v.884
  ViewVC Help
Powered by ViewVC 1.1.26