/[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 56 by dpavlin, Sun Jul 6 11:59:58 2008 UTC revision 380 by dpavlin, Mon Nov 17 18:42:51 2008 UTC
# Line 2  package Frey::Introspect; Line 2  package Frey::Introspect;
2    
3  use Moose;  use Moose;
4  use Carp;  use Carp;
5  use Class::MOP;  #use Moose::Meta::Role;
6  use Moose::Meta::Role;  #use Moose::Meta::Class;
 use Moose::Meta::Class;  
 use Scalar::Util qw/blessed/;  
7  use Data::Dump qw/dump/;  use Data::Dump qw/dump/;
8  use File::Slurp;  use File::Slurp;
9  use List::Util;  use List::Util;
10    
11  use Continuity::Widget::DomNode;  use PPI;
12    use PPI::HTML;
13    
14  use lib 'lib';  use lib 'lib';
15    
16  extends 'Frey';  extends 'Frey::ClassLoader';
17    with 'Frey::Web';
18    
19  has 'package' => (  has 'class' => (
20          is => 'rw',          is => 'rw',
21          isa => 'Str',          isa => 'Str',
22          required => 1,          required => 1,
# Line 25  has 'path' => ( Line 26  has 'path' => (
26          is => 'rw',          is => 'rw',
27  );  );
28    
 =head2 load_package  
   
   my ( $class, $meta, $is_role ) = $o->load_package( 'Some::Package' );  
   
 =cut  
   
 sub load_package {  
         my ( $self ) = @_;  
   
         my $package = $self->package;  
   
         #intercept role application so we can accurately generate  
         #method and attribute information for the parent class.  
         #this is fragile, but there is not better way that i am aware of  
         my $rmeta = Moose::Meta::Role->meta;  
         $rmeta->make_mutable if $rmeta->is_immutable;  
         my $original_apply = $rmeta->get_method("apply")->body;  
         $rmeta->remove_method("apply");  
         my @roles_to_apply;  
         $rmeta->add_method("apply", sub{push(@roles_to_apply, [@_])});  
         #load the package with the hacked Moose::Meta::Role  
         eval { Class::MOP::load_class($package); };  
         confess "Failed to load package ${package} $@" if $@;  
   
         my $meta = $package->meta;  
   
         my ($class, $is_role);  
         if($package->meta->isa('Moose::Meta::Role')){  
                 $is_role = 1;  
                 # we need to apply the role to a class to be able to properly introspect it  
                 $class = Moose::Meta::Class->create_anon_class;  
                 $original_apply->($meta, $class);  
         } else {  
                 #roles don't have superclasses ...  
                 $class = $meta;  
         }  
         return ( $class, $meta, $is_role );  
 }  
   
29  =head2 joose  =head2 joose
30    
31    my $js = $o->joose( 'Some::Package' );    my $js = $o->joose;
32    
33  =cut  =cut
34    
35  sub joose {  sub joose {
36          my ($self) = @_;          my ($self) = @_;
37    
38          my ( $class, $meta, $is_role ) = $self->load_package;          my ( $meta, $is_role ) = $self->class_meta;
39    
40          if ( ! $is_role ) {          if ( ! $is_role ) {
41                  my @superclasses = map{ $_->meta->name }                  my @superclasses = map{ $_->meta->name }
42                          grep { $_ ne 'Moose::Object' } $meta->superclasses;                          grep { $_ ne 'Moose::Object' } $meta->superclasses;
43                  warn "superclasses ",dump( @superclasses );                  warn "superclasses ",dump( @superclasses ) if $self->debug;
44          }          }
45    
46          my $out;          my $out;
47    
48          my ( $m, $c ) = split(/::/, $class->name, 2);          my ( $m, $c ) = split(/::/, $self->class, 2);
49          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';
50    
51            $c ||= '';
52    
53          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";
54    
55          foreach ( $class->get_attribute_list ) {          foreach ( $meta->get_attribute_list ) {
56                  $out .= "\t\t\t$_: {\n";                  $out .= "\t\t\t$_: {\n";
57    
58                  my $attr = $class->get_attribute($_);                  my $attr = $meta->get_attribute($_);
59                  my $is = $attr->_is_metadata;                  my $is = $attr->_is_metadata;
60                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
61                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
# Line 116  sub joose { Line 80  sub joose {
80          $out .= "\t\t},\n\t\tmeta: Frey.HTML,          $out .= "\t\t},\n\t\tmeta: Frey.HTML,
81                  classMethods: {                  classMethods: {
82                          renderHTML: function () {                          renderHTML: function () {
83                                  return new Joose.SimpleRequest().getText(\"/~/${m}::${c}\")                                  return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
84                          },\n";                          },\n";
85    
86          $out .= "\t\t},\n";          $out .= "\t\t},\n";
# Line 126  sub joose { Line 90  sub joose {
90          $out =~ s/,\n$/\n/;          $out =~ s/,\n$/\n/;
91          $out .= "});\n";          $out .= "});\n";
92    
93          $out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n";          $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";
94    
95          warn $class->dump(2);          warn "method_list = ",dump( $meta->get_method_list ) if $self->debug;
   
         warn "method_list = ",dump( $class->get_method_list );  
         warn dump( map{ $class->get_method($_)->name } sort $class->get_method_list );  
96    
97  #       print $out;  #       print $out;
98          my $path = "static/blib/$filename";          my $path = "static/blib/$filename";
# Line 151  sub joose { Line 112  sub joose {
112  sub methods {  sub methods {
113          my $self = shift;          my $self = shift;
114    
115          my ( $class, $meta, $is_role ) = $self->load_package;          my ( $meta, $is_role ) = $self->class_meta;
116    
117          my $attr;          my $attr;
118          $attr->{$_}++ foreach $class->get_attribute_list;          $attr->{$_}++ foreach $meta->get_attribute_list;
119          my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list;          my @methods = grep { ! defined($attr->{$_}) } $meta->get_method_list;
120          warn "# methods = ",dump( @methods );          warn "# methods = ",dump( @methods ) if $self->debug;
121    
122          return @methods;          return sort @methods;
123  }  }
124    
125  =head1 OUTPUT GENERATION  =head1 OUTPUT GENERATION
126    
127  =head2 html  =head2 markup
128    
129    $o->html( $request );    $o->markup;
130    
131  =cut  =cut
132    
133  our @javascript = ( qw'  sub markup {
134  ../lib/Joose.js          my ( $self ) = @_;
 ');  
   
 sub html {  
         my ( $self, $request ) = @_;  
135    
136          while (1) {          $self->add_head( 'static/introspect.css' );
137    
138                  my $js = Continuity::Widget::DomNode->create(          my ( $meta, $is_role ) = $self->class_meta;
                         map {  
                                 ( script => { type => 'text/javascript', src => $_ } )  
                         } @javascript  
                 )->to_string;  
   
                 $js .= << '__END_OF_JS__';  
 <script type="text/javascript">  
 joose.loadComponents("../lib")  
139    
140  function $(id) {          my $class = $self->class;
         return document.getElementById(id)  
 }  
141    
142  </script>          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
143  __END_OF_JS__          if ( ! $is_role ) {
144                    if ( $meta->superclasses ) {
145                            $superclasses = 'Superclasses: ' .
146                                    join(', ',
147                                            map {
148                                                    my $name = $_->meta->name;
149                                                    qq|<a class="frey-popdown" href="/$name">$name<code>| . $_->meta->dump(2) . qq|</code></a>|;
150                                            }
151                                            #grep { $_ ne 'Moose::Object' }
152                                            $meta->superclasses
153                                    );
154                    }
155            }
156    
157                  warn "# >>> js\n$js\n";          my $role_method;
158            my $role_attribute;
159    
160                  my $methods;          if ( $meta->can('roles') ) {
161                    my $role_nr = 1;
162                    $roles = join(' ',
163                            grep { ! m/\Q$class\E/ }        # skip me
164                            map {
165                                    my $name = $_->name;
166                                    $role_method->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
167                                    $role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
168                                    qq|<a class="frey-popdown" href="/$name">$name<code>| . $name->meta->dump(2) . qq|</code></a><sup>| . $role_nr++ . qq|</sup>|;
169                            }
170                            $meta->calculate_all_roles
171                    );
172                    $roles = qq| with roles: $roles| if $roles;
173            }
174            warn "# role_method ",dump( $role_method );
175    
176                  my ( $class, $meta, $is_role );          my @methods;
177                  eval { ( $class, $meta, $is_role ) = $self->load_package(); };          @methods = map {
178                  if ( $@ ) {                  my $name = $_;
179                          warn "ERROR: $@";                  if ( $role_method->{$name} ) {
180                          $request->conn->send_status_line( 500, $@ );                          my ( $role_name, $nr ) = each %{ $role_method->{$name} };
181                          $request->print( $@ );                          $name .= qq|<sup title="$role_name">$nr</sup>|;
                         $request->next;  
                         return;  
182                  }                  }
183                    qq|<td class="m">$name</td>|
184            } $self->methods;
185    
186                  if ( $class->can('meta') ) {          my @attributes;
187                          $methods = Continuity::Widget::DomNode->create(          if ( $meta->get_attribute_list ) {
188                                  ul => [          @attributes = map {
189                                          map { (                          my $name = $_;
190                                                  li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ] ]                          my $attr = $meta->get_attribute($name);
191                                          ) } $self->methods                          warn "## ref attr: ",ref( $attr );
192                                  ]                          my ( $before, $title, $after ) = ( '', '', '' );
193                          )->to_string;                          ( $before, $title, $after ) = ( '<b>', ' title="required"', '</b>' ) if $attr->is_required;
194                  } else {  warn $attr->dump(3);
195                          $methods = '<b>not introspectable</b>';                          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/ ) {
196                  }                                  my $getter;
197                                    
198                                    $getter = $check;
199                                    $getter =~ s/^has_//;
200                                    
201                                    if ( $attr->$check ) {
202                                            if ( $getter eq $check ) {
203                                                    $after .= "$check";
204                                            } else {
205                                                    $after .= qq{<span class="frey-popdown">$check};
206                                                    # we need dump here instead of $attr->$getter->dump because default can return scalar
207                                                    $after .= '<code>' . dump( $attr->$getter ) . '</code>' if $getter ne $check;
208                                                    $after .= '</span>';
209                                            }
210                                    }
211                                    $after .= ' ';
212                            }
213                            my $type = $attr->has_type_constraint ? $attr->type_constraint->name : '';
214    
215                  my $attributes = Continuity::Widget::DomNode->create(                          if ( $role_attribute->{$name} ) {
216                          ul => [                                  my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };
217                                  map {                                  $name .= qq|<sup title="$role_name">$nr</sup>|;
218                                          my $attr = $class->get_attribute($_);                          }
219                                          warn "## $_ ", $attr->is_required ? 'required' : 'optional';  
220                                          ( li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ], ( $attr->is_required ? ' <b>required</b>' : '' ) ] )                          qq|<td class="a">$before $name</td><td class="t">$type</td><td>$after</td>|
221                                  } $class->get_attribute_list                  } sort $meta->get_attribute_list
222                          ],          }
                 )->to_string;  
   
                 my $doc = Continuity::Widget::DomNode->create(  
                         html => [  
                                 head => [  
                                         link => { rel=>"stylesheet", href=>"/static/app.css", type=>"text/css", media=>"screen" },  
                                         $js,  
                                         title => [ 'Introspect ', $self->package ],  
                                 ],  
                                 body => [  
                                         h1 => [ $self->package ],  
                                         h2 => [ 'Methods' ],  
                                         $methods,  
                                         h2 => [ 'Atrributes' ],  
                                         $attributes,  
                                 ],  
                         ]  
                 );  
223    
224                  $request->print($doc->to_string);          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>|;
225                  warn "# >>> html\n", $doc->to_string, "\n";          while ( @methods || @attributes ) {
226                  $request->next;                  my ($m,$a) = ( shift @methods, shift @attributes );
227                    $m ||= '<td></td>';
228                    $a ||= '<td></td>';
229                    $table .= qq|<tr>$m$a</tr>|;
230          }          }
231          warn "# exit html";          $table .= qq|</table>|;
232    
233            my $pod = Frey::Pod->new( class => $class )->markup;
234            $pod = $pod->{body} if ref($pod);
235    
236            my $Document = PPI::Document->new( $self->class_path( $class ) );
237    
238            # Create a reusable syntax highlighter
239            my $Highlight = PPI::HTML->new(
240    #               line_numbers => 1,
241    #               page => 1,
242    #               colors => {
243    #                       line_number => '#CCCCCC',
244    #                       number      => '#990000',
245    #               },
246            );
247    
248            # Spit out the HTML
249            my $source = $Highlight->html( $Document );
250    
251    #       $source =~ s{^.*<body[^>]+>}{}s;
252    #       $source =~ s{</body.*$}{}s;
253    
254            use Frey::Run;
255            my $runnable = join("\n", map { qq|<a href="/$class/$_">$_</a>| } grep { $class->can($_) } Frey::Run->runnable );
256            $runnable = " runnable: $runnable" if $runnable;
257    
258            my $html = {
259                    title => $class,
260                    body => join("\n"
261                            , qq|<h1>$class</h1>|,
262                            , qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,
263                            , ( $pod ? qq|<a href="#___top" title="Skip to POD" class="frey-skip">pod</a>| : '' )
264                            , qq|<a href="#source" title="Skip to source" class="frey-skip">source</a>|
265                            , qq|$table\n$pod\n</div>\n|
266                            , qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|
267                    ),
268            };
269    
270            return $html;
271  }  }
272    
273  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.56  
changed lines
  Added in v.380
  ViewVC Help
Powered by ViewVC 1.1.26