chore: Tidy up

Author: SeriousSoftware

.gitignore

@@ -1,25 +1,39 @@
-# sbt
-lib_managed
-project/project
-target
+# Log files
+*.class
+*.log
+
+# sbt specific
+.cache
+dist/*
+lib_managed/
+project/**/project
+project/activator-sbt*
+src_managed/
+target/
 
 # Worksheets (Eclipse or IntelliJ)
 *.sc
 
-# Eclipse
-.cache
+# Scala-IDE specific
 .classpath
 .project
 .scala_dependencies
 .settings
-.target
 .worksheet
 
 # IntelliJ
-.idea
+*.iml
+*.iws
+.idea/
+/classes/
+/out/
+
+# ScalaTest
+exportToHTML
 
 # Mac
 .DS_Store
 
-# Log files
-*.log
+# Windows
+desktop.ini
+thumbs.db

build.sbt

@@ -1,54 +1,70 @@
-name := "FullWindowHtml5Canvas"
-version := "0.0"
-organization := "nl.amsscala"
-organizationName := "Amsterdam.scala Meetup Group"
+                name := "FullWindowHtml5Canvas"
+             version := "0.0"
+         description := "Simple HTML5 Canvas game ported to Scala.js."
+        organization := "nl.amsscala"
+    organizationName := "Amsterdam.scala Meetup Group"
 organizationHomepage := Some(url("http://www.meetup.com/amsterdam-scala/"))
-homepage := Some(url("http://github.com/amsterdam-scala/Sjs-Full-Window-HTML5-Canvas"))
+            homepage := Some(url("http://github.com/amsterdam-scala/Sjs-Full-Window-HTML5-Canvas"))
+           startYear := Some(2016)
+            licenses += "EUPL v.1.1" -> url("http://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11")
 
-startYear := Some(2016)
+// KEEP THIS normalizedName CONSTANTLY THE SAME, otherwise the outputted JS filename will be changed.
+      normalizedName := "main"
 
-description := "Scala.js application using HTML5 canvas to fill the window, repainted on window resize."
-
-licenses += "EUPL v.1.1" -> url("http://joinup.ec.europa.eu/community/eupl/og_page/european-union-public-licence-eupl-v11")
-
-scalaVersion := "2.11.8"
-
-// Keep this normalizedName constantly the same, otherwise the outputted JS filename will be changed.
-normalizedName := "main"
+// ** Scala dependencies **
+scalaVersion in ThisBuild := "2.11.8"
 
 resolvers += Resolver.sonatypeRepo("snapshots")
 libraryDependencies ++= Seq(
-  "be.doeraene" %%% "scalajs-jquery" % "0.9.0",
+         "be.doeraene" %%% "scalajs-jquery"     % "0.9.0",
   "com.github.cquiroz" %%% "scala-java-locales" % "0.3.0+29",
-  "com.github.karasiq" %%% "scalajs-bootstrap" % "1.1.1",
-  "com.lihaoyi" %%% "scalatags" % "0.6.0",
-  "com.lihaoyi" %%% "upickle" % "0.4.1",
-  "com.lihaoyi" %%% "utest" % "0.4.3" % "test",
-  "io.github.soc" %%% "scala-java-time" % "2.0.0-M2",
-  "io.surfkit" %%% "scalajs-google-maps" % "0.1-SNAPSHOT",
-  "org.scala-js" %%% "scalajs-dom" % "0.9.1",
-  "org.scalatest" %% "scalatest" % "3.0.0" % "test")
-
-//scalaJSStage in Global := FastOptStage
-scalaJSUseRhino in Global := false
+  "com.github.karasiq" %%% "scalajs-bootstrap"  % "1.1.1",
+         "com.lihaoyi" %%% "scalatags"          % "0.6.0",
+         "com.lihaoyi" %%% "upickle"            % "0.4.1",
+       "io.github.soc" %%% "scala-java-time"    % "2.0.0-M2",
+          "io.surfkit" %%% "scalajs-google-maps"% "0.1-SNAPSHOT",
+        "org.scala-js" %%% "scalajs-dom"        % "0.9.1",
+        "org.scalatest" %% "scalatest"          % "3.0.0" % "test")
+
+scalacOptions in (Compile,doc) ++= Seq("-doc-root-content", baseDirectory.value+"/src/main/scala-2.11/root-doc.md",
+  "-groups", "-implicits")
+
+// ** Scala.js configuration **
+// lazy val root = (project in file(".")).
+enablePlugins(ScalaJSPlugin)
+
+// Necessary for testing
 jsDependencies += RuntimeDOM
+scalaJSUseRhino in Global := false
+jsEnv := PhantomJSEnv(autoExit = false).value
 
-// If true, a launcher script src="../[normalizedName]-launcher.js will
-// be generated that always calls the main def indicated by the JSApp.
+// If true, a launcher script src="../[normalizedName]-launcher.js will be generated
+// that always calls the main def indicated by the used JSApp trait.
 persistLauncher in Compile := true
 persistLauncher in Test := false
 
 // Will create [normalizedName]-jsdeps.js containing all JavaScript libraries
 jsDependencies ++= Seq(
   // "org.webjars" % "jquery" % "3.1.0" / "3.1.0/jquery.js",
   "org.webjars" % "jstimezonedetect" % "1.0.6" / "1.0.6/jstz.js")
+skip in packageJSDependencies := false // All JavaScript dependencies to be concatenated to a single file
+
+// ScalaTest settings //
+// testOptions in Test += Tests.Argument(TestFrameworks.ScalaTest, "-oF")
 
-lazy val root = (project in file(".")).enablePlugins(ScalaJSPlugin)
+// Workbench settings **
+if (sys.env.isDefinedAt("CI")) {
+  println("Workbench disabled ", sys.env.getOrElse("CI", "?"))
+  Seq.empty
+} else {
+  println("Workbench enabled")
+  workbenchSettings
+}
 
-// Set the main class for packaging the main in jar, so irrelevant for Scala.js
-// mainClass in Compile := Some("nl.amsscala.rembrandt.Main")
-workbenchSettings
-refreshBrowsers <<= refreshBrowsers.triggeredBy(fastOptJS in Compile)
+if (sys.env.isDefinedAt("CI")) normalizedName := normalizedName.value // Dummy
+else // Update without refreshing the page every time fastOptJS completes
+  updateBrowsers <<= updateBrowsers.triggeredBy(fastOptJS in Compile)
 
-// Workbench has to know how to restart your application.
-bootSnippet := "Main().main(document.getElementById('canvas'));"
+if (sys.env.isDefinedAt("CI")) normalizedName := normalizedName.value
+else // Workbench has to know how to restart your application.
+  bootSnippet := "Main().main(document.getElementById('canvas'));"

project/plugins.sbt

@@ -1,2 +1,2 @@
 addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.11")
-addSbtPlugin("com.lihaoyi" % "workbench" % "0.2.3")
+addSbtPlugin("com.lihaoyi" % "workbench" % "latest.integration")

src/main/resources/index-dev.html

@@ -11,23 +11,15 @@
     <meta name=generator content="Scala.js Scalatags">
     <meta name=versionId content="2016-08">
 
-    <title>Scala.js | Scaffold</title>
+    <title>Scala.js | Bubbles!</title>
     <link rel=apple-touch-icon href="img/apple-touch-icon.png">
-    <!-- Place favicon.ico in the root directory -->
-    <link rel=icon href="img/favicon.ico" type="image/x-icon">
-
-    <!-- Latest compiled and minified Bootstrap CSS, normalize.css is already included-->
-    <!--<link rel="stylesheet" media="screen" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
-          integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">-->
+    <!-- Place favicon.ico in the img directory -->
+    <link rel=icon type="image/x-icon" href="img/favicon.ico">
 
     <!-- Custom styles for this page -->
     <link rel=stylesheet media="screen" href="css/main.css">
 
-    <!-- Include JavaScript dependencies e.g. jquery.js -->
-    <script type="text/javascript" src="../main-jsdeps.js"></script>
-    <!-- Include Scala.js compiled code -->
-    <script type="text/javascript" src="../main-fastopt.js"></script>
-
+    <!--Workbench for development only -->
     <script type="text/javascript" src="/workbench.js"></script>
 
     <!--<style type="text/css"></style>-->
@@ -41,10 +33,15 @@
 
 <!-- Add your site or application content here -->
 <div>
-    <canvas id="canvas">Your browser doesn't support the HTML5 CANVAS tag.</canvas>
+    <canvas id="canvas main">Your browser doesn't support the HTML5 CANVAS tag.</canvas>
 </div>
 
-<!-- Run application. -->
+<!-- Include JavaScript dependencies -->
+<script type="text/javascript" src="../main-jsdeps.js"></script>
+<!-- Include Scala.js compiled code -->
+<script type="text/javascript" src="../main-fastopt.js"></script>
+<!-- Run JSApp -->
+<!-- <script type="text/javascript" src="../main-launcher.js"></script> -->
 <script type="text/javascript"> nl.amsscala.rembrandt.Main().main(document.getElementById('canvas'));</script>
 </body>
 </html>

src/main/resources/index.html

@@ -13,21 +13,12 @@
 
     <title>Scala.js | Bubbles!</title>
     <link rel=apple-touch-icon href="img/apple-touch-icon.png">
-    <!-- Place favicon.ico in the root directory -->
-    <link rel=icon href="img/favicon.ico" type="image/x-icon">
-
-    <!-- Latest compiled and minified Bootstrap CSS, normalize.css is already included-->
-    <!--<link rel="stylesheet" media="screen" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"
-          integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">-->
+    <!-- Place favicon.ico in the img directory -->
+    <link rel=icon type="image/x-icon" href="img/favicon.ico">
 
     <!-- Custom styles for this page -->
     <link rel=stylesheet media="screen" href="css/main.css">
 
-    <!-- Include JavaScript dependencies e.g. jquery.js -->
-    <script type="text/javascript" src="../main-opt.js"></script>
-    <!-- Include Scala.js compiled code -->
-    <script type="text/javascript" src="../main-jsdeps.min.js"></script>
-
     <!--<style type="text/css"></style>-->
 </head>
 
@@ -39,9 +30,14 @@
 
 <!-- Add your site or application content here -->
 <div>
-    <canvas id="canvas">Your browser doesn't support the HTML5 CANVAS tag.</canvas>
+    <canvas id="canvas main">Your browser doesn't support the HTML5 CANVAS tag.</canvas>
 </div>
 
+<!-- Include JavaScript dependencies e.g. jQuery.js -->
+<script type="text/javascript" src="../main-jsdeps.min.js"></script>
+<!-- Include Scala.js compiled code -->
+<script type="text/javascript" src="../main-opt.js"></script>
+
 <!-- Run application. -->
 <script type="text/javascript"> nl.amsscala.rembrandt.Main().main(document.getElementById('canvas'));</script>
 </body>

src/main/scala-2.11/nl/amsscala/rembrandt/Bubbles.scala

@@ -30,7 +30,8 @@ trait Bubbles{
 
     waves = waves.map(draw).takeWhile { w => w.time * 8 * speed < canvas.width || w.time * 5 * speed < canvas.height }
 
-    canvas.onmousedown = { (e: dom.MouseEvent) => waves +:= Wave(new Point(e.clientX, e.clientY)) }
+    lazy val runOnce = canvas.onmousedown = { (e: dom.MouseEvent) => waves +:= Wave(new Point(e.clientX, e.clientY)) }
+    runOnce
   }
 
 }

src/main/scala-2.11/nl/amsscala/rembrandt/Main.scala

@@ -1,4 +1,5 @@
-package nl.amsscala.rembrandt
+package nl.amsscala
+package rembrandt
 
 import org.scalajs.dom
 
@@ -9,16 +10,14 @@ import scala.scalajs.js.annotation.JSExport
   * Use this code as a template for resizeable full-window canvas applications. In index.html, replace %main application
   * class% with the application's main class name (whatever packaged name you give to the copy of this file).
   */
-@JSExport
-object Main extends js.JSApp with Resizeable with Fancy with Clock with Bubbles{
+object Main extends js.JSApp with Resizeable/* with Fancy*/ with Clock with Bubbles{
   lazy val timezone = js.Dynamic.global.jstz.determine().name().toString
 
   /**
     * Alternative method is enforced by JSApp which is necessary for the parameterless main call of the sbt
     * generated launcher when generation is set in build.sbt as: `persistLauncher in Compile := true`
     */
-  @JSExport
-  def main(): Unit = main(dom.document.getElementById("canvas").asInstanceOf[dom.html.Canvas])
+  def main(): Unit = main(dom.document.getElementById("canvas main").asInstanceOf[dom.html.Canvas])
 
   /**
     * The method initially called when the HTML page is loaded typically by its `Main().main(...)`
@@ -28,14 +27,14 @@ object Main extends js.JSApp with Resizeable with Fancy with Clock with Bubbles{
     *
     * @param canvas The HTML element, the container for graphics
     */
-  @JSExport
   def main(canvas: dom.html.Canvas): Unit = {
 
-    println(s"Main started at ${dateTimeStringOfPattern("d-MMM-yyyy HH:mm:ss")}.")
+    def run() = intialResize(canvas, List(successiveResize, fancy, clock, bubbles), timezone)
 
-    intialResize(canvas, List(successiveResize, fancy, clock, bubbles), timezone)
+    println(s"Main started at ${dateTimeStringOfPattern("d-MMM-yyyy HH:mm:ss")}.")
+    run()
     // Initialize the canvas and refresh continuously.
-    dom.window.setInterval(() => intialResize(canvas, List(successiveResize, fancy, clock, bubbles), timezone), 40)
+    dom.window.setInterval(() => run(), 40)
 
     // ... rest of the application logic
   }

src/main/scala-2.11/nl/amsscala/rembrandt/Resizeable.scala

@@ -6,18 +6,18 @@ import org.scalajs.dom
 trait Resizeable {
   type painterList = List[(dom.html.Canvas, dom.CanvasRenderingContext2D, => String) => Unit]
 
-  private var painters: Option[painterList] = None
+  private var painters: painterList = List.empty
 
   def successiveResize(canvas: dom.html.Canvas, renderer: dom.CanvasRenderingContext2D, dummy: => String) = {
     canvas.width = dom.window.innerWidth.toInt
     canvas.height = dom.window.innerHeight.toInt
   }
 
   protected def intialResize(canvas: dom.html.Canvas, _painters: painterList, context: => String): Unit = {
-    painters = Option(_painters)
+    painters = _painters
     val renderer = canvas.getContext("2d").asInstanceOf[dom.CanvasRenderingContext2D]
 
-    painters.get.foreach(_ (canvas, renderer, context))
-    dom.window.onresize = (event: dom.Event) => painters.get.foreach(_ (canvas, renderer, context))
+    painters.foreach(_ (canvas, renderer, context))
+    dom.window.onresize = (event: dom.Event) => painters.foreach(_ (canvas, renderer, context))
   }
 }