/[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 116 by dpavlin, Sun Jul 13 18:01:40 2008 UTC revision 602 by dpavlin, Fri Nov 28 19:19:46 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    
16  extends 'Frey';  extends 'Frey::PPI';
17  with 'Frey::Web';  with 'Frey::Web';
18    with 'Frey::Storage';
19    
20  has 'package' => (  has 'class' => (
21          is => 'rw',          is => 'rw',
22          isa => 'Str',          isa => 'Str',
23          required => 1,          required => 1,
24  );  );
25    
 has 'path' => (  
         is => 'rw',  
 );  
   
26  =head2 joose  =head2 joose
27    
28    my $js = $o->joose( 'Some::Package' );    my $js = $o->joose;
29    
30  =cut  =cut
31    
32  sub joose {  sub joose {
33          my ($self) = @_;          my ($self) = @_;
34    
35          my ( $class, $meta, $is_role ) = $self->load_package;          my ( $meta, $is_role ) = $self->class_meta;
36    
37          if ( ! $is_role ) {          if ( ! $is_role ) {
38                  my @superclasses = map{ $_->meta->name }                  my @superclasses = map{ $_->meta->name }
# Line 42  sub joose { Line 42  sub joose {
42    
43          my $out;          my $out;
44    
45          my ( $m, $c ) = split(/::/, $class->name, 2);          my ( $m, $c ) = split(/::/, $self->class, 2);
46          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';
47    
48            $c ||= '';
49    
50          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";
51    
52          foreach ( $class->get_attribute_list ) {          foreach ( $meta->get_attribute_list ) {
53                  $out .= "\t\t\t$_: {\n";                  $out .= "\t\t\t$_: {\n";
54    
55                  my $attr = $class->get_attribute($_);                  my $attr = $meta->get_attribute($_);
56                  my $is = $attr->_is_metadata;                  my $is = $attr->_is_metadata;
57                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
58                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
# Line 75  sub joose { Line 77  sub joose {
77          $out .= "\t\t},\n\t\tmeta: Frey.HTML,          $out .= "\t\t},\n\t\tmeta: Frey.HTML,
78                  classMethods: {                  classMethods: {
79                          renderHTML: function () {                          renderHTML: function () {
80                                  return new Joose.SimpleRequest().getText(\"/~/" . $self->package . "\")                                  return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
81                          },\n";                          },\n";
82    
83          $out .= "\t\t},\n";          $out .= "\t\t},\n";
# Line 85  sub joose { Line 87  sub joose {
87          $out =~ s/,\n$/\n/;          $out =~ s/,\n$/\n/;
88          $out .= "});\n";          $out .= "});\n";
89    
90          $out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n";          $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";
91    
92          warn "method_list = ",dump( $class->get_method_list ) if $self->debug;          warn "method_list = ",dump( $meta->get_method_list ) if $self->debug;
93    
94  #       print $out;  #       print $out;
95          my $path = "static/blib/$filename";          my $path = "static/blib/$filename";
96          write_file( $path, $out );          write_file( $path, $out );
97          warn "# created $path\n";          warn "# created $path\n";
         $self->path( $path );  
98    
99          return $out;          return $out;
100  }  }
101    
102  =head2 methods  sub as_markup {
103            my ( $self ) = @_;
   my @methods = $o->methods;  
   
 =cut  
   
 sub methods {  
         my $self = shift;  
   
         my ( $class, $meta, $is_role ) = $self->load_package;  
   
         my $attr;  
         $attr->{$_}++ foreach $class->get_attribute_list;  
         my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list;  
         warn "# methods = ",dump( @methods ) if $self->debug;  
   
         return @methods;  
 }  
   
 use Frey::ClassLoader;  
   
 sub load_package {  
         my $self = shift;  
         return Frey::ClassLoader->load_package( $self->package );  
 }  
104    
105            $self->add_head( 'static/introspect.css' );
106    
107  =head1 OUTPUT GENERATION          my ( $meta, $is_role ) = $self->class_meta;
108    
109  =head2 html          my $class = $self->class;
110    
111    $o->html( $request );          my $introspect_path = "var/introspect/$class.yaml";
112            $self->mkbasepath( $introspect_path );
113            my $introspect = $self->load( $introspect_path );
114    
115  =cut          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
116            if ( ! $is_role ) {
117                    if ( $meta->superclasses ) {
118                            $superclasses = 'Superclasses: ' .
119                                    join(', ',
120                                            map {
121                                                    my $name = $_->meta->name;
122                                                    $introspect->{superclass}->{$name}++;
123                                                    $self->dropdown( $name, $_->meta )
124                                            }
125                                            #grep { $_ ne 'Moose::Object' }
126                                            $meta->superclasses
127                                    );
128                    }
129            }
130    
131  sub html {          my $role_method;
132          my ( $self, $request ) = @_;          my $role_attribute;
133    
134          while (1) {          if ( $meta->can('roles') ) {
135                    my $role_nr = 1;
136                    $roles = join(' ',
137                            grep { ! m/\Q$class\E/ }        # skip me
138                            map {
139                                    my $name = $_->name;
140                                    $introspect->{role}->{$name}++;
141                                    $role_method->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
142                                    $role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
143                                    $self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|;
144                            }
145                            $meta->calculate_all_roles
146                    );
147                    $roles = qq| with roles: $roles| if $roles;
148            }
149            warn "# role_method ",dump( $role_method );
150    
151                  my $js = $self->head_javascript;          my @methods;
152                  $js .= << '__END_OF_JS__';          @methods = map {
153  <script type="text/javascript">                  my $name = $_;
154  joose.loadComponents("../lib")                  $introspect->{method}->{$name}++;
155                    if ( $role_method->{$name} ) {
156                            my ( $role_name, $nr ) = each %{ $role_method->{$name} };
157                            $name .= qq|<sup title="$role_name">$nr</sup>|;
158                    }
159                    qq|<td class="m">$name</td>|
160            } $self->class_methods( $class );
161    
162  function $(id) {          my @attributes;
163          return document.getElementById(id)          if ( $meta->get_attribute_list ) {
164  }                  @attributes = map {
165                            my $name = $_;
166                            $introspect->{attribute}->{$name}++;
167                            my $html_name = $name;
168                            my $attr = $meta->get_attribute($name);
169                            confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
170                            warn "## attr $name ref ",ref( $attr ) if $self->debug;
171    
172                            my ( $title, $properties ) = ( '', '' );
173                            ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' )
174                                    if $attr->can('is_required') && $attr->is_required;
175    
176                            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/ ) {
177                                    my $getter;
178                                    
179                                    $getter = $check;
180                                    $getter =~ s/^has_//;
181                                    
182                                    if ( $attr->can($check) && $attr->$check ) {
183                                            if ( $getter eq $check ) {
184                                                    $properties .= "$check";
185                                            } else {
186                                                    # we need our dump here instead of $attr->$getter->dump because default can return scalar
187                                                    $properties .= $self->dropdown( $check, $attr->$getter );
188                                            }
189                                    }
190                                    $properties .= ' ';
191                            }
192                            my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
193    
194  </script>                          if ( $role_attribute->{$name} ) {
195  __END_OF_JS__                                  my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };
196                                    $name .= qq|<sup title="$role_name">$nr</sup>|;
197                            }
198    
199                  my ( $class, $meta, $is_role ) = $self->load_package;                          eval { $properties = $attr->documentation . ' ' . $properties };
200    
201                  my $methods;                          qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>|
202                  if ( $class->can('meta') ) {                  } $meta->get_attribute_list
203                          $methods = dom2html(          }
                                 ul => [  
                                         map { (  
                                                 li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ] ]  
                                         ) } $self->methods  
                                 ]  
                         );  
                         $methods = "<h2>Methods</h2>$methods" if $methods;  
                 } else {  
                         $methods = '<b>not introspectable</b>';  
                 }  
204    
205                  my $attributes;          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>|;
206                  if ( $class->get_attribute_list ) {          while ( @methods || @attributes ) {
207                          $attributes = dom2html(                  my ($m,$a) = ( shift @methods, shift @attributes );
208                                  table => [                  $m ||= '<td></td>';
209                                          map {                  $a ||= '<td></td>';
210                                                  my $attr = $class->get_attribute($_);                  $table .= qq|<tr>$m$a</tr>|;
211                                                  warn "## $_ ", $attr->is_required ? 'required' : 'optional';          }
212                                                  ( tr => [          $table .= qq|</table>|;
                                                         td => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ] ],  
                                                         td => [ $attr->is_required ? ' <b>required</b>' : '' ],  
                                                 ] )  
                                         } $class->get_attribute_list  
                                 ],  
                         );  
                         $attributes = "<h2>Attributes</h2>$attributes" if $attributes;  
                 } else {  
                         $attributes = '<b>no attributes</b>';  
                 }  
213    
214            my $pod = Frey::Pod->new( class => $class )->as_markup;
215            $pod = $pod->{body} if ref($pod);
216    
217                  my $html = dom2html(          my $path = $self->class_path( $class );
218                          html => [          my $Document = PPI::Document->new( $path );
                                 head => [  
                                         link => { rel=>"stylesheet", href=>"/static/app.css", type=>"text/css", media=>"screen" },  
                                         $js,  
                                         title => [ 'Introspect ', $self->package ],  
                                 ],  
                                 body => [  
                                         h1 => [ $self->package ],  
                                         $methods,  
                                         $attributes,  
                                 ],  
                         ]  
                 );  
219    
220                  $request->print($html);          # Create a reusable syntax highlighter
221                  warn "# >>> html ",length($html)," bytes\n";          my $Highlight = PPI::HTML->new(
222                  $request->next;                  line_numbers => 1,
223    #               page => 1,
224    #               colors => {
225    #                       line_number => '#CCCCCC',
226    #                       number      => '#990000',
227    #               },
228            );
229    
230            # Spit out the HTML
231            my $source = $Highlight->html( $Document );
232    
233            $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
234    
235            # strip page html
236    #       $source =~ s{^.*<body[^>]+>}{}s;
237    #       $source =~ s{</body.*$}{}s;
238    
239            my $runnable = join("\n",
240                    map {
241                            $introspect->{runnable}->{$_}++;
242                            qq|<a target="$class" href="/$class/$_">$_</a>|
243                    } $self->class_runnable( $class )
244            );
245            $runnable = " runnable: $runnable" if $runnable;
246    
247            $self->store( $introspect_path, $introspect );
248    
249            $self->title( $class );
250    
251            my $has_tests = '';
252            if ( my @tests = $self->has_tests ) {
253                    $has_tests =
254                    '<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' .      
255                    join("\n", map {
256                            qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
257                    } @tests );
258          }          }
259          warn "# exit html";  
260            return join("\n",
261                    qq|<h1>$class</h1>|,
262                    qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,
263                    $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',
264                    $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
265                    $has_tests,
266                    qq|$table\n$pod\n</div>\n|,
267                    qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,
268            );
269  }  }
270    
271  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.116  
changed lines
  Added in v.602
  ViewVC Help
Powered by ViewVC 1.1.26