Convert Articles, ArticlesDatabase, and SyncDatabase to Swift Packages

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/Article+Database.swift

@@ -0,0 +1,220 @@
+//
+//  Article+Database.swift
+//  NetNewsWire
+//
+//  Created by Brent Simmons on 7/3/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import RSDatabase
+import RSDatabaseObjC
+import Articles
+import RSParser
+
+extension Article {
+	
+	init?(accountID: String, row: FMResultSet, status: ArticleStatus) {
+		guard let articleID = row.string(forColumn: DatabaseKey.articleID) else {
+			assertionFailure("Expected articleID.")
+			return nil
+		}
+		guard let webFeedID = row.string(forColumn: DatabaseKey.feedID) else {
+			assertionFailure("Expected feedID.")
+			return nil
+		}
+		guard let uniqueID = row.string(forColumn: DatabaseKey.uniqueID) else {
+			assertionFailure("Expected uniqueID.")
+			return nil
+		}
+
+		let title = row.string(forColumn: DatabaseKey.title)
+		let contentHTML = row.string(forColumn: DatabaseKey.contentHTML)
+		let contentText = row.string(forColumn: DatabaseKey.contentText)
+		let url = row.string(forColumn: DatabaseKey.url)
+		let externalURL = row.string(forColumn: DatabaseKey.externalURL)
+		let summary = row.string(forColumn: DatabaseKey.summary)
+		let imageURL = row.string(forColumn: DatabaseKey.imageURL)
+		let datePublished = row.date(forColumn: DatabaseKey.datePublished)
+		let dateModified = row.date(forColumn: DatabaseKey.dateModified)
+
+		self.init(accountID: accountID, articleID: articleID, webFeedID: webFeedID, uniqueID: uniqueID, title: title, contentHTML: contentHTML, contentText: contentText, url: url, externalURL: externalURL, summary: summary, imageURL: imageURL, datePublished: datePublished, dateModified: dateModified, authors: nil, status: status)
+	}
+
+	init(parsedItem: ParsedItem, maximumDateAllowed: Date, accountID: String, webFeedID: String, status: ArticleStatus) {
+		let authors = Author.authorsWithParsedAuthors(parsedItem.authors)
+
+		// Deal with future datePublished and dateModified dates.
+		var datePublished = parsedItem.datePublished
+		if datePublished == nil {
+			datePublished = parsedItem.dateModified
+		}
+		if datePublished != nil, datePublished! > maximumDateAllowed {
+			datePublished = nil
+		}
+
+		var dateModified = parsedItem.dateModified
+		if dateModified != nil, dateModified! > maximumDateAllowed {
+			dateModified = nil
+		}
+
+		self.init(accountID: accountID, articleID: parsedItem.syncServiceID, webFeedID: webFeedID, uniqueID: parsedItem.uniqueID, title: parsedItem.title, contentHTML: parsedItem.contentHTML, contentText: parsedItem.contentText, url: parsedItem.url, externalURL: parsedItem.externalURL, summary: parsedItem.summary, imageURL: parsedItem.imageURL, datePublished: datePublished, dateModified: dateModified, authors: authors, status: status)
+	}
+
+	private func addPossibleStringChangeWithKeyPath(_ comparisonKeyPath: KeyPath<Article,String?>, _ otherArticle: Article, _ key: String, _ dictionary: inout DatabaseDictionary) {
+		if self[keyPath: comparisonKeyPath] != otherArticle[keyPath: comparisonKeyPath] {
+			dictionary[key] = self[keyPath: comparisonKeyPath] ?? ""
+		}
+	}
+
+	func byAdding(_ authors: Set<Author>) -> Article {
+		if authors.isEmpty {
+			return self
+		}
+		return Article(accountID: self.accountID, articleID: self.articleID, webFeedID: self.webFeedID, uniqueID: self.uniqueID, title: self.title, contentHTML: self.contentHTML, contentText: self.contentText, url: self.url, externalURL: self.externalURL, summary: self.summary, imageURL: self.imageURL, datePublished: self.datePublished, dateModified: self.dateModified, authors: authors, status: self.status)
+	}
+
+	func changesFrom(_ existingArticle: Article) -> DatabaseDictionary? {
+		if self == existingArticle {
+			return nil
+		}
+		
+		var d = DatabaseDictionary()
+		if uniqueID != existingArticle.uniqueID {
+			d[DatabaseKey.uniqueID] = uniqueID
+		}
+
+		addPossibleStringChangeWithKeyPath(\Article.title, existingArticle, DatabaseKey.title, &d)
+		addPossibleStringChangeWithKeyPath(\Article.contentHTML, existingArticle, DatabaseKey.contentHTML, &d)
+		addPossibleStringChangeWithKeyPath(\Article.contentText, existingArticle, DatabaseKey.contentText, &d)
+		addPossibleStringChangeWithKeyPath(\Article.url, existingArticle, DatabaseKey.url, &d)
+		addPossibleStringChangeWithKeyPath(\Article.externalURL, existingArticle, DatabaseKey.externalURL, &d)
+		addPossibleStringChangeWithKeyPath(\Article.summary, existingArticle, DatabaseKey.summary, &d)
+		addPossibleStringChangeWithKeyPath(\Article.imageURL, existingArticle, DatabaseKey.imageURL, &d)
+
+		// If updated versions of dates are nil, and we have existing dates, keep the existing dates.
+		// This is data that’s good to have, and it’s likely that a feed removing dates is doing so in error.
+		if datePublished != existingArticle.datePublished {
+			if let updatedDatePublished = datePublished {
+				d[DatabaseKey.datePublished] = updatedDatePublished
+			}
+		}
+		if dateModified != existingArticle.dateModified {
+			if let updatedDateModified = dateModified {
+				d[DatabaseKey.dateModified] = updatedDateModified
+			}
+		}
+
+		return d.count < 1 ? nil : d
+	}
+
+//	static func articlesWithParsedItems(_ parsedItems: Set<ParsedItem>, _ accountID: String, _ feedID: String, _ statusesDictionary: [String: ArticleStatus]) -> Set<Article> {
+//		let maximumDateAllowed = Date().addingTimeInterval(60 * 60 * 24) // Allow dates up to about 24 hours ahead of now
+//		return Set(parsedItems.map{ Article(parsedItem: $0, maximumDateAllowed: maximumDateAllowed, accountID: accountID, feedID: feedID, status: statusesDictionary[$0.articleID]!) })
+//	}
+
+	private static func _maximumDateAllowed() -> Date {
+		return Date().addingTimeInterval(60 * 60 * 24) // Allow dates up to about 24 hours ahead of now
+	}
+
+	static func articlesWithWebFeedIDsAndItems(_ webFeedIDsAndItems: [String: Set<ParsedItem>], _ accountID: String, _ statusesDictionary: [String: ArticleStatus]) -> Set<Article> {
+		let maximumDateAllowed = _maximumDateAllowed()
+		var feedArticles = Set<Article>()
+		for (webFeedID, parsedItems) in webFeedIDsAndItems {
+			for parsedItem in parsedItems {
+				let status = statusesDictionary[parsedItem.articleID]!
+				let article = Article(parsedItem: parsedItem, maximumDateAllowed: maximumDateAllowed, accountID: accountID, webFeedID: webFeedID, status: status)
+				feedArticles.insert(article)
+			}
+		}
+		return feedArticles
+	}
+
+	static func articlesWithParsedItems(_ parsedItems: Set<ParsedItem>, _ webFeedID: String, _ accountID: String, _ statusesDictionary: [String: ArticleStatus]) -> Set<Article> {
+		let maximumDateAllowed = _maximumDateAllowed()
+		return Set(parsedItems.map{ Article(parsedItem: $0, maximumDateAllowed: maximumDateAllowed, accountID: accountID, webFeedID: webFeedID, status: statusesDictionary[$0.articleID]!) })
+	}
+}
+
+extension Article: DatabaseObject {
+
+	public func databaseDictionary() -> DatabaseDictionary? {
+		var d = DatabaseDictionary()
+
+		d[DatabaseKey.articleID] = articleID
+		d[DatabaseKey.feedID] = webFeedID
+		d[DatabaseKey.uniqueID] = uniqueID
+
+		if let title = title {
+			d[DatabaseKey.title] = title
+		}
+		if let contentHTML = contentHTML {
+			d[DatabaseKey.contentHTML] = contentHTML
+		}
+		if let contentText = contentText {
+			d[DatabaseKey.contentText] = contentText
+		}
+		if let url = url {
+			d[DatabaseKey.url] = url
+		}
+		if let externalURL = externalURL {
+			d[DatabaseKey.externalURL] = externalURL
+		}
+		if let summary = summary {
+			d[DatabaseKey.summary] = summary
+		}
+		if let imageURL = imageURL {
+			d[DatabaseKey.imageURL] = imageURL
+		}
+		if let datePublished = datePublished {
+			d[DatabaseKey.datePublished] = datePublished
+		}
+		if let dateModified = dateModified {
+			d[DatabaseKey.dateModified] = dateModified
+		}
+		return d
+	}
+	
+	public var databaseID: String {
+		return articleID
+	}
+
+	public func relatedObjectsWithName(_ name: String) -> [DatabaseObject]? {
+		switch name {
+		case RelationshipName.authors:
+			return databaseObjectArray(with: authors)
+		default:
+			return nil
+		}
+	}
+
+	private func databaseObjectArray<T: DatabaseObject>(with objects: Set<T>?) -> [DatabaseObject]? {
+		guard let objects = objects else {
+			return nil
+		}
+		return Array(objects)
+	}
+}
+
+extension Set where Element == Article {
+
+	func statuses() -> Set<ArticleStatus> {
+		return Set<ArticleStatus>(map { $0.status })
+	}
+	
+	func dictionary() -> [String: Article] {
+		var d = [String: Article]()
+		for article in self {
+			d[article.articleID] = article
+		}
+		return d
+	}
+
+	func databaseObjects() -> [DatabaseObject] {
+		return self.map{ $0 as DatabaseObject }
+	}
+
+	func databaseDictionaries() -> [DatabaseDictionary]? {
+		return self.compactMap { $0.databaseDictionary() }
+	}
+}

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/ArticleStatus+Database.swift

@@ -0,0 +1,35 @@
+//
+//  ArticleStatus+Database.swift
+//  NetNewsWire
+//
+//  Created by Brent Simmons on 7/3/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import RSDatabase
+import RSDatabaseObjC
+import Articles
+
+extension ArticleStatus {
+	
+	convenience init(articleID: String, dateArrived: Date, row: FMResultSet) {
+		let read = row.bool(forColumn: DatabaseKey.read)
+		let starred = row.bool(forColumn: DatabaseKey.starred)
+
+		self.init(articleID: articleID, read: read, starred: starred, dateArrived: dateArrived)
+	}
+	
+}
+
+extension ArticleStatus: DatabaseObject {
+	
+	public var databaseID: String {
+		return articleID
+	}
+
+	public func databaseDictionary() -> DatabaseDictionary? {
+		return [DatabaseKey.articleID: articleID, DatabaseKey.read: read, DatabaseKey.starred: starred, DatabaseKey.dateArrived: dateArrived]
+	}
+}
+

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/Author+Database.swift

@@ -0,0 +1,66 @@
+//
+//  Author+Database.swift
+//  NetNewsWire
+//
+//  Created by Brent Simmons on 7/8/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import Articles
+import RSDatabase
+import RSDatabaseObjC
+import RSParser
+
+// MARK: - DatabaseObject
+
+extension Author {
+	
+	init?(row: FMResultSet) {
+		let authorID = row.string(forColumn: DatabaseKey.authorID)
+		let name = row.string(forColumn: DatabaseKey.name)
+		let url = row.string(forColumn: DatabaseKey.url)
+		let avatarURL = row.string(forColumn: DatabaseKey.avatarURL)
+		let emailAddress = row.string(forColumn: DatabaseKey.emailAddress)
+		
+		self.init(authorID: authorID, name: name, url: url, avatarURL: avatarURL, emailAddress: emailAddress)
+	}
+	
+	init?(parsedAuthor: ParsedAuthor) {
+		self.init(authorID: nil, name: parsedAuthor.name, url: parsedAuthor.url, avatarURL: parsedAuthor.avatarURL, emailAddress: parsedAuthor.emailAddress)
+	}
+	
+	public static func authorsWithParsedAuthors(_ parsedAuthors: Set<ParsedAuthor>?) -> Set<Author>? {
+		guard let parsedAuthors = parsedAuthors else {
+			return nil
+		}
+		
+		let authors = Set(parsedAuthors.compactMap { Author(parsedAuthor: $0) })
+		return authors.isEmpty ? nil: authors
+	}
+}
+
+extension Author: DatabaseObject {
+
+	public var databaseID: String {
+		return authorID
+	}
+
+	public func databaseDictionary() -> DatabaseDictionary? {
+		var d: DatabaseDictionary = [DatabaseKey.authorID: authorID]
+		if let name = name {
+			d[DatabaseKey.name] = name
+		}
+		if let url = url {
+			d[DatabaseKey.url] = url
+		}
+		if let avatarURL = avatarURL {
+			d[DatabaseKey.avatarURL] = avatarURL
+		}
+		if let emailAddress = emailAddress {
+			d[DatabaseKey.emailAddress] = emailAddress
+		}
+		return d
+	}
+}
+

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/DatabaseObject+Database.swift

@@ -0,0 +1,19 @@
+//
+//  DatabaseObject+Database.swift
+//  NetNewsWire
+//
+//  Created by Brent Simmons on 9/13/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import RSDatabase
+import Articles
+
+extension Array where Element == DatabaseObject {
+	
+	func asAuthors() -> Set<Author>? {
+		let authors = Set(self.map { $0 as! Author })
+		return authors.isEmpty ? nil : authors
+	}
+}

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/ParsedArticle+Database.swift

@@ -0,0 +1,22 @@
+//
+//  ParsedArticle+Database.swift
+//  NetNewsWire
+//
+//  Created by Brent Simmons on 9/18/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import RSParser
+import Articles
+
+extension ParsedItem {
+	
+	var articleID: String {
+		if let s = syncServiceID {
+			return s
+		}
+		// Must be same calculation as for Article.
+		return Article.calculatedArticleID(webFeedID: feedURL, uniqueID: uniqueID)
+	}
+}

ArticlesDatabase/Sources/ArticlesDatabase/Extensions/RelatedObjectsMap+Database.swift

@@ -0,0 +1,21 @@
+//
+//  RelatedObjectsMap+Database.swift
+//  Database
+//
+//  Created by Brent Simmons on 9/13/17.
+//  Copyright © 2017 Ranchero Software. All rights reserved.
+//
+
+import Foundation
+import RSDatabase
+import Articles
+
+extension RelatedObjectsMap {
+	
+	func authors(for articleID: String) -> Set<Author>? {
+		if let objects = self[articleID] {
+			return objects.asAuthors()
+		}
+		return nil
+	}
+}