Merge pull request #17 from magneticflux-/feature/spock-tests

magneticflux- · web-flow · commit df692b9bce9e · 2018-02-25T15:47:07.000-06:00
Feature/spock tests
diff --git a/build.gradle b/build.gradle
@@ -1,107 +1,102 @@
 buildscript {
-    ext.kotlin_version = '1.2.21'
-    ext.spek_version = '1.1.5'
-
-    repositories {
-        jcenter()
-    }
-    dependencies {
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-        classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.16"
-        classpath 'org.junit.platform:junit-platform-gradle-plugin:1.1.0'
-    }
+	ext.kotlin_version = '1.2.21'
+	ext.spek_version = '1.1.5'
+
+	repositories { jcenter() }
+	dependencies {
+		classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+		classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.16"
+		classpath 'org.junit.platform:junit-platform-gradle-plugin:1.1.0'
+	}
 }
 
 plugins {
-    id 'java-library'
-    id 'jacoco'
-    id 'maven-publish'
-    id 'com.jfrog.bintray' version '1.8.0'
-    id 'org.shipkit.java' version '2.0.2'
-    id 'com.diffplug.gradle.spotless' version '3.10.0'
-    id 'com.github.ben-manes.versions' version '0.17.0'
+	id 'java-library'
+	id 'jacoco'
+	id 'maven-publish'
+	id 'groovy'
+	id 'com.jfrog.bintray' version '1.8.0'
+	id 'org.shipkit.java' version '2.0.2'
+	id 'com.diffplug.gradle.spotless' version '3.10.0'
+	id 'com.github.ben-manes.versions' version '0.17.0'
 }
 
 apply plugin: 'kotlin'
 apply plugin: 'org.jetbrains.dokka'
-apply plugin: 'org.junit.platform.gradle.plugin'
 
 group 'com.github.magneticflux'
 
 repositories {
-    jcenter()
-    maven { url 'http://dl.bintray.com/jetbrains/spek' }
+	jcenter()
+	maven { url 'http://dl.bintray.com/jetbrains/spek' }
 }
 
-junitPlatform {
-    filters {
-        engines {
-            include 'spek'
-        }
-    }
+test {
+	useJUnitPlatform { includeEngines 'spek', 'junit-vintage' }
 }
 
 publishing {
-    publications {
-        myPublication(MavenPublication) {
-            from components.java
-            //noinspection GroovyAssignabilityCheck
-            artifact sourcesJar
-            //noinspection GroovyAssignabilityCheck
-            artifact dokkaJavadocJar
-        }
-    }
+	publications {
+		myPublication(MavenPublication) {
+			from components.java
+			//noinspection GroovyAssignabilityCheck
+			artifact sourcesJar
+			//noinspection GroovyAssignabilityCheck
+			artifact dokkaJavadocJar
+		}
+	}
 }
 
 dokka {
-    outputFormat = 'javadoc'
-    jdkVersion = 7
-    impliedPlatforms = ["JVM"]
+	outputFormat = 'javadoc'
+	jdkVersion = 7
+	impliedPlatforms = ["JVM"]
 }
 
 task dokkaJavadocJar(type: Jar, dependsOn: dokka) {
-    classifier = 'javadoc'
-    from dokka.outputDirectory
+	classifier = 'javadoc'
+	//noinspection GroovyAssignabilityCheck
+	from dokka.outputDirectory
 }
 
 spotless {
-    kotlin {
-        ktlint('0.14.0')
-    }
-}
-
-dependencies {
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+	kotlin { ktlint('0.15.1') }
 
-    api 'org.simpleframework:simple-xml:2.7.1'
-    api 'org.threeten:threetenbp:1.3.6'
+	groovy { greclipse() }
 
-    testImplementation 'org.hamcrest:java-hamcrest:2.0.0.0'
-    testImplementation "org.jetbrains.spek:spek-api:$spek_version"
-    testImplementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
-    testRuntimeOnly "org.jetbrains.spek:spek-junit-platform-engine:$spek_version"
+	groovyGradle { greclipse() }
 }
 
-jacoco {
-    applyTo junitPlatformTest
-}
-
-junitPlatformTest {
-    jacoco {
-        destinationFile = file("$buildDir/jacoco/test.exec")
-    }
+dependencies {
+	implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+
+	api 'org.simpleframework:simple-xml:2.7.1'
+	api 'org.threeten:threetenbp:1.3.6'
+
+	// Tests
+	testImplementation 'org.hamcrest:java-hamcrest:2.0.0.0'
+
+	// Spock
+	testImplementation 'org.codehaus.groovy:groovy-all:2.4.13'
+	testImplementation "org.spockframework:spock-core:1.1-groovy-2.4"
+	testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
+	testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
+	testRuntimeOnly 'org.junit.vintage:junit-vintage-engine:5.1.0'
+	testCompileOnly 'junit:junit:4.12'
+
+	// Spek
+	testImplementation "org.jetbrains.spek:spek-api:$spek_version"
+	testImplementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
+	testRuntimeOnly "org.jetbrains.spek:spek-junit-platform-engine:$spek_version"
 }
 
 jacocoTestReport {
-    executionData junitPlatformTest
-    sourceSets sourceSets.main
-    dependsOn(junitPlatformTest)
-
-    reports {
-        //noinspection GroovyAssignabilityCheck
-        xml {
-            enabled true
-        }
-    }
+	sourceSets sourceSets.main
+	dependsOn test
+
+	reports {
+		//noinspection GroovyAssignabilityCheck
+		xml { enabled true }
+	}
 }
 check.dependsOn(jacocoTestReport)
diff --git a/gradle.properties b/gradle.properties
@@ -1,2 +1,2 @@
 org.gradle.caching=true
-org.gradle.parallel=true
+org.gradle.parallel=true
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.5.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.6-rc-2-all.zip
diff --git a/src/main/kotlin/com/github/magneticflux/rss/Converters.kt b/src/main/kotlin/com/github/magneticflux/rss/Converters.kt
@@ -16,7 +16,7 @@ internal val InputNode.fullName: String
     get() {
         val prefix = this.prefix
         val name = this.name
-        return if (prefix.isNullOrEmpty()) name else "$prefix:$name"
+        return if (prefix.isEmpty()) name else "$prefix:$name"
     }
 
 /**
@@ -44,7 +44,6 @@ private class InputNodeChildIterator(val rootNode: InputNode) : AbstractIterator
         val next = rootNode.next
         if (next != null)
             setNext(next)
-        else
-            done()
+        else done()
     }
-}
+}
diff --git a/src/main/kotlin/com/github/magneticflux/rss/Transforms.kt b/src/main/kotlin/com/github/magneticflux/rss/Transforms.kt
@@ -82,7 +82,6 @@ object URLTransform : Transform<URL> {
     override fun write(value: URL): String {
         return if (value.authority == null)
             value.file
-        else
-            value.toExternalForm()
+        else value.toExternalForm()
     }
 }
diff --git a/src/test/groovy/com/github/magneticflux/rss/PersisterSpecification.groovy b/src/test/groovy/com/github/magneticflux/rss/PersisterSpecification.groovy
@@ -0,0 +1,9 @@
+package com.github.magneticflux.rss
+
+import spock.lang.Shared
+import spock.lang.Specification
+
+abstract class PersisterSpecification extends Specification {
+	@Shared
+	protected persister = PersistersKt.createRssPersister()
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/UrlUtils.groovy b/src/test/groovy/com/github/magneticflux/rss/UrlUtils.groovy
@@ -0,0 +1,7 @@
+package com.github.magneticflux.rss
+
+class UrlUtils {
+	static URL testUrl() {
+		return new URL('http://www.example.com')
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/CategoryTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/CategoryTest.groovy
@@ -0,0 +1,23 @@
+package com.github.magneticflux.rss.namespaces.standard.elements
+
+import com.github.magneticflux.rss.PersisterSpecification
+import spock.lang.Unroll
+
+class CategoryTest extends PersisterSpecification {
+
+	@Unroll
+	def 'category  #object read/write'() {
+
+		expect: 'the output XML equals the given XML'
+		persister.write(object) == xml
+
+		and: 'the input object equals the given object'
+		persister.read(Category, xml) == object
+
+		where:
+		domain       | text       | xml
+		'testDomain' | 'testText' | """<category domain="$domain">$text</category>"""
+		null         | 'testText' | """<category>$text</category>"""
+		object = new Category(domain, text)
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/CloudTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/CloudTest.groovy
@@ -0,0 +1,21 @@
+package com.github.magneticflux.rss.namespaces.standard.elements
+
+import com.github.magneticflux.rss.PersisterSpecification
+import spock.lang.Unroll
+
+class CloudTest extends PersisterSpecification {
+	@Unroll
+	def 'cloud #object read/write'() {
+
+		expect: 'the output XML equals the given XML'
+		persister.write(object) == xml
+
+		and: 'the input object equals the given object'
+		persister.read(Cloud, xml) == object
+
+		where:
+		domain       | path       | port | protocol       | registerProcedure       | xml
+		'testDomain' | 'testPath' | 8080 | 'testProtocol' | 'testRegisterProcedure' | """<cloud domain="$domain" path="$path" port="$port" protocol="$protocol" registerProcedure="$registerProcedure"/>"""
+		object = new Cloud(domain, path, port, protocol, registerProcedure)
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/EnclosureTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/EnclosureTest.groovy
@@ -0,0 +1,21 @@
+package com.github.magneticflux.rss.namespaces.standard.elements
+
+import com.github.magneticflux.rss.PersisterSpecification
+import spock.lang.Unroll
+
+class EnclosureTest extends PersisterSpecification {
+	@Unroll
+	def 'enclosure #object read/write'() {
+
+		expect: 'the output XML equals the given XML'
+		persister.write(object) == xml
+
+		and: 'the input object equals the given object'
+		persister.read(Enclosure, xml) == object
+
+		where:
+		url                              | length | type       | xml
+		'http://www.example.com'.toURL() | 1000   | 'testType' | """<enclosure url="$url" length="$length" type="$type"/>"""
+		object = new Enclosure(url, length, type)
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/GuidTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/GuidTest.groovy
@@ -0,0 +1,23 @@
+package com.github.magneticflux.rss.namespaces.standard.elements
+
+import com.github.magneticflux.rss.PersisterSpecification
+import spock.lang.Unroll
+
+class GuidTest extends PersisterSpecification {
+	@Unroll
+	def 'enclosure #object read/write'() {
+
+		expect: 'the output XML equals the given XML'
+		persister.write(object) == xml
+
+		and: 'the input object equals the given object'
+		persister.read(Guid, xml) == object
+
+		where:
+		isPermaLinkRaw | text       | xml
+		'true'         | 'testText' | """<guid isPermaLink="$isPermaLinkRaw">$text</guid>"""
+		'false'        | 'testText' | """<guid isPermaLink="$isPermaLinkRaw">$text</guid>"""
+		null           | 'testText' | """<guid>$text</guid>"""
+		object = new Guid(isPermaLinkRaw, text)
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/ImageTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/ImageTest.groovy
@@ -0,0 +1,55 @@
+package com.github.magneticflux.rss.namespaces.standard.elements
+
+import com.github.magneticflux.rss.PersisterSpecification
+import spock.lang.Unroll
+
+import static com.github.magneticflux.rss.UrlUtils.testUrl
+
+class ImageTest extends PersisterSpecification {
+	@Unroll
+	def 'enclosure #object read/write'() {
+
+		expect: 'the output XML equals the given XML'
+		persister.write(object) == xml
+
+		and: 'the input object equals the given object'
+		persister.read(Image, xml) == object
+
+		where:
+		url       | title       | link      | description       | widthRaw | heightRaw | xml
+		testUrl() | 'testTitle' | testUrl() | 'testDescription' | '100'    | '100'     | """<image>
+                                                                                           |   <url>$url</url>
+                                                                                           |   <title>$title</title>
+                                                                                           |   <link>$link</link>
+                                                                                           |   <description>$description</description>
+                                                                                           |   <width>$widthRaw</width>
+                                                                                           |   <height>$heightRaw</height>
+                                                                                           |</image>""".stripMargin()
+
+		testUrl() | 'testTitle' | testUrl() | null              | '100'    | '100'     | """<image>
+                                                                                           |   <url>$url</url>
+                                                                                           |   <title>$title</title>
+                                                                                           |   <link>$link</link>
+                                                                                           |   <width>$widthRaw</width>
+                                                                                           |   <height>$heightRaw</height>
+                                                                                           |</image>""".stripMargin()
+
+		testUrl() | 'testTitle' | testUrl() | 'testDescription' | null     | '100'     | """<image>
+                                                                                           |   <url>$url</url>
+                                                                                           |   <title>$title</title>
+                                                                                           |   <link>$link</link>
+                                                                                           |   <description>$description</description>
+                                                                                           |   <height>$heightRaw</height>
+                                                                                           |</image>""".stripMargin()
+
+		testUrl() | 'testTitle' | testUrl() | 'testDescription' | '100'    | null      | """<image>
+                                                                                           |   <url>$url</url>
+                                                                                           |   <title>$title</title>
+                                                                                           |   <link>$link</link>
+                                                                                           |   <description>$description</description>
+                                                                                           |   <width>$widthRaw</width>
+                                                                                           |</image>""".stripMargin()
+
+		object = new Image(url, title, link, description, widthRaw, heightRaw)
+	}
+}
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/SourceTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/SourceTest.groovy
diff --git a/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/TextInputTest.groovy b/src/test/groovy/com/github/magneticflux/rss/namespaces/standard/elements/TextInputTest.groovy
diff --git a/src/test/kotlin/com/github/magneticflux/rss/PersisterUtils.kt b/src/test/kotlin/com/github/magneticflux/rss/PersisterUtils.kt
diff --git a/src/test/resources/META-INF/services/org.codehaus.groovy.runtime.ExtensionModule b/src/test/resources/META-INF/services/org.codehaus.groovy.runtime.ExtensionModule

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`org.gradle.caching=true`
`2`		`-org.gradle.parallel=true`
	`2`	`+org.gradle.parallel=true`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,6 @@ object URLTransform : Transform<URL> {`
`82`	`82`	`override fun write(value: URL): String {`
`83`	`83`	`return if (value.authority == null)`
`84`	`84`	`value.file`
`85`		`- else`
`86`		`- value.toExternalForm()`
	`85`	`+ else value.toExternalForm()`
`87`	`86`	`}`
`88`	`87`	`}`