Skip to content

Rename MediaRssReader class #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
w3stling merged 1 commit into from
Dec 23, 2025
Merged

Rename MediaRssReader class #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions src/main/java/com/apptasticsoftware/rssreader/module/mediarss/MediaRssFeedReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*
* MIT License
*
* Copyright (c) 2022, Apptastic Software
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.apptasticsoftware.rssreader.module.mediarss;

import com.apptasticsoftware.rssreader.AbstractRssReader;
import com.apptasticsoftware.rssreader.DateTimeParser;
import com.apptasticsoftware.rssreader.module.mediarss.internal.MediaRssChannelImpl;
import com.apptasticsoftware.rssreader.module.mediarss.internal.MediaRssItemImpl;

import java.net.http.HttpClient;

/**
* Class for reading media rss feeds.
*/
public class MediaRssFeedReader extends AbstractRssReader<MediaRssChannel, MediaRssItem> {

/**
* Constructor
*/
public MediaRssFeedReader() {
super();
}

/**
* Constructor
* @param httpClient http client
*/
public MediaRssFeedReader(HttpClient httpClient) {
super(httpClient);
}

@Override
protected MediaRssChannel createChannel(DateTimeParser dateTimeParser) {
return new MediaRssChannelImpl(dateTimeParser);
}

@Override
protected MediaRssItem createItem(DateTimeParser dateTimeParser) {
return new MediaRssItemImpl(dateTimeParser);
}

@Override
protected void registerChannelTags() {
super.registerChannelTags();
var registry = getFeedExtensionRegistry();
MediaRssExtensions.register(registry);
}
}
28 changes: 6 additions & 22 deletions src/main/java/com/apptasticsoftware/rssreader/module/mediarss/MediaRssReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@
*/
package com.apptasticsoftware.rssreader.module.mediarss;

import com.apptasticsoftware.rssreader.AbstractRssReader;
import com.apptasticsoftware.rssreader.DateTimeParser;
import com.apptasticsoftware.rssreader.module.mediarss.internal.MediaRssChannelImpl;
import com.apptasticsoftware.rssreader.module.mediarss.internal.MediaRssItemImpl;

import java.net.http.HttpClient;

/**
* Class for reading media rss feeds.
*
* @deprecated
* Use {@link MediaRssFeedReader} instead.
*/
public class MediaRssReader extends AbstractRssReader<MediaRssChannel, MediaRssItem> {
@SuppressWarnings("java:S1133")
@Deprecated(since="3.13.0", forRemoval=true)
public class MediaRssReader extends MediaRssFeedReader {

/**
* Constructor
Expand All @@ -50,20 +50,4 @@ public MediaRssReader(HttpClient httpClient) {
super(httpClient);
}

@Override
protected MediaRssChannel createChannel(DateTimeParser dateTimeParser) {
return new MediaRssChannelImpl(dateTimeParser);
}

@Override
protected MediaRssItem createItem(DateTimeParser dateTimeParser) {
return new MediaRssItemImpl(dateTimeParser);
}

@Override
protected void registerChannelTags() {
super.registerChannelTags();
var registry = getFeedExtensionRegistry();
MediaRssExtensions.register(registry);
}
}
34 changes: 17 additions & 17 deletions ...r/module/mediarss/MediaRssReaderTest.java → ...dule/mediarss/MediaRssFeedReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@
import static org.junit.jupiter.api.Assertions.assertNotNull;

@SuppressWarnings("java:S5961")
class MediaRssReaderTest {
class MediaRssFeedReaderTest {

@Test
void readMediaRssFeed() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.collect(Collectors.toList());

assertEquals(10, res.size());
}

@Test
void readMediaRssFeedItemTitle() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -48,7 +48,7 @@ void readMediaRssFeedItemTitle() {

@Test
void readMediaRssFeedItemPubDate() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -58,7 +58,7 @@ void readMediaRssFeedItemPubDate() {

@Test
void readMediaRssFeedItemLink() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -68,7 +68,7 @@ void readMediaRssFeedItemLink() {

@Test
void readMediaRssFeedDescription() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -78,7 +78,7 @@ void readMediaRssFeedDescription() {

@Test
void readMediaRssFeedGuid() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -88,7 +88,7 @@ void readMediaRssFeedGuid() {

@Test
void readMediaRssFeedIsPermaLink() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -98,7 +98,7 @@ void readMediaRssFeedIsPermaLink() {

@Test
void readMediaRssFeedThumbnail() {
var res = new MediaRssReader().read(fromFile("mediarss/media-rss.xml"))
var res = new MediaRssFeedReader().read(fromFile("mediarss/media-rss.xml"))
.sorted(ItemComparator.oldestPublishedItemFirst())
.collect(Collectors.toList());

Expand All @@ -114,7 +114,7 @@ void readMediaRssFeedThumbnail() {

@Test
void readMediaRssContent() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-content.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-content.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -275,7 +275,7 @@ void readMediaRssContent() {

@Test
void readMediaRssGroup() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-group.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-group.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -442,7 +442,7 @@ void readMediaRssGroup() {

@Test
void mediaRssChannel() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-channel.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-channel.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -934,7 +934,7 @@ void mediaRssExample1(AbstractRssReader<MediaRssChannel, MediaRssItem> feedReade

@Test
void mediaRssExample2() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-example-2.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-example-2.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -1221,7 +1221,7 @@ void mediaRssExample2() {

@Test
void mediaRssExample3() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-example-3.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-example-3.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -1489,7 +1489,7 @@ void mediaRssExample3() {

@Test
void mediaRssExample4() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-example-4.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-example-4.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -1761,7 +1761,7 @@ void mediaRssExample4() {

@Test
void mediaRssExample5() {
var items = new MediaRssReader().read(fromFile("mediarss/media-rss-example-5.xml"))
var items = new MediaRssFeedReader().read(fromFile("mediarss/media-rss-example-5.xml"))
.collect(Collectors.toList());

assertEquals(1, items.size());
Expand Down Expand Up @@ -1807,7 +1807,7 @@ void equalsContract() {

private static Stream<? extends Arguments> feedReaderArguments() {
return Stream.of(
Arguments.of(new MediaRssReader()),
Arguments.of(new MediaRssFeedReader()),
Arguments.of(new FeedReader())
);
}
Expand Down