fix: lint-issues

Package.resolved

@@ -5,8 +5,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/brightdigit/Contribute.git",
       "state" : {
-        "revision" : "2dbdcdc99861f589639f1828b10ec3c459323639",
-        "version" : "1.0.0-alpha.2"
+        "branch" : "v1.0.0",
+        "revision" : "72290ab018d72870cf243fe99366fab63a7ef979"
       }
     },
     {

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
   dependencies: [
     .package(
       url: "https://github.com/brightdigit/Contribute.git",
-      from: "1.0.0-alpha.2"
+      branch: "v1.0.0"
     ),
     .package(
       url: "https://github.com/brightdigit/SyndiKit.git",

Sources/ContributeWordPress/Decoder/BaseURLSite.swift

@@ -1,19 +1,18 @@
 import Foundation
 import SyndiKit
 
-protocol BaseURLSite {
+/// A protocol representing a site with a base URL.
+public protocol BaseURLSite {
+  /// The main URL of the site.
   var link: URL { get }
+
+  /// The base URL of the blog, if available.
   var baseBlogURL: URL? { get }
 }
 
 extension BaseURLSite {
+  /// The base URL of the site.
   public var baseURL: URL {
     baseBlogURL ?? link
   }
 }
-
-extension RSSChannel: BaseURLSite {
-  var baseBlogURL: URL? {
-    wpBaseBlogURL
-  }
-}

Sources/ContributeWordPress/Decoder/SitesExportDecoder.swift

@@ -0,0 +1,20 @@
+import Foundation
+import SyndiKit
+
+#if canImport(FoundationNetworking)
+  import FoundationNetworking
+#endif
+
+/// A typealias that represents the section name for the blog
+public typealias SectionName = String
+
+/// A protocol for decoding WordPress sites from exports.
+public protocol SitesExportDecoder {
+  /// Returns a dictionary of WordPress sites keyed by the filename of
+  /// the export file as section name.
+  ///
+  /// - Parameter directoryURL: The URL of the directory containing the exports.
+  /// - Returns: A dictionary of WordPress sites keyed by section name.
+  /// - Throws: An error if sites couldn't be extracted from any of the export files.
+  func sites(fromExportsAt directoryURL: URL) throws -> [SectionName: WordPressSite]
+}

Sources/ContributeWordPress/Decoder/PostsExportSynDecoder.swift → Sources/ContributeWordPress/Decoder/SitesExportSynDecoder.swift

@@ -7,7 +7,7 @@ import SyndiKit
 #endif
 
 /// A type that decodes WordPress export files using the `SynDecoder`.
-public struct PostsExportSynDecoder: PostsExportDecoder {
+public struct SitesExportSynDecoder: SitesExportDecoder {
   /// The decoder used to decode the WordPress export file.
   private let decoder: WordPressDecoder = SynDecoder()
 
@@ -21,48 +21,44 @@ public struct PostsExportSynDecoder: PostsExportDecoder {
 
   public init() {}
 
-  /// The method decodes posts from the given file URL.
+  /// The method decodes `WordPressSite` from the given file URL.
   ///
   /// - Parameters:
-  ///   - url: The URL of file containing WordPress posts to be decoded.
+  ///   - url: The URL of export file containing the WordPress site with its posts.
   ///   - decoder: The WordPress decoder.
-  /// - Returns: An array of WordPress posts.
-  /// - Throws: An error of posts couldn't be decoded from the given file..
-  private static func postsFromURL(
+  /// - Returns: The decoded WordPress site, or nil if decoding failed.
+  /// - Throws: An error of site couldn't be decoded from the given file..
+  private static func siteFromURL(
     _ url: URL,
     using decoder: WordPressDecoder
   ) throws -> WordPressSite? {
     let data = try Data(contentsOf: url)
-    return try decoder.decodePosts(fromData: data, allowInvalidCharacters: true)
+    return try decoder.decodeSites(fromData: data, allowInvalidCharacters: true)
   }
 
-  /// Returns a dictionary of WordPress posts keyed by filename.
+  /// Returns a dictionary of WordPress sites keyed by filename.
   ///
   /// - Parameter directoryURL: The URL of the directory containing the exports.
-  /// - Returns: A dictionary of WordPress posts keyed by section name.
-  /// - Throws: An error if posts couldn't be extracted from any of the export files.
-  public func posts(
+  /// - Returns: A dictionary of WordPress sites keyed by section name.
+  /// - Throws: An error if sites couldn't be extracted from any of the export files.
+  public func sites(
     fromExportsAt directoryURL: URL
   ) throws -> [SectionName: WordPressSite] {
     let files = try fileURLsFromDirectory(directoryURL)
 
     let feedPairs = try files.map { url -> (String, WordPressSite?) in
-      try (self.keyFromURL(url), Self.postsFromURL(url, using: decoder))
+      try (self.keyFromURL(url), Self.siteFromURL(url, using: decoder))
     }
 
     return Dictionary(uniqueKeysWithValues: feedPairs).compactMapValues { $0 }
   }
 }
 
-extension PostsExportSynDecoder {
+extension SitesExportSynDecoder {
   /// A default logic for finding all files found at given directory.
   ///
-  /// If the `directoryURL` is not valid directory, this method
-  /// throws `ImportError.directory(:_)` error.
-  ///
   /// - Parameter directoryURL: The directory URL.
-  /// - Returns: An array of export file URLs that can be found in the given directory.
-  /// - Throws: An error if the directory could not be enumerated.
+  /// - Returns: An array of URLs for export files found in the given directory.
   private static func defaultFileURLs(atDirectory directoryURL: URL) -> [URL] {
     let enumerator = FileManager.default.enumerator(
       at: directoryURL,

Sources/ContributeWordPress/Decoder/SynDecoder.swift

@@ -5,39 +5,19 @@ import SyndiKit
   import FoundationNetworking
 #endif
 
-/// An extension that enables SynDecoder to decode WordPress posts.
+/// An extension that enables SynDecoder to decode WordPress sites.
 extension SynDecoder: WordPressDecoder {
-  public func decodePosts(
-    fromData data: Data,
-    allowInvalidCharacters: Bool
-  ) throws -> WordPressSite? {
-    let text = String(bytes: data, encoding: .utf8)?
-      .replacingOccurrences(of: "\u{10}", with: "")
-      .data(using: .utf8, allowLossyConversion: true)
-
-    let newData: Data
-    if let text = text, allowInvalidCharacters {
-      newData = text
-    } else {
-      newData = data
-    }
-
-    let feed = try decode(newData)
-    let rss = feed as? RSSFeed
-    return try rss.map(\.channel).map(WordPressSite.init)
-  }
-
-  /// Decodes an array of WordPress posts from the given data.
+  /// Decodes an array of WordPress sites from the given data.
   ///
   /// - Parameters:
   ///   - data: The data to decode.
-  ///   - allowInvalidCharacters: Whether to allow invalid characters in decoded data.
-  /// - Returns: An array of WordPress posts, or nil if decoding failed.
+  ///   - allowInvalidCharacters: Whether to allow invalid characters in the data.
+  /// - Returns: The decoded WordPress site, or nil if decoding failed.
   /// - Throws: An error if data couldn't be decoded.
-  public func decodePosts(
+  public func decodeSites(
     fromData data: Data,
     allowInvalidCharacters: Bool
-  ) throws -> [WordPressPost]? {
+  ) throws -> WordPressSite? {
     let text = String(bytes: data, encoding: .utf8)?
       .replacingOccurrences(of: "\u{10}", with: "")
       .data(using: .utf8, allowLossyConversion: true)
@@ -51,6 +31,6 @@ extension SynDecoder: WordPressDecoder {
 
     let feed = try decode(newData)
     let rss = feed as? RSSFeed
-    return rss?.channel.items.compactMap(\.wpPost)
+    return try rss.map(\.channel).map(WordPressSite.init)
   }
 }

Sources/ContributeWordPress/Decoder/WordPressDecoder.swift

@@ -5,16 +5,16 @@ import SyndiKit
   import FoundationNetworking
 #endif
 
-/// A protocol for decoding WordPress posts from raw data.
+/// A protocol for decoding WordPress sites from raw data.
 public protocol WordPressDecoder {
-  /// Decodes an array of WordPress posts from the given data.
+  /// Decodes an array of WordPress sites from the given data.
   ///
   /// - Parameters:
   ///   - data: The data to decode.
   ///   - allowInvalidCharacters: Whether to allow invalid characters in the data.
-  /// - Returns: An array of WordPress posts, or nil if decoding failed.
+  /// - Returns: An array of WordPress sites, or nil if decoding failed.
   /// - Throws: An error if data couldn't be decoded.
-  func decodePosts(
+  func decodeSites(
     fromData data: Data,
     allowInvalidCharacters: Bool
   ) throws -> WordPressSite?