Skip to content
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

Parse item elements in RSS feeds outside of the channel element too #1854

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Parse item elements in RSS feeds outside of the channel element too #1854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06fe217
Parse RSS item elements too if they are outside of the channel element
Eitot Dec 5, 2024
e16f7f9
Remove unused success bool from -initRSSFeedItems: method
Eitot Dec 5, 2024
b76d094
Add unit-test cases for RSS parsing of item elements
Eitot Dec 5, 2024
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
20 changes: 20 additions & 0 deletions Vienna Tests/Files/RSSFeedWithItemElementUnderRSSAndChannelElement.rss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
<channel>
<title>Feed title</title>
<link>http://localhost</link>
<description>Feed description</description>
<item>
<description>Item description</description>
<content:encoded>Item content</content:encoded>
<pubDate>Thu, 01 Jan 1970 00:00:00 +0000</pubDate>
<guid isPermaLink="false">channelItemGUID</guid>
</item>
</channel>
<item>
<description>Item description</description>
<content:encoded>Item content</content:encoded>
<pubDate>Thu, 01 Jan 1970 00:00:00 +0000</pubDate>
<guid isPermaLink="false">rssItemGUID</guid>
</item>
</rss>
14 changes: 14 additions & 0 deletions Vienna Tests/Files/RSSFeedWithItemElementUnderRSSElement.rss
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/">
<channel>
<title>Feed title</title>
<link>http://localhost</link>
<description>Feed description</description>
</channel>
<item>
<description>Item description</description>
<content:encoded>Item content</content:encoded>
<pubDate>Thu, 01 Jan 1970 00:00:00 +0000</pubDate>
<guid isPermaLink="false">itemGUID</guid>
</item>
</rss>
26 changes: 26 additions & 0 deletions Vienna Tests/RSSFeedTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,32 @@ class RSSFeedTests: XCTestCase {

// MARK: Test methods

func testParsingItemElementUnderRSSElement() throws {
let fileData = try data(
forResource: "RSSFeedWithItemElementUnderRSSElement",
withExtension: "rss"
)
let feedData = try VNAXMLFeedParser().feed(withXMLData: fileData)
let rssFeed = try XCTUnwrap(feedData as? RSSFeed)
let feedItems = rssFeed.items

XCTAssert(feedItems.count == 1)
XCTAssert(feedItems.first?.guid == "itemGUID")
}

func testParsingItemElementUnderRSSAndChannelElement() throws {
let fileData = try data(
forResource: "RSSFeedWithItemElementUnderRSSAndChannelElement",
withExtension: "rss"
)
let feedData = try VNAXMLFeedParser().feed(withXMLData: fileData)
let rssFeed = try XCTUnwrap(feedData as? RSSFeed)
let feedItems = rssFeed.items

XCTAssert(feedItems.count == 1)
XCTAssert(feedItems.first?.guid == "channelItemGUID")
}

/// Validate the content:encoded elements.
func testParsingContentElement() throws {
let fileData = try data(forResource: "RSSFeedWithContentElements", withExtension: "rss")
Expand Down
8 changes: 8 additions & 0 deletions Vienna.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@
F6B059E42961D0DD00F6E31B /* JSONFeedParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = F6B059E32961D0DD00F6E31B /* JSONFeedParser.swift */; };
F6B3561525616313008CA1ED /* DownloadItem.m in Sources */ = {isa = PBXBuildFile; fileRef = F6B3561425616313008CA1ED /* DownloadItem.m */; };
F6B7BC3624A2A9A40051D76F /* FMDB in Frameworks */ = {isa = PBXBuildFile; productRef = F6B7BC3524A2A9A40051D76F /* FMDB */; };
F6C136582D01C0D0009E42F8 /* RSSFeedWithItemElementUnderRSSElement.rss in Resources */ = {isa = PBXBuildFile; fileRef = F6C136572D01C0D0009E42F8 /* RSSFeedWithItemElementUnderRSSElement.rss */; };
F6C1365A2D01C3E2009E42F8 /* RSSFeedWithItemElementUnderRSSAndChannelElement.rss in Resources */ = {isa = PBXBuildFile; fileRef = F6C136592D01C3E2009E42F8 /* RSSFeedWithItemElementUnderRSSAndChannelElement.rss */; };
F6C9DA70271BB3BB00FC3027 /* RSSFeed.m in Sources */ = {isa = PBXBuildFile; fileRef = F6C9DA6F271BB3BB00FC3027 /* RSSFeed.m */; };
F6C9DA73271BB55000FC3027 /* AtomFeed.m in Sources */ = {isa = PBXBuildFile; fileRef = F6C9DA72271BB55000FC3027 /* AtomFeed.m */; };
F6CE47131E7E3DCB0045EAD7 /* ActivityItem.m in Sources */ = {isa = PBXBuildFile; fileRef = F6CE47121E7E3DCB0045EAD7 /* ActivityItem.m */; };
Expand Down Expand Up @@ -633,6 +635,8 @@
F6BD1FDA2C9D7DD40075D04F /* .swiftlint.yml */ = {isa = PBXFileReference; lastKnownFileType = text.yaml; path = .swiftlint.yml; sourceTree = "<group>"; };
F6BD1FDC2C9D7E230075D04F /* CONTRIBUTING.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
F6BD1FDD2C9D7E2E0075D04F /* LICENCE.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = LICENCE.md; sourceTree = "<group>"; };
F6C136572D01C0D0009E42F8 /* RSSFeedWithItemElementUnderRSSElement.rss */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = RSSFeedWithItemElementUnderRSSElement.rss; sourceTree = "<group>"; };
F6C136592D01C3E2009E42F8 /* RSSFeedWithItemElementUnderRSSAndChannelElement.rss */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; path = RSSFeedWithItemElementUnderRSSAndChannelElement.rss; sourceTree = "<group>"; };
F6C9DA6E271BB3BB00FC3027 /* RSSFeed.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RSSFeed.h; sourceTree = "<group>"; };
F6C9DA6F271BB3BB00FC3027 /* RSSFeed.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = RSSFeed.m; sourceTree = "<group>"; };
F6C9DA71271BB55000FC3027 /* AtomFeed.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = AtomFeed.h; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1062,6 +1066,8 @@
children = (
F64499FB259773B9005A1EFA /* FeedDiscovery.html */,
F6E01A082C652FA50082E07B /* RSSFeedWithContentElements.rss */,
F6C136592D01C3E2009E42F8 /* RSSFeedWithItemElementUnderRSSAndChannelElement.rss */,
F6C136572D01C0D0009E42F8 /* RSSFeedWithItemElementUnderRSSElement.rss */,
);
path = Files;
sourceTree = "<group>";
Expand Down Expand Up @@ -1540,6 +1546,8 @@
files = (
F6449A0325977521005A1EFA /* FeedDiscovery.html in Resources */,
F6E01A092C652FA50082E07B /* RSSFeedWithContentElements.rss in Resources */,
F6C1365A2D01C3E2009E42F8 /* RSSFeedWithItemElementUnderRSSAndChannelElement.rss in Resources */,
F6C136582D01C0D0009E42F8 /* RSSFeedWithItemElementUnderRSSElement.rss in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down
16 changes: 11 additions & 5 deletions Vienna/Sources/Parsing/RSSFeed.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,16 @@ - (BOOL)initRSSFeed:(NSXMLElement *)rssElement isRDF:(BOOL)isRDF
success = [self initRSSFeedHeaderWithElement:channelElement];
if (success) {
if (isRDF) {
success = [self initRSSFeedItems:rssElement];
[self initRSSFeedItems:rssElement];
} else {
success = [self initRSSFeedItems:channelElement];
[self initRSSFeedItems:channelElement];

// Previous versions of RSS allowed <item> elements under the <rss>
// element instead of the <channel> element. If no items were found
// under the <channel> element then traverse the <rss> element too.
if (self.items.count == 0) {
[self initRSSFeedItems:rssElement];
}
}
}
return success;
Expand Down Expand Up @@ -168,9 +175,8 @@ - (void)parseSequence:(NSXMLElement *)seqElement
}
}

- (BOOL)initRSSFeedItems:(NSXMLElement *)startElement
- (void)initRSSFeedItems:(NSXMLElement *)startElement
{
BOOL success = YES;
NSMutableArray *items = [NSMutableArray array];

for (NSXMLElement *element in startElement.children) {
Expand Down Expand Up @@ -348,7 +354,7 @@ - (BOOL)initRSSFeedItems:(NSXMLElement *)startElement

self.items = items;

return success;
return;
}

// MARK: Overrides
Expand Down