Added atom:author element parsing

Author: magneticflux-

src/main/kotlin/com/github/magneticflux/rss/Converters.kt

@@ -14,8 +14,16 @@ internal val fallbackPersister = createRssPersister()
  */
 internal val InputNode.fullName: String
     get() {
-        val prefix = this.prefix
+        var prefix = this.prefix
         val name = this.name
+
+        if (prefix.isEmpty())
+            prefix = when (this.reference) {
+                "http://www.w3.org/1999/xhtml" -> "xhtml"
+                "http://www.w3.org/2005/Atom" -> "atom"
+                else -> prefix
+            }
+
         return if (prefix.isEmpty()) name else "$prefix:$name"
     }
 

src/main/kotlin/com/github/magneticflux/rss/Persisters.kt

@@ -1,5 +1,9 @@
 package com.github.magneticflux.rss
 
+import com.github.magneticflux.rss.namespaces.atom.converters.AtomAuthorConverter
+import com.github.magneticflux.rss.namespaces.atom.converters.AtomFeedConverter
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomAuthor
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomFeed
 import com.github.magneticflux.rss.namespaces.itunes.converters.ITunesImageConverter
 import com.github.magneticflux.rss.namespaces.itunes.converters.ITunesSubCategoryConverter
 import com.github.magneticflux.rss.namespaces.itunes.converters.ITunesTopLevelCategoryConverter
@@ -62,9 +66,13 @@ fun createRssStrategy(): Strategy {
             this.bind(Enclosure::class.java, EnclosureConverter)
             this.bind(Guid::class.java, GuidConverter)
             this.bind(Source::class.java, SourceConverter)
+
             this.bind(ITunesTopLevelCategory::class.java, ITunesTopLevelCategoryConverter)
             this.bind(ITunesSubCategory::class.java, ITunesSubCategoryConverter)
             this.bind(ITunesImage::class.java, ITunesImageConverter)
+
+            this.bind(AtomFeed::class.java, AtomFeedConverter)
+            this.bind(AtomAuthor::class.java, AtomAuthorConverter)
         })
 }
 
@@ -80,4 +88,4 @@ fun createRssMatcher(): Matcher {
         this.bind(Locale::class.java, LocaleLanguageTransform)
         this.bind(URL::class.java, URLTransform)
     }
-}
+}

src/main/kotlin/com/github/magneticflux/rss/namespaces/atom/converters/AtomAuthorConverter.kt

@@ -0,0 +1,40 @@
+package com.github.magneticflux.rss.namespaces.atom.converters
+
+import com.github.magneticflux.rss.children
+import com.github.magneticflux.rss.createChild
+import com.github.magneticflux.rss.fullName
+import com.github.magneticflux.rss.namespaces.atom.elements.ATOM_REFERENCE
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomAuthor
+import org.simpleframework.xml.convert.Converter
+import org.simpleframework.xml.stream.InputNode
+import org.simpleframework.xml.stream.OutputNode
+
+/**
+ * @author Mitchell Skaggs
+ * @since 1.2.0
+ */
+object AtomAuthorConverter : Converter<AtomAuthor> {
+    override fun read(node: InputNode): AtomAuthor {
+        lateinit var name: String
+        var uri: String? = null
+        var email: String? = null
+
+        node.children.forEach {
+            when (it.fullName) {
+                "atom:name" -> name = it.value
+                "atom:uri" -> uri = it.value
+                "atom:email" -> email = it.value
+            }
+        }
+
+        return AtomAuthor(name, uri, email)
+    }
+
+    override fun write(node: OutputNode, value: AtomAuthor) {
+        val writable = value.toWritable()
+
+        node.createChild(ATOM_REFERENCE, "name", writable.name)
+        writable.uri?.let { node.createChild(ATOM_REFERENCE, "uri", it) }
+        writable.email?.let { node.createChild(ATOM_REFERENCE, "email", it) }
+    }
+}

src/main/kotlin/com/github/magneticflux/rss/namespaces/atom/converters/AtomFeedConverter.kt

@@ -0,0 +1,34 @@
+package com.github.magneticflux.rss.namespaces.atom.converters
+
+import com.github.magneticflux.rss.children
+import com.github.magneticflux.rss.fallbackPersister
+import com.github.magneticflux.rss.fullName
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomAuthor
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomFeed
+import org.simpleframework.xml.convert.Converter
+import org.simpleframework.xml.stream.InputNode
+import org.simpleframework.xml.stream.OutputNode
+
+/**
+ * @author Mitchell Skaggs
+ * @since 1.2.0
+ */
+object AtomFeedConverter : Converter<AtomFeed> {
+    override fun read(node: InputNode): AtomFeed {
+        var author: AtomAuthor? = null
+
+        node.children.forEach {
+            when (it.fullName) {
+                "atom:author" -> author = fallbackPersister.read(AtomAuthor::class.java, it)
+            }
+        }
+
+        return AtomFeed(author)
+    }
+
+    override fun write(node: OutputNode, value: AtomFeed) {
+        val writable = value.toWritable()
+
+        writable.author?.let { fallbackPersister.write(it, node) }
+    }
+}

src/main/kotlin/com/github/magneticflux/rss/namespaces/atom/elements/AtomAuthor.kt

@@ -0,0 +1,50 @@
+package com.github.magneticflux.rss.namespaces.atom.elements
+
+import com.github.magneticflux.rss.namespaces.atom.converters.AtomAuthorConverter
+import com.github.magneticflux.rss.namespaces.standard.elements.HasReadWrite
+import org.simpleframework.xml.Namespace
+import org.simpleframework.xml.Root
+
+/**
+ * Properties common to all representations of a `<person>` element.
+ *
+ * @since 1.2.0
+ */
+interface ICommonAtomPerson : HasReadWrite<IAtomPerson, IWritableAtomPerson> {
+    val name: String
+    val uri: String?
+    val email: String?
+}
+
+/**
+ * The final RSS view of a `<person>` element. Defaults are used if applicable.
+ *
+ * @since 1.2.0
+ */
+interface IAtomPerson : ICommonAtomPerson {
+    override fun toReadOnly(): IAtomPerson = this
+}
+
+/**
+ * The literal contents of a `<person>` element. Elements with defaults may be omitted or invalid.
+ *
+ * @since 1.2.0
+ */
+interface IWritableAtomPerson : ICommonAtomPerson {
+    override fun toWritable(): IWritableAtomPerson = this
+}
+
+/**
+ * This class represents an Author object in a [AtomFeed].
+ *
+ * @author Mitchell Skaggs
+ * @since 1.2.0
+ * @see AtomAuthorConverter
+ */
+@Root(name = "author")
+@Namespace(reference = ATOM_REFERENCE)
+data class AtomAuthor(
+    override val name: String,
+    override val uri: String?,
+    override val email: String?
+) : IAtomPerson, IWritableAtomPerson

src/main/kotlin/com/github/magneticflux/rss/namespaces/atom/elements/AtomFeed.kt

@@ -0,0 +1,46 @@
+package com.github.magneticflux.rss.namespaces.atom.elements
+
+import com.github.magneticflux.rss.namespaces.atom.converters.AtomFeedConverter
+import com.github.magneticflux.rss.namespaces.standard.elements.HasReadWrite
+import org.simpleframework.xml.Namespace
+import org.simpleframework.xml.Root
+
+/**
+ * Properties common to all representations of a `<feed>` element.
+ *
+ * @since 1.2.0
+ */
+interface ICommonAtomFeed : HasReadWrite<IAtomFeed, IWritableAtomFeed> {
+    val author: AtomAuthor?
+}
+
+/**
+ * The final RSS view of a `<feed>` element. Defaults are used if applicable.
+ *
+ * @since 1.2.0
+ */
+interface IAtomFeed : ICommonAtomFeed {
+    override fun toReadOnly(): IAtomFeed = this
+}
+
+/**
+ * The literal contents of a `<feed>` element. Elements with defaults may be omitted or invalid.
+ *
+ * @since 1.2.0
+ */
+interface IWritableAtomFeed : ICommonAtomFeed {
+    override fun toWritable(): IWritableAtomFeed = this
+}
+
+/**
+ * This class represents an atom:feed.
+ *
+ * @author Mitchell Skaggs
+ * @since 1.2.0
+ * @see AtomFeedConverter
+ */
+@Root(name = "feed")
+@Namespace(reference = ATOM_REFERENCE)
+data class AtomFeed(
+    override val author: AtomAuthor?
+) : IAtomFeed, IWritableAtomFeed

src/test/kotlin/com/github/magneticflux/rss/RssTest.kt

@@ -1,6 +1,7 @@
 package com.github.magneticflux.rss
 
 import com.github.magneticflux.rss.SampleUtils.getSample
+import com.github.magneticflux.rss.namespaces.atom.elements.AtomFeed
 import com.github.magneticflux.rss.namespaces.itunes.elements.ITunesSubCategory
 import com.github.magneticflux.rss.namespaces.itunes.elements.ITunesTopLevelCategory
 import com.github.magneticflux.rss.namespaces.standard.elements.Category
@@ -392,5 +393,29 @@ class RssTest : Spek({
                 }
             }
         }
+
+        given("sample_atom", { "$it RSS feed" }) {
+            val rssFeed = persister.read(AtomFeed::class.java, getSample("$it.xml"))
+
+            on("feed reread") {
+                val rssText = persister.write(rssFeed)
+
+                println(rssText)
+
+                val rereadRssFeed = persister.read(AtomFeed::class.java, rssText)
+
+                it("should equal original RSS feed read") {
+                    assertThat(rereadRssFeed, equalTo(rssFeed))
+                }
+
+                it("should have the same hashCode as original RSS feed read") {
+                    assertThat(rereadRssFeed.hashCode(), equalTo(rssFeed.hashCode()))
+                }
+
+                it("should have the same String representation as original RSS feed read") {
+                    assertThat(rereadRssFeed.toString(), equalTo(rssFeed.toString()))
+                }
+            }
+        }
     }
 })

src/test/resources/com/github/magneticflux/rss/sample_atom.xml

@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <feed xmlns="http://www.w3.org/2005/Atom">
+    <author>
+        <name>Mark Pilgrim</name>
+        <uri>http://example.org/</uri>
+        <email>f8dy@example.com</email>
+    </author>
     <title type="text">dive into mark</title>
     <subtitle type="html">
         A &lt;em&gt;lot&lt;/em&gt; of effort