No functional change: sort sub definitions.

In the code:
* general plugin API calls (in plugins/write order),
* VCS plugin API calls (in plugins/write order), then
* internal support routines (in alphabetical order).

In the tests:
* general meta-behavior (in no particular order, yet),
* general plugin API calls (in plugins/write order),
* VCS plugin API calls (in plugins/write order), then
* internal support routines (in semi-logical order).

diff --git a/IkiWiki/Plugin/cvs.pm b/IkiWiki/Plugin/cvs.pm
index 71566d212ba71ea3b8c2296ffeb46c0101bea92d..97a568c0eab6d95ae24cd8fbd619b6dd494f312e 100644 (file)
--- a/IkiWiki/Plugin/cvs.pm
+++ b/IkiWiki/Plugin/cvs.pm
@@ -35,10 +35,14 @@ use IkiWiki;
 
 use File::chdir;
 
 
 use File::chdir;
 

+
+# GENERAL PLUGIN API CALLS
+

 sub import {
 sub import {

-       hook(type => "genwrapper", id => "cvs", call => \&genwrapper);

        hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
        hook(type => "getsetup", id => "cvs", call => \&getsetup);
        hook(type => "checkconfig", id => "cvs", call => \&checkconfig);
        hook(type => "getsetup", id => "cvs", call => \&getsetup);

+       hook(type => "genwrapper", id => "cvs", call => \&genwrapper);
+

        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
        hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
        hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
        hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);


@@ -52,17 +56,6 @@ sub import {
        hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
 }
 
        hook(type => "rcs", id => "rcs_getmtime", call => \&rcs_getmtime);
 }
 

-sub genwrapper () {
-       return <<EOF;
-       {
-               int j;
-               for (j = 1; j < argc; j++)
-                       if (strstr(argv[j], "New directory") != NULL)
-                               exit(0);
-       }
-EOF
-}
-

 sub checkconfig () {
        if (! defined $config{cvspath}) {
                $config{cvspath}="ikiwiki";
 sub checkconfig () {
        if (! defined $config{cvspath}) {
                $config{cvspath}="ikiwiki";


@@ -132,36 +125,19 @@ sub getsetup () {
                },
 }
 
                },
 }
 

-sub cvs_info ($$) {
-       my $field=shift;
-       my $file=shift;
-
-       local $CWD = $config{srcdir};
-
-       my $info=`cvs status $file`;
-       my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
-       return $ret;
+sub genwrapper () {
+       return <<EOF;
+       {
+               int j;
+               for (j = 1; j < argc; j++)
+                       if (strstr(argv[j], "New directory") != NULL)
+                               exit(0);
+       }
+EOF

 }
 
 }
 

-sub cvs_runcvs(@) {
-       my @cmd = @_;
-       unshift @cmd, 'cvs', '-Q';
-
-       local $CWD = $config{srcdir};
-
-       open(my $savedout, ">&STDOUT");
-       open(STDOUT, ">", "/dev/null");
-       my $ret = system(@cmd);
-       open(STDOUT, ">&", $savedout);
-
-       return ($ret == 0) ? 1 : 0;
-}

 
 

-sub cvs_is_controlling {
-       my $dir=shift;
-       $dir=$config{srcdir} unless defined($dir);
-       return (-d "$dir/CVS") ? 1 : 0;
-}
+# VCS PLUGIN API CALLS

 
 sub rcs_update () {
        return unless cvs_is_controlling;
 
 sub rcs_update () {
        return unless cvs_is_controlling;


@@ -183,24 +159,6 @@ sub rcs_prepedit ($) {
        return defined $rev ? $rev : "";
 }
 
        return defined $rev ? $rev : "";
 }
 

-sub commitmessage (@) {
-       my %params=@_;
-       
-       if (defined $params{session}) {
-               if (defined $params{session}->param("name")) {
-                       return "web commit by ".
-                               $params{session}->param("name").
-                               (length $params{message} ? ": $params{message}" : "");
-               }
-               elsif (defined $params{session}->remote_addr()) {
-                       return "web commit from ".
-                               $params{session}->remote_addr().
-                               (length $params{message} ? ": $params{message}" : "");
-               }
-       }
-       return $params{message};
-}
-

 sub rcs_commit (@) {
        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.
 sub rcs_commit (@) {
        # Tries to commit the page; returns undef on _success_ and
        # a version of the page with the rcs's conflict markers on failure.


@@ -493,4 +451,56 @@ sub rcs_getmtime ($) {
        error "rcs_getmtime is not implemented for cvs\n"; # TODO
 }
 
        error "rcs_getmtime is not implemented for cvs\n"; # TODO
 }
 

+
+# INTERNAL SUPPORT ROUTINES
+
+sub commitmessage (@) {
+       my %params=@_;
+
+       if (defined $params{session}) {
+               if (defined $params{session}->param("name")) {
+                       return "web commit by ".
+                               $params{session}->param("name").
+                               (length $params{message} ? ": $params{message}" : "");
+               }
+               elsif (defined $params{session}->remote_addr()) {
+                       return "web commit from ".
+                               $params{session}->remote_addr().
+                               (length $params{message} ? ": $params{message}" : "");
+               }
+       }
+       return $params{message};
+}
+
+sub cvs_info ($$) {
+       my $field=shift;
+       my $file=shift;
+
+       local $CWD = $config{srcdir};
+
+       my $info=`cvs status $file`;
+       my ($ret)=$info=~/^\s*$field:\s*(\S+)/m;
+       return $ret;
+}
+
+sub cvs_is_controlling {
+       my $dir=shift;
+       $dir=$config{srcdir} unless defined($dir);
+       return (-d "$dir/CVS") ? 1 : 0;
+}
+
+sub cvs_runcvs(@) {
+       my @cmd = @_;
+       unshift @cmd, 'cvs', '-Q';
+
+       local $CWD = $config{srcdir};
+
+       open(my $savedout, ">&STDOUT");
+       open(STDOUT, ">", "/dev/null");
+       my $ret = system(@cmd);
+       open(STDOUT, ">&", $savedout);
+
+       return ($ret == 0) ? 1 : 0;
+}
+

 1
 1

diff --git a/t/cvs.t b/t/cvs.t
index cfc33261f70ce0333ecd1af82b712af31cbb4d4f..390e9af474624f85a2c8f0fdebb905fc2363550a 100755 (executable)
--- a/t/cvs.t
+++ b/t/cvs.t
@@ -7,124 +7,7 @@ use IkiWiki;
 my $default_test_methods = '^test_*';
 my $dir = "/tmp/ikiwiki-test-cvs.$$";
 
 my $default_test_methods = '^test_*';
 my $dir = "/tmp/ikiwiki-test-cvs.$$";
 

-sub _plan_for_test_more {
-       my $can_plan = shift;
-
-       foreach my $program (qw(
-               cvs
-               cvsps
-       )) {
-               my $program_path = `which $program`;
-               chomp $program_path;
-               return plan(skip_all => "$program not available")
-                       unless -x $program_path;
-       }
-
-       foreach my $module (qw(
-               File::chdir
-               File::MimeInfo
-               Date::Parse
-               File::Temp
-               File::ReadBackwards
-       )) {
-               eval qq{use $module};
-               return plan(skip_all => "$module not available")
-                       if $@;
-       }
-
-       return plan(skip_all => "can't create $dir: $!")
-               unless mkdir($dir);
-       return plan(skip_all => "can't remove $dir: $!")
-               unless rmdir($dir);
-
-       return unless $can_plan;
-
-       return plan(tests => $total_tests);
-}
-
-
-# http://stackoverflow.com/questions/607282/whats-the-best-way-to-discover-all-subroutines-a-perl-module-has
-
-use B qw/svref_2object/;
-
-sub in_package {
-       my ($coderef, $package) = @_;
-       my $cv = svref_2object($coderef);
-       return if not $cv->isa('B::CV') or $cv->GV->isa('B::SPECIAL');
-       return $cv->GV->STASH->NAME eq $package;
-}
-
-sub list_module {
-       my $module = shift;
-       no strict 'refs';
-       return grep {
-               defined &{"$module\::$_"} and in_package(\&{*$_}, $module)
-       } keys %{"$module\::"};
-}
-
-
-# support for xUnit-style testing, a la Test::Class
-
-sub _startup {
-       my $can_plan = shift;
-       _plan_for_test_more($can_plan);
-       _generate_test_config();
-}
-
-sub _shutdown {
-       my $had_plan = shift;
-       done_testing() unless $had_plan;
-}
-
-sub _setup {
-       _generate_test_repo();
-}
-
-sub _teardown {
-       system "rm -rf $dir";
-}
-
-sub _runtests {
-       my @coderefs = (@_);
-       for (@coderefs) {
-               _setup();
-               $_->();
-               _teardown();
-       }
-}
-
-sub _get_matching_test_subs {
-       my $re = shift;
-       no strict 'refs';
-       return map { \&{*$_} } grep { /$re/ } sort(list_module('main'));
-}
-
-sub _generate_test_config {
-       %config = IkiWiki::defaultconfig();
-       $config{rcs} = "cvs";
-       $config{srcdir} = "$dir/src";
-       $config{cvsrepo} = "$dir/repo";
-       $config{cvspath} = "ikiwiki";
-       IkiWiki::loadplugins();
-       IkiWiki::checkconfig();
-}
-
-sub _generate_test_repo {
-       die "can't create $dir: $!"
-               unless mkdir($dir);
-
-       my $cvs = "cvs -d $config{cvsrepo}";
-       my $dn = ">/dev/null";
-       system "$cvs init $dn";
-       system "mkdir $dir/$config{cvspath} $dn";
-       system "cd $dir/$config{cvspath} && "
-               . "$cvs import -m import $config{cvspath} VENDOR RELEASE $dn";
-       system "rm -rf $dir/$config{cvspath} $dn";
-       system "$cvs co -d $config{srcdir} $config{cvspath} $dn";
-}
-
-
-# tests for general meta-behavior:
+# TESTS FOR GENERAL META-BEHAVIOR

 
 sub test_web_add_and_commit {
        my $message = "Add a page via VCS API";
 
 sub test_web_add_and_commit {
        my $message = "Add a page via VCS API";


@@ -205,35 +88,6 @@ sub test_chdir_magic {
        # when are we bothering with "local $CWD" and when aren't we?
 }
 
        # when are we bothering with "local $CWD" and when aren't we?
 }
 

-
-# tests for VCS API calls:
-
-sub test_genwrapper {
-       # testable directly? affects rcs_add, but are we exercising this?
-}
-
-sub test_checkconfig {
-       # undef cvspath, expect "ikiwiki"
-       # define cvspath normally, get it back
-       # define cvspath in a subdir, get it back?
-       # define cvspath with extra slashes, get sanitized version back
-       # - yoink test_extra_path_slashes
-       # undef cvs_wrapper, expect $config{wrappers} same size as before
-
-       my $initial_cvspath = $config{cvspath};
-       $config{cvspath} = "/ikiwiki//";
-       IkiWiki::checkconfig();
-       is(
-               $config{cvspath},
-               $initial_cvspath,
-               q{rcs_recentchanges assumes checkconfig has sanitized cvspath},
-       );
-}
-
-sub test_getsetup {
-       # anything worth testing?
-}
-

 sub test_cvs_info {
        # inspect "Repository revision" (used in code)
        # inspect "Sticky Options" (used in tests to verify existence of "-kb")
 sub test_cvs_info {
        # inspect "Repository revision" (used in code)
        # inspect "Sticky Options" (used in tests to verify existence of "-kb")


@@ -287,6 +141,38 @@ sub test_cvs_is_controlling {
        # - else, die
 }
 
        # - else, die
 }
 

+
+# TESTS FOR GENERAL PLUGIN API CALLS
+
+sub test_checkconfig {
+       # undef cvspath, expect "ikiwiki"
+       # define cvspath normally, get it back
+       # define cvspath in a subdir, get it back?
+       # define cvspath with extra slashes, get sanitized version back
+       # - yoink test_extra_path_slashes
+       # undef cvs_wrapper, expect $config{wrappers} same size as before
+
+       my $initial_cvspath = $config{cvspath};
+       $config{cvspath} = "/ikiwiki//";
+       IkiWiki::checkconfig();
+       is(
+               $config{cvspath},
+               $initial_cvspath,
+               q{rcs_recentchanges assumes checkconfig has sanitized cvspath},
+       );
+}
+
+sub test_getsetup {
+       # anything worth testing?
+}
+
+sub test_genwrapper {
+       # testable directly? affects rcs_add, but are we exercising this?
+}
+
+
+# TESTS FOR VCS PLUGIN API CALLS
+

 sub test_rcs_update {
        # can it assume we're under CVS control? or must it check?
        # anything else worth testing?
 sub test_rcs_update {
        # can it assume we're under CVS control? or must it check?
        # anything else worth testing?


@@ -443,3 +329,121 @@ sub main {
 }
 
 main();
 }
 
 main();

+
+
+# INTERNAL SUPPORT ROUTINES
+
+sub _plan_for_test_more {
+       my $can_plan = shift;
+
+       foreach my $program (qw(
+               cvs
+               cvsps
+       )) {
+               my $program_path = `which $program`;
+               chomp $program_path;
+               return plan(skip_all => "$program not available")
+                       unless -x $program_path;
+       }
+
+       foreach my $module (qw(
+               File::chdir
+               File::MimeInfo
+               Date::Parse
+               File::Temp
+               File::ReadBackwards
+       )) {
+               eval qq{use $module};
+               return plan(skip_all => "$module not available")
+                       if $@;
+       }
+
+       return plan(skip_all => "can't create $dir: $!")
+               unless mkdir($dir);
+       return plan(skip_all => "can't remove $dir: $!")
+               unless rmdir($dir);
+
+       return unless $can_plan;
+
+       return plan(tests => $total_tests);
+}
+
+# http://stackoverflow.com/questions/607282/whats-the-best-way-to-discover-all-subroutines-a-perl-module-has
+
+use B qw/svref_2object/;
+
+sub in_package {
+       my ($coderef, $package) = @_;
+       my $cv = svref_2object($coderef);
+       return if not $cv->isa('B::CV') or $cv->GV->isa('B::SPECIAL');
+       return $cv->GV->STASH->NAME eq $package;
+}
+
+sub list_module {
+       my $module = shift;
+       no strict 'refs';
+       return grep {
+               defined &{"$module\::$_"} and in_package(\&{*$_}, $module)
+       } keys %{"$module\::"};
+}
+
+
+# support for xUnit-style testing, a la Test::Class
+
+sub _startup {
+       my $can_plan = shift;
+       _plan_for_test_more($can_plan);
+       _generate_test_config();
+}
+
+sub _shutdown {
+       my $had_plan = shift;
+       done_testing() unless $had_plan;
+}
+
+sub _setup {
+       _generate_test_repo();
+}
+
+sub _teardown {
+       system "rm -rf $dir";
+}
+
+sub _runtests {
+       my @coderefs = (@_);
+       for (@coderefs) {
+               _setup();
+               $_->();
+               _teardown();
+       }
+}
+
+sub _get_matching_test_subs {
+       my $re = shift;
+       no strict 'refs';
+       return map { \&{*$_} } grep { /$re/ } sort(list_module('main'));
+}
+
+sub _generate_test_config {
+       %config = IkiWiki::defaultconfig();
+       $config{rcs} = "cvs";
+       $config{srcdir} = "$dir/src";
+       $config{cvsrepo} = "$dir/repo";
+       $config{cvspath} = "ikiwiki";
+       IkiWiki::loadplugins();
+       IkiWiki::checkconfig();
+}
+
+sub _generate_test_repo {
+       die "can't create $dir: $!"
+               unless mkdir($dir);
+
+       my $cvs = "cvs -d $config{cvsrepo}";
+       my $dn = ">/dev/null";
+       system "$cvs init $dn";
+       system "mkdir $dir/$config{cvspath} $dn";
+       system "cd $dir/$config{cvspath} && "
+               . "$cvs import -m import $config{cvspath} VENDOR RELEASE $dn";
+       system "rm -rf $dir/$config{cvspath} $dn";
+       system "$cvs co -d $config{srcdir} $config{cvspath} $dn";
+}