--- trunk/lib/Frey/Introspect.pm 2008/11/28 18:31:28 599 +++ trunk/lib/Frey/Introspect.pm 2009/01/11 12:09:58 993 @@ -12,9 +12,17 @@ use PPI::HTML; use lib 'lib'; +use Frey::Pod; 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', @@ -52,7 +60,9 @@ $out .= "\t\t\t$_: {\n"; my $attr = $meta->get_attribute($_); - my $is = $attr->_is_metadata; + my $is = eval { $attr->_is_metadata; }; + return if $@; + $out .= "\t\t\t\tis: \"$is\",\n" if defined $is; $out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy; $out .= "\t\t\t\trequired: true,\n" if $attr->is_required; @@ -106,6 +116,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 ) { @@ -114,7 +129,10 @@ join(', ', map { my $name = $_->meta->name; - $self->dropdown( $name, $_->meta ) + $introspect->{superclass}->{$name} = {}; + + qq|$name| . + $self->dropdown( qq|?|, $_->meta ) } #grep { $_ ne 'Moose::Object' } $meta->superclasses @@ -122,8 +140,8 @@ } } - my $role_method; - my $role_attribute; + my $method_from_role; + my $attribute_from_role; if ( $meta->can('roles') ) { my $role_nr = 1; @@ -131,38 +149,54 @@ 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; - $self->dropdown( $name, $name->meta ) . 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| + } sort { + lc($a) cmp lc($b) } $self->class_methods( $class ); my @attributes; if ( $meta->get_attribute_list ) { @attributes = map { my $name = $_; + $introspect->{attribute}->{$name} = {}; my $html_name = $name; my $attr = $meta->get_attribute($name); confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr; warn "## attr $name ref ",ref( $attr ) if $self->debug; my ( $title, $properties ) = ( '', '' ); - ( $html_name, $title ) = ( "$name", ' title="required"' ) - if $attr->can('is_required') && $attr->is_required; + 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; @@ -171,26 +205,41 @@ $getter =~ s/^has_//; if ( $attr->can($check) && $attr->$check ) { - if ( $getter eq $check ) { - $properties .= "$check"; - } else { - # we need our dump here instead of $attr->$getter->dump because default can return scalar - $properties .= $self->dropdown( $check, $attr->$getter ); - } + $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| + ; } $properties .= ' '; } 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|; } - eval { $properties = $attr->documentation . ' ' . $properties }; + 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| - } $meta->get_attribute_list + qq|$html_name$type$properties| + } sort $meta->get_attribute_list } my $table = qq||; @@ -202,10 +251,11 @@ } $table .= qq|
MethodsAttributesTypeProperties
|; - my $pod = Frey::Pod->new( class => $class )->as_markup; - $pod = $pod->{body} if ref($pod); - my $path = $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 @@ -229,30 +279,79 @@ my $runnable = join("\n", map { - qq|$_| + $introspect->{runnable}->{$_} = {}; + my $short = $_; + $short =~ s{_as_(?:markup|data|sponge)$}{}; + qq|$short| } $self->class_runnable( $class ) ); - $runnable = " runnable: $runnable" if $runnable; - - $self->title( $class ); + $runnable = "Runnable: $runnable" if $runnable; my $has_tests = ''; - if ( my @tests = $self->has_tests ) { + my @tests = grep { defined $_ } $self->has_tests; + if ( @tests ) { $has_tests = - '
test' . ( $#tests > 0 ? 's' : '' ) . ': ' . + '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} + } + ) + ; + } + } + + $self->store( $introspect_path, $introspect ); + + $self->add_css(qq| + .right { + position: fixed; + top: 1em; + right: 1em; + z-index: 10; + background: #fff; + padding: 0.2em; + border: 1px dashed #ee8; + } + |); + return join("\n", - qq|

$class

|, - qq|
$superclasses\n$roles\n$runnable\n|, + qq| +

$class

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

Source

$source
|, + qq| +
+ $table + $pod + + +

Source

+
$source
+ |, ); }