Add support for stylesheets (#499)

rometools · Dec 28, 2021 · f7d6c85 · f7d6c85
1 parent 49c3c7a
commit f7d6c85
Show file tree

Hide file tree

Showing 17 changed files with 76 additions and 42 deletions.
diff --git a/pom.xml b/pom.xml
@@ -316,6 +316,12 @@
                 <artifactId>hamcrest-library</artifactId>
                 <version>2.2</version>
             </dependency>
+            <!-- AssertJ -->
+            <dependency>
+                <groupId>org.assertj</groupId>
+                <artifactId>assertj-core</artifactId>
+                <version>3.21.0</version>
+            </dependency>
             <!-- JavaX -->
             <dependency>
                 <groupId>javax.servlet</groupId>

diff --git a/rome/pom.xml b/rome/pom.xml
@@ -98,6 +98,11 @@
             <artifactId>junit</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.github.tomakehurst</groupId>
             <artifactId>wiremock</artifactId>

diff --git a/rome/src/main/java/com/rometools/rome/io/WireFeedOutput.java b/rome/src/main/java/com/rometools/rome/io/WireFeedOutput.java
@@ -20,12 +20,14 @@
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.Writer;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.WeakHashMap;
 
 import org.jdom2.Document;
 import org.jdom2.JDOMException;
+import org.jdom2.ProcessingInstruction;
 import org.jdom2.output.DOMOutputter;
 import org.jdom2.output.Format;
 import org.jdom2.output.XMLOutputter;
@@ -119,6 +121,7 @@ public String outputString(final WireFeed feed) throws IllegalArgumentException,
      *
      */
     public String outputString(final WireFeed feed, final boolean prettyPrint) throws IllegalArgumentException, FeedException {
+
         final Document doc = outputJDom(feed);
         final String encoding = feed.getEncoding();
         Format format;
@@ -130,6 +133,7 @@ public String outputString(final WireFeed feed, final boolean prettyPrint) throw
         if (encoding != null) {
             format.setEncoding(encoding);
         }
+
         final XMLOutputter outputter = new XMLOutputter(format);
         return outputter.outputString(doc);
     }
@@ -232,6 +236,7 @@ public void output(final WireFeed feed, final Writer writer) throws IllegalArgum
      *
      */
     public void output(final WireFeed feed, final Writer writer, final boolean prettyPrint) throws IllegalArgumentException, IOException, FeedException {
+
         final Document doc = outputJDom(feed);
         final String encoding = feed.getEncoding();
         Format format;
@@ -243,8 +248,10 @@ public void output(final WireFeed feed, final Writer writer, final boolean prett
         if (encoding != null) {
             format.setEncoding(encoding);
         }
+
         final XMLOutputter outputter = new XMLOutputter(format);
         outputter.output(doc, writer);
+
     }
 
     /**
@@ -290,7 +297,9 @@ public org.w3c.dom.Document outputW3CDom(final WireFeed feed) throws IllegalArgu
      *
      */
     public Document outputJDom(final WireFeed feed) throws IllegalArgumentException, FeedException {
+
         final String type = feed.getFeedType();
+
         final WireFeedGenerator generator = getFeedGenerators().getGenerator(type);
         if (generator == null) {
             throw new IllegalArgumentException("Invalid feed type [" + type + "]");
@@ -299,7 +308,19 @@ public Document outputJDom(final WireFeed feed) throws IllegalArgumentException,
         if (!generator.getType().equals(type)) {
             throw new IllegalArgumentException("WireFeedOutput type[" + type + "] and WireFeed type [" + type + "] don't match");
         }
-        return generator.generate(feed);
+
+        final Document doc = generator.generate(feed);
+
+        final String styleSheet = feed.getStyleSheet();
+        if (styleSheet != null) {
+            final Map<String, String> data = new LinkedHashMap<String, String>();
+            data.put("type", "text/xsl");
+            data.put("href", styleSheet);
+            doc.addContent(0, new ProcessingInstruction("xml-stylesheet", data));
+        }
+
+        return doc;
+
     }
 
 }
diff --git a/rome/src/test/java/com/rometools/rome/unittest/FeedOpsTest.java b/rome/src/test/java/com/rometools/rome/unittest/FeedOpsTest.java
@@ -15,6 +15,8 @@
  */
 package com.rometools.rome.unittest;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.ObjectInputStream;
@@ -23,13 +25,14 @@
 import com.rometools.rome.feed.WireFeed;
 import com.rometools.rome.feed.synd.SyndFeed;
 import com.rometools.rome.feed.synd.SyndFeedImpl;
+import com.rometools.rome.io.SyndFeedOutput;
 
 public abstract class FeedOpsTest extends FeedTest {
 
     protected FeedOpsTest(final String feedType) {
         super(feedType + ".xml");
     }
-    
+
     protected FeedOpsTest(final String feedType, boolean allowDoctypes) {
         super(feedType + ".xml", allowDoctypes);
     }
@@ -123,4 +126,17 @@ public void testSyndFeedSerialization() throws Exception {
         assertTrue(feed1.equals(feed2));
     }
 
+    public void testStylesheet() throws Exception {
+
+        // verify parser
+        assertThat(this.getCachedSyndFeed().getStyleSheet()).isEqualTo("style.xsl");
+        assertThat(this.getCachedWireFeed().getStyleSheet()).isEqualTo("style.xsl");
+
+        // verify output
+        final SyndFeed feed = this.getCachedSyndFeed();
+        final String xml = new SyndFeedOutput().outputString(feed);
+        assertThat(xml).contains("<?xml-stylesheet type=\"text/xsl\" href=\"style.xsl\"?>");
+
+    }
+
 }
diff --git a/rome/src/test/java/com/rometools/rome/unittest/TestOpsRSS091N.java b/rome/src/test/java/com/rometools/rome/unittest/TestOpsRSS091N.java
@@ -15,15 +15,18 @@
  */
 package com.rometools.rome.unittest;
 
-public class TestOpsRSS091N extends FeedOpsTest {
+import static org.assertj.core.api.Assertions.assertThat;
 
-    public static void main(final String[] args) throws Exception {
-        final FeedOpsTest test = new TestOpsRSS091N();
-        test.testWireFeedSyndFeedConversion();
-    }
+public class TestOpsRSS091N extends FeedOpsTest {
 
     public TestOpsRSS091N() {
         super("rss_0.91N", true);
     }
+
+    @Override
+    public void testStylesheet() throws Exception {
+        assertThat(this.getCachedSyndFeed().getStyleSheet()).isEqualTo("style.xsl");
+        assertThat(this.getCachedWireFeed().getStyleSheet()).isEqualTo("style.xsl");
+    }
 
 }
diff --git a/rome/src/test/java/com/rometools/rome/unittest/TestOpsRSS091U.java b/rome/src/test/java/com/rometools/rome/unittest/TestOpsRSS091U.java
@@ -1,9 +1,17 @@
 package com.rometools.rome.unittest;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 public class TestOpsRSS091U extends FeedOpsTest {
 
     public TestOpsRSS091U() {
         super("rss_0.91U");
     }
+
+    @Override
+    public void testStylesheet() throws Exception {
+        assertThat(this.getCachedSyndFeed().getStyleSheet()).isEqualTo("style.xsl");
+        assertThat(this.getCachedWireFeed().getStyleSheet()).isEqualTo("style.xsl");
+    }
 
 }
diff --git a/rome/src/test/java/com/rometools/rome/unittest/issues/Issue88Test.java b/rome/src/test/java/com/rometools/rome/unittest/issues/Issue88Test.java
diff --git a/rome/src/test/resources/atom_0.3.xml b/rome/src/test/resources/atom_0.3.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <feed version="0.3" 
       xmlns="http://purl.org/atom/ns#"
       xmlns:rometest='http://rome.dev.java.net/namespacetest' >

diff --git a/rome/src/test/resources/atom_1.0.xml b/rome/src/test/resources/atom_1.0.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <feed xmlns='http://www.w3.org/2005/Atom' 
       xmlns:rometest='http://rome.dev.java.net/namespacetest' 
       xml:lang='en-us'>

diff --git a/rome/src/test/resources/rss_0.9.xml b/rome/src/test/resources/rss_0.9.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
          xmlns="http://my.netscape.com/rdf/simple/0.9/">
     <channel>

diff --git a/rome/src/test/resources/rss_0.91N.xml b/rome/src/test/resources/rss_0.91N.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN"
                      "http://my.netscape.com/publish/formats/rss-0.91.dtd">
 

diff --git a/rome/src/test/resources/rss_0.91U.xml b/rome/src/test/resources/rss_0.91U.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rss version="0.91">
 
     <channel>

diff --git a/rome/src/test/resources/rss_0.92.xml b/rome/src/test/resources/rss_0.92.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rss version="0.92">
     <channel>
         <title>rss_0.92.channel.title</title>

diff --git a/rome/src/test/resources/rss_0.93.xml b/rome/src/test/resources/rss_0.93.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rss version="0.93">
     <channel>
         <title>rss_0.93.channel.title</title>

diff --git a/rome/src/test/resources/rss_0.94.xml b/rome/src/test/resources/rss_0.94.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rss version="0.94">
     <channel>
         <title>rss_0.94.channel.title</title>

diff --git a/rome/src/test/resources/rss_1.0.xml b/rome/src/test/resources/rss_1.0.xml
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
          xmlns:rometest='http://rome.dev.java.net/namespacetest'
          xmlns:content='http://purl.org/rss/1.0/modules/content/'

diff --git a/rome/src/test/resources/rss_2.0.xml b/rome/src/test/resources/rss_2.0.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<?xml-stylesheet type="text/xsl" href="http://test.example/test.xslt"?>
+<?xml-stylesheet type="text/xsl" href="style.xsl"?>
 <rss version="2.0" 
     xmlns:rometest='http://rome.dev.java.net/namespacetest'
     xmlns:content='http://purl.org/rss/1.0/modules/content/'>