Universal feed reader (#314)

Author: w3stling

src/main/java/com/apptasticsoftware/rssreader/AbstractRssReader.java

@@ -199,7 +199,7 @@ protected void initialize() {
     /**
      * Register channel tags for mapping to channel object fields
      */
-    @SuppressWarnings("java:S1192")
+    @SuppressWarnings({"java:S1192", "java:S1612"})
     protected void registerChannelTags() {
         channelTags.putIfAbsent("title", (channel, value) -> Mapper.mapIfEmpty(value, channel::getTitle, channel::setTitle));
         channelTags.putIfAbsent("description", (channel, value) -> Mapper.mapIfEmpty(value, channel::getDescription, channel::setDescription));
@@ -239,8 +239,8 @@ protected void registerChannelTags() {
         channelTags.putIfAbsent("dc:title", (channel, value) -> Mapper.mapIfEmpty(value, channel::getTitle, channel::setTitle));
         channelTags.putIfAbsent("dc:date", (channel, value) -> Mapper.mapIfEmpty(value, channel::getPubDate, channel::setPubDate));
         channelTags.putIfAbsent("dc:creator", (channel, value) -> Mapper.mapIfEmpty(value, channel::getManagingEditor, channel::setManagingEditor));
-        channelTags.putIfAbsent("sy:updatePeriod", (channel, value) -> { if (channel instanceof ChannelImpl) ((ChannelImpl)channel).syUpdatePeriod = value; });
-        channelTags.putIfAbsent("sy:updateFrequency", (channel, value) -> { if (channel instanceof ChannelImpl) mapInteger(value, number -> ((ChannelImpl)channel).syUpdateFrequency = number); });
+        channelTags.putIfAbsent("sy:updatePeriod", (channel, value) -> { if (channel instanceof ChannelImpl) ((ChannelImpl)channel).setSyUpdatePeriod(value); });
+        channelTags.putIfAbsent("sy:updateFrequency", (channel, value) -> { if (channel instanceof ChannelImpl) mapInteger(value, number -> ((ChannelImpl)channel).setSyUpdateFrequency(number)); });
         channelTags.putIfAbsent("/feed/icon", (channel, value) -> createIfNull(channel::getImage, channel::setImage, Image::new).setUrl(value));
         channelTags.putIfAbsent("/feed/logo", (channel, value) -> createIfNull(channel::getImage, channel::setImage, Image::new).setUrl(value));
     }

src/main/java/com/apptasticsoftware/rssreader/Channel.java

@@ -34,7 +34,7 @@ public interface Channel {
      *
      * @deprecated
      * This method be removed in a future version.
-     * <p> Use {@link ChannelImpl#getCategories()} instead.
+     * <p> Use {@link Channel#getCategories()} instead.
      *
      * @return category
      */
@@ -47,7 +47,7 @@ public interface Channel {
      *
      * @deprecated
      * This method be removed in a future version.
-     * <p> Use {@link ChannelImpl#addCategory(String category)} instead.
+     * <p> Use {@link Channel#addCategory(String category)} instead.
      *
      * @param category channel category
      */

src/main/java/com/apptasticsoftware/rssreader/DateTime.java

@@ -23,6 +23,7 @@
  */
 package com.apptasticsoftware.rssreader;
 
+import com.apptasticsoftware.rssreader.internal.ItemImpl;
 import com.apptasticsoftware.rssreader.util.Default;
 import com.apptasticsoftware.rssreader.util.ItemComparator;
 

src/main/java/com/apptasticsoftware/rssreader/FeedChannel.java

@@ -0,0 +1,12 @@
+package com.apptasticsoftware.rssreader;
+
+import com.apptasticsoftware.rssreader.module.itunes.ItunesChannel;
+import com.apptasticsoftware.rssreader.module.mediarss.MediaRssChannel;
+import com.apptasticsoftware.rssreader.module.opensearch.OpenSearchChannel;
+import com.apptasticsoftware.rssreader.module.podcast.PodcastChannel;
+import com.apptasticsoftware.rssreader.module.psc.PscChannel;
+import com.apptasticsoftware.rssreader.module.spotify.SpotifyChannel;
+import com.apptasticsoftware.rssreader.module.youtube.YoutubeChannel;
+
+public interface FeedChannel extends Channel, ItunesChannel, MediaRssChannel, OpenSearchChannel, PodcastChannel, PscChannel, SpotifyChannel, YoutubeChannel {
+}

src/main/java/com/apptasticsoftware/rssreader/FeedItem.java

@@ -0,0 +1,13 @@
+package com.apptasticsoftware.rssreader;
+
+import com.apptasticsoftware.rssreader.module.itunes.ItunesItem;
+import com.apptasticsoftware.rssreader.module.mediarss.MediaRssItem;
+import com.apptasticsoftware.rssreader.module.opensearch.OpenSearchItem;
+import com.apptasticsoftware.rssreader.module.podcast.PodcastItem;
+import com.apptasticsoftware.rssreader.module.psc.PscItem;
+import com.apptasticsoftware.rssreader.module.spotify.SpotifyItem;
+import com.apptasticsoftware.rssreader.module.youtube.YoutubeItem;
+
+public interface FeedItem extends Item, ItunesItem, MediaRssItem, OpenSearchItem, PodcastItem, PscItem, SpotifyItem, YoutubeItem {
+
+}

src/main/java/com/apptasticsoftware/rssreader/FeedReader.java

@@ -0,0 +1,37 @@
+package com.apptasticsoftware.rssreader;
+
+import com.apptasticsoftware.rssreader.internal.FeedChannelImpl;
+import com.apptasticsoftware.rssreader.internal.FeedItemImpl;
+import com.apptasticsoftware.rssreader.module.itunes.ItunesExtensions;
+import com.apptasticsoftware.rssreader.module.mediarss.MediaRssExtensions;
+import com.apptasticsoftware.rssreader.module.opensearch.OpenSearchExtensions;
+import com.apptasticsoftware.rssreader.module.podcast.PodcastExtensions;
+import com.apptasticsoftware.rssreader.module.psc.PscExtensions;
+import com.apptasticsoftware.rssreader.module.spotify.SpotifyExtensions;
+import com.apptasticsoftware.rssreader.module.youtube.YoutubeExtensions;
+
+public class FeedReader extends AbstractRssReader<FeedChannel, FeedItem> {
+
+    @Override
+    protected FeedChannel createChannel(DateTimeParser dateTimeParser) {
+        return new FeedChannelImpl(dateTimeParser);
+    }
+
+    @Override
+    protected FeedItem createItem(DateTimeParser dateTimeParser) {
+        return new FeedItemImpl(dateTimeParser);
+    }
+
+    @Override
+    protected void registerChannelTags() {
+        super.registerChannelTags();
+        var registry = getFeedExtensionRegistry();
+        ItunesExtensions.register(registry);
+        MediaRssExtensions.register(registry);
+        OpenSearchExtensions.register(registry);
+        PodcastExtensions.register(registry, dateTimeParser);
+        PscExtensions.register(registry);
+        SpotifyExtensions.register(registry);
+        YoutubeExtensions.register(registry);
+    }
+}

src/main/java/com/apptasticsoftware/rssreader/Item.java

@@ -81,7 +81,7 @@ public interface Item extends Comparable<Item> {
      *
      * @deprecated
      * This method be removed in a future version.
-     * <p> Use {@link ItemImpl#getCategories()} instead.
+     * <p> Use {@link Item#getCategories()} instead.
      *
      * @return category
      */
@@ -94,7 +94,7 @@ public interface Item extends Comparable<Item> {
      *
      * @deprecated
      * This method be removed in a future version.
-     * <p> Use {@link ItemImpl#addCategory(String category)} instead.
+     * <p> Use {@link Item#addCategory(String category)} instead.
      *
      * @param category category
      */

src/main/java/com/apptasticsoftware/rssreader/RssReader.java

@@ -23,6 +23,9 @@
  */
 package com.apptasticsoftware.rssreader;
 
+import com.apptasticsoftware.rssreader.internal.ChannelImpl;
+import com.apptasticsoftware.rssreader.internal.ItemImpl;
+
 import java.net.http.HttpClient;
 
 /**

src/main/java/com/apptasticsoftware/rssreader/filter/FeedFilter.java

@@ -1,13 +1,11 @@
 package com.apptasticsoftware.rssreader.filter;
 
-import com.apptasticsoftware.rssreader.ItemImpl;
-
 import java.io.InputStream;
 
 /**
  * An interface for filtering RSS or Atom feed streams. This filter can
  * modify or clean feed data before it is processed by the feed parser,
- * which maps it to {@link ItemImpl} objects.
+ * which maps it to {@link com.apptasticsoftware.rssreader.Item} objects.
  */
 public interface FeedFilter {
 

…asticsoftware/rssreader/ChannelImpl.java …ware/rssreader/internal/ChannelImpl.javasrc/main/java/com/apptasticsoftware/rssreader/ChannelImpl.java renamed to src/main/java/com/apptasticsoftware/rssreader/internal/ChannelImpl.java src/main/java/com/apptasticsoftware/rssreader/ChannelImpl.java renamed to src/main/java/com/apptasticsoftware/rssreader/internal/ChannelImpl.java

@@ -21,8 +21,11 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.apptasticsoftware.rssreader;
+package com.apptasticsoftware.rssreader.internal;
 
+import com.apptasticsoftware.rssreader.Channel;
+import com.apptasticsoftware.rssreader.DateTimeParser;
+import com.apptasticsoftware.rssreader.Image;
 import com.apptasticsoftware.rssreader.util.Default;
 import com.apptasticsoftware.rssreader.util.Mapper;
 import com.apptasticsoftware.rssreader.util.Util;
@@ -57,8 +60,8 @@ public class ChannelImpl implements Channel {
     private List<Integer> skipHours;
     private List<String> skipDays;
     private Image image;
-    protected String syUpdatePeriod;
-    protected int syUpdateFrequency = 1;
+    private String syUpdatePeriod;
+    private int syUpdateFrequency = 1;
     private final DateTimeParser dateTimeParser;
 
     /**
@@ -463,6 +466,14 @@ public void setImage(Image image) {
         this.image = image;
     }
 
+    public void setSyUpdatePeriod(String syUpdatePeriod) {
+        this.syUpdatePeriod = syUpdatePeriod;
+    }
+
+    public void setSyUpdateFrequency(int syUpdateFrequency) {
+        this.syUpdateFrequency = syUpdateFrequency;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;