/[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 66 by dpavlin, Wed Jul 9 12:08:07 2008 UTC revision 735 by dpavlin, Sat Dec 6 12:22:36 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    use Frey::Pod;
16    
17  extends 'Frey';  extends 'Frey::PPI';
18    with 'Frey::Web';
19    with 'Frey::Storage';
20    
21  has 'package' => (  has 'class' => (
22          is => 'rw',          is => 'rw',
23          isa => 'Str',          isa => 'Str',
24          required => 1,          required => 1,
25  );  );
26    
 has 'path' => (  
         is => 'rw',  
 );  
   
 =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 $@;  
         Class::MOP::load_class($package);  
   
         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 );  
 }  
   
27  =head2 joose  =head2 joose
28    
29    my $js = $o->joose( 'Some::Package' );    my $js = $o->joose;
30    
31  =cut  =cut
32    
33  sub joose {  sub joose {
34          my ($self) = @_;          my ($self) = @_;
35    
36          my ( $class, $meta, $is_role ) = $self->load_package;          my ( $meta, $is_role ) = $self->class_meta;
37    
38          if ( ! $is_role ) {          if ( ! $is_role ) {
39                  my @superclasses = map{ $_->meta->name }                  my @superclasses = map{ $_->meta->name }
40                          grep { $_ ne 'Moose::Object' } $meta->superclasses;                          grep { $_ ne 'Moose::Object' } $meta->superclasses;
41                  warn "superclasses ",dump( @superclasses );                  warn "superclasses ",dump( @superclasses ) if $self->debug;
42          }          }
43    
44          my $out;          my $out;
45    
46          my ( $m, $c ) = split(/::/, $class->name, 2);          my ( $m, $c ) = split(/::/, $self->class, 2);
47          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';          my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';
48    
49            $c ||= '';
50    
51          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";          $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";
52    
53          foreach ( $class->get_attribute_list ) {          foreach ( $meta->get_attribute_list ) {
54                  $out .= "\t\t\t$_: {\n";                  $out .= "\t\t\t$_: {\n";
55    
56                  my $attr = $class->get_attribute($_);                  my $attr = $meta->get_attribute($_);
57                  my $is = $attr->_is_metadata;                  my $is = $attr->_is_metadata;
58                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;                  $out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
59                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;                  $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
# Line 118  sub joose { Line 78  sub joose {
78          $out .= "\t\t},\n\t\tmeta: Frey.HTML,          $out .= "\t\t},\n\t\tmeta: Frey.HTML,
79                  classMethods: {                  classMethods: {
80                          renderHTML: function () {                          renderHTML: function () {
81                                  return new Joose.SimpleRequest().getText(\"/~/" . $self->package . "\")                                  return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
82                          },\n";                          },\n";
83    
84          $out .= "\t\t},\n";          $out .= "\t\t},\n";
# Line 128  sub joose { Line 88  sub joose {
88          $out =~ s/,\n$/\n/;          $out =~ s/,\n$/\n/;
89          $out .= "});\n";          $out .= "});\n";
90    
91          $out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n";          $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";
92    
93          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 );  
94    
95  #       print $out;  #       print $out;
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 ( $class, $meta, $is_role ) = $self->load_package;          my ( $meta, $is_role ) = $self->class_meta;
109    
110          my $attr;          my $class = $self->class;
         $attr->{$_}++ foreach $class->get_attribute_list;  
         my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list;  
         warn "# methods = ",dump( @methods );  
111    
112          return @methods;          my $introspect_path = "var/introspect/$class.yaml";
113  }          $self->mkbasepath( $introspect_path );
114            my $introspect; # FIXME update with = $self->load( $introspect_path );
115    
116  =head1 OUTPUT GENERATION          my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
117            if ( ! $is_role ) {
118  =head2 html                  if ( $meta->superclasses ) {
119                            $superclasses = 'Superclasses: ' .
120                                    join(', ',
121                                            map {
122                                                    my $name = $_->meta->name;
123                                                    $introspect->{superclass}->{$name} = {};
124                                                    $self->dropdown( $name, $_->meta )
125                                            }
126                                            #grep { $_ ne 'Moose::Object' }
127                                            $meta->superclasses
128                                    );
129                    }
130            }
131    
132    $o->html( $request );          my $method_from_role;
133            my $attribute_from_role;
134    
135  =cut          if ( $meta->can('roles') ) {
136                    my $role_nr = 1;
137                    $roles = join(' ',
138                            grep { ! m/\Q$class\E/ }        # skip me
139                            map {
140                                    my $name = $_->name;
141                                    $introspect->{roles}->{$name} = {};
142                                    $method_from_role->{    $_ }->{$name} = $role_nr foreach $_->get_method_list;
143                                    $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
144                                    $self->dropdown( $name, $name->meta ) . qq|<sup>| . $role_nr++ . qq|</sup>|;
145                            }
146                            $meta->calculate_all_roles
147                    );
148                    $roles = qq| with roles: $roles| if $roles;
149            }
150            warn "# method_from_role ",dump( $method_from_role );
151    
152  our @javascript = ( qw'          my @methods;
153  ../lib/Joose.js          @methods = map {
154  ');                  my $name = $_;
155                    if ( $method_from_role->{$name} ) {
156                            my ( $role_name, $nr ) = each %{ $method_from_role->{$name} };
157                            $introspect->{methods}->{$name}->{role} = $role_name;
158                            $name .= qq|<sup title="$role_name">$nr</sup>|;
159                    } else {
160                            $introspect->{methods}->{$name} = {};
161                    }
162                    qq|<td class="m">$name</td>|
163            } sort $self->class_methods( $class );
164    
165  sub html {          my @attributes;
166          my ( $self, $request ) = @_;          if ( $meta->get_attribute_list ) {
167                    @attributes = map {
168                            my $name = $_;
169                            $introspect->{attribute}->{$name} = {};
170                            my $html_name = $name;
171                            my $attr = $meta->get_attribute($name);
172                            confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
173                            warn "## attr $name ref ",ref( $attr ) if $self->debug;
174    
175                            my ( $title, $properties ) = ( '', '' );
176                            if ( $attr->can('is_required') && $attr->is_required ) {
177                                    ( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' );
178                                    $introspect->{attribute}->{$name}->{required} = 1;
179                            }
180    
181          while (1) {                          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/ ) {
182                                    my $getter;
183                                    
184                                    $getter = $check;
185                                    $getter =~ s/^has_//;
186                                    
187                                    if ( $attr->can($check) && $attr->$check ) {
188                                            if ( $getter eq $check ) {
189                                                    $properties .= "$check";
190                                            } else {
191                                                    # we need our dump here instead of $attr->$getter->dump because default can return scalar
192                                                    $properties .= $self->dropdown( $check, $attr->$getter );
193                                            }
194                                    }
195                                    $properties .= ' ';
196                            }
197                            my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
198    
199                  my $js = Continuity::Widget::DomNode->create(                          if ( $attribute_from_role->{$name} ) {
200                          map {                                  my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} };
201                                  ( script => { type => 'text/javascript', src => $_ } )                                  $name .= qq|<sup title="$role_name">$nr</sup>|;
202                          } @javascript                          }
                 )->to_string;  
   
                 $js .= << '__END_OF_JS__';  
 <script type="text/javascript">  
 joose.loadComponents("../lib")  
203    
204  function $(id) {                          if ( my $doc = eval { $attr->documentation } ) {
205          return document.getElementById(id)                                  $properties = qq|
206  }                                          $properties
207                                            <span class="documentation">$doc</span>
208                                    |;
209                                    $self->add_css(qq|
210                                            span.documentation {
211                                                    background: #eee;
212                                                    padding: 0.25em;
213                                            }
214                                    |);
215                                    $introspect->{action}->{$name}->{documentation} = $doc;
216                            }
217    
218  </script>                          qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>|
219  __END_OF_JS__                  } sort $meta->get_attribute_list
220            }
221    
222                  warn "# >>> js\n$js\n" if $self->debug;          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>|;
223            while ( @methods || @attributes ) {
224                    my ($m,$a) = ( shift @methods, shift @attributes );
225                    $m ||= '<td></td>';
226                    $a ||= '<td></td>';
227                    $table .= qq|<tr>$m$a</tr>|;
228            }
229            $table .= qq|</table>|;
230    
231                  my ( $class, $meta, $is_role ) = $self->load_package();          my $path = $self->class_path( $class );
232    
233                  my $methods;          my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
234                  if ( $class->can('meta') ) {          return $pod if $path =~ m{\.pod};
                         $methods = Continuity::Widget::DomNode->create(  
                                 ul => [  
                                         map { (  
                                                 li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ] ]  
                                         ) } $self->methods  
                                 ]  
                         )->to_string;  
                 } else {  
                         $methods = '<b>not introspectable</b>';  
                 }  
235    
236                  my $attributes = Continuity::Widget::DomNode->create(          my $Document = PPI::Document->new( $path );
                         ul => [  
                                 map {  
                                         my $attr = $class->get_attribute($_);  
                                         warn "## $_ ", $attr->is_required ? 'required' : 'optional';  
                                         ( li => [ a => { href => '/~/' . $self->package . '/' . $_ } => [ $_ ], ( $attr->is_required ? ' <b>required</b>' : '' ) ] )  
                                 } $class->get_attribute_list  
                         ],  
                 )->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,  
                                 ],  
                         ]  
                 );  
237    
238                  $request->print($doc->to_string);          # Create a reusable syntax highlighter
239                  warn "# >>> html\n", $doc->to_string, "\n";          my $Highlight = PPI::HTML->new(
240                  $request->next;                  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{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
252    
253            # strip page html
254    #       $source =~ s{^.*<body[^>]+>}{}s;
255    #       $source =~ s{</body.*$}{}s;
256    
257            my $runnable = join("\n",
258                    map {
259                            $introspect->{runnable}->{$_} = {};
260                            my $short = $_;
261                            $short =~ s{_as_(?:markup|data|sponge)$}{};
262                            qq|<a target="$class" href="/$class/$_" title="/$class/$_">$short</a>|
263                    } $self->class_runnable( $class )
264            );
265            $runnable = "<br>run: $runnable" if $runnable;
266    
267            $self->store( $introspect_path, $introspect );
268    
269            $self->title( $class );
270    
271            my $has_tests = '';
272            my @tests = grep { defined $_ } $self->has_tests;
273            if ( @tests ) {
274                    $has_tests =
275                    '<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' .      
276                    join("\n", map {
277                            qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
278                    } @tests );
279          }          }
280          warn "# exit html";  
281            return join("\n",
282                    qq|<h1>$class</h1>|,
283                    qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,
284                    $has_tests,
285                    $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',
286                    $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
287                    qq|$table\n$pod\n</div>\n|,
288                    qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,
289            );
290  }  }
291    
292  =head1 SEE ALSO  =head1 SEE ALSO
Legend:
Removed from v.66  
changed lines
  Added in v.735
  ViewVC Help
Powered by ViewVC 1.1.26