Enable MooseX::Declare Method Modifiers in OutLine

[bowtie]

Enable MooseX::Declare Method Modifiers in OutLine

• with reference to revision r14225

before / after / around / override / augment

    before   foo ($x, $y, $z) { ... }
    after    bar ($x, $y, $z) { ... }
    around   baz ($x, $y, $z) { ... }
    override moo ($x, $y, $z) { ... }
    augment  kuh ($x, $y, $z) { ... }

FunctionList.pm

lib/Padre/Document/Perl/FunctionList.pm

@@ -21 +21 @@
         |
         $n$n=\w+.*?$n$n=cut\b(?=.*?$n$n)
         |
-        (?:^|$n)\s*(?:sub|func|method)\s+(\w+(?:::\w+)*)
+        (?:^|$n)\s*(?:sub|func|method|before|after|around|override|augment)\s+(\w+(?:::\w+)*)
         )
     /sx;
 

Perl.pm

lib/Padre/Document/Perl.pm

@@ -295 +295 @@
 # triggering a "Variable length lookbehind not implemented" error.
 # return qr/(?:(?<=^)\s*sub\s+$_[1]|(?<=[\012\015])\s*sub\s+$_[1])\b/;
 sub get_function_regex {
-    qr/(?:^|[^# \t])[ \t]*((?:sub|func|method)\s+$_[1])\b/;
+    qr/(?:^|[^# \t])[ \t]*((?:sub|func|method|before|after|around|override|augment)\s+$_[1])\b/;
 }
 
 sub get_functions {
@@ -310 +310 @@
         |
         $n$n=\w+.*?$n$n=cut\b(?=.*?$n$n)
         |
-        (?:^|$n)\s*(?:sub|func|method)\s+(\w+(?:::\w+)*)
+        (?:^|$n)\s*(?:sub|func|method|before|after|around|override|augment)\s+(\w+(?:::\w+)*)
         )
     /sgx;
 }
@@ -758 +758 @@
                     close $fh;
                     my @subs = $lines =~ /sub\s+(\w+)/g;
                     if ( $lines =~ /use MooseX::Declare;/ ) {
-                        push @subs, ( $lines =~ /\bmethod\s+(\w+)/g );
+                        push @subs, ( $lines =~ /\b(method|before|after|around|override|augment)\s+(\w+)/g );
                     }
 
                     if ( $lines =~ /use (?:MooseX::)?Method::Signatures;/ ) {

OutLine.pm

PPIx-EditorTools/lib/PPIx/EditorTools/Outline.pm

@@ -128 +128 @@
         $ppi->find(
             sub {
                 $_[1]->isa('PPI::Token::Word') or return 0;
-                $_[1]->content =~ /^(?:func|method)\z/ or return 0;
+                $_[1]->content =~ /^(?:func|method|before|after|around|override|augment)\z/ or return 0;
                 $_[1]->next_sibling->isa('PPI::Token::Whitespace') or return 0;
                 my $sib_content = $_[1]->next_sibling->next_sibling->content or return 0;
 

[bowtie]

Opps revision 14225

[bowtie]

Outline.pm markII inc Moose Attributes correction

ignore Data::Dumper as this is a rem-lent of poking around.

node name: 'account'
modified node neme: account

node name: [qw/ warned start_time times_up running/]
modified node neme: warned start_time times_up running

node name: qw( sound )
modified node neme: sound

node name: qw/ sound /
modified node neme: sound

node name: ['label2','proggress','bbutWarn']
modified node neme: label2 proggress bbutWarn

Moose Attributes displayed correctly in Outline,

PPIx-EditorTools/lib/PPIx/EditorTools/Outline.pm

@@ -6 +6 @@
 use strict;
 use warnings;
 use Carp;
-
+use Data::Dumper;
 use base 'PPIx::EditorTools';
 use Class::XSAccessor accessors => {};
 
@@ -112 +112 @@
 
             # Moose attribute declaration
             if ( $node1->isa('PPI::Token::Word') && $node1->content eq 'has' ) {
+                # tidy up Moose attributes for Outline display
+                my $name_node2 = $node2->content;
+                my $space = q{ };
+                $name_node2 =~ s/^\[?(qw(\/|\())?$space?//; # remove leading 'quote word'
+                $name_node2 =~ s/(\/|\))?\]?$//; # remove traling 'quote word'
+                $name_node2 =~ s/(\'$space?)//g; # remove Single-Quoted String Literals
+                $name_node2 =~ s/($space?\,$space?)/$space/g; # remove commers add space
                 push @{ $cur_pkg->{attributes} }, { name => $node2->content, line => $thing->location->[0] };
                 next;
             }
@@ -128 +135 @@
         $ppi->find(
             sub {
                 $_[1]->isa('PPI::Token::Word') or return 0;
-                $_[1]->content =~ /^(?:func|method)\z/ or return 0;
+                $_[1]->content =~ /^(?:func|method|before|after|around|override|augment)\z/ or return 0;
                 $_[1]->next_sibling->isa('PPI::Token::Whitespace') or return 0;
                 my $sib_content = $_[1]->next_sibling->next_sibling->content or return 0;
 
@@ -147 +154 @@
     }
 
     push @outline, $cur_pkg;
-
+#   say Dumper @outline;
     return \@outline;
 }

[bowtie]

Opps missed a line

{{{#! perl

# Moose attribute declaration
if ( $node1->isa('PPI::Token::Word') && $node1->content eq 'has' ) {

# tidy up Moose attributes for Outline display
my $name_node2 = $node2->content;
my $space = q{ };
$name_node2 =~ s/^{\[?(qw(\/|\())?$space?; # remove leading 'quote word'
$name_node2 =~ s/(\/|\))?\]?$; # remove traling 'quote word'
$name_node2 =~ s/(\'$space?)g; # remove Single-Quoted String Literals
$name_node2 =~ s/($space?\,$space?)/$space/g; # remove commers add space
push @{ $cur_pkg->{attributes} }, { name => $name_node2, line => $thing->location->[0] };
next;}

}

}}}

[bowtie]

Outline.pm markIII it works needs testing

• class and role support

• attribute support

• method support

• only uses first class or role as package name

• observation, why does padre check file being edited after every key stroke, can we not wait until no changes for say 3 seconds then update Outline, Syntax checker etc..

PPIx-EditorTools/lib/PPIx/EditorTools/Outline.pm

@@ -1 +1 @@
 package PPIx::EditorTools::Outline;
+BEGIN {
+  $PPIx::EditorTools::Outline::VERSION = '0.13';
+}
 
 # ABSTRACT: Collect use pragmata, modules, subroutiones
 
@@ -6 +9 @@
 use strict;
 use warnings;
 use Carp;
-
+use Data::Dumper;
 use base 'PPIx::EditorTools';
 use Class::XSAccessor accessors => {};
 
 use PPI;
 
-=pod
 
-=head1 SYNOPSIS
 
-  my $outline = PPIx::EditorTools::Outline->new->find(
-        code => "package TestPackage;\nsub x { 1;\n"
-      );
- print Dumper $outline;
-
-=head1 DESCRIPTION
-
-Return a list of pragmatas, modules, methods of a C<PPI::Document>.
-
-=head1 METHODS
-
-=over 4
-
-=item new()
-
-Constructor. Generally shouldn't be called with any arguments.
-
-=item find( ppi => PPI::Document $ppi )
-=item find( code => Str $code )
-
-Accepts either a C<PPI::Document> to process or a string containing
-the code (which will be converted into a C<PPI::Document>) to process.
-Return a reference to a hash.
-
-=back
-
-=cut
-
-
 sub find {
     my ( $self, %args ) = @_;
     $self->process_doc(%args);
@@ -74 +46 @@
     my @outline       = ();
     my $cur_pkg       = {};
     my $not_first_one = 0;
+    my $pkg_main = 1;   # add flag for package called main
+    #my $mod_mxd = 0;   # add flag for module MooseX::Declare
     foreach my $thing (@things) {
         if ( ref $thing eq 'PPI::Statement::Package' ) {
             if ($not_first_one) {
                 if ( not $cur_pkg->{name} ) {
                     $cur_pkg->{name} = 'main';
+                    # this never runs as MooseX-Declare does not contain a StatementPkg
+                    $pkg_main = 1;  # set flag for package called main
+                    print "1 pkg main: $pkg_main\n";
                 }
                 push @outline, $cur_pkg;
                 $cur_pkg = {};
@@ -86 +63 @@
             $not_first_one   = 1;
             $cur_pkg->{name} = $thing->namespace;
             $cur_pkg->{line} = $thing->location->[0];
-        } elsif ( ref $thing eq 'PPI::Statement::Include' ) {
+
+            if ( $thing->namespace ) { $pkg_main = 0}
+            ##print "2 pkg main: $pkg_main\t".$thing->namespace."\n";
+        
+        }
+
+        elsif ( ref $thing eq 'PPI::Statement::Include' ) {
             next if $thing->type eq 'no';
             if ( $thing->pragma ) {
                 push @{ $cur_pkg->{pragmata} }, { name => $thing->pragma, line => $thing->location->[0] };
-            } elsif ( $thing->module ) {
+            }
+            elsif ( $thing->module ) {
                 push @{ $cur_pkg->{modules} }, { name => $thing->module, line => $thing->location->[0] };
                 unless ($check_alternate_sub_decls) {
                     $check_alternate_sub_decls = 1
@@ -99 +83 @@
                         'MooseX::Declare',
                         'MooseX::Method::Signatures'
                         );
+                        ## print "what have I found:". $thing->module;
+                        # s/.*MooseX::Declare.*/1/;
+                        # $mod_mxd = 1;
                 }
             }
-        } elsif ( ref $thing eq 'PPI::Statement::Sub' ) {
+        }
+        
+        elsif ( ref $thing eq 'PPI::Statement::Sub' ) {
             push @{ $cur_pkg->{methods} }, { name => $thing->name, line => $thing->location->[0] };
-        } elsif ( ref $thing eq 'PPI::Statement' ) {
+        }
+        
+        elsif ( ref $thing eq 'PPI::Statement' ) {
 
             # last resort, let's analyse further down...
             my $node1 = $thing->first_element;
@@ -112 +103 @@
 
             # Moose attribute declaration
             if ( $node1->isa('PPI::Token::Word') && $node1->content eq 'has' ) {
-                push @{ $cur_pkg->{attributes} }, { name => $node2->content, line => $thing->location->[0] };
+                # tidy up Moose attributes for Outline display
+                my $name_node2 = $node2->content;
+                my $space = q{ };
+                $name_node2 =~ s/^\[?(qw(\/|\())?$space?//; # remove leading 'quote word'
+                $name_node2 =~ s/(\/|\))?\]?$//; # remove traling 'quote word'
+                $name_node2 =~ s/(\'$space?)//g; # remove Single-Quoted String Literals
+                $name_node2 =~ s/($space?\,$space?)/$space/g; # remove commers add space
+                push @{ $cur_pkg->{attributes} }, { name => $name_node2, line => $thing->location->[0] };
                 next;
             }
 
@@ -128 +126 @@
         $ppi->find(
             sub {
                 $_[1]->isa('PPI::Token::Word') or return 0;
-                $_[1]->content =~ /^(?:func|method)\z/ or return 0;
+                $_[1]->content =~ /^(?:func|method|before|after|around|override|augment|class|role)\z/ or return 0;
                 $_[1]->next_sibling->isa('PPI::Token::Whitespace') or return 0;
                 my $sib_content = $_[1]->next_sibling->next_sibling->content or return 0;
 
                 $sib_content =~ m/^\b(\w+)\b/;
                 return 0 unless defined $1;
+                # test for MooseX::Declare attributes class, role
+                if ( $_[1]->content =~ m/(class|role)/){
+                    ##print "method type:". $_[1]->content;
+                    ##print " method name: $sib_content \n";
+                    if ($cur_pkg->{name}){return 1;}
+                    if ( $pkg_main eq 1 ){
+                        $cur_pkg->{name} = $sib_content;
+                        $cur_pkg->{line} = $_[1]->line_number;
+                    }
+                    return 1; # break out so we don't write Packae name as method
+                }
 
                 push @{ $cur_pkg->{methods} }, { name => $1, line => $_[1]->line_number };
 
@@ -147 +156 @@
     }
 
     push @outline, $cur_pkg;
-
+##  print Dumper @outline;
     return \@outline;
 }
 
 1;
 
-__END__
 
+
+=pod
+
+=head1 NAME
+
+PPIx::EditorTools::Outline - Collect use pragmata, modules, subroutiones
+
+=head1 VERSION
+
+version 0.13
+
+=head1 SYNOPSIS
+
+  my $outline = PPIx::EditorTools::Outline->new->find(
+        code => "package TestPackage;\nsub x { 1;\n"
+      );
+ print Dumper $outline;
+
+=head1 DESCRIPTION
+
+Return a list of pragmatas, modules, methods of a C<PPI::Document>.
+
+=head1 METHODS
+
+=over 4
+
+=item new()
+
+Constructor. Generally shouldn't be called with any arguments.
+
+=item find( ppi => PPI::Document $ppi )
+=item find( code => Str $code )
+
+Accepts either a C<PPI::Document> to process or a string containing
+the code (which will be converted into a C<PPI::Document>) to process.
+Return a reference to a hash.
+
+=back
+
 =head1 SEE ALSO
 
 This class inherits from C<PPIx::EditorTools>.
 Also see L<App::EditorTools>, L<Padre>, and L<PPI>.
 
+=head1 AUTHORS
+
+=over 4
+
+=item *
+
+Steffen Mueller C<smueller@cpan.org>
+
+=item *
+
+Repackaged by Mark Grimes C<mgrimes@cpan.org>
+
+=item *
+
+Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2011 by The Padre development team as listed in Padre.pm.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
 =cut
 
+
+__END__
+
+
 # Copyright 2008-2011 The Padre development team as listed in Padre.pm.
 # LICENSE
 # This program is free software; you can redistribute it and/or

[szabgab]

I am happy to see you are working on the issue.

1 Please don't move around the pods to make it easier to see what is the real change.
2 In t/09-outline.t there is the beginning of automated tests for the outline. There is where you should add test cases and make sure they work.

If you need help with 2 let us know.

[szabgab]

And another comment related to discussion on IRC

I think the module should be able to parse Moose-ish files. It can first check for use Moose; or similar and spend the extra cycles only if Moose is loaded. The same should work for other accessor generator modules as well. The parser could also check if Moose is installed but I would like to be able to process Moose-ish files even if Moose itself is not installed. So that should be done based on some parameter.

[bowtie]

suggested upgrade to Outline.pm

[bowtie]

upgraded test file for Moose outline

[bowtie]

test file Moose class

[bowtie]

test file Moose role

[bowtie]

szabdgab

I have tidy up code in PPIx::EditorTools::Outline (peto)

created two tests, plus test files.

all additional actions in peto us the existing Moose test, hence they only run when requested.

Deve::Cover

File:	t/09-outline.t
Coverage:	42.9%

line	%	coverage		branch
15	50	T	F	if ($PPI::VERSION =~ /_/)
142	100	T	F	if ($$c{'file'})
143	50	T	F	unless open my $fh, '<', $$c{'file'}
150	0	T	F	unless is_deeply($outline, $$c{'expected'})
269	50	T	F	if ($$c{'file'})
270	50	T	F	unless open my $fh, '<', $$c{'file'}
275	0	T	F	unless is_deeply($outline, $$c{'expected'})

As for the Regex testing in

• lib/Padre/Document/Perl/FunctionList.pm
  • line 24 no moose test $sub_search_re
• lib/Padre/Document/Perl.pm
  • line 298/313 on moose test
  • line 761 moose test
    

Could we not just have one test here, for Moose rather than two?

foreach my $f (@files) {
    if ( open my $fh, '<', $f ) {
        my $lines = do { local $/ = undef; <$fh> };
        close $fh;
        my @subs = $lines =~ /sub\s+(\w+)/g;
        if ( $lines =~ /use MooseX::Declare;/ ) {
            push @subs,
              ( $lines =~
                  /\b(method|before|after|around|override|augment)\s+(\w+)/g );
        }

        if ( $lines =~ /use (?:MooseX::)?Method::Signatures;/ ) {
            my @subs = $lines =~ /\b(?:method|func)\s+(\w+)/g;
        }

        $self->{_methods_}->{$_} = $f for @subs;
    }
}

Enc the four files.
bowtie

[szabgab]

applied with slight modifications in r14312, will be in release 0.15 soon