--- trunk/lib/Frey/Introspect.pm 2008/11/17 19:08:31 381 +++ trunk/lib/Frey/Introspect.pm 2009/01/06 14:50:30 943 @@ -12,9 +12,17 @@ use PPI::HTML; use lib 'lib'; +use Frey::Pod; -extends 'Frey::ClassLoader'; +extends 'Frey::PPI'; with 'Frey::Web'; +with 'Frey::Storage'; + +=head1 DESCRIPTION + +Provide introspection on any perl class installed on system + +=cut has 'class' => ( is => 'rw', @@ -22,10 +30,6 @@ required => 1, ); -has 'path' => ( - is => 'rw', -); - =head2 joose my $js = $o->joose; @@ -98,39 +102,11 @@ my $path = "static/blib/$filename"; write_file( $path, $out ); warn "# created $path\n"; - $self->path( $path ); return $out; } -=head2 methods - - my @methods = $o->methods; - -=cut - -sub methods { - my $self = shift; - - my ( $meta, $is_role ) = $self->class_meta; - - my $attr; - $attr->{$_}++ foreach $meta->get_attribute_list; - 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 - -sub markup { +sub as_markup { my ( $self ) = @_; $self->add_head( 'static/introspect.css' ); @@ -138,6 +114,11 @@ my ( $meta, $is_role ) = $self->class_meta; my $class = $self->class; + $self->title( $class ); + + my $introspect_path = "var/introspect/$class.yaml"; + $self->mkbasepath( $introspect_path ); + my $introspect; # FIXME update with = $self->load( $introspect_path ); my ( $superclasses, $roles ) = ( 'Role', '' ); if ( ! $is_role ) { @@ -146,7 +127,10 @@ join(', ', map { my $name = $_->meta->name; - qq|$name| . $_->meta->dump(2) . qq||; + $introspect->{superclass}->{$name} = {}; + + qq|$name| . + $self->dropdown( qq|?|, $_->meta ) } #grep { $_ ne 'Moose::Object' } $meta->superclasses @@ -154,8 +138,8 @@ } } - my $role_method; - my $role_attribute; + my $method_from_role; + my $attribute_from_role; if ( $meta->can('roles') ) { my $role_nr = 1; @@ -163,61 +147,96 @@ grep { ! m/\Q$class\E/ } # skip me map { my $name = $_->name; - $role_method->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; - $role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; - qq|$name| . $name->meta->dump(2) . qq|| . $role_nr++ . qq||; + $introspect->{roles}->{$name} = {}; + $method_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_method_list; + $attribute_from_role->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list; + + qq|$name| +# . qq|| . $self->dropdown( $role_nr++, $name->meta ) . qq|| + . $self->dropdown( + qq|| . $role_nr++ . qq||, + $name->meta + ) + ; } $meta->calculate_all_roles ); - $roles = qq| with roles: $roles| if $roles; + $roles = qq|with roles: $roles| if $roles; } - warn "# role_method ",dump( $role_method ); + warn "# method_from_role ",dump( $method_from_role ); my @methods; @methods = map { my $name = $_; - if ( $role_method->{$name} ) { - my ( $role_name, $nr ) = each %{ $role_method->{$name} }; + if ( $method_from_role->{$name} ) { + my ( $role_name, $nr ) = each %{ $method_from_role->{$name} }; + $introspect->{methods}->{$name}->{role} = $role_name; $name .= qq|$nr|; + } else { + $introspect->{methods}->{$name} = {}; } qq|$name| - } $self->methods; + } sort { + lc($a) cmp lc($b) + } $self->class_methods( $class ); my @attributes; if ( $meta->get_attribute_list ) { - @attributes = map { + @attributes = map { my $name = $_; + $introspect->{attribute}->{$name} = {}; + my $html_name = $name; my $attr = $meta->get_attribute($name); - warn "## ref attr: ",ref( $attr ); - my ( $before, $title, $after ) = ( '', '', '' ); - ( $before, $title, $after ) = ( '', ' title="required"', '' ) if $attr->is_required; -warn $attr->dump(3); - 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; + warn "## attr $name ref ",ref( $attr ) if $self->debug; + + my ( $title, $properties ) = ( '', '' ); + if ( $attr->can('is_required') && $attr->is_required ) { + ( $html_name, $title ) = ( "$name", ' title="required"' ); + $introspect->{attribute}->{$name}->{required} = 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/ ) { my $getter; $getter = $check; $getter =~ s/^has_//; - if ( $attr->$check ) { - if ( $getter eq $check ) { - $after .= "$check"; - } else { - $after .= qq{$check}; - # we need dump here instead of $attr->$getter->dump because default can return scalar - $after .= '' . dump( $attr->$getter ) . '' if $getter ne $check; - $after .= ''; - } + if ( $attr->can($check) && $attr->$check ) { + $properties .= $check; + # we need our dump here instead of $attr->$getter->dump because default can return scalar + my $v = $attr->$getter; + $properties .= ref($v) + ? $self->dropdown( qq|?|, $attr->$getter ) + : qq| $v| + ; } - $after .= ' '; + $properties .= ' '; } - my $type = $attr->has_type_constraint ? $attr->type_constraint->name : ''; + my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; - if ( $role_attribute->{$name} ) { - my ( $role_name, $nr ) = each %{ $role_attribute->{$name} }; + if ( $attribute_from_role->{$name} ) { + my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; $name .= qq|$nr|; } - qq|$before $name$type$after| + if ( my $doc = eval { $attr->documentation } ) { + $properties = qq| + $properties + $doc + |; + $self->add_css(qq| + span.documentation { + background: #eee; + padding: 0.25em; + float: left; + clear: left; + } + |); + $introspect->{action}->{$name}->{documentation} = $doc; + } + + qq|$html_name$type$properties| } sort $meta->get_attribute_list } @@ -230,14 +249,16 @@ } $table .= qq||; - my $pod = Frey::Pod->new( class => $class )->markup; - $pod = $pod->{body} if ref($pod); + my $path = $self->class_path( $class ); - my $Document = PPI::Document->new( $self->class_path( $class ) ); + my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; + return $pod if $path =~ m{\.pod}; + + my $Document = PPI::Document->new( $path ); # Create a reusable syntax highlighter my $Highlight = PPI::HTML->new( -# line_numbers => 1, + line_numbers => 1, # page => 1, # colors => { # line_number => '#CCCCCC', @@ -248,26 +269,68 @@ # Spit out the HTML my $source = $Highlight->html( $Document ); + $source =~ s{(\s*)(\d+)(:\s*)}{$1$2$3}g; + + # strip page html # $source =~ s{^.*]+>}{}s; # $source =~ s{$_| } grep { $class->can($_) } Frey::Run->runnable ); - $runnable = " runnable: $runnable" if $runnable; - - my $html = { - title => $class, - body => join("\n", - qq|

$class

|, - qq|
$superclasses\n$roles\n$runnable\n|, - $pod ? qq|pod| : '', - $source ? qq|source| : '', - qq|$table\n$pod\n
\n|, - qq|

Source

$source
|, - ), - }; + my $runnable = join("\n", + map { + $introspect->{runnable}->{$_} = {}; + my $short = $_; + $short =~ s{_as_(?:markup|data|sponge)$}{}; + qq|$short| + } $self->class_runnable( $class ) + ); + $runnable = "Runnable: $runnable" if $runnable; + + my $has_tests = ''; + my @tests = grep { defined $_ } $self->has_tests; + if ( @tests ) { + $has_tests = + 'Test' . ( $#tests > 0 ? 's' : '' ) . ': ' . + join("\n", map { + qq|$_| + } @tests ); + $introspect->{tests} = [ @tests ], + } + + my $includes = ''; + if ( my $inc = $self->includes ) { + $introspect->{includes} = $inc; + foreach my $type ( keys %$inc ) { + $includes + .= ucfirst($type) + . qq|: | + . join("\n", + map { + qq|$_| + } @{ + $inc->{$type} + } + ) + ; + } + } - return $html; + $self->store( $introspect_path, $introspect ); + + return join("\n", + qq|

$class

|, + qq|
+ $superclasses $roles +
+ $includes +
+ $runnable + |, + $has_tests, + $pod ? qq|pod| : '', + $source ? qq|source| : '', + qq|$table\n$pod\n
\n|, + qq|

Source

$source
|, + ); } =head1 SEE ALSO