lib/Frey/Introspect.pm

package Frey::Introspect;

use Moose;
use Carp;
#use Moose::Meta::Role;
#use Moose::Meta::Class;
use Data::Dump qw/dump/;
use File::Slurp;
use List::Util;

use PPI;
use PPI::HTML;

use lib 'lib';

extends 'Frey::PPI';
with 'Frey::Web';
with 'Frey::Storage';

has 'class' => (
        is => 'rw',
        isa => 'Str',
        required => 1,
);

=head2 joose

  my $js = $o->joose;

=cut

sub joose {
        my ($self) = @_;

        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 ) if $self->debug;
        }

        my $out;

        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 ( $meta->get_attribute_list ) {
                $out .= "\t\t\t$_: {\n";

                my $attr = $meta->get_attribute($_);
                my $is = $attr->_is_metadata;
                $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;
                $out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg;      # FIXME

                if( defined(my $isa = $attr->_isa_metadata) ){
                        if( blessed $isa ){
                                while( blessed $isa ){
                                        $isa = $isa->name;
                                }
                        }
                        $isa =~ s/\s+\|\s+undef//gi;
                        $out .= "\t\t\t\tisa: Moose.$isa,\n";
                }


                $out .= "\t\t\t},\n";

        }

        $out .= "\t\t},\n\t\tmeta: Frey.HTML,
                classMethods: {
                        renderHTML: function () {
                                return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
                        },\n";

        $out .= "\t\t},\n";

        $out .= "\t}),\n";

        $out =~ s/,\n$/\n/;
        $out .= "});\n";

        $out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";

        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";

        return $out;
}

sub as_markup {
        my ( $self ) = @_;

        $self->add_head( 'static/introspect.css' );

        my ( $meta, $is_role ) = $self->class_meta;

        my $class = $self->class;

        my $introspect_path = "var/introspect/$class.yaml";
        $self->mkbasepath( $introspect_path );
        my $introspect = $self->load( $introspect_path );

        my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
        if ( ! $is_role ) {
                if ( $meta->superclasses ) {
                        $superclasses = 'Superclasses: ' .
                                join(', ',
                                        map {
                                                my $name = $_->meta->name;
                                                $introspect->{superclass}->{$name}++;
                                                $self->dropdown( $name, $_->meta )
                                        }
                                        #grep { $_ ne 'Moose::Object' }
                                        $meta->superclasses
                                );
                }
        }

        my $role_method;
        my $role_attribute;

        if ( $meta->can('roles') ) {
                my $role_nr = 1;
                $roles = join(' ',
                        grep { ! m/\Q$class\E/ }        # skip me
                        map {
                                my $name = $_->name;
                                $introspect->{role}->{$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|<sup>| . $role_nr++ . qq|</sup>|;
                        }
                        $meta->calculate_all_roles
                );
                $roles = qq| with roles: $roles| if $roles;
        }
        warn "# role_method ",dump( $role_method );

        my @methods;
        @methods = map {
                my $name = $_;
                $introspect->{method}->{$name}++;
                if ( $role_method->{$name} ) {
                        my ( $role_name, $nr ) = each %{ $role_method->{$name} };
                        $name .= qq|<sup title="$role_name">$nr</sup>|;
                }
                qq|<td class="m">$name</td>|
        } $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 ) = ( "<b>$name</b>", ' title="required"' )
                                if $attr->can('is_required') && $attr->is_required;

                        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 ) {
                                        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 .= ' ';
                        }
                        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} };
                                $name .= qq|<sup title="$role_name">$nr</sup>|;
                        }

                        eval { $properties = $attr->documentation . ' ' . $properties };

                        qq|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>|
                } $meta->get_attribute_list
        }

        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>|;
        while ( @methods || @attributes ) {
                my ($m,$a) = ( shift @methods, shift @attributes );
                $m ||= '<td></td>';
                $a ||= '<td></td>';
                $table .= qq|<tr>$m$a</tr>|;
        }
        $table .= qq|</table>|;

        my $pod = Frey::Pod->new( class => $class )->as_markup;
        $pod = $pod->{body} if ref($pod);

        my $path = $self->class_path( $class );
        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{(<span.*?line_number.*>\s*)(\d+)(:\s*</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;

        # strip page html
#       $source =~ s{^.*<body[^>]+>}{}s;
#       $source =~ s{</body.*$}{}s;

        my $runnable = join("\n",
                map {
                        $introspect->{runnable}->{$_}++;
                        qq|<a target="$class" href="/$class/$_">$_</a>|
                } $self->class_runnable( $class )
        );
        $runnable = " runnable: $runnable" if $runnable;

        $self->store( $introspect_path, $introspect );

        $self->title( $class );

        my $has_tests = '';
        if ( my @tests = $self->has_tests ) {
                $has_tests = 
                '<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' .       
                join("\n", map {
                        qq|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>|
                } @tests );
        }

        return join("\n",
                qq|<h1>$class</h1>|,
                qq|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n|,
                $pod    ? qq|<a class="frey-skip" href="#___top" title="Skip to POD"    >pod</a>|    : '',
                $source ? qq|<a class="frey-skip" href="#source" title="Skip to source" >source</a>| : '',
                $has_tests,
                qq|$table\n$pod\n</div>\n|,
                qq|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>|,
        );
}

=head1 SEE ALSO

L<MooseX::AutoDoc> on which this code is based

=cut

1;
1	dpavlin	49	package Frey::Introspect;
2
3			use Moose;
4			use Carp;
5	dpavlin	100	#use Moose::Meta::Role;
6			#use Moose::Meta::Class;
7	dpavlin	49	use Data::Dump qw/dump/;
8			use File::Slurp;
9	dpavlin	51	use List::Util;
10	dpavlin	49
11	dpavlin	380	use PPI;
12			use PPI::HTML;
13
14	dpavlin	55	use lib 'lib';
15	dpavlin	53
16	dpavlin	496	extends 'Frey::PPI';
17	dpavlin	100	with 'Frey::Web';
18	dpavlin	602	with 'Frey::Storage';
19	dpavlin	49
20	dpavlin	270	has 'class' => (
21	dpavlin	49	is => 'rw',
22			isa => 'Str',
23			required => 1,
24			);
25
26	dpavlin	53	=head2 joose
27
28	dpavlin	137	my $js = $o->joose;
29	dpavlin	53
30			=cut
31
32			sub joose {
33			my ($self) = @_;
34
35	dpavlin	308	my ( $meta, $is_role ) = $self->class_meta;
36	dpavlin	53
37			if ( ! $is_role ) {
38	dpavlin	50	my @superclasses = map{ $_->meta->name }
39			grep { $_ ne 'Moose::Object' } $meta->superclasses;
40	dpavlin	100	warn "superclasses ",dump( @superclasses ) if $self->debug;
41	dpavlin	50	}
42	dpavlin	49
43			my $out;
44
45	dpavlin	270	my ( $m, $c ) = split(/::/, $self->class, 2);
46	dpavlin	51	my $filename = $m . '.' . ( $c ? "$c." : '' ) . 'js';
47	dpavlin	49
48	dpavlin	137	$c \|\|= '';
49
50	dpavlin	49	$out .= "Module(\"$m\", function (m) {\n\tClass(\"$c\", {\n\t\thas: {\n";
51
52	dpavlin	137	foreach ( $meta->get_attribute_list ) {
53	dpavlin	49	$out .= "\t\t\t$_: {\n";
54
55	dpavlin	137	my $attr = $meta->get_attribute($_);
56	dpavlin	50	my $is = $attr->_is_metadata;
57			$out .= "\t\t\t\tis: \"$is\",\n" if defined $is;
58			$out .= "\t\t\t\tlazy: true,\n" if $attr->is_lazy;
59			$out .= "\t\t\t\trequired: true,\n" if $attr->is_required;
60			$out .= "\t\t\t\tinit: \"" . $attr->init_arg . "\",\n" if $attr->init_arg; # FIXME
61
62			if( defined(my $isa = $attr->_isa_metadata) ){
63			if( blessed $isa ){
64			while( blessed $isa ){
65			$isa = $isa->name;
66			}
67			}
68			$isa =~ s/\s+\\|\s+undef//gi;
69			$out .= "\t\t\t\tisa: Moose.$isa,\n";
70			}
71
72
73	dpavlin	49	$out .= "\t\t\t},\n";
74
75			}
76
77	dpavlin	51	$out .= "\t\t},\n\t\tmeta: Frey.HTML,
78			classMethods: {
79			renderHTML: function () {
80	dpavlin	292	return new Joose.SimpleRequest().getText(\"/" . $self->class . "\")
81	dpavlin	51	},\n";
82
83	dpavlin	49	$out .= "\t\t},\n";
84
85			$out .= "\t}),\n";
86	dpavlin	50
87			$out =~ s/,\n$/\n/;
88	dpavlin	49	$out .= "});\n";
89
90	dpavlin	270	$out .= "\nconsole.log( 'loaded " . $self->class . " from $filename' );\n";
91	dpavlin	49
92	dpavlin	137	warn "method_list = ",dump( $meta->get_method_list ) if $self->debug;
93	dpavlin	49
94	dpavlin	51	# print $out;
95	dpavlin	49	my $path = "static/blib/$filename";
96			write_file( $path, $out );
97			warn "# created $path\n";
98	dpavlin	51
99			return $out;
100	dpavlin	49	}
101
102	dpavlin	455	sub as_markup {
103	dpavlin	269	my ( $self ) = @_;
104	dpavlin	53
105	dpavlin	160	$self->add_head( 'static/introspect.css' );
106	dpavlin	139
107	dpavlin	308	my ( $meta, $is_role ) = $self->class_meta;
108	dpavlin	53
109	dpavlin	270	my $class = $self->class;
110	dpavlin	54
111	dpavlin	602	my $introspect_path = "var/introspect/$class.yaml";
112			$self->mkbasepath( $introspect_path );
113			my $introspect = $self->load( $introspect_path );
114
115	dpavlin	310	my ( $superclasses, $roles ) = ( '<b>Role</b>', '' );
116			if ( ! $is_role ) {
117			if ( $meta->superclasses ) {
118			$superclasses = 'Superclasses: ' .
119			join(', ',
120			map {
121			my $name = $_->meta->name;
122	dpavlin	602	$introspect->{superclass}->{$name}++;
123	dpavlin	543	$self->dropdown( $name, $_->meta )
124	dpavlin	310	}
125			#grep { $_ ne 'Moose::Object' }
126			$meta->superclasses
127			);
128			}
129			}
130
131			my $role_method;
132	dpavlin	313	my $role_attribute;
133	dpavlin	310
134			if ( $meta->can('roles') ) {
135			my $role_nr = 1;
136			$roles = join(' ',
137			grep { ! m/\Q$class\E/ } # skip me
138			map {
139			my $name = $_->name;
140	dpavlin	602	$introspect->{role}->{$name}++;
141	dpavlin	313	$role_method->{ $_ }->{$name} = $role_nr foreach $_->get_method_list;
142			$role_attribute->{ $_ }->{$name} = $role_nr foreach $_->get_attribute_list;
143	dpavlin	543	$self->dropdown( $name, $name->meta ) . qq\|<sup>\| . $role_nr++ . qq\|</sup>\|;
144	dpavlin	310	}
145			$meta->calculate_all_roles
146			);
147			$roles = qq\| with roles: $roles\| if $roles;
148			}
149			warn "# role_method ",dump( $role_method );
150
151	dpavlin	269	my @methods;
152	dpavlin	310	@methods = map {
153	dpavlin	313	my $name = $_;
154	dpavlin	602	$introspect->{method}->{$name}++;
155	dpavlin	313	if ( $role_method->{$name} ) {
156			my ( $role_name, $nr ) = each %{ $role_method->{$name} };
157			$name .= qq\|<sup title="$role_name">$nr</sup>\|;
158	dpavlin	310	}
159	dpavlin	313	qq\|<td class="m">$name</td>\|
160	dpavlin	408	} $self->class_methods( $class );
161	dpavlin	53
162	dpavlin	269	my @attributes;
163			if ( $meta->get_attribute_list ) {
164	dpavlin	409	@attributes = map {
165	dpavlin	313	my $name = $_;
166	dpavlin	602	$introspect->{attribute}->{$name}++;
167	dpavlin	582	my $html_name = $name;
168	dpavlin	313	my $attr = $meta->get_attribute($name);
169	dpavlin	416	confess "$class attribute $name isn't blessed ",dump( $attr ) unless blessed $attr;
170	dpavlin	393	warn "## attr $name ref ",ref( $attr ) if $self->debug;
171	dpavlin	582
172			my ( $title, $properties ) = ( '', '' );
173			( $html_name, $title ) = ( "<b>$name</b>", ' title="required"' )
174			if $attr->can('is_required') && $attr->is_required;
175
176			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/ ) {
177	dpavlin	269	my $getter;
178
179			$getter = $check;
180			$getter =~ s/^has_//;
181
182	dpavlin	416	if ( $attr->can($check) && $attr->$check ) {
183	dpavlin	269	if ( $getter eq $check ) {
184	dpavlin	582	$properties .= "$check";
185	dpavlin	269	} else {
186	dpavlin	543	# we need our dump here instead of $attr->$getter->dump because default can return scalar
187	dpavlin	582	$properties .= $self->dropdown( $check, $attr->$getter );
188	dpavlin	197	}
189			}
190	dpavlin	582	$properties .= ' ';
191	dpavlin	269	}
192	dpavlin	416	my $type = $attr->can('has_type_constraint') && $attr->has_type_constraint ? $attr->type_constraint->name : '';
193	dpavlin	313
194			if ( $role_attribute->{$name} ) {
195			my ( $role_name, $nr ) = each %{ $role_attribute->{$name} };
196			$name .= qq\|<sup title="$role_name">$nr</sup>\|;
197			}
198
199	dpavlin	599	eval { $properties = $attr->documentation . ' ' . $properties };
200	dpavlin	582
201			qq\|<td class="a">$html_name</td><td class="t">$type</td><td>$properties</td>\|
202	dpavlin	409	} $meta->get_attribute_list
203	dpavlin	269	}
204	dpavlin	54
205	dpavlin	312	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>\|;
206	dpavlin	269	while ( @methods \|\| @attributes ) {
207			my ($m,$a) = ( shift @methods, shift @attributes );
208			$m \|\|= '<td></td>';
209			$a \|\|= '<td></td>';
210			$table .= qq\|<tr>$m$a</tr>\|;
211			}
212			$table .= qq\|</table>\|;
213
214	dpavlin	455	my $pod = Frey::Pod->new( class => $class )->as_markup;
215	dpavlin	380	$pod = $pod->{body} if ref($pod);
216	dpavlin	134
217	dpavlin	406	my $path = $self->class_path( $class );
218			my $Document = PPI::Document->new( $path );
219	dpavlin	380
220			# Create a reusable syntax highlighter
221			my $Highlight = PPI::HTML->new(
222	dpavlin	406	line_numbers => 1,
223	dpavlin	380	# page => 1,
224			# colors => {
225			# line_number => '#CCCCCC',
226			# number => '#990000',
227			# },
228			);
229
230			# Spit out the HTML
231			my $source = $Highlight->html( $Document );
232
233	dpavlin	407	$source =~ s{(<span.?line_number.>\s)(\d+)(:\s</span>)}{$1<a target="editor" href="/editor+$path+$2">$2</a>$3}g;
234	dpavlin	406
235			# strip page html
236	dpavlin	380	# $source =~ s{^.*<body[^>]+>}{}s;
237			# $source =~ s{</body.*$}{}s;
238
239	dpavlin	409	my $runnable = join("\n",
240	dpavlin	458	map {
241	dpavlin	602	$introspect->{runnable}->{$_}++;
242	dpavlin	534	qq\|<a target="$class" href="/$class/$_">$_</a>\|
243	dpavlin	458	} $self->class_runnable( $class )
244	dpavlin	409	);
245	dpavlin	314	$runnable = " runnable: $runnable" if $runnable;
246	dpavlin	128
247	dpavlin	602	$self->store( $introspect_path, $introspect );
248
249	dpavlin	418	$self->title( $class );
250	dpavlin	128
251	dpavlin	496	my $has_tests = '';
252			if ( my @tests = $self->has_tests ) {
253			$has_tests =
254			'<br/>test' . ( $#tests > 0 ? 's' : '' ) . ': ' .
255			join("\n", map {
256	dpavlin	534	qq\|<a target="$class" href="/Frey::Test::Runner/as_markup?test=$_">$_</a>\|
257	dpavlin	496	} @tests );
258			}
259
260	dpavlin	418	return join("\n",
261			qq\|<h1>$class</h1>\|,
262			qq\|<div class="frey-introspect">$superclasses\n$roles\n$runnable\n\|,
263			$pod ? qq\|<a class="frey-skip" href="#___top" title="Skip to POD" >pod</a>\| : '',
264			$source ? qq\|<a class="frey-skip" href="#source" title="Skip to source" >source</a>\| : '',
265	dpavlin	496	$has_tests,
266	dpavlin	418	qq\|$table\n$pod\n</div>\n\|,
267			qq\|<h1>Source</h1><a name="source"></a><div class="frey-source">$source</div>\|,
268			);
269	dpavlin	53	}
270
271	dpavlin	49	=head1 SEE ALSO
272
273			L<MooseX::AutoDoc> on which this code is based
274
275			=cut
276
277			1;