--- trunk/lib/Frey/Introspect.pm 2008/07/14 23:39:56 128 +++ trunk/lib/Frey/Introspect.pm 2009/01/09 19:33:26 972 @@ -8,31 +8,38 @@ use File::Slurp; use List::Util; +use PPI; +use PPI::HTML; + use lib 'lib'; +use Frey::Pod; -extends 'Frey'; +extends 'Frey::PPI'; with 'Frey::Web'; +with 'Frey::Storage'; + +=head1 DESCRIPTION + +Provide introspection on any perl class installed on system -has 'package' => ( +=cut + +has 'class' => ( is => 'rw', isa => 'Str', required => 1, ); -has 'path' => ( - is => 'rw', -); - =head2 joose - my $js = $o->joose( 'Some::Package' ); + my $js = $o->joose; =cut sub joose { my ($self) = @_; - my ( $class, $meta, $is_role ) = $self->load_package; + my ( $meta, $is_role ) = $self->class_meta; if ( ! $is_role ) { my @superclasses = map{ $_->meta->name } @@ -42,16 +49,20 @@ my $out; - my ( $m, $c ) = split(/::/, $class->name, 2); + my ( $m, $c ) = split(/::/, $self->class, 2); my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js'; + $c ||= ''; + $out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n"; - foreach ( $class->get_attribute_list ) { + foreach ( $meta->get_attribute_list ) { $out .= "\t\t\t$_: {\n"; - my $attr = $class->get_attribute($_); - my $is = $attr->_is_metadata; + my $attr = $meta->get_attribute($_); + 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; @@ -75,7 +86,7 @@ $out .= "\t\t},\n\t\tmeta: Frey.HTML, classMethods: { renderHTML: function () { - return new Joose.SimpleRequest().getText(\"/~/" . $self->package . "\") + return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") },\n"; $out .= "\t\t},\n"; @@ -85,120 +96,243 @@ $out =~ s/,\n$/\n/; $out .= "});\n"; - $out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n"; + $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; - warn "method_list = ",dump( $class->get_method_list ) if $self->debug; + warn "method_list = ",dump( $meta->get_method_list ) if $self->debug; # print $out; my $path = "static/blib/$filename"; write_file( $path, $out ); warn "# created $path\n"; - $self->path( $path ); return $out; } -=head2 methods - - my @methods = $o->methods; +sub as_markup { + my ( $self ) = @_; -=cut + $self->add_head( 'static/introspect.css' ); -sub methods { - my $self = shift; + my ( $meta, $is_role ) = $self->class_meta; - my ( $class, $meta, $is_role ) = $self->load_package; + my $class = $self->class; + $self->title( $class ); - my $attr; - $attr->{$_}++ foreach $class->get_attribute_list; - my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list; - warn "# methods = ",dump( @methods ) if $self->debug; + my $introspect_path = "var/introspect/$class.yaml"; + $self->mkbasepath( $introspect_path ); + my $introspect; # FIXME update with = $self->load( $introspect_path ); - return sort @methods; -} + my ( $superclasses, $roles ) = ( 'Role', '' ); + if ( ! $is_role ) { + if ( $meta->superclasses ) { + $superclasses = 'Superclasses: ' . + join(', ', + map { + my $name = $_->meta->name; + $introspect->{superclass}->{$name} = {}; + + qq|$name| . + $self->dropdown( qq|?|, $_->meta ) + } + #grep { $_ ne 'Moose::Object' } + $meta->superclasses + ); + } + } -use Frey::ClassLoader; + my $method_from_role; + my $attribute_from_role; -sub load_package { - my $self = shift; - return Frey::ClassLoader->load_package( $self->package ); -} + if ( $meta->can('roles') ) { + my $role_nr = 1; + $roles = join(' ', + grep { ! m/\Q$class\E/ } # skip me + map { + my $name = $_->name; + $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; + } + warn "# method_from_role ",dump( $method_from_role ); + my @methods; + @methods = map { + my $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 ); -=head1 OUTPUT GENERATION + 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 ) = ( '', '' ); + if ( $attr->can('is_required') && $attr->is_required ) { + ( $html_name, $title ) = ( "$name", ' title="required"' ); + $introspect->{attribute}->{$name}->{required} = 1; + } -=head2 html + 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->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| + ; + } + $properties .= ' '; + } + my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : ''; - $o->html( $request ); + if ( $attribute_from_role->{$name} ) { + my ( $role_name, $nr ) = each %{ $attribute_from_role->{$name} }; + $name .= qq|$nr|; + } -=cut + 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; + } -sub html { - my ( $self, $request ) = @_; + qq|$html_name$type$properties| + } sort $meta->get_attribute_list + } - while (1) { + my $table = qq||; + while ( @methods || @attributes ) { + my ($m,$a) = ( shift @methods, shift @attributes ); + $m ||= ''; + $a ||= ''; + $table .= qq|$m$a|; + } + $table .= qq|
MethodsAttributesTypeProperties
|; - my ( $class, $meta, $is_role ) = $self->load_package; + my $path = $self->class_path( $class ); - my $package = $self->package; + my $pod = Frey::Pod->new( class => $class, request_url => $self->request_url )->as_markup; + return $pod if $path =~ m{\.pod}; - my @methods; - @methods = map { qq|$_| } $self->methods if $class->can('meta'); + my $Document = PPI::Document->new( $path ); - my @attributes; - if ( $class->get_attribute_list ) { - @attributes = map { - my $attr = $class->get_attribute($_); -# warn "## $_ ", $attr->is_required ? 'required' : 'optional'; - qq|$_| . - ( $attr->is_required ? ' required' : '' ) . - qq||; - } sort $class->get_attribute_list - } + # Create a reusable syntax highlighter + my $Highlight = PPI::HTML->new( + line_numbers => 1, +# page => 1, +# colors => { +# line_number => '#CCCCCC', +# number => '#990000', +# }, + ); + + # 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{{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 $table = qq||; - while ( @methods || @attributes ) { - my ($m,$a) = ( shift @methods, shift @attributes ); - $m ||= ''; - $a ||= ''; - $table .= qq|$m$a|; + 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} + } + ) + ; } - $table .= qq|
MethodsAttributes
|; - - my $classes = - qq|
| . - Frey::ClassBrowser->new->markup . - qq|
|; - - $self->add_css( 'static/introspect.css' ); - - warn "## css = ",dump( $self->css ); - - my $superclasses = 'Role'; - $superclasses = 'Superclasses: ' . join(', ', - map { - my $s = $_->meta->name; - qq|$s| - } - #grep { $_ ne 'Moose::Object' } - $meta->superclasses - ) if ! $is_role && $meta->superclasses; - - my $pod = Frey::Pod->new( class => $package )->markup; - - my $html = $self->page( - title => "Introspect $package", - body => qq|

$package

| - . ( $pod ? qq|↓pod&darr | : '' ) - . qq|$superclasses\n$table\n$pod\n$classes|, + } - ); + $self->store( $introspect_path, $introspect ); - $request->print($html); - warn "# >>> html ",length($html)," bytes\n"; - $request->next; - } - warn "# exit html"; + 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