Changeset 308

Timestamp:

05/25/06 15:59:17 (6 years ago)

Author:

nick

Message:

Support for RSS feeds of the node all versions, and tests for it

Location:

wiki-toolkit/trunk

Files:

• MANIFEST (modified) (1 diff)
• lib/Wiki/Toolkit/Feed/Listing.pm (modified) (2 diffs)
• lib/Wiki/Toolkit/Feed/RSS.pm (modified) (5 diffs)
• t/296_feed_rss_recentchanges_add_test_data.t (modified) (1 diff)

wiki-toolkit/trunk/MANIFEST

@@ -71 +71 @@
 t/296_feed_rss_recentchanges_add_test_data.t
 t/297_feed_rss_recentchanges.t
+t/298_feed_rss_node_all_versions.t
 t/300_feed_atom_setup.t
 t/301_feed_atom_add_test_data.t

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/Listing.pm

@@ -9 +9 @@
 Handles common data fetching tasks, so that child classes need only
 worry about formatting the feeds.
+
+Also enforces some common methods that must be implemented.
 
 =cut
@@ -74 +76 @@
     my ($self, %args) = @_;
 
-    # TODO. Will make use of store->list_node_all_versions()
+    # Check we got the right options
+    unless($args{'name'}) {
+        return ();
+    }
+
+    # Do the fetch
+    my @nodes = $self->{wiki}->list_node_all_versions(
+                        name => $args{'name'},
+                        with_content => 0,
+                        with_metadata => 1,
+    );
+
+    # Ensure that all the metadata fields are arrays and not strings
+    foreach my $node (@nodes) {
+        foreach my $mdk (keys %{$node->{'metadata'}}) {
+            unless(ref($node->{'metadata'}->{$mdk}) eq "ARRAY") {
+                $node->{'metadata'}->{$mdk} = [ $node->{'metadata'}->{$mdk} ];
+            }
+        }
+    }
+
+    return @nodes;
 }
 
+
+# The following are methods that any feed renderer must provide
+
+=item B<recent_changes>
+All implementing feed renderers must implement a method to fetch a list
+of recent changes, and render them
+=cut
+sub recent_changes    { die("Not implemented by feed renderer!"); }
+=item B<node_all_versions>
+All implementing feed renderers must implement a method to fetch a list
+of the different versions of a node, and render them
+=cut
+sub node_all_versions { die("Not implemented by feed renderer!"); }
+=item B<feed_timestamp>
+All implementing feed renderers must implement a method to produce a
+feed specific timestamp, based on the supplied node
+=cut
+sub feed_timestamp    { die("Not implemented by feed renderer!"); }
+
 1;

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/RSS.pm

@@ -62 +62 @@
 
   my @changes = $self->fetch_recently_changed_nodes(%args);
-  my $rss_timestamp = $self->rss_timestamp(
+  my $feed_timestamp = $self->feed_timestamp(
                               $self->fetch_newest_for_recently_changed(%args)
   );
 
-  return $self->generate_node_list_feed($rss_timestamp, @changes);
-}
+  return $self->generate_node_list_feed($feed_timestamp, @changes);
+}
+
+
+=item B<node_all_versions>
+
+Build an RSS Feed of all the different versions of a given node.
+
+=cut
+sub node_all_versions
+{
+  my ($self, %args) = @_;
+
+  my @all_versions = $self->fetch_node_all_versions(%args);
+  my $feed_timestamp = $self->feed_timestamp( $all_versions[0] );
+
+  return $self->generate_node_list_feed($feed_timestamp, @all_versions);
+}
+
 
 =item <generate_node_list_feed>
@@ -75 +92 @@
 =cut
 sub generate_node_list_feed {
-  my ($self,$rss_timestamp,@nodes) = @_;
+  my ($self,$feed_timestamp,@nodes) = @_;
 
   #"http://purl.org/rss/1.0/modules/wiki/"
@@ -124 +141 @@
 <link>}               . $self->{recent_changes_link}  . qq{</link>
 <description>}        . $self->{site_description}     . qq{</description>
-<dc:date>}            . $rss_timestamp                . qq{</dc:date>
+<dc:date>}            . $feed_timestamp                . qq{</dc:date>
 <modwiki:interwiki>}     . $self->{interwiki_identifier} . qq{</modwiki:interwiki>};
 
@@ -214 +231 @@
 }
 
-=item B<rss_timestamp>
+=item B<feed_timestamp>
 
 Generate the timestamp for the RSS, based on the newest node (if available)
 
 =cut
-sub rss_timestamp
+sub feed_timestamp
 {
     my ($self, $newest_node) = @_;
@@ -394 +411 @@
 =back
 
-=head2 C<rss_timestamp()>
-
-  print $rss->rss_timestamp();
+=head2 C<feed_timestamp()>
+
+  print $rss->feed_timestamp();
 
 Returns the timestamp of the feed in POSIX::strftime style ("Tue, 29 Feb 2000 

wiki-toolkit/trunk/t/296_feed_rss_recentchanges_add_test_data.t

@@ -19 +19 @@
       my $wiki = Wiki::Toolkit->new( store => $store );
 
+      # Write two versions of one node
+      # The recent changes should only show it once though
       $wiki->write_node( "Old Node",
-                         "We will write at least 15 nodes after this one" );
+                         "First version of Old Node" );
+      my %old_node = $wiki->retrieve_node("Old Node");
+      $wiki->write_node( "Old Node",
+                         "We will write at least 15 nodes after this one",
+                         $old_node{'checksum'} );
 
       my $slept = sleep(2);