/[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 50 by dpavlin, Wed Jul 2 22:30:19 2008 UTC revision 884 by dpavlin, Wed Dec 24 12:43:41 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;
10    
11  extends 'Frey';  use PPI;
12    use PPI::HTML;
13    
14  has 'package' => (  use lib 'lib';
15    use Frey::Pod;
16    
17    extends 'Frey::PPI';
18    with 'Frey::Web';
19    with 'Frey::Storage';
20    
21    has 'class' => (
22          is => 'rw',          is => 'rw',
23          isa => 'Str',          isa => 'Str',
24          required => 1,          required => 1,
25  );  );
26    
27  sub examine {  =head2 joose
28    
29      my $js = $o->joose;
30    
31    =cut
32    
33    sub joose {
34          my ($self) = @_;          my ($self) = @_;
35    
36          my $package = $self->package;          my ( $meta, $is_role ) = $self->class_meta;
37    
38          #intercept role application so we can accurately generate          if ( ! $is_role ) {
         #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 $@;  
   
         #get on with analyzing the      package  
         my $meta = $package->meta;  
         my $spec = {};  
         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;  
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.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 84  sub examine { Line 75  sub examine {
75    
76          }          }
77    
78            $out .= "\t\t},\n\t\tmeta: Frey.HTML,
79                    classMethods: {
80                            renderHTML: function () {
81                                    return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
82                            },\n";
83    
84          $out .= "\t\t},\n";          $out .= "\t\t},\n";
85    
86          $out .= "\t}),\n";          $out .= "\t}),\n";
# Line 91  sub examine { Line 88  sub examine {
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";
   
         warn $class->dump(2);  
   
         warn "get_attribute_list = ",dump( $class->get_attribute_list );  
 #       warn dump( map{ $class->get_attribute($_) } sort $class->get_attribute_list );  
92    
93          warn dump( $class->get_method_list );          warn "method_list = ",dump( $meta->get_method_list ) if $self->debug;
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";
99    
100            return $out;
101    }
102    
103    sub as_markup {
104            my ( $self ) = @_;
105    
106            $self->add_head( 'static/introspect.css' );
107    
108            my ( $meta, $is_role ) = $self->class_meta;
109    
110            my $class = $self->class;
111            $self->title( $class );
112    
113            my $introspect_path = "var/introspect/$class.yaml";
114            $self->mkbasepath( $introspect_path );
115            my $introspect; # FIXME update with = $self->load( $introspect_path );
116    
117            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 $method_from_role;
134            my $attribute_from_role;
135    
136            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;
154            @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;
169            if ( $meta->get_attribute_list ) {
170                    @attributes = map {
171                            my $name = $_;
172                            $introspect->{attribute}->{$name} = {};
173                            my $html_name = $name;
174                            my $attr = $meta->get_attribute($name);
175                            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;
186                                    
187                                    $getter = $check;
188                                    $getter =~ s/^has_//;
189                                    
190                                    if ( $attr->can($check) && $attr->$check ) {
191                                            if ( $getter eq $check ) {
192                                                    $properties .= "$check";
193                                            } else {
194                                                    # we need our dump here instead of $attr->$getter->dump because default can return scalar
195                                                    $properties .= $self->dropdown( $check, $attr->$getter );
196                                            }
197                                    }
198                                    $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    
223                            qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>|
224                    } sort $meta->get_attribute_list
225            }
226    
227            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 ) {
229                    my ($m,$a) = ( shift @methods, shift @attributes );
230                    $m ||= '<td></td>';
231                    $a ||= '<td></td>';
232                    $table .= qq|<tr>$m$a</tr>|;
233            }
234            $table .= qq|</table>|;
235    
236            my $path = $self->class_path( $class );
237    
238            my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup;
239            return $pod if $path =~ m{\.pod};
240    
241            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            # Spit out the HTML
254            my $source = $Highlight->html( $Document );
255    
256            $source =~ s{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
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            $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.50  
changed lines
  Added in v.884

  ViewVC Help
Powered by ViewVC 1.1.26