--- trunk/lib/Frey/Introspect.pm 2008/07/05 15:19:55 53 +++ trunk/lib/Frey/Introspect.pm 2009/01/11 12:09:58 993 @@ -2,96 +2,67 @@ use Moose; use Carp; -use Class::MOP; -use Moose::Meta::Role; -use Moose::Meta::Class; -use Scalar::Util qw/blessed/; +#use Moose::Meta::Role; +#use Moose::Meta::Class; use Data::Dump qw/dump/; use File::Slurp; use List::Util; -use Continuity::Widget::DomNode; +use PPI; +use PPI::HTML; -extends 'Frey'; +use lib 'lib'; +use Frey::Pod; -has 'package' => ( - is => 'rw', - isa => 'Str', - required => 1, -); - -has 'path' => ( - is => 'rw', -); +extends 'Frey::PPI'; +with 'Frey::Web'; +with 'Frey::Storage'; -=head2 load_package +=head1 DESCRIPTION - my ( $class, $meta, $is_role ) = $o->load_package( 'Some::Package' ); +Provide introspection on any perl class installed on system =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 $@; - - 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 ); -} +has 'class' => ( + is => 'rw', + isa => 'Str', + required => 1, +); =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 } grep { $_ ne 'Moose::Object' } $meta->superclasses; - warn "superclasses ",dump( @superclasses ); + warn "superclasses ",dump( @superclasses ) if $self->debug; } 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; @@ -115,7 +86,7 @@ $out .= "\t\t},\n\t\tmeta: Frey.HTML, classMethods: { renderHTML: function () { - return new Joose.SimpleRequest().getText(\"inspect?module=$m;class=$c\") + return new Joose.SimpleRequest().getText(\"/" . $self->class . "\") },\n"; $out .= "\t\t},\n"; @@ -125,98 +96,263 @@ $out =~ s/,\n$/\n/; $out .= "});\n"; - $out .= "\nconsole.log( 'loaded " . $class->name . " from $filename' );\n"; - - warn $class->dump(2); + $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n"; - warn "method_list = ",dump( $class->get_method_list ); - warn dump( map{ $class->get_method($_)->name } sort $class->get_method_list ); + 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 +sub as_markup { + my ( $self ) = @_; - my @methods = $o->methods; + $self->add_head( 'static/introspect.css' ); -=cut + my ( $meta, $is_role ) = $self->class_meta; + + my $class = $self->class; + $self->title( $class ); -sub methods { - my $self = shift; + my $introspect_path = "var/introspect/$class.yaml"; + $self->mkbasepath( $introspect_path ); + my $introspect; # FIXME update with = $self->load( $introspect_path ); - my ( $class, $meta, $is_role ) = $self->load_package; + 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 + ); + } + } - my $attr; - $attr->{$_}++ foreach $class->get_attribute_list; - my @methods = grep { ! defined($attr->{$_}) } $class->get_method_list; - warn "# methods = ",dump( @methods ); + my $method_from_role; + my $attribute_from_role; - return @methods; -} + 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 ); -=head1 OUTPUT GENERATION + 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 ); + + 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; + } -our @javascript = ( qw' -../lib/Joose.js -'); - -sub html { - my ( $self, $request ) = @_; - - while (1) { - - my $js = [ map { - ( script => { type => 'text/javascript', src => $_ } ) - } @javascript ]; - warn "# js = ",dump( $js ); - - my $o; - - my ( $class, $meta, $is_role ) = $self->load_package(); - if ( $class->can('meta') ) { - $o = Continuity::Widget::DomNode->create( - ul => [ - map { ( - li => [ a => { href => $_ } => [ $_ ] ] - ) } $self->methods - ] - )->to_string; - } else { - $o = 'not introspectable'; - } + qq|$html_name$type$properties| + } sort $meta->get_attribute_list + } - warn "# o = ",dump( $o ); - - my $doc = Continuity::Widget::DomNode->create( - html => [ - head => [ - link => { rel=>"stylesheet", href=>"/static/app.css", type=>"text/css", media=>"screen" }, -# $js, - ], - body => [ - h1 => [ 'Introspect ', $self->package ], - $o, - ], - ] - ); + my $table = qq||; + while ( @methods || @attributes ) { + my ($m,$a) = ( shift @methods, shift @attributes ); + $m ||= ''; + $a ||= ''; + $table .= qq|$m$a|; + } + $table .= qq|
MethodsAttributesTypeProperties
|; + + my $path = $self->class_path( $class ); - $request->print($doc->to_string); - warn "# html = ", $doc->to_string; - $request->next; + 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, +# 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 ], } - warn "# exit html"; + + 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

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

Source

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