autoindex: stop tracking deletions, use generic autofile tracking instead

- Migrate the set of deletions to the {autofile} set, since it has
  more or less the same effect. This affects the "deleted" case in the
  test.
- If a page has just been deleted, add it as an autofile anyway: by
  the time gen_autofile is called, it'll be in the list of deleted files,
  so it'll just be added to {autofile}. This affects the "gone" case
  in the test.
- Behaviour change: we don't forget that a page with no reason to be
  re-created was deleted. This affects the 'expunged' and 'reinstated'
  cases in the test.

diff --git a/IkiWiki/Plugin/autoindex.pm b/IkiWiki/Plugin/autoindex.pm
index ba2dcb907ce9657f1792432e3efd4dec2f977f5f..5a58c820aaefa1244fd2b08947f82968ce945c37 100644 (file)
--- a/IkiWiki/Plugin/autoindex.pm
+++ b/IkiWiki/Plugin/autoindex.pm
@@ -78,53 +78,38 @@ sub refresh () {
                chdir($origdir) || die "chdir $origdir: $!";
        }
 
-       # FIXME: some of this is probably redundant with add_autofile now, and
-       # the rest should perhaps be added to the autofile machinery
-
+       # Compatibility code.
+       #
+       # {deleted} contains pages that have been deleted at some point.
+       # This plugin used to delete from the hash sometimes, but no longer
+       # does; in [[todo/autoindex_should_use_add__95__autofile]] Joey
+       # thought the old behaviour was probably a bug.
+       #
+       # The effect of listing a page in {deleted} was to avoid re-creating
+       # it; we migrate these pages to {autofile} which has the same effect.
+       # However, {autofile} contains source filenames whereas {deleted}
+       # contains page names.
        my %deleted;
        if (ref $wikistate{autoindex}{deleted}) {
                %deleted=%{$wikistate{autoindex}{deleted}};
+               delete $wikistate{autoindex}{deleted};
        }
         elsif (ref $pagestate{index}{autoindex}{deleted}) {
-               # compatability code
+               # an even older version
                %deleted=%{$pagestate{index}{autoindex}{deleted}};
                delete $pagestate{index}{autoindex};
        }
 
        if (keys %deleted) {
                foreach my $dir (keys %deleted) {
-                       # remove deleted page state if the deleted page is re-added,
-                       # or if all its subpages are deleted
-                       if ($deleted{$dir} && (exists $pages{$dir} ||
-                                              ! grep /^$dir\/.*/, keys %pages)) {
-                               delete $deleted{$dir};
-                       }
+                       my $file=newpagefile($dir, $config{default_pageext});
+                       $wikistate{autoindex}{autofile}{$file} = 1;
                }
-               $wikistate{autoindex}{deleted}=\%deleted;
        }
 
-       my @needed;
        foreach my $dir (keys %dirs) {
-               if (! exists $pages{$dir} && ! $deleted{$dir} &&
-                   grep /^$dir\/.*/, keys %pages) {
-                       if (exists $IkiWiki::pagemtime{$dir}) {
-                               # This page must have just been deleted, so
-                               # don't re-add it. And remember it was
-                               # deleted.
-                               if (! ref $wikistate{autoindex}{deleted}) {
-                                       $wikistate{autoindex}{deleted}={};
-                               }
-                               ${$wikistate{autoindex}{deleted}}{$dir}=1;
-                       }
-                       else {
-                               push @needed, $dir;
-                       }
-               }
-       }
-       
-       if (@needed) {
-               foreach my $page (@needed) {
-                       genindex($page);
+               if (! exists $pages{$dir} && grep /^$dir\/.*/, keys %pages) {
+                       genindex($dir);
                }
        }
 }

diff --git a/t/autoindex.t b/t/autoindex.t
index 2c1331da27df1d330aed9f7b967da3d44f23296f..665f0dc1cdf20991f1398b2fc37b1e7eb2de951b 100755 (executable)
--- a/t/autoindex.t
+++ b/t/autoindex.t
@@ -3,7 +3,7 @@ package IkiWiki;
 
 use warnings;
 use strict;
-use Test::More tests => 33;
+use Test::More tests => 37;
 
 BEGIN { use_ok("IkiWiki"); }
 BEGIN { use_ok("IkiWiki::Render"); }
@@ -33,7 +33,8 @@ is(checkconfig(), 1);
 %pagesources=%pagemtime=%oldlinks=%links=%depends=%typedlinks=%oldtypedlinks=
 %destsources=%renderedfiles=%pagecase=%pagestate=();
 
-# pages that (we claim) were deleted in an earlier pass
+# Pages that (we claim) were deleted in an earlier pass. We're using deleted,
+# not autofile, to test backwards compat.
 $wikistate{autoindex}{deleted}{deleted} = 1;
 $wikistate{autoindex}{deleted}{expunged} = 1;
 $wikistate{autoindex}{deleted}{reinstated} = 1;
@@ -66,33 +67,50 @@ my @del;
 
 IkiWiki::Plugin::autoindex::refresh();
 
-# these pages are still on record as having been deleted, because they have
+# this page is still on record as having been deleted, because it has
 # a reason to be re-created
-is($wikistate{autoindex}{deleted}{deleted}, 1);
-is($wikistate{autoindex}{deleted}{gone}, 1);
-ok(! exists $autofiles{deleted});
-ok(! exists $autofiles{gone});
+is($wikistate{autoindex}{autofile}{"deleted.mdwn"}, 1);
+is($autofiles{"deleted.mdwn"}{plugin}, "autoindex");
+%pages = ();
+@del = ();
+IkiWiki::gen_autofile("deleted.mdwn", \%pages, \@del);
+is_deeply(\%pages, {}) || diag explain \%pages;
+is_deeply(\@del, []) || diag explain \@del;
 ok(! -f "t/tmp/deleted.mdwn");
+
+# this page is tried as an autofile, but because it'll be in @del, it's not
+# actually created
+ok(! exists $wikistate{autoindex}{autofile}{"gone.mdwn"});
+%pages = ();
+@del = ("gone.mdwn");
+is($autofiles{"gone.mdwn"}{plugin}, "autoindex");
+IkiWiki::gen_autofile("gone.mdwn", \%pages, \@del);
+is_deeply(\%pages, {}) || diag explain \%pages;
+is_deeply(\@del, ["gone.mdwn"]) || diag explain \@del;
 ok(! -f "t/tmp/gone.mdwn");
 
-# this page does not exist and has no reason to be re-created, so we forget
-# about it - it will be re-created if it gains sub-pages
-ok(! exists $wikistate{autoindex}{deleted}{expunged});
-ok(! exists $autofiles{expunged});
+# this page does not exist and has no reason to be re-created, but we no longer
+# have a special case for that - see
+# [[todo/autoindex_should_use_add__95__autofile]] - so it won't be created
+# even if it gains subpages later
+is($wikistate{autoindex}{autofile}{"expunged.mdwn"}, 1);
+ok(! exists $autofiles{"expunged.mdwn"});
 ok(! -f "t/tmp/expunged.mdwn");
 
 # a directory containing only an internal page shouldn't be indexed
-ok(! exists $wikistate{autoindex}{deleted}{has_internal});
-ok(! exists $autofiles{has_internal});
+ok(! exists $wikistate{autoindex}{autofile}{"has_internal.mdwn"});
+ok(! exists $autofiles{"has_internal.mdwn"});
 ok(! -f "t/tmp/has_internal.mdwn");
 
-# this page was re-created, so it drops off the radar
-ok(! exists $wikistate{autoindex}{deleted}{reinstated});
-ok(! exists $autofiles{reinstated});
+# this page was re-created, but that no longer gets a special case
+# (see [[todo/autoindex_should_use_add__95__autofile]]) so it's the same as
+# deleted
+is($wikistate{autoindex}{autofile}{"reinstated.mdwn"}, 1);
+ok(! exists $autofiles{"reinstated.mdwn"});
 ok(! -f "t/tmp/reinstated.mdwn");
 
 # needs creating (deferred; part of the autofile mechanism now)
-ok(! exists $wikistate{autoindex}{deleted}{tags});
+ok(! exists $wikistate{autoindex}{autofile}{"tags.mdwn"});
 %pages = ();
 @del = ();
 is($autofiles{"tags.mdwn"}{plugin}, "autoindex");
@@ -102,7 +120,7 @@ is_deeply(\@del, []) || diag explain \@del;
 ok(-s "t/tmp/tags.mdwn");
 
 # needs creating because of an attachment
-ok(! exists $wikistate{autoindex}{deleted}{attached});
+ok(! exists $wikistate{autoindex}{autofile}{"attached.mdwn"});
 %pages = ();
 @del = ();
 is($autofiles{"attached.mdwn"}{plugin}, "autoindex");