Merge pull request #40 from KenSuenobu/cleanup-5

Cleanup 5

README.md

@@ -14,9 +14,10 @@ Monix Task, and others.  It is designed to be self-contained, and extensible.
 - Java 8 SDK
 - Apache Ant
 
-## Documentation
+## Getting Started
 
-[There is a maintained Wiki here.](https://github.com/KenSuenobu/scattersphere/wiki)
+[There is a maintained Wiki here.](https://github.com/KenSuenobu/scattersphere/wiki)  You can also view
+[sample code in the test suite here.](/scattersphere-core/src/test/scala/com/scattersphere/core/util/)
 
 ## Dependencies
 

scattersphere-core/src/main/scala/com/scattersphere/core/util/Job.scala

@@ -110,10 +110,15 @@ class JobBuilder {
     *
     * @return a new [[Job]] object.
     */
-  def build(): Job = new Job(jobName, tasks)
+  def build(): Job = Job(jobName, tasks)
 
 }
 
+/** Factory class with convenience method to create a new [[JobBuilder]] on demand. */
+object JobBuilder {
+  def apply(): JobBuilder = new JobBuilder()
+}
+
 /** This is the root class that all status values should inherit.
   *
   * @param t the optional Throwable object associated with the status.

scattersphere-core/src/main/scala/com/scattersphere/core/util/Task.scala

@@ -183,10 +183,15 @@ class TaskBuilder {
     *
     * @return [[Task]] object.
     */
-  def build(): Task = new Task(taskName, runnableTask, dependencies, taskAsync)
+  def build(): Task = Task(taskName, runnableTask, dependencies, taskAsync)
 
 }
 
+/** Factory class with convenience method to create a new [[TaskBuilder]] on demand. */
+object TaskBuilder {
+  def apply(): TaskBuilder = new TaskBuilder()
+}
+
 /** This is the root class that all status values should inherit.
   *
   * @param t `Throwable` that may have occurred.

scattersphere-core/src/test/scala/com/scattersphere/core/util/ComplicatedJobTest.scala

@@ -55,17 +55,17 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     val runnableTask1 = new RunnableTestTask("1")
     val runnableTask2 = new RunnableTestTask("2-A")
     val runnableTask3 = new RunnableTestTask("2-B")
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("First Task")
         .withTask(runnableTask1)
         .build()
-    val task2: Task = new TaskBuilder()
+    val task2: Task = TaskBuilder()
         .withName("Second Task")
         .withTask(runnableTask2)
         .dependsOn(task1)
         .async()
         .build()
-    val task3: Task = new TaskBuilder()
+    val task3: Task = TaskBuilder()
         .withName("Third Task")
         .withTask(runnableTask3)
         .dependsOn(task1)
@@ -85,7 +85,7 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     task3.name shouldBe "Third Task"
     task3.dependencies.length shouldBe 1
 
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Test")
         .addTasks(task1, task2, task3)
         .build()
@@ -135,23 +135,23 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     val runnableTask2 = new RunnableTestTask("2-A")
     val runnableTask3 = new RunnableTestTask("2-B")
     val runnableTask4 = new RunnableTestTask("3")
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("First Task")
         .withTask(runnableTask1)
         .build()
-    val task2: Task = new TaskBuilder()
+    val task2: Task = TaskBuilder()
         .withName("Second Task")
         .withTask(runnableTask2)
         .dependsOn(task1)
         .async()
         .build()
-    val task3: Task = new TaskBuilder()
+    val task3: Task = TaskBuilder()
         .withName("Third Task")
         .withTask(runnableTask3)
         .dependsOn(task1)
         .async()
         .build()
-    val task4: Task = new TaskBuilder()
+    val task4: Task = TaskBuilder()
         .withName("Fourth Task")
         .withTask(runnableTask4)
         .dependsOn(task2)
@@ -178,7 +178,7 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     task4.name shouldBe "Fourth Task"
     task4.dependencies.length shouldBe 2
 
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Test")
         .addTasks(task1, task2, task3, task4)
         .build()
@@ -232,33 +232,33 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     val runnableTask4 = new RunnableTestTask("3-A-2-B")
     val runnableTask5 = new RunnableTestTask("3-B-2-B")
     val runnableTask6 = new RunnableTestTask("4")
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("1")
         .withTask(runnableTask1)
         .build()
-    val task2: Task = new TaskBuilder()
+    val task2: Task = TaskBuilder()
         .withName("2-A")
         .withTask(runnableTask2)
         .dependsOn(task1)
         .build()
-    val task3: Task = new TaskBuilder()
+    val task3: Task = TaskBuilder()
         .withName("2-B")
         .withTask(runnableTask3)
         .dependsOn(task1)
         .build()
-    val task4: Task = new TaskBuilder()
+    val task4: Task = TaskBuilder()
         .withName("3-A-2-B")
         .withTask(runnableTask4)
         .dependsOn(task3)
         .async()
         .build()
-    val task5: Task = new TaskBuilder()
+    val task5: Task = TaskBuilder()
         .withName("3-B-2-B")
         .withTask(runnableTask5)
         .dependsOn(task3)
         .async()
         .build()
-    val task6: Task = new TaskBuilder()
+    val task6: Task = TaskBuilder()
         .withName("4")
         .withTask(runnableTask6)
         .dependsOn(task2)
@@ -296,7 +296,7 @@ class ComplicatedJobTest extends FlatSpec with Matchers with LazyLogging {
     task6.name shouldBe "4"
     task6.dependencies.length shouldBe 3
 
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Test")
         .addTasks(task1, task2, task3, task4, task5, task6)
         .build()

scattersphere-core/src/test/scala/com/scattersphere/core/util/ExceptionJobTest.scala

@@ -18,7 +18,7 @@ class ExceptionJobTest extends FlatSpec with Matchers with LazyLogging {
 
   "Exception Jobs" should "handle an exception" in {
     val runnableTask1: RunnableTask = new TimerJob(3)
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("3 second task")
         .withTask(runnableTask1)
         .build()
@@ -27,7 +27,7 @@ class ExceptionJobTest extends FlatSpec with Matchers with LazyLogging {
     task1.name shouldBe "3 second task"
     task1.dependencies.length shouldBe 0
 
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Cancelable Job")
         .addTask(task1)
         .build()

scattersphere-core/src/test/scala/com/scattersphere/core/util/RealWorldTest.scala

@@ -101,23 +101,23 @@ class RealWorldTest extends FlatSpec with Matchers with LazyLogging {
       val fetcherRunnableTask: RunnableTask = new DataFetchRunnable(url) with RunnableTask
       val stripDataRunnableTask: RunnableTask = new StripFetchedDataRunnable(url, counter) with RunnableTask
       val wordsCountRunnableTask: RunnableTask = new CountWordsRunnable(url, counter) with RunnableTask
-      val fetcherTask: Task = new TaskBuilder()
+      val fetcherTask: Task = TaskBuilder()
         .withName("fetcherTask")
         .withTask(fetcherRunnableTask)
         .build()
-      val stripDataTask: Task = new TaskBuilder()
+      val stripDataTask: Task = TaskBuilder()
         .withName("stripDataTask")
         .withTask(stripDataRunnableTask)
         .dependsOn(fetcherTask)
         .async()
         .build()
-      val wordsCountTask: Task = new TaskBuilder()
+      val wordsCountTask: Task = TaskBuilder()
         .withName("wordsCountTask")
         .withTask(wordsCountRunnableTask)
         .dependsOn(fetcherTask)
         .async()
         .build()
-      val urlTestJob: Job = new JobBuilder()
+      val urlTestJob: Job = JobBuilder()
         .withName("urlTest")
         .addTasks(fetcherTask, stripDataTask, wordsCountTask)
         .build()

scattersphere-core/src/test/scala/com/scattersphere/core/util/SimpleJobTest.scala

@@ -57,16 +57,16 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
     val runnableTask1 = new RunnableTestTask("1") with RunnableTask
     val runnableTask2 = new RunnableTestTask("2") with RunnableTask
     val runnableTask3 = new RunnableTestTask("3") with RunnableTask
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("First Runnable Task")
         .withTask(runnableTask1)
         .build()
-    val task2: Task = new TaskBuilder()
+    val task2: Task = TaskBuilder()
         .withName("Second Runnable Task")
         .withTask(runnableTask2)
         .dependsOn(task1)
         .build()
-    val task3: Task = new TaskBuilder()
+    val task3: Task = TaskBuilder()
         .withName("Third Runnable Task")
         .withTask(runnableTask3)
         .dependsOn(task2)
@@ -85,7 +85,7 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
     task3.name shouldBe "Third Runnable Task"
     task3.dependencies.length shouldBe 1
 
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Test")
         .addTasks(task1, task2, task3)
         .build()
@@ -120,15 +120,15 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
     val runnableTask1 = new RunnableTestTask("1") with RunnableTask
     val runnableTask2 = new RunnableTestTask("2") with RunnableTask
     val runnableTask3 = new RunnableTestTask("3") with RunnableTask
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("First Runnable Task")
         .withTask(runnableTask1)
         .build()
-    val task2: Task = new TaskBuilder()
+    val task2: Task = TaskBuilder()
         .withName("Second Runnable Task")
         .withTask(runnableTask2)
         .build()
-    val task3: Task = new TaskBuilder()
+    val task3: Task = TaskBuilder()
         .withName("Third Runnable Task")
         .withTask(runnableTask3)
         .build()
@@ -146,7 +146,8 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
     task3.name shouldBe "Third Runnable Task"
     task3.dependencies.length shouldBe 0
 
-    val job1: Job = new JobBuilder().withName("Test")
+    val job1: Job = JobBuilder()
+      .withName("Test")
       .addTasks(task1, task2, task3)
       .build()
     val jobExec: JobExecutor = new JobExecutor(job1)
@@ -165,15 +166,15 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
 
   it should "not allow the same task to exist on two separate jobs after completing in one job" in {
     val runnableTask1 = new RunnableTestTask("1") with RunnableTask
-    val task1: Task = new TaskBuilder()
+    val task1: Task = TaskBuilder()
         .withName("First Runnable Task")
         .withTask(runnableTask1)
         .build()
 
     task1.status shouldBe TaskQueued
     task1.name shouldBe "First Runnable Task"
     task1.dependencies.length shouldBe 0
-    val job1: Job = new JobBuilder()
+    val job1: Job = JobBuilder()
         .withName("Test")
         .addTask(task1)
         .build()
@@ -187,7 +188,7 @@ class SimpleJobTest extends FlatSpec with Matchers with LazyLogging {
     runnableTask1.setVar shouldBe 1
     task1.status shouldBe TaskFinished
 
-    val job2: Job = new JobBuilder()
+    val job2: Job = JobBuilder()
         .withName("Test2")
         .addTask(task1)
         .build()